ArduPilot / ArduPilot/WebTools

Improve webtools (mainly PID tool) documentation / useability

Open
#157 6 comments 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
62
Forks
92
Avg merge
1d 23h
Merged PRs (30d)
2

Description

In the Filter review tool there's a description of what the tool does and what the tool needs in terms of logging data. If the data isn't present in the uploaded logs, the tool gives an error.

The PID-tool does neither have the text, nor the warning when there's not enough data in the logging. It just doesn't calculate the step-responses.

Proposed solution:
Post a picture of the logging bitmasks with the minimum required logging options selected at the top of each tool.
Alternatively post the parameter values of the needed logging parameter bitmasks with the minimum required options.

Contributor guide

No contributing guide indexed for this repository

Research direction

Inspect the PID tool and the Filter review tool to find where the tool description and logging requirements are shown. Compare the existing Filter review guidance with the PID tool’s behavior, then document the minimum logging options and add a warning when the uploaded logs lack enough data for step responses. Done means users can see the requirements and receive an explanatory warning.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.