|
| 1 | +/** |
| 2 | + * INAV Override API Definition |
| 3 | + * |
| 4 | + * Location: js/transpiler/api/definitions/override.js |
| 5 | + * |
| 6 | + * Writable override operations for flight control. |
| 7 | + * Source: src/main/programming/logic_condition.h |
| 8 | + */ |
| 9 | + |
| 10 | +'use strict'; |
| 11 | + |
| 12 | +import { OPERATION } from '../../transpiler/inav_constants.js'; |
| 13 | + |
| 14 | +export default { |
| 15 | + // Throttle Control |
| 16 | + throttleScale: { |
| 17 | + type: 'number', |
| 18 | + unit: '%', |
| 19 | + desc: 'Scale throttle output (0-100%)', |
| 20 | + readonly: false, |
| 21 | + range: [0, 100], |
| 22 | + inavOperation: OPERATION.OVERRIDE_THROTTLE_SCALE |
| 23 | + }, |
| 24 | + |
| 25 | + throttle: { |
| 26 | + type: 'number', |
| 27 | + unit: 'us', |
| 28 | + desc: 'Direct throttle override in microseconds', |
| 29 | + readonly: false, |
| 30 | + range: [1000, 2000], |
| 31 | + inavOperation: OPERATION.OVERRIDE_THROTTLE |
| 32 | + }, |
| 33 | + |
| 34 | + // VTX Control (nested object) |
| 35 | + vtx: { |
| 36 | + type: 'object', |
| 37 | + desc: 'Video transmitter control', |
| 38 | + properties: { |
| 39 | + power: { |
| 40 | + type: 'number', |
| 41 | + desc: 'VTX power level (0-4)', |
| 42 | + readonly: false, |
| 43 | + range: [0, 4], |
| 44 | + inavOperation: OPERATION.SET_VTX_POWER_LEVEL |
| 45 | + }, |
| 46 | + |
| 47 | + band: { |
| 48 | + type: 'number', |
| 49 | + desc: 'VTX frequency band (0-5)', |
| 50 | + readonly: false, |
| 51 | + range: [0, 5], |
| 52 | + inavOperation: OPERATION.SET_VTX_BAND |
| 53 | + }, |
| 54 | + |
| 55 | + channel: { |
| 56 | + type: 'number', |
| 57 | + desc: 'VTX channel (1-8)', |
| 58 | + readonly: false, |
| 59 | + range: [1, 8], |
| 60 | + inavOperation: OPERATION.SET_VTX_CHANNEL |
| 61 | + } |
| 62 | + } |
| 63 | + }, |
| 64 | + |
| 65 | + // Arming Control |
| 66 | + armSafety: { |
| 67 | + type: 'boolean', |
| 68 | + desc: 'Override arm safety switch', |
| 69 | + readonly: false, |
| 70 | + inavOperation: OPERATION.OVERRIDE_ARMING_SAFETY |
| 71 | + }, |
| 72 | + |
| 73 | + // OSD Override |
| 74 | + osdLayout: { |
| 75 | + type: 'number', |
| 76 | + desc: 'Set OSD layout (0-3)', |
| 77 | + readonly: false, |
| 78 | + range: [0, 3], |
| 79 | + inavOperation: OPERATION.SET_OSD_LAYOUT |
| 80 | + }, |
| 81 | + |
| 82 | + // RC Channel Override |
| 83 | + rcChannel: { |
| 84 | + type: 'function', |
| 85 | + desc: 'Override RC channel value. Usage: override.rcChannel(channel, value)', |
| 86 | + readonly: false, |
| 87 | + inavOperation: OPERATION.RC_CHANNEL_OVERRIDE |
| 88 | + // Note: This requires special handling in codegen as it takes channel number as operandA |
| 89 | + }, |
| 90 | + |
| 91 | + // Loiter Override |
| 92 | + loiterRadius: { |
| 93 | + type: 'number', |
| 94 | + unit: 'cm', |
| 95 | + desc: 'Override loiter radius in centimeters', |
| 96 | + readonly: false, |
| 97 | + range: [0, 100000], |
| 98 | + inavOperation: OPERATION.LOITER_OVERRIDE |
| 99 | + }, |
| 100 | + |
| 101 | + // Min Ground Speed Override |
| 102 | + minGroundSpeed: { |
| 103 | + type: 'number', |
| 104 | + unit: 'm/s', |
| 105 | + desc: 'Override minimum ground speed', |
| 106 | + readonly: false, |
| 107 | + range: [0, 150], |
| 108 | + inavOperation: OPERATION.OVERRIDE_MIN_GROUND_SPEED |
| 109 | + } |
| 110 | + |
| 111 | + // Note: Flight axis angle/rate overrides (operations 45, 46) would need |
| 112 | + // special syntax since they require specifying the axis (0=roll, 1=pitch, 2=yaw) |
| 113 | + // These should probably be exposed as: |
| 114 | + // override.flightAxis.angle(axis, degrees) |
| 115 | + // override.flightAxis.rate(axis, degreesPerSecond) |
| 116 | +}; |
0 commit comments