Skip to content

Commit 40bbbac

Browse files
committed
docs(tuning guide): Add component editor documentation
1 parent a5e477d commit 40bbbac

19 files changed

Lines changed: 225 additions & 3 deletions

TUNING_GUIDE_ArduCopter.md

Lines changed: 225 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,231 @@ So, [start the ArduPilot Methodic Configurator and select a vehicle that resembl
140140
1. select the destination directory, give it a name and press `Create a vehicle configuration directory from template`
141141
1. On the component editor window, **add all the details of the components of your system** as we did in [Section 1.2](#12-our-example-vehicle):
142142
![Component editor window](images/App_screenshot_Component_Editor.png)
143-
1. Make sure to **scroll all the way down and enter all the information requested**, even if it does not seem important to you.
144-
1. Click the `Save data and start configuration` button on the bottom
145-
1. You now have a vehicle configuration directory with the name that you selected. But the files are just templates, you need to edit them in the next steps.
143+
144+
Most optional information fields are only visible in `normal` GUI complexity mode.
145+
146+
All components have **optional** information about the product itself:
147+
148+
![product](images/blog/component_editor_product.png)
149+
150+
The URL can be used to store a link to a datasheet or a link to a shop product page.
151+
152+
Some components have **optional** information about their firmware:
153+
154+
![firmware](images/blog/component_editor_firmware.png)
155+
156+
All components have an **optional** notes field.
157+
158+
## Flight Controller
159+
160+
![flight controller](images/blog/component_editor_flight_controller.png)
161+
162+
Some information, if available, is automatically filed in by the software as seen in the example above.
163+
164+
## Frame
165+
166+
![frame](images/blog/component_editor_frame.png)
167+
168+
The minimum take off weight and the maximum take off weight in Kilo are entered here.
169+
If you have variable payload configure the vehicle at the minimum take off weight.
170+
Only after completely tuned can you add the additional payload.
171+
172+
## Battery Monitor
173+
174+
All supported connection types and their corresponding protocols are:
175+
176+
| Connection Type | Protocol |
177+
| --------------- | -------- |
178+
| `None` | `Disabled` |
179+
| `Analog` | `Analog Voltage Only` |
180+
| `Analog` | `Analog Voltage and Current` |
181+
| `Analog` | `FuelLevelAnalog` |
182+
| `Analog` | `Synthetic Current and Analog Voltage` |
183+
| `I2C1``I2C4` | `Solo` |
184+
| `I2C1``I2C4` | `Bebop` |
185+
| `I2C1``I2C4` | `SMBus-Generic` |
186+
| `I2C1``I2C4` | `FuelFlow` |
187+
| `I2C1``I2C4` | `SMBUS-SUI3` |
188+
| `I2C1``I2C4` | `SMBUS-SUI6` |
189+
| `I2C1``I2C4` | `NeoDesign` |
190+
| `I2C1``I2C4` | `SMBus-Maxell` |
191+
| `I2C1``I2C4` | `Generator-Elec` |
192+
| `I2C1``I2C4` | `Generator-Fuel` |
193+
| `I2C1``I2C4` | `Rotoye` |
194+
| `I2C1``I2C4` | `MPPT` |
195+
| `I2C1``I2C4` | `INA2XX` |
196+
| `I2C1``I2C4` | `LTC2946` |
197+
| `I2C1``I2C4` | `EFI` |
198+
| `I2C1``I2C4` | `AD7091R5` |
199+
| `CAN1``CAN2` | `DroneCAN-BatteryInfo` |
200+
| `PWM` | `FuelLevelPWM` |
201+
| `SPI` | `INA239_SPI` |
202+
| `other` | `ESC` |
203+
| `other` | `Sum Of Selected Monitors` |
204+
| `other` | `Torqeedo` |
205+
| `other` | `Scripting` |
206+
207+
It is strongly recommended to use a battery monitor.
208+
But if you do not have one select `none` in the flight controller connection:
209+
210+
![battery monitor none](images/blog/component_editor_battery_monitor_none.png)
211+
212+
If your battery monitor has an analog connection to the FC, select `analog` and one of the possible protocols:
213+
214+
![battery monitor analog](images/blog/component_editor_battery_monitor_analog.png)
215+
216+
If your battery monitor has an I2C connection to the FC, select the I2C bus and one of the possible protocols:
217+
218+
![battery monitor i2c](images/blog/component_editor_battery_monitor_i2c.png)
219+
220+
If your battery monitor has a CAN connection to the FC, select the CAN bus:
221+
222+
![battery monitor can](images/blog/component_editor_battery_monitor_can.png)
223+
224+
If your battery monitor has a SPI connection to the FC, select the SPI bus:
225+
226+
![battery monitor spi](images/blog/component_editor_battery_monitor_spi.png)
227+
228+
If your battery monitor has a PWM connection to the FC, select the PWM:
229+
230+
![battery monitor pwm](images/blog/component_editor_battery_monitor_pwm.png)
231+
232+
Otherwise select `other` and one of the possible protocols:
233+
234+
![battery monitor other](images/blog/component_editor_battery_monitor_other.png)
235+
236+
## Battery
237+
238+
![battery](images/blog/component_editor_battery.png)
239+
240+
Select the correct battery chemistry, doing so will automatically set typical voltage thresholds for that battery chemistry.
241+
242+
Afterwards you should tweak the voltage thresholds to meet your requirements.
243+
244+
- `Volt per cell max` - PID values will only scale when below this voltage
245+
- `Volt per cell arm` - vehicle will only arm if battery voltage is above this threshold
246+
- `Volt per cell low` - first failsafe level gets triggered when below this value
247+
- `Volt per cell crit` - second failsafe level gets triggered when below this value
248+
- `Volt per cell min` - PID values will only scale when above this voltage
249+
250+
They must obey `Volt per cell crit` < `Volt per cell low` < `Volt per cell arm` < `Volt per cell max`
251+
252+
`Number of cells` is the number of cells connected in series.
253+
For a 6S battery this is 6.
254+
255+
## ESC
256+
257+
Electronic speed controllers have a `FC->ESC Connection` for control of the motor speed and
258+
an optional `ESC->FC Telemetry` for telemetry feedback from the ESC to the flight controller.
259+
260+
![esc main out](images/blog/component_editor_esc_main_out.png)
261+
262+
The `FC->ESC Connection` type can be `Main Out`, an `AIO` integrated output, a serial port, or a CAN bus.
263+
The protocol is determined by the `MOT_PWM_TYPE` parameter (e.g. `Normal`, `DShot600`) for PWM outputs,
264+
or the serial/CAN protocol (e.g. `FETtecOneWire`, `DroneCAN`) for digital connections.
265+
266+
The `ESC->FC Telemetry` type and protocol describe the return path:
267+
268+
| Connection Type | Protocol | Notes |
269+
| --------------- | -------- | ----- |
270+
| `None` | `None` | No ESC telemetry |
271+
| same as FC->ESC | `BDShot` | BDShot only on Main Out and/or AIO, without serial port backup channel |
272+
| serial port | `ESC Telemetry` | DShot or BDShot serial telemetry backup channel |
273+
| serial port | `FETtecOneWire` | Bidirectional FETtec protocol on the same wire |
274+
| serial port | `Scripting` | For T-Motor/Hobbywing Datalink v2 serial telemetry |
275+
| serial port | `Torqeedo` | For Torqeedo telemetry |
276+
| serial port | `CoDevESC` | For CoDevESC serial telemetry |
277+
| CAN port | `DroneCAN` | Telemetry over CAN bus |
278+
279+
When using BDShot only on `Main Out` (1-8) and/or `Aux I/O` (9-14) connection, without serial port backup channel:
280+
281+
![ESC telemetry BDshot only](images/blog/component_editor_esc_telem_main_out_aio.png)
282+
283+
When using DShot or BDShot with a serial port backup channel:
284+
285+
![ESC telemetry serial](images/blog/component_editor_esc_telem_serial.png)
286+
287+
## Motors
288+
289+
![Motor configuration interface showing pole count input](images/blog/component_editor_motors.png)
290+
291+
Enter the number of magnetic **poles** of the motor rotor.
292+
This is the **P** number in the common `nNmP` motor winding notation (e.g. `12N14P` → 14 poles).
293+
The value must be an even integer.
294+
It is used by ArduPilot to calculate the actual motor RPM from the ESC telemetry electrical frequency.
295+
296+
## Propellers
297+
298+
![Propeller configuration interface showing diameter input](images/blog/component_editor_propellers.png)
299+
300+
Enter the propeller **diameter in inches**.
301+
This value affects many initial PID values.
302+
303+
## GNSS Receiver
304+
305+
![GNSS receiver configuration interface](images/blog/component_editor_gnss.png)
306+
307+
Select the FC connection **type** (serial port or CAN bus) and the matching **protocol**:
308+
309+
| Connection Type | Protocol |
310+
| --------------- | -------- |
311+
| None | `None` |
312+
| CAN bus | `DroneCAN` |
313+
| serial port — auto-detect | `AUTO` |
314+
| serial port — vendor-specific | other |
315+
316+
If you do not have a GNSS receiver, select `None` as the connection type.
317+
318+
## RC Controller
319+
320+
The hand-held controller used by the pilot.
321+
Enter the manufacturer and model for documentation purposes.
322+
This component has no FC connection — it communicates wirelessly via the RC Transmitter and RC Receiver pair.
323+
324+
## RC Transmitter
325+
326+
The RF transmitter module (may be integrated in the RC Controller or a separate module).
327+
Enter the manufacturer and model for documentation purposes.
328+
This component has no FC connection.
329+
330+
## RC Receiver
331+
332+
Select the FC connection **type** and **protocol** that match how the receiver is wired to the flight controller:
333+
334+
| Connection Type | Protocol |
335+
| --------------- | -------- |
336+
| RCin/SBUS — auto-detect all protocols | `All` |
337+
| RCin/SBUS | `PPM` |
338+
| RCin/SBUS or serial | `SBUS` / `SBUS_NI` |
339+
| serial port | `DSM` |
340+
| serial port | `CRSF` |
341+
| serial port | `FPORT` |
342+
| serial port | `MAVRadio` |
343+
| serial port — vendor-specific | other |
344+
345+
If your receiver is connected to a dedicated RC input pin, choose `RCin/SBUS` as the type.
346+
If it is connected to a UART (e.g. CRSF, FPORT, DSM), choose the corresponding serial port.
347+
348+
## Telemetry
349+
350+
Select the FC connection **type** (serial port or CAN bus) and the matching **protocol**:
351+
352+
| Connection Type | Protocol | Notes |
353+
| --------------- | -------- | ----- |
354+
| None | `None` | when not present |
355+
| serial | `MAVLink2` | recommended for most ground stations |
356+
| serial | `MAVLink1` | legacy ground stations |
357+
| serial | `MAVLink High Latency` | satellite / low-bandwidth links |
358+
| serial | `DDS XRCE` | ROS 2 micro-XRCE-DDS bridge |
359+
| serial | other | vendor-specific |
360+
361+
If you do not have a telemetry radio, select `None` as the connection type.
362+
363+
Make sure to **scroll all the way down and enter all the information requested**, even if it does not seem important to you.
364+
Click the `Save data and start configuration` button on the bottom
365+
366+
You now have a vehicle configuration directory with the name that you selected.
367+
But the files are just templates, you need to edit them in the next steps.
146368

147369
# 4. Perform IMU temperature calibration before assembling the autopilot into the vehicle (optional)
148370

10.6 KB
Loading
5.6 KB
Loading
2.32 KB
Loading
6.75 KB
Loading
1.79 KB
Loading
3.65 KB
Loading
2.59 KB
Loading
2.12 KB
Loading
5.92 KB
Loading

0 commit comments

Comments
 (0)