bluerobotics / bluerobotics/ardusub-gitbook
Joystick Button Functions Corrections
- Dominant language
- Python
- Stars
- 26
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
- The [Joystick Button Functions](https://www.ardusub.com/reference/ardusub/joystick-setup-page.html#joystick-button-functions) section is missing descriptions for:
- `servo_#_max_momentary` and `servo_#_min_momentary`
- ` servo_#_min_toggle` and `servo_#_max_toggle`
- `relay_#_momentary `
- `relay_4_on/off/toggle`
- also `input_hold_toggle` should be `input_hold_set`
Contributor guide
No contributing guide indexed for this repository
Research direction
Open the Joystick Button Functions section at the linked ArduSub documentation page and compare its entries with the requested names. Add descriptions for the listed servo and relay functions, and change input_hold_toggle to input_hold_set; done means every requested entry is documented and the incorrect name is corrected.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100