Skip to content

Commit 588e203

Browse files
committed
Complete transfer of INAV 5.1.0 docs
1 parent 746a55a commit 588e203

111 files changed

Lines changed: 11147 additions & 901 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/advanced/AAT-Automatic-Antenna-Tracker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ title: Automatic Antenna Tracker
44

55
## Introduction
66

7-
Since release 3.0, iNav directly supports embedded video telemetry data to drive the VirtualPilot Sentinel antenna tracker.
7+
Since release 3.0, INAV directly supports embedded video telemetry data to drive the VirtualPilot Sentinel antenna tracker.
88

99
This enables the use of directional higher gain antennas to maintain higher quality video in all directions, provide the ability to use lower video transmission power or increase the maximum reception distance over traditional omnidirectional antennas. The AAT provides the benefit of maintaining a more accurate direction over manually mounted antennas without the concern of the aircraft moving outside of the antenna’s dominant reception area.
1010

1111
***
1212
## Configuring - iNAV 3.0 onwards (embedded support)
13-
* Requires minimum of iNav 3.0 and fonts installed
13+
* Requires minimum of INAV 3.0 and fonts installed
1414
* Enable AAT telemetry in the cli: set osd_telemetry = ON
1515

1616
## Configuring - iNAV earlier versions
17-
* Check content at the link here: [iNAV AAT for earlier versions](https://github.com/aat-sentinel/Documentation/blob/main/Sentinel%20AAT%20lite%20User%20Guide.pdf)
17+
* Check content at the link here: [INAV AAT for earlier versions](https://github.com/aat-sentinel/Documentation/blob/main/Sentinel%20AAT%20lite%20User%20Guide.pdf)
1818

1919
## Testing
2020
As telemetry data is not normally visible, the telemetry data can be viewed on the OSD using a cli command:

docs/advanced/Boards-Targets-and-PWM-allocations.md

Lines changed: 142 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ The usage is taken directly from the source code, the following interpretation i
1717
| LED | LED strip |
1818
| PWM, ANY | Some other PWM function |
1919

20-
*List generated 2022-01-30 from the [inav master branch](https://github.com/iNavFlight/inav/) by [`parse_targets.rb`](http://seyrsnys.myzen.co.uk/parse_targets.rb). Some targets may not be available in official or prior releases.* **E&OE.**
20+
*List generated 2022-06-05 from the [INAV release_5.0.0 branch](https://github.com/iNavFlight/inav/) by [`parse_targets.rb`](/img/content/parse_targets.rb). Some targets may not be available in official or prior releases.* **E&OE.**
2121

2222
You are strongly advised to check the board documentation as to the suitability of any particular board.
2323

24-
The configurations listed above are those supported by the inav developers; other configurations may be possible with a custom target. The source tree contains other, unofficial targets that may (or not) work. A full report, including non-release targets may be generated with `parse_targets.rb --all`.
24+
The configurations listed above are those supported by the INAV developers; other configurations may be possible with a custom target. The source tree contains other, unofficial targets that may (or not) work. A full report, including non-release targets may be generated with `parse_targets.rb --all`.
2525

26-
Note also that due to the complexity of output options available in inav, dynamic resource allocation is not available. Paweł Spychalski has published a [video](https://www.youtube.com/watch?v=v4R-pnO4srU) explaining why resource allocation is not supported by inav; [see also #1154](https://github.com/iNavFlight/inav/issues/1145)
26+
Note also that due to the complexity of output options available in INAV, dynamic resource allocation is not available. Paweł Spychalski has published a [video](https://www.youtube.com/watch?v=v4R-pnO4srU) explaining why resource allocation is not supported by INAV; [see also #1154](https://github.com/iNavFlight/inav/issues/1145)
2727

2828
## Board: AIKONF4
2929

@@ -163,6 +163,23 @@ Board is not DSHOT enabled.
163163
| 13 | MC_MOTOR, FW_SERVO, LED |
164164
| 14 | MC_MOTOR, FW_SERVO |
165165

166+
## Board: AOCODARCF7DUAL
167+
168+
Board is DSHOT enabled.
169+
170+
### Target: AOCODARCF7DUAL
171+
172+
| PWM | Usage |
173+
| --- | ----- |
174+
| 1 | MC_MOTOR, FW_MOTOR |
175+
| 2 | MC_MOTOR, FW_MOTOR |
176+
| 3 | MC_MOTOR, FW_MOTOR |
177+
| 4 | MC_MOTOR, FW_MOTOR |
178+
| 5 | MC_MOTOR, FW_SERVO |
179+
| 6 | MC_MOTOR, FW_SERVO |
180+
| 7 | MC_MOTOR, FW_SERVO |
181+
| 8 | MC_MOTOR, FW_SERVO |
182+
166183
## Board: ASGARD32F4
167184

168185
Board is DSHOT enabled.
@@ -234,21 +251,6 @@ Board is DSHOT enabled.
234251
| 5 | MC_MOTOR |
235252
| 6 | MC_MOTOR |
236253

237-
## Board: BLUEJAYF4
238-
239-
Board is not DSHOT enabled.
240-
241-
### Target: BLUEJAYF4
242-
243-
| PWM | Usage |
244-
| --- | ----- |
245-
| 1 | MC_MOTOR, FW_MOTOR |
246-
| 2 | MC_MOTOR, FW_MOTOR |
247-
| 3 | MC_MOTOR, FW_SERVO |
248-
| 4 | MC_MOTOR, FW_SERVO |
249-
| 5 | MC_MOTOR, FW_SERVO, LED |
250-
| 6 | MC_MOTOR, FW_SERVO |
251-
252254
## Board: CLRACINGF4AIR
253255

254256
Board is not DSHOT enabled.
@@ -830,10 +832,23 @@ Board is DSHOT enabled.
830832
| 2 | MC_MOTOR, FW_MOTOR |
831833
| 3 | MC_MOTOR, FW_SERVO |
832834
| 4 | MC_MOTOR, FW_SERVO |
833-
| 5 | MC_MOTOR, FW_SERVO |
834-
| 6 | MC_MOTOR, FW_SERVO |
835-
| 7 | MC_MOTOR, FW_SERVO |
836-
| 8 | MC_MOTOR, FW_SERVO |
835+
| 5 | MC_SERVO, FW_SERVO |
836+
| 6 | MC_SERVO, FW_SERVO |
837+
| 7 | MC_SERVO, FW_SERVO |
838+
| 8 | MC_SERVO, FW_SERVO |
839+
840+
### Target: KAKUTEH7MINI
841+
842+
| PWM | Usage |
843+
| --- | ----- |
844+
| 1 | MC_MOTOR, FW_MOTOR |
845+
| 2 | MC_MOTOR, FW_MOTOR |
846+
| 3 | MC_MOTOR, FW_SERVO |
847+
| 4 | MC_MOTOR, FW_SERVO |
848+
| 5 | MC_SERVO, FW_SERVO |
849+
| 6 | MC_SERVO, FW_SERVO |
850+
| 7 | MC_SERVO, FW_SERVO |
851+
| 8 | MC_SERVO, FW_SERVO |
837852

838853
## Board: MAMBAF405US
839854

@@ -857,6 +872,21 @@ Board is DSHOT enabled.
857872
| 3 | MC_MOTOR, FW_SERVO |
858873
| 4 | MC_MOTOR, FW_SERVO |
859874

875+
## Board: MAMBAF405_2022A
876+
877+
Board is DSHOT enabled.
878+
879+
### Target: MAMBAF405_2022A
880+
881+
| PWM | Usage |
882+
| --- | ----- |
883+
| 1 | MC_MOTOR, FW_SERVO |
884+
| 2 | MC_MOTOR, FW_SERVO |
885+
| 3 | MC_MOTOR, FW_SERVO |
886+
| 4 | MC_MOTOR, FW_SERVO |
887+
| 5 | MC_SERVO, FW_MOTOR |
888+
| 6 | MC_SERVO, FW_MOTOR |
889+
860890
## Board: MAMBAF722
861891

862892
Board is DSHOT enabled.
@@ -879,6 +909,40 @@ Board is DSHOT enabled.
879909
| 3 | MC_MOTOR, FW_SERVO |
880910
| 4 | MC_MOTOR, FW_SERVO |
881911

912+
## Board: MAMBAF722_2022A
913+
914+
Board is DSHOT enabled.
915+
916+
### Target: MAMBAF722_2022A
917+
918+
| PWM | Usage |
919+
| --- | ----- |
920+
| 1 | MC_MOTOR, FW_MOTOR |
921+
| 2 | MC_MOTOR, FW_MOTOR |
922+
| 3 | MC_MOTOR, FW_SERVO |
923+
| 4 | MC_MOTOR, FW_SERVO |
924+
| 5 | MC_SERVO, FW_SERVO |
925+
| 6 | MC_SERVO, FW_SERVO |
926+
| 7 | MC_SERVO, FW_SERVO |
927+
| 8 | MC_SERVO, FW_SERVO |
928+
929+
## Board: MAMBAF722_X8
930+
931+
Board is DSHOT enabled.
932+
933+
### Target: MAMBAF722_X8
934+
935+
| PWM | Usage |
936+
| --- | ----- |
937+
| 1 | MC_MOTOR, FW_MOTOR |
938+
| 2 | MC_MOTOR, FW_MOTOR |
939+
| 3 | MC_MOTOR, FW_SERVO |
940+
| 4 | MC_MOTOR, FW_SERVO |
941+
| 5 | MC_MOTOR, FW_SERVO |
942+
| 6 | MC_MOTOR, FW_SERVO |
943+
| 7 | MC_MOTOR, FW_SERVO |
944+
| 8 | MC_MOTOR, FW_SERVO |
945+
882946
## Board: MAMBAH743
883947

884948
Board is DSHOT enabled.
@@ -891,10 +955,10 @@ Board is DSHOT enabled.
891955
| 2 | MC_MOTOR, FW_SERVO |
892956
| 3 | MC_MOTOR, FW_SERVO |
893957
| 4 | MC_MOTOR, FW_SERVO |
894-
| 5 | MC_MOTOR, FW_SERVO |
895-
| 6 | MC_MOTOR, FW_SERVO |
896-
| 7 | MC_MOTOR, FW_MOTOR |
897-
| 8 | MC_MOTOR, FW_MOTOR |
958+
| 5 | MC_SERVO, FW_SERVO |
959+
| 6 | MC_SERVO, FW_SERVO |
960+
| 7 | MC_SERVO, FW_MOTOR |
961+
| 8 | MC_SERVO, FW_MOTOR |
898962

899963
## Board: MATEKF405
900964

@@ -971,6 +1035,42 @@ Board is DSHOT enabled.
9711035
| 8 | MC_SERVO, FW_SERVO |
9721036
| 9 | MC_SERVO, FW_SERVO |
9731037

1038+
## Board: MATEKF405TE
1039+
1040+
Board is DSHOT enabled.
1041+
1042+
### Target: MATEKF405TE
1043+
1044+
| PWM | Usage |
1045+
| --- | ----- |
1046+
| 1 | MC_MOTOR, FW_MOTOR |
1047+
| 2 | MC_MOTOR, FW_MOTOR |
1048+
| 3 | MC_MOTOR, FW_SERVO |
1049+
| 4 | MC_MOTOR, FW_SERVO |
1050+
| 5 | MC_MOTOR, FW_SERVO |
1051+
| 6 | MC_MOTOR, FW_SERVO |
1052+
| 7 | MC_MOTOR, FW_SERVO |
1053+
| 8 | MC_MOTOR, FW_SERVO |
1054+
| 9 | MC_SERVO, FW_SERVO |
1055+
| 10 | MC_SERVO, FW_SERVO |
1056+
| 11 | MC_SERVO, FW_SERVO |
1057+
1058+
### Target: MATEKF405TE_SD
1059+
1060+
| PWM | Usage |
1061+
| --- | ----- |
1062+
| 1 | MC_MOTOR, FW_MOTOR |
1063+
| 2 | MC_MOTOR, FW_MOTOR |
1064+
| 3 | MC_MOTOR, FW_SERVO |
1065+
| 4 | MC_MOTOR, FW_SERVO |
1066+
| 5 | MC_MOTOR, FW_SERVO |
1067+
| 6 | MC_MOTOR, FW_SERVO |
1068+
| 7 | MC_MOTOR, FW_SERVO |
1069+
| 8 | MC_MOTOR, FW_SERVO |
1070+
| 9 | MC_SERVO, FW_SERVO |
1071+
| 10 | MC_SERVO, FW_SERVO |
1072+
| 11 | MC_SERVO, FW_SERVO |
1073+
9741074
## Board: MATEKF411
9751075

9761076
Board is DSHOT enabled.
@@ -1070,6 +1170,22 @@ Board is DSHOT enabled.
10701170
| 4 | MC_MOTOR, FW_SERVO |
10711171
| 5 | MC_MOTOR, FW_SERVO |
10721172

1173+
## Board: MATEKF411TE
1174+
1175+
Board is DSHOT enabled.
1176+
1177+
### Target: MATEKF411TE
1178+
1179+
| PWM | Usage |
1180+
| --- | ----- |
1181+
| 1 | MC_MOTOR, FW_MOTOR |
1182+
| 2 | MC_MOTOR, FW_MOTOR |
1183+
| 3 | MC_MOTOR, FW_SERVO |
1184+
| 4 | MC_MOTOR, FW_SERVO |
1185+
| 5 | MC_MOTOR, FW_SERVO |
1186+
| 6 | MC_MOTOR, FW_SERVO |
1187+
| 7 | LED, MC_SERVO |
1188+
10731189
## Board: MATEKF722
10741190

10751191
Board is DSHOT enabled.
@@ -1624,4 +1740,3 @@ Board is DSHOT enabled.
16241740
| 6 | MC_MOTOR, FW_SERVO |
16251741
| 7 | MC_MOTOR, FW_SERVO |
16261742
| 8 | MC_MOTOR, FW_SERVO |
1627-

docs/advanced/Custom-mixes-for-exotic-setups.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ mmix 7 1.0 1.0 0.414178 -1.0 # MIDREAR_L
113113

114114
## Bicopter
115115

116-
***Warning*** this is highly experimental, not documented, not tested in real life conditions and I'm pretty sure there are not more than few in the whole world!
116+
**_Warning_** this is highly experimental, not documented, not tested in real life conditions and I'm pretty sure there are not more than few in the whole world!
117117
Mixer configuration below is reverse engineered from CF code.
118118

119119
```
@@ -130,8 +130,9 @@ smix 3 5 1 100 0 # Servo 5 for right motor pitch change
130130

131131
## Dualcopter
132132

133-
***Warning*** this is highly experimental, not documented, not tested in real life conditions and I'm pretty sure there are not more than few in the whole world!
133+
**_Warning_** this is highly experimental, not documented, not tested in real life conditions and I'm pretty sure there are not more than few in the whole world!
134134
Mixer configuration below is reverse engineered from CF code.
135+
135136
```
136137
mmix reset
137138
mmix 0 1.0 0.0 0.0 -1.0 # Left
@@ -177,12 +178,14 @@ smix 2 2 1 -100 0
177178
```
178179

179180
## Nano Talon with 2 Servos for the V-Tail
181+
180182
Note: See [this video](https://www.youtube.com/watch?v=IOApkFPGKtc) for details on the V-Tail mod.
183+
181184
```
182185
# mixer
183186
mmix reset
184187
mmix 0 1.0 0.0 0.0 0.0 # motor
185-
smix reset
188+
smix reset
186189
smix 0 2 0 -100 0 # servo 2 takes Stabilised ROLL (PWM 3)
187190
smix 1 3 1 -50 0 # servo 3 takes Stabilised PITCH (PWM 4)
188191
smix 2 4 1 50 0 # servo 4 takes Stabilised -PITCH (PWM 5)
@@ -191,6 +194,7 @@ smix 4 4 2 50 0 # servo 4 takes Stabilised YAW (PWM 5)
191194
```
192195

193196
## AVIOS BUSHMULE – Notably separate FLAPS (instead of flapperons). Uses single aileron control with Y cable
197+
194198
```
195199
# servo mix
196200
smix reset
@@ -199,10 +203,12 @@ smix 1 3 0 100 0 # servo 3 takes Stabilised ROLL (PWM 4)
199203
smix 2 4 14 100 0 # servo 4 takes FLAPS (PWM 5)
200204
smix 3 5 2 100 0 # servo 5 takes Stabilised YAW (PWM 6)
201205
# servo – also consider manipulating of servo midpoint for correct flaps operation:
202-
servo 4 1000 2000 2000 -100 -1
206+
servo 4 1000 2000 2000 -100 -1
203207
204208
```
209+
205210
## Twin Motor - Differential thrust and FLAPERONS
211+
206212
```
207213
# mixer
208214
mmix reset
@@ -217,7 +223,7 @@ smix 2 5 2 100 0 #servo 5 takes Stabilised YAW (PWM 6)
217223
smix 3 2 1 100 0 #servo 2 takes Stabilised PITCH (PWM 3)
218224
smix 4 3 14 100 0 #Setup flaps on aileron pins (PWM 4)
219225
smix 5 4 14 100 0 #Setup flaps on aileron pins (PWM 5)
220-
smix reverse 3 14 r #Reverse the Flaps on PWM 4/5, skip this if you want spoilerons
226+
smix reverse 3 14 r #Reverse the Flaps on PWM 4/5, skip this if you want spoilerons
221227
smix reverse 4 14 r #or if it works based on servo orientation
222228
223229
# servo
@@ -238,23 +244,23 @@ Never implemented.
238244

239245
## MIXER_GIMBAL
240246

241-
Use feature ***SERVO_TILT*** instead.
247+
Use feature **_SERVO_TILT_** instead.
242248

243249
## Singlecopter
244250

245-
***Warning*** this is highly experimental, not documented and I'm pretty sure there are not more than few in the whole world!
246-
Mixer configuration below is reverse engineered from CF code. Mixer is capable of processing this setup, but servo output will not work due to BF/CF PWM output limitations.
251+
**_Warning_** this is highly experimental, not documented and I'm pretty sure there are not more than few in the whole world!
252+
Mixer configuration below is reverse engineered from CF code. Mixer is capable of processing this setup, but servo output will not work due to BF/CF PWM output limitations.
247253

248254
```
249255
mmix reset
250256
251257
smix reset
252-
smix 0 3 2 100 0
253-
smix 1 3 1 100 0
254-
smix 2 4 2 100 0
255-
smix 3 4 1 100 0
256-
smix 4 5 2 100 0
257-
smix 5 5 0 100 0
258+
smix 0 3 2 100 0
259+
smix 1 3 1 100 0
260+
smix 2 4 2 100 0
261+
smix 3 4 1 100 0
262+
smix 4 5 2 100 0
263+
smix 5 5 0 100 0
258264
smix 6 6 2 100 0
259-
smix 7 6 0 100 0
265+
smix 7 6 0 100 0
260266
```

0 commit comments

Comments
 (0)