bluerobotics / bluerobotics/ardusub-gitbook

pymavlink: read/set params improvements

Open
#217 1 comment 0 reactions 0 assignees View on GitHub
enhancement good-first-issue
Dominant language
Python
Stars
26
Forks
43
PR merge metrics
No merged PRs in 30d

Description

Existing docs could be updated to make use of [`master.param_fetch_*`](https://github.com/ArduPilot/pymavlink/blob/master/mavutil.py#L519-L535), and [`master.param_set_send`](https://github.com/ArduPilot/pymavlink/blob/master/mavutil.py#L543-L552) or [`pymavlink.mavparm.MAVParmDict.mavset`](https://github.com/ArduPilot/pymavlink/blob/master/mavparm.py#L10-L71).

Would also be good to format the output values as floats, since not all parameters are integers (as brought up [here](https://discuss.bluerobotics.com/t/set-thrusters-to-run-with-a-pilot-input-gain-less-than-25/10547/2)). Likely worth changing to `.format` syntax (or `f-strings`, but since they require Python >= 3.6 they aren't compatible with the current companion, so would only work on the surface computer or a companion with a [more recent Python version](https://discuss.bluerobotics.com/t/updating-python-in-companion/10398/2))

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the existing parameter read/set documentation, then compare it with the referenced APIs in mavutil.py and mavparm.py. Update the examples to cover parameter fetching and setting, and ensure displayed parameter values are formatted as floats using syntax compatible with the supported Python versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.