Skip to content

Commit ba84d46

Browse files
committed
docs(usermanual): added information on how to edit bitmasks
Added more screenshots Explain the progress bar
1 parent 4a4374f commit ba84d46

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

USERMANUAL.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,13 +165,24 @@ All other intermediate parameter files can be used without modifications across
165165
- **Use the `Current intermediate parameter file:` combobox to select an intermediate parameter file.**
166166
- The first available intermediate parameter file not named `00_default.param` will be selected by default
167167
- If the selection changes, the parameter table will update to display the parameters from the selected file.
168+
- The sequence is defined by the order of the intermediate parameter files in the vehicle configuration directory.
168169

169170
#### 3. About information and help links (optional)
170171

171172
When you click the ArduPilot logo the following window will appear:
172173
![About and help information](images/App_screenshot_about.png)
173174

174-
#### 4. Viewing Documentation
175+
#### 4a. Configuration sequence progress bar
176+
177+
This segmented bar shows the progress in the vehicle configuration sequence.
178+
The progress bar is updated automatically when you upload an intermediate parameter file to the flight controller or
179+
select a different intermediate parameter file in the `Current intermediate parameter file:` combobox above it.
180+
The steps are grouped into phases and optional phases are greyed-out.
181+
There are mouse-over hints for each phase.
182+
183+
![Parameter editor and uploader window](images/App_parameter_editor_and_uploader.png)
184+
185+
#### 4b. Viewing Documentation
175186

176187
- **Click on the documentation labels to open the corresponding documentation in a web browser.**
177188
- Documentation is split into four categories:
@@ -185,6 +196,8 @@ When you click the ArduPilot logo the following window will appear:
185196

186197
#### 5. Editing Parameters
187198

199+
![Editing parameters](images/App_editing_parameters.png)
200+
188201
- The parameter table presents the parameters in the current intermediate parameter file
189202
- The first column is a `Del` button that deletes the parameter in this row from the current intermediate parameter file.
190203
- The second column is the ArduPilot parameter name used in that row.
@@ -197,7 +210,10 @@ When you click the ArduPilot logo the following window will appear:
197210
- The new value is the value in the intermediate file and will be uploaded to the flight controller.
198211
**You MUST change the value to meet your needs**. The provided values in the `vehicle_template` directory are just examples.
199212
- parameters that should not be changed by the users, or are derived from information in the [*component editor*](#vehicle-component-editor-interface)
200-
are greyed out and can not be edited
213+
are greyed out and can not be edited.
214+
- bitmask parameters are editable in two ways:
215+
- *Decimal* - enter the decimal value of the bitmask as you would with any other parameter.
216+
- *Bitmask* - double-click the parameter value with the mouse and a window will popup where you can edit the individual bits in the bitmask.
201217
- **In the parameter table, you can edit the `New Value` and `Change Reason` entries for each parameter.**
202218
- **You MUST edit the `Change Reason` so that other users understand why you changed the parameter to that particular `New value`**
203219
- Check the `Upload` checkbox to select parameters to be uploaded to the flight controller

images/App_editing_parameters.png

255 KB
Loading
243 KB
Loading

0 commit comments

Comments
 (0)