Mirror/inav
1
0
Fork 0
mirror of https://github.com/iNavFlight/inav.git synced 2025-07-13 19:40:27 +03:00
Code Issues Wiki Activity

Added missing notes and tidied

Browse source
This commit is contained in:
Darren Lines 2022-04-15 10:42:27 +01:00
parent 666f98ee8d
commit eef3524bb3
1 changed files with 108 additions and 109 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/Programming Framework.md
View file

@ -32,20 +32,20 @@ IPF can be edited using INAV Configurator user interface, of via CLI
### Operations ### Operations
| Operation ID | Name | Notes | | Operation ID | Name | Notes |
|---- |---- |---- | |---------------|-------------------------------|-------|
| 0 | TRUE | Always evaluates as true | | 0 | TRUE | Always evaluates as true |
| 1 | EQUAL | Evaluates `false` if `false` or `0` | | 1 | EQUAL | Evaluates `false` if `false` or `0` |
| 2 | GREATER_THAN | | | 2 | GREATER_THAN | `true` if `Operand A` is a higher value than `Operand B` |
| 3 | LOWER_THAN | | | 3 | LOWER_THAN | `true` if `Operand A` is a lower value than `Operand B` |
| 4 | LOW | `true` if `<1333` | | 4 | LOW | `true` if `<1333` |
| 5 | MID | `true` if `>=1333 and <=1666` | | 5 | MID | `true` if `>=1333 and <=1666` |
| 6 | HIGH | `true` if `>1666` | | 6 | HIGH | `true` if `>1666` |
| 7 | AND | | | 7 | AND | `true` if `Operand A` and `Operand B` are the same value or both `true` |
| 8 | OR | | | 8 | OR | `true` if `Operand A` and/or `OperandB` is `true` |
| 9 | XOR | | | 9 | XOR | `true` if `Operand A` or `Operand B` is `true`, but not both |
| 10 | NAND | | | 10 | NAND | `false` if `Operand A` and `Operand B` are both `true`|
| 11 | NOR | | | 11 | NOR | `true` if `Operand A` and `Operand B` are both `false` |
| 12 | NOT | | | 12 | NOT | The boolean opposite to `Operand A` |
| 13 | STICKY | `Operand A` is activation operator, `Operand B` is deactivation operator. After activation, operator will return `true` until Operand B is evaluated as `true`| | 13 | STICKY | `Operand A` is activation operator, `Operand B` is deactivation operator. After activation, operator will return `true` until Operand B is evaluated as `true`|
| 14 | ADD | Add `Operand A` to `Operand B` and returns the result | | 14 | ADD | Add `Operand A` to `Operand B` and returns the result |
| 15 | SUB | Substract `Operand B` from `Operand A` and returns the result | | 15 | SUB | Substract `Operand B` from `Operand A` and returns the result |
@ -78,11 +78,10 @@ IPF can be edited using INAV Configurator user interface, of via CLI
| 42 | SET_PROFILE | Sets the active config profile (PIDFF/Rates/Filters/etc) to `Operand A`. `Operand A` must be a valid profile number, currently from 1 to 3. If not, the profile will not change | | 42 | SET_PROFILE | Sets the active config profile (PIDFF/Rates/Filters/etc) to `Operand A`. `Operand A` must be a valid profile number, currently from 1 to 3. If not, the profile will not change |
| 43 | MIN | Finds the lowest value of `Operand A` and `Operand B` | | 43 | MIN | Finds the lowest value of `Operand A` and `Operand B` |
| 44 | MAX | Finds the highest value of `Operand A` and `Operand B` | | 44 | MAX | Finds the highest value of `Operand A` and `Operand B` |
### Operands ### Operands
| Operand Type | Name | Notes | | Operand Type | Name | Notes |
|---- |---- |---- | |---------------|-----------------------|-------|
| 0 | VALUE | Value derived from `value` field | | 0 | VALUE | Value derived from `value` field |
| 1 | GET_RC_CHANNEL | `value` points to RC channel number, indexed from 1 | | 1 | GET_RC_CHANNEL | `value` points to RC channel number, indexed from 1 |
| 2 | FLIGHT | `value` points to flight parameter table | | 2 | FLIGHT | `value` points to flight parameter table |
@ -94,7 +93,7 @@ IPF can be edited using INAV Configurator user interface, of via CLI
#### FLIGHT #### FLIGHT
| Operand Value | Name | Notes | | Operand Value | Name | Notes |
|---- |---- |---- | |---------------|-------------------------------|-------|
| 0 | ARM_TIMER | in `seconds` | | 0 | ARM_TIMER | in `seconds` |
| 1 | HOME_DISTANCE | in `meters` | | 1 | HOME_DISTANCE | in `meters` |
| 2 | TRIP_DISTANCE | in `meters` | | 2 | TRIP_DISTANCE | in `meters` |
@ -136,7 +135,7 @@ IPF can be edited using INAV Configurator user interface, of via CLI
#### ACTIVE_WAYPOINT_ACTION #### ACTIVE_WAYPOINT_ACTION
| Action | Value | | Action | Value |
|---- |---- | |---------------|-------|
| WAYPOINT | 1 | | WAYPOINT | 1 |
| HOLD_TIME | 3 | | HOLD_TIME | 3 |
| RTH | 4 | | RTH | 4 |
@ -149,7 +148,7 @@ IPF can be edited using INAV Configurator user interface, of via CLI
#### FLIGHT_MODE #### FLIGHT_MODE
| Operand Value | Name | Notes | | Operand Value | Name | Notes |
|---- |---- |---- | |---------------|-----------|-------|
| 0 | FAILSAFE | | | 0 | FAILSAFE | |
| 1 | MANUAL | | | 1 | MANUAL | |
| 2 | RTH | | | 2 | RTH | |
@ -168,7 +167,7 @@ IPF can be edited using INAV Configurator user interface, of via CLI
All flags are reseted on ARM and DISARM event. All flags are reseted on ARM and DISARM event.
| bit | Decimal | Function | | bit | Decimal | Function |
|---- |---- |---- | |-------|-----------|-----------|
| 0 | 1 | Latch - after activation LC will stay active until LATCH flag is reseted | | 0 | 1 | Latch - after activation LC will stay active until LATCH flag is reseted |
## Global variables ## Global variables