### JSON Parameter Format Example Source: https://context7.com/ardupilot/parameterrepository/llms.txt This JSON snippet illustrates the structure of parameter definitions within the apm.pdef.json file, including display names, descriptions, user access levels, units, ranges, and enumerated values. ```json { "json": { "version": 0 }, "Copter": { "FORMAT_VERSION": { "DisplayName": "Eeprom format version number", "Description": "This value is incremented when changes are made to the eeprom format", "User": "Advanced" }, "PILOT_THR_FILT": { "DisplayName": "Throttle filter cutoff", "Description": "Throttle filter cutoff (Hz) - active whenever altitude control is inactive - 0 to disable", "User": "Advanced", "Units": "Hz", "Range": { "low": "0", "high": "10" }, "Increment": "0.5" }, "FS_GCS_ENABLE": { "DisplayName": "Ground Station Failsafe Enable", "Description": "Controls whether failsafe will be invoked when connection with Ground station is lost", "User": "Standard", "Values": { "0": "Disabled/NoAction", "1": "RTL", "3": "SmartRTL or RTL", "4": "SmartRTL or Land", "5": "Land" } } }, "ADSB_": { "ADSB_EMIT_TYPE": { "DisplayName": "Emitter type", "Description": "ADSB classification for the type of vehicle emitting the transponder signal", "User": "Advanced", "Values": { "0": "NoInfo", "14": "UAV", "7": "Rotocraft" } } } } ``` -------------------------------- ### Q_GUIDED_MODE: Enable VTOL in GUIDED Mode Source: https://github.com/ardupilot/parameterrepository/blob/main/Plane-4.8/Parameters.rst Enables the use of VTOL flight within GUIDED mode. When enabled, the aircraft transitions to VTOL flight and hovers upon reaching the guided destination. ```APIDOC ## Q_GUIDED_MODE ### Description Enables the use of VTOL flight within GUIDED mode. When this parameter is enabled, the aircraft will switch to VTOL flight upon reaching the guided destination and hover there. ### Method SET ### Endpoint /ardupilot/parameterrepository ### Parameters #### Query Parameters - **parameter_id** (string) - Required - The ID of the parameter to set. - **value** (integer) - Required - The new value for the parameter. #### Request Body None ### Request Example ```json { "parameter_id": "Q_GUIDED_MODE", "value": 1 } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Parameter Q_GUIDED_MODE set to 1" } ``` ### Values - 0: Disabled - 1: Enabled ``` -------------------------------- ### Script and Lighting Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Sub-4.8/ParametersLatex.rst List of script and lighting parameters available in the ArduPilot parameter repository. ```APIDOC ## Script Parameters ### Description Parameters for script execution. ### Method N/A ### Endpoint N/A ### Parameters #### Query Parameters - **ID** (integer) - N/A - Script ID - **Name** (string) - N/A - Script Name | ID | Name | |-----|-----------| | 103 | Script10 | | 104 | Script11 | | 105 | Script12 | | 106 | Script13 | | 107 | Script14 | | 108 | Script15 | | 109 | Script16 | ## NeoPixel Parameters ### Description Parameters for NeoPixel LED control. ### Method N/A ### Endpoint N/A ### Parameters #### Query Parameters - **ID** (integer) - N/A - NeoPixel ID - **Name** (string) - N/A - NeoPixel Name | ID | Name | |-----|-----------| | 120 | NeoPixel1 | | 121 | NeoPixel2 | | 122 | NeoPixel3 | | 123 | NeoPixel4 | ## Lights Parameters ### Description Parameters for general lighting control. ### Method N/A ### Endpoint N/A ### Parameters #### Query Parameters - **ID** (integer) - N/A - Light ID - **Name** (string) - N/A - Light Name | ID | Name | |-----|-------------| | 181 | Lights1 | | 182 | Lights2 | | 183 | VideoSwitch | ``` -------------------------------- ### Simulation Initialization Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Sub-4.8/Parameters.rst Parameters for setting initial conditions in ArduPilot simulations. ```APIDOC ## SIM_INIT_ALT_OFS: Initial Altitude Offset ### Description GPS initial alt offset from origin ## SIM_INIT_LAT_OFS: Initial Latitude Offset ### Description GPS initial lat offset from origin ## SIM_INIT_LON_OFS: Initial Longitude Offset ### Description GPS initial lon offset from origin ``` -------------------------------- ### Parameter List Overview Source: https://github.com/ardupilot/parameterrepository/blob/main/Copter-4.8/Parameters.rst A comprehensive list of available parameters in the ArduPilot parameter repository. ```APIDOC ## Parameter List ### Description This section provides a list of available parameters within the ArduPilot system. ### Parameters - **105** (Script12) - **106** (Script13) - **107** (Script14) - **108** (Script15) - **109** (Script16) - **120** (NeoPixel1) - **121** (NeoPixel2) - **122** (NeoPixel3) - **123** (NeoPixel4) - **124** (RateRoll) - **125** (RatePitch) - **126** (RateThrust) - **127** (RateYaw) - **129** (ProfiLED1) - **130** (ProfiLED2) - **131** (ProfiLED3) - **132** (ProfiLEDClock) - **133** (Winch Clutch) - **134** (SERVOn_MIN) - **135** (SERVOn_TRIM) - **136** (SERVOn_MAX) - **138** (Alarm) - **139** (Alarm Inverted) - **140** (RCIN1Scaled) - **141** (RCIN2Scaled) - **142** (RCIN3Scaled) - **143** (RCIN4Scaled) - **144** (RCIN5Scaled) - **145** (RCIN6Scaled) - **146** (RCIN7Scaled) - **147** (RCIN8Scaled) - **148** (RCIN9Scaled) - **149** (RCIN10Scaled) - **150** (RCIN11Scaled) - **151** (RCIN12Scaled) - **152** (RCIN13Scaled) - **153** (RCIN14Scaled) - **154** (RCIN15Scaled) - **155** (RCIN16Scaled) - **160** (Motor13) - **161** (Motor14) - **162** (Motor15) - **163** (Motor16) - **164** (Motor17) - **165** (Motor18) - **166** (Motor19) - **167** (Motor20) - **168** (Motor21) - **169** (Motor22) - **170** (Motor23) - **171** (Motor24) - **172** (Motor25) - **173** (Motor26) - **174** (Motor27) - **175** (Motor28) - **176** (Motor29) - **177** (Motor30) - **178** (Motor31) - **179** (Motor32) ``` -------------------------------- ### General Parameter Mappings Source: https://github.com/ardupilot/parameterrepository/blob/main/Plane-4.8/Parameters.html List of general parameters including RC inputs, ignition, starter, throttle, motor outputs, camera controls, script assignments, airbrakes, NeoPixel control, rate controls, ProfiLED control, servo on/off parameters, and alarm settings. ```APIDOC ## General Parameter Mappings ### Description List of general parameters including RC inputs, ignition, starter, throttle, motor outputs, camera controls, script assignments, airbrakes, NeoPixel control, rate controls, ProfiLED control, servo on/off parameters, and alarm settings. ### Parameters - **RCIN4** (int) - **RCIN5** (int) - **RCIN6** (int) - **RCIN7** (int) - **RCIN8** (int) - **RCIN9** (int) - **RCIN10** (int) - **RCIN11** (int) - **RCIN12** (int) - **RCIN13** (int) - **RCIN14** (int) - **RCIN15** (int) - **RCIN16** (int) - **Ignition** (int) - **Starter** (int) - **Throttle** (int) - **ThrottleLeft** (int) - **ThrottleRight** (int) - **TiltMotorFrontLeft** (int) - **TiltMotorFrontRight** (int) - **ElevonLeft** (int) - **ElevonRight** (int) - **VTailLeft** (int) - **VTailRight** (int) - **Motor9** (int) - **Motor10** (int) - **Motor11** (int) - **Motor12** (int) - **DifferentialSpoilerLeft2** (int) - **DifferentialSpoilerRight2** (int) - **CameraISO** (int) - **CameraAperture** (int) - **CameraFocus** (int) - **CameraShutterSpeed** (int) - **Script1** (int) - **Script2** (int) - **Script3** (int) - **Script4** (int) - **Script5** (int) - **Script6** (int) - **Script7** (int) - **Script8** (int) - **Script9** (int) - **Script10** (int) - **Script11** (int) - **Script12** (int) - **Script13** (int) - **Script14** (int) - **Script15** (int) - **Script16** (int) - **Airbrakes** (int) - **NeoPixel1** (int) - **NeoPixel2** (int) - **NeoPixel3** (int) - **NeoPixel4** (int) - **RateRoll** (int) - **RatePitch** (int) - **RateThrust** (int) - **RateYaw** (int) - **ProfiLED1** (int) - **ProfiLED2** (int) - **ProfiLED3** (int) - **ProfiLEDClock** (int) - **SERVOn_MIN** (int) - **SERVOn_TRIM** (int) - **SERVOn_MAX** (int) - **Alarm** (int) - **Alarm Inverted** (int) - **RCIN1Scaled** (int) - **RCIN2Scaled** (int) - **RCIN3Scaled** (int) - **RCIN4Scaled** (int) - **RCIN5Scaled** (int) - **RCIN6Scaled** (int) - **RCIN7Scaled** (int) - **RCIN8Scaled** (int) - **RCIN9Scaled** (int) - **RCIN10Scaled** (int) - **RCIN11Scaled** (int) - **RCIN12Scaled** (int) - **RCIN13Scaled** (int) - **RCIN14Scaled** (int) - **RCIN15Scaled** (int) - **RCIN16Scaled** (int) - **Motor13** (int) - **Motor14** (int) - **Motor15** (int) - **Motor16** (int) - **Motor17** (int) - **Motor18** (int) - **Motor19** (int) - **Motor20** (int) - **Motor21** (int) - **Motor22** (int) - **Motor23** (int) - **Motor24** (int) - **Motor25** (int) - **Motor26** (int) - **Motor27** (int) - **Motor28** (int) - **Motor29** (int) - **Motor30** (int) - **Motor31** (int) - **Motor32** (int) ### RebootRequired - **Value**: True ``` -------------------------------- ### Tuning and Stabilization Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Plane-4.8/ParametersLatex.rst Parameters related to autotuning, QuickTune, and mount stabilization. ```APIDOC ## Test autotuned gains after tune is complete (180) ### Description Tests the autotuned gains after a tuning process has been completed. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 180 ``` ```APIDOC ## QuickTune (181) ### Description Enables and configures the QuickTune functionality for rapid parameter adjustments. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 181 ``` ```APIDOC ## Mount Roll/Pitch Lock (185) ### Description Enables or configures the lock for Mount Roll and Pitch axes. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 185 ``` ```APIDOC ## Mount POI Lock (186) ### Description Enables or configures the lock for the Mount Point of Interest (POI) functionality. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 186 ``` ```APIDOC ## Mount1 Roll (212) ### Description Controls the Roll axis of Mount 1. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 212 ``` ```APIDOC ## Mount1 Pitch (213) ### Description Controls the Pitch axis of Mount 1. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 213 ``` ```APIDOC ## Mount1 Yaw (214) ### Description Controls the Yaw axis of Mount 1. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 214 ``` ```APIDOC ## Mount2 Roll (215) ### Description Controls the Roll axis of Mount 2. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 215 ``` ```APIDOC ## Mount2 Pitch (216) ### Description Controls the Pitch axis of Mount 2. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 216 ``` ```APIDOC ## Mount2 Yaw (217) ### Description Controls the Yaw axis of Mount 2. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ### Details - **ID**: 217 ``` -------------------------------- ### Rover Quicktune Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Blimp-4.8/ParametersLatex.rst Parameters for enabling and configuring the rover quicktune system. ```APIDOC ## RTUN_ENABLE: Rover Quicktune Enable ### Description Enables the rover quicktune system. ### Method N/A (Parameter Configuration) ### Endpoint N/A ### Parameters #### Query Parameters - **RTUN_ENABLE** (enum) - Required - Enable quicktune system. - Value 0: Disabled - Value 1: Enabled ## RTUN_AXES: Rover Quicktune Axes ### Description Specifies the axes to be tuned by the rover quicktune system. ### Method N/A (Parameter Configuration) ### Endpoint N/A ### Parameters #### Query Parameters - **RTUN_AXES** (bitmask) - Required - Axes to tune. - Bit 0: Steering - Bit 1: Speed ## RTUN_STR_FFRATIO: Rover Quicktune Steering Rate FeedForward Ratio ### Description Sets the ratio between measured response and FF gain for steering rate. Raising this value increases FF gain. ### Method N/A (Parameter Configuration) ### Endpoint N/A ### Parameters #### Query Parameters - **RTUN_STR_FFRATIO** (float) - Required - Rover Quicktune Steering Rate FeedForward ratio. - Range: 0 to 1.0 ## RTUN_STR_P_RATIO: Rover Quicktune Steering FF to P Ratio ### Description Sets the ratio between steering FeedForward and Proportional gain. ### Method N/A (Parameter Configuration) ### Endpoint N/A ### Parameters #### Query Parameters - **RTUN_STR_P_RATIO** (float) - Required - Rover Quicktune Steering FF to P ratio. ``` -------------------------------- ### ArduPilot Parameters Overview Source: https://github.com/ardupilot/parameterrepository/blob/main/Blimp-4.8/Parameters.rst A list of available script and hardware-related parameters in the ArduPilot parameter repository. ```APIDOC ## ArduPilot Parameters Overview ### Description This section provides a general overview of parameters available in the ArduPilot parameter repository, including script identifiers and hardware control parameters. ### Parameters #### Script Parameters - **Script13** (ID: 106) - **Script14** (ID: 107) - **Script15** (ID: 108) - **Script16** (ID: 109) #### NeoPixel Parameters - **NeoPixel1** (ID: 120) - **NeoPixel2** (ID: 121) - **NeoPixel3** (ID: 122) - **NeoPixel4** (ID: 123) #### Rate Control Parameters - **RateRoll** (ID: 124) - **RatePitch** (ID: 125) - **RateThrust** (ID: 126) - **RateYaw** (ID: 127) #### Wing/Sail Parameters - **WingSailElevator** (ID: 128) #### ProfiLED Parameters - **ProfiLED1** (ID: 129) - **ProfiLED2** (ID: 130) - **ProfiLED3** (ID: 131) - **ProfiLEDClock** (ID: 132) #### Winch Parameters - **Winch Clutch** (ID: 133) #### Servo Parameters - **SERVOn_MIN** (ID: 134) - **SERVOn_TRIM** (ID: 135) - **SERVOn_MAX** (ID: 136) - **SailMastRotation** (ID: 137) #### Alarm Parameters - **Alarm** (ID: 138) - **Alarm Inverted** (ID: 139) #### RC Input Scaled Parameters - **RCIN1Scaled** (ID: 140) - **RCIN2Scaled** (ID: 141) - **RCIN3Scaled** (ID: 142) - **RCIN4Scaled** (ID: 143) - **RCIN5Scaled** (ID: 144) - **RCIN6Scaled** (ID: 145) - **RCIN7Scaled** (ID: 146) - **RCIN8Scaled** (ID: 147) - **RCIN9Scaled** (ID: 148) - **RCIN10Scaled** (ID: 149) - **RCIN11Scaled** (ID: 150) - **RCIN12Scaled** (ID: 151) - **RCIN13Scaled** (ID: 152) - **RCIN14Scaled** (ID: 153) - **RCIN15Scaled** (ID: 154) - **RCIN16Scaled** (ID: 155) #### Camera Parameters - **CameraZoom** (ID: 180) ``` -------------------------------- ### ArduPilot Parameters Overview Source: https://github.com/ardupilot/parameterrepository/blob/main/Sub-4.8/Parameters.rst A list of available parameters in the ArduPilot parameter repository. ```APIDOC ## ArduPilot Parameters Overview ### Description This section provides a comprehensive list of parameters available within the ArduPilot parameter repository, categorized for clarity. ### Parameters #### Motor Parameters - **Motor6** (int) - Motor 6 control - **Motor7** (int) - Motor 7 control - **Motor8** (int) - Motor 8 control - **Motor9** (int) - Motor 9 control - **Motor10** (int) - Motor 10 control - **Motor11** (int) - Motor 11 control - **Motor12** (int) - Motor 12 control #### RC Input Parameters - **RCIN1/Pitch** (int) - RC Input 1 (Pitch) - **RCIN2/Roll** (int) - RC Input 2 (Roll) - **RCIN3/HeaveVertical** (int) - RC Input 3 (Heave/Vertical) - **RCIN4/YawTurn** (int) - RC Input 4 (Yaw/Turn) - **RCIN5/SurgeForward** (int) - RC Input 5 (Surge/Forward) - **RCIN6/SwayLateral** (int) - RC Input 6 (Sway/Lateral) - **RCIN7/CameraPan** (int) - RC Input 7 (Camera Pan) - **RCIN8/CameraTilt** (int) - RC Input 8 (Camera Tilt) - **RCIN9** (int) - RC Input 9 - **RCIN10** (int) - RC Input 10 - **RCIN11** (int) - RC Input 11 - **RCIN12** (int) - RC Input 12 - **RCIN13** (int) - RC Input 13 - **RCIN14** (int) - RC Input 14 - **RCIN15** (int) - RC Input 15 - **RCIN16** (int) - RC Input 16 #### Camera Parameters - **CameraISO** (int) - Camera ISO setting - **CameraAperture** (int) - Camera Aperture setting - **CameraFocus** (int) - Camera Focus setting - **CameraShutterSpeed** (int) - Camera Shutter Speed setting #### Script Parameters - **Script1** (int) - Script 1 control - **Script2** (int) - Script 2 control - **Script3** (int) - Script 3 control - **Script4** (int) - Script 4 control - **Script5** (int) - Script 5 control - **Script6** (int) - Script 6 control - **Script7** (int) - Script 7 control - **Script8** (int) - Script 8 control - **Script9** (int) - Script 9 control - **Script10** (int) - Script 10 control - **Script11** (int) - Script 11 control - **Script12** (int) - Script 12 control - **Script13** (int) - Script 13 control - **Script14** (int) - Script 14 control - **Script15** (int) - Script 15 control - **Script16** (int) - Script 16 control #### NeoPixel Parameters - **NeoPixel1** (int) - NeoPixel 1 control - **NeoPixel2** (int) - NeoPixel 2 control - **NeoPixel3** (int) - NeoPixel 3 control - **NeoPixel4** (int) - NeoPixel 4 control #### Servo Parameters - **SERVOn_MIN** (int) - Servo On Minimum PWM - **SERVOn_TRIM** (int) - Servo On Trim PWM - **SERVOn_MAX** (int) - Servo On Maximum PWM #### Other Parameters - **Winch** (int) - Winch control - **Lights1** (int) - Lights 1 control - **Lights2** (int) - Lights 2 control - **VideoSwitch** (int) - Video Switch control - **Actuator1** (int) - Actuator 1 control - **Actuator2** (int) - Actuator 2 control - **Actuator3** (int) - Actuator 3 control - **Actuator4** (int) - Actuator 4 control - **Actuator5** (int) - Actuator 5 control - **Actuator6** (int) - Actuator 6 control ``` -------------------------------- ### Other Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Sub-4.8/Parameters.rst Miscellaneous parameters including SERVOn_MIN, SERVOn_TRIM, SERVOn_MAX, Lights1, Lights2, and VideoSwitch. ```APIDOC ## Other Parameters ### Description Miscellaneous parameters including SERVOn_MIN, SERVOn_TRIM, SERVOn_MAX, Lights1, Lights2, and VideoSwitch. ### Parameters - **SERVOn_MIN**: Parameter ID 134 - **SERVOn_TRIM**: Parameter ID 135 - **SERVOn_MAX**: Parameter ID 136 - **Lights1**: Parameter ID 181 - **Lights2**: Parameter ID 182 - **VideoSwitch**: Parameter ID 183 ``` -------------------------------- ### General Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Tracker-4.8/ParametersLatex.rst A list of general ArduPilot parameters. ```APIDOC ## General Parameters ### Description A list of general ArduPilot parameters. ### Parameters - **RateYaw** (Integer) - **WingSailElevator** (Integer) - **ProfiLED1** (Integer) - **ProfiLED2** (Integer) - **ProfiLED3** (Integer) - **ProfiLEDClock** (Integer) - **WinchClutch** (Integer) - **SERVOn_MIN** (Integer) - **SERVOn_TRIM** (Integer) - **SERVOn_MAX** (Integer) - **SailMastRotation** (Integer) - **Alarm** (Integer) - **AlarmInverted** (Integer) - **RCIN1Scaled** (Integer) - **RCIN2Scaled** (Integer) - **RCIN3Scaled** (Integer) - **RCIN4Scaled** (Integer) - **RCIN5Scaled** (Integer) - **RCIN6Scaled** (Integer) - **RCIN7Scaled** (Integer) - **RCIN8Scaled** (Integer) - **RCIN9Scaled** (Integer) - **RCIN10Scaled** (Integer) - **RCIN11Scaled** (Integer) - **RCIN12Scaled** (Integer) - **RCIN13Scaled** (Integer) - **RCIN14Scaled** (Integer) - **RCIN15Scaled** (Integer) - **RCIN16Scaled** (Integer) - **CameraZoom** (Integer) ``` -------------------------------- ### General Parameters List Source: https://github.com/ardupilot/parameterrepository/blob/main/Tracker-4.8/ParametersLatex.rst A list of general parameters available in the ArduPilot parameter repository. ```APIDOC ## General Parameters ### Description A list of general parameters available in the ArduPilot parameter repository. ### Parameters - **123**: NeoPixel4 - **124**: RateRoll - **125**: RatePitch - **126**: RateThrust - **127**: RateYaw - **128**: WingSailElevator - **129**: ProfiLED1 - **130**: ProfiLED2 - **131**: ProfiLED3 - **132**: ProfiLEDClock - **133**: Winch Clutch - **134**: SERVOn_MIN - **135**: SERVOn_TRIM - **136**: SERVOn_MAX - **137**: SailMastRotation - **138**: Alarm - **139**: Alarm Inverted - **140**: RCIN1Scaled - **141**: RCIN2Scaled - **142**: RCIN3Scaled - **143**: RCIN4Scaled - **144**: RCIN5Scaled - **145**: RCIN6Scaled - **146**: RCIN7Scaled - **147**: RCIN8Scaled - **148**: RCIN9Scaled - **149**: RCIN10Scaled - **150**: RCIN11Scaled - **151**: RCIN12Scaled - **152**: RCIN13Scaled - **153**: RCIN14Scaled - **154**: RCIN15Scaled - **155**: RCIN16Scaled - **180**: CameraZoom ``` -------------------------------- ### NeoPixel Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Rover-4.8/ParametersLatex.rst Details parameters for configuring NeoPixel LED outputs. ```APIDOC ## NeoPixel Parameters ### Description This section details parameters for configuring NeoPixel LED outputs. ### Parameters #### Query Parameters - **pixel_num** (integer) - Required - The NeoPixel number. ### Example GET /api/parameters/neopixel?pixel_num=1 ``` -------------------------------- ### SIM_LED_LAYOUT: LED Layout Configuration Source: https://github.com/ardupilot/parameterrepository/blob/main/Copter-4.8/Parameters.rst Configures the layout for LEDs. ```APIDOC ## SIM_LED_LAYOUT ### Description LED layout config value ``` -------------------------------- ### Fetch Parameter JSON and Markdown Documentation Source: https://context7.com/ardupilot/parameterrepository/llms.txt Uses curl to download parameter definition files in JSON and Markdown formats from the GitHub repository. Specify the vehicle type and version. ```bash # List available vehicle versions ls -d */ # Fetch parameter JSON for Copter 4.8 curl -O https://raw.githubusercontent.com/ArduPilot/ParameterRepository/main/Copter-4.8/apm.pdef.json # Fetch parameter documentation in Markdown curl -O https://raw.githubusercontent.com/ArduPilot/ParameterRepository/main/Plane-4.8/Parameters.md ``` -------------------------------- ### General Parameter List Source: https://github.com/ardupilot/parameterrepository/blob/main/Sub-4.8/Parameters.rst A list of available parameters in the ArduPilot parameter repository. ```APIDOC ## General Parameter List API ### Description Retrieves a list of all available parameters in the ArduPilot parameter repository. ### Method GET ### Endpoint /ardupilot/parameterrepository/parameters ### Response #### Success Response (200) - **parameters** (array) - A list of parameter objects. - **id** (integer) - The unique identifier for the parameter. - **name** (string) - The name of the parameter. #### Response Example ```json { "parameters": [ {"id": 90, "name": "CameraISO"}, {"id": 91, "name": "CameraAperture"}, {"id": 92, "name": "CameraFocus"}, {"id": 93, "name": "CameraShutterSpeed"}, {"id": 94, "name": "Script1"}, {"id": 95, "name": "Script2"}, {"id": 96, "name": "Script3"}, {"id": 97, "name": "Script4"}, {"id": 98, "name": "Script5"}, {"id": 99, "name": "Script6"}, {"id": 100, "name": "Script7"}, {"id": 101, "name": "Script8"}, {"id": 102, "name": "Script9"}, {"id": 103, "name": "Script10"}, {"id": 104, "name": "Script11"}, {"id": 105, "name": "Script12"}, {"id": 106, "name": "Script13"}, {"id": 107, "name": "Script14"}, {"id": 108, "name": "Script15"}, {"id": 109, "name": "Script16"}, {"id": 120, "name": "NeoPixel1"}, {"id": 121, "name": "NeoPixel2"}, {"id": 122, "name": "NeoPixel3"}, {"id": 123, "name": "NeoPixel4"}, {"id": 134, "name": "SERVOn_MIN"}, {"id": 135, "name": "SERVOn_TRIM"}, {"id": 136, "name": "SERVOn_MAX"}, {"id": 181, "name": "Lights1"}, {"id": 182, "name": "Lights2"}, {"id": 183, "name": "VideoSwitch"}, {"id": 184, "name": "Actuator1"}, {"id": 185, "name": "Actuator2"}, {"id": 186, "name": "Actuator3"}, {"id": 187, "name": "Actuator4"}, {"id": 188, "name": "Actuator5"}, {"id": 189, "name": "Actuator6"} ] } ``` ``` -------------------------------- ### General Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Blimp-4.8/Parameters.rst A list of general system parameters including servo outputs, camera controls, and alarms. ```APIDOC ## General Parameters List ### Description This section lists various parameters available in the ArduPilot parameter repository. ### Method N/A (Parameter Listing) ### Endpoint N/A (Parameter Listing) ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) List of parameters with their IDs and names. #### Response Example ``` | 134 | SERVOn_MIN | | 135 | SERVOn_TRIM | | 136 | SERVOn_MAX | | 137 | SailMastRotation | | 138 | Alarm | | 139 | Alarm Inverted | | 140 | RCIN1Scaled | | 141 | RCIN2Scaled | | 142 | RCIN3Scaled | | 143 | RCIN4Scaled | | 144 | RCIN5Scaled | | 145 | RCIN6Scaled | | 146 | RCIN7Scaled | | 147 | RCIN8Scaled | | 148 | RCIN9Scaled | | 149 | RCIN10Scaled | | 150 | RCIN11Scaled | | 151 | RCIN12Scaled | | 152 | RCIN13Scaled | | 153 | RCIN14Scaled | | 154 | RCIN15Scaled | | 155 | RCIN16Scaled | | 180 | CameraZoom | ``` ``` -------------------------------- ### ArduPilot Parameters Overview Source: https://github.com/ardupilot/parameterrepository/blob/main/Plane-4.8/ParametersLatex.rst A list of parameter IDs and their brief descriptions from the ArduPilot parameter repository. ```APIDOC ## ArduPilot Parameters Overview ### Description This section provides a list of parameter IDs and their corresponding descriptions. ### Parameters | ID | Description | |-----|-------------------------------------| | 180 | Test autotuned gains after tune is complete | | 181 | QuickTune | | 183 | AUTOLAND mode | | 184 | System ID Chirp | | 185 | Mount Roll/Pitch Lock | | 186 | Mount POI Lock | | 208 | Flap | | 209 | VTOL Forward Throttle | | 210 | Airbrakes | | 212 | Mount1 Roll | | 213 | Mount1 Pitch | | 214 | Mount1 Yaw | | 215 | Mount2 Roll | | 216 | Mount2 Pitch | | 217 | Mount2 Yaw | | 218 | Loweheiser throttle | | 300 | Scripting1 | | 301 | Scripting2 | | 302 | Scripting3 | | 303 | Scripting4 | | 304 | Scripting5 | | 305 | Scripting6 | | 306 | Scripting7 | | 307 | Scripting8 | | 308 | Scripting9 | | 309 | Scripting10 | | 310 | Scripting11 | | 311 | Scripting12 | | 312 | Scripting13 | | 313 | Scripting14 | | 314 | Scripting15 | | 315 | Scripting16 | | 316 | Stop-Restart Scripting | ``` -------------------------------- ### NeoPixel and Lights Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Sub-4.8/ParametersLatex.rst Information on parameters related to NeoPixel and general lighting configurations. ```APIDOC ## NeoPixel and Lights Parameters API ### Description This section lists parameters related to NeoPixel devices and other lighting configurations. ### Method GET (Conceptual) ### Endpoint /ardupilot/parameterrepository/lights ### Parameters #### Path Parameters None #### Query Parameters - **name** (string) - Optional - Filter parameters by name (e.g., NeoPixel). ### Response #### Success Response (200) - **parameter_name** (string) - The name of the parameter. - **id** (integer) - The ID associated with the parameter. - **description** (string) - A description of the parameter. #### Response Example ```json [ { "id": 121, "parameter_name": "NeoPixel2", "description": "NeoPixel 2 configuration" }, { "id": 122, "parameter_name": "NeoPixel3", "description": "NeoPixel 3 configuration" }, { "id": 181, "parameter_name": "Lights1", "description": "Lights 1 configuration" } ] ``` ### Available Parameters: - NeoPixel2 (ID: 121) - NeoPixel3 (ID: 122) - NeoPixel4 (ID: 123) - Lights1 (ID: 181) - Lights2 (ID: 182) - VideoSwitch (ID: 183) - Actuator1 (ID: 184) - Actuator2 (ID: 185) - Actuator3 (ID: 186) - Actuator4 (ID: 187) - Actuator5 (ID: 188) - Actuator6 (ID: 189) ``` -------------------------------- ### General ArduPilot Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Sub-4.8/Parameters.rst A list of general ArduPilot parameters including motor, winch, camera, script, NeoPixel, servo, lights, video switch, and actuator configurations. ```APIDOC ## ArduPilot Parameter List ### Description This section provides a list of various ArduPilot parameters and their corresponding IDs. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ### Parameter Table | ID | Name | |-----|---------------| | 84 | Motor11 | | 85 | Motor12 | | 88 | Winch | | 90 | CameraISO | | 91 | CameraAperture| | 92 | CameraFocus | | 93 | CameraShutterSpeed| | 94 | Script1 | | 95 | Script2 | | 96 | Script3 | | 97 | Script4 | | 98 | Script5 | | 99 | Script6 | | 100 | Script7 | | 101 | Script8 | | 102 | Script9 | | 103 | Script10 | | 104 | Script11 | | 105 | Script12 | | 106 | Script13 | | 107 | Script14 | | 108 | Script15 | | 109 | Script16 | | 120 | NeoPixel1 | | 121 | NeoPixel2 | | 122 | NeoPixel3 | | 123 | NeoPixel4 | | 134 | SERVOn_MIN | | 135 | SERVOn_TRIM | | 136 | SERVOn_MAX | | 181 | Lights1 | | 182 | Lights2 | | 183 | VideoSwitch | | 184 | Actuator1 | | 185 | Actuator2 | | 186 | Actuator3 | | 187 | Actuator4 | | 188 | Actuator5 | | 189 | Actuator6 | ``` -------------------------------- ### Lighting and Video Switch Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Sub-4.8/Parameters.rst This section lists parameters for lighting control and video switching. ```APIDOC ## Lighting and Video Switch Parameters This section lists parameters for lighting control and video switching. ### Parameters - **Lights1** (int) - Lighting Control 1 - **Lights2** (int) - Lighting Control 2 - **VideoSwitch** (int) - Video Switch Control ``` -------------------------------- ### SERVO Parameters Overview Source: https://github.com/ardupilot/parameterrepository/blob/main/Tracker-4.8/Parameters.rst This section provides an overview of SERVO parameters. ```APIDOC ## SERVO Parameters This section details various SERVO parameters available in ArduPilot. ### SERVO_RATE #### Description Default output rate in Hz for all PWM outputs. #### Method N/A (Parameter Configuration) #### Endpoint N/A #### Parameters ##### Query Parameters - **SERVO_RATE** (integer) - Description: Default output rate in Hz for all PWM outputs. - Range: 25 to 400 - Units: hertz ### SERVO_DSHOT_RATE #### Description DShot output rate for all outputs as a multiple of the loop rate. 0 sets the output rate to be fixed at 1Khz for low loop rates. This value should never be set below 500Hz. #### Method N/A (Parameter Configuration) #### Endpoint N/A #### Parameters ##### Query Parameters - **SERVO_DSHOT_RATE** (integer) - Description: DShot output rate for all outputs. - Values: - 0: 1Khz - 1: loop-rate - 2: double loop-rate - 3: triple loop-rate - 4: quadruple loop rate ### SERVO_DSHOT_ESC #### Description DShot ESC type for all outputs. The ESC type affects the range of DShot commands available and the bit widths used. None means that no dshot commands will be executed. Some ESC types support Extended DShot Telemetry (EDT) which allows telemetry other than RPM data to be returned when using bi-directional dshot. If you enable EDT you must install EDT capable firmware for correct operation. #### Method N/A (Parameter Configuration) #### Endpoint N/A #### Parameters ##### Query Parameters - **SERVO_DSHOT_ESC** (integer) - Description: DShot ESC type for all outputs. - Values: - 0: None - 1: BLHeli32/Kiss/AM32 - 2: BLHeli_S/BlueJay - 3: BLHeli32/AM32/Kiss+EDT - 4: BLHeli_S/BlueJay+EDT ### SERVO_GPIO_MASK #### Description Bitmask of outputs which will be available as GPIOs. Any output with either the function set to -1 or with the corresponding bit set in this mask will be available for use as a GPIO pin. #### Method N/A (Parameter Configuration) #### Endpoint N/A #### Parameters ##### Query Parameters - **SERVO_GPIO_MASK** (integer) - Description: Bitmask of outputs available as GPIOs. - Bitmask: - Bit 0: Servo 1 - Bit 1: Servo 2 - Bit 2: Servo 3 - Bit 3: Servo 4 - Bit 4: Servo 5 - Bit 5: Servo 6 - Bit 6: Servo 7 - Bit 7: Servo 8 - Bit 8: Servo 9 *Note: Reboot required after change.* ``` -------------------------------- ### NeoPixel and LED Parameters Source: https://github.com/ardupilot/parameterrepository/blob/main/Rover-4.8/Parameters.rst Details parameters for controlling NeoPixel and ProfiLED devices. ```APIDOC ## NeoPixel and LED Parameters ### Description This section details parameters for controlling NeoPixel and ProfiLED devices. ### Parameters #### NeoPixel Parameters - **NeoPixel1** to **NeoPixel4** (number) - Parameters for controlling NeoPixel strips. #### ProfiLED Parameters - **ProfiLED1** to **ProfiLED3** (number) - Parameters for controlling ProfiLED devices. - **ProfiLEDClock** (number) - Parameter for ProfiLED clock settings. ```