diff --git a/src/lib/circuit_breaker/CMakeLists.txt b/src/lib/circuit_breaker/CMakeLists.txt index 54ee7cdbd0..c3a1743d4a 100644 --- a/src/lib/circuit_breaker/CMakeLists.txt +++ b/src/lib/circuit_breaker/CMakeLists.txt @@ -32,3 +32,4 @@ ############################################################################ px4_add_library(circuit_breaker circuit_breaker.cpp) +set_property(GLOBAL APPEND PROPERTY PX4_MODULE_CONFIG_FILES ${CMAKE_CURRENT_SOURCE_DIR}/circuit_breaker_params.yaml) diff --git a/src/lib/circuit_breaker/circuit_breaker_params.c b/src/lib/circuit_breaker/circuit_breaker_params.c deleted file mode 100644 index b68e60a56c..0000000000 --- a/src/lib/circuit_breaker/circuit_breaker_params.c +++ /dev/null @@ -1,134 +0,0 @@ -/**************************************************************************** - * - * Copyright (c) 2014 PX4 Development Team. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in - * the documentation and/or other materials provided with the - * distribution. - * 3. Neither the name PX4 nor the names of its contributors may be - * used to endorse or promote products derived from this software - * without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS - * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE - * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, - * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, - * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS - * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED - * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN - * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE - * POSSIBILITY OF SUCH DAMAGE. - * - ****************************************************************************/ - -/* - * @file circuit_breaker_params.c - * - * Circuit breaker parameters. - * Analog to real aviation circuit breakers these parameters - * allow to disable subsystems. They are not supported as standard - * operation procedure and are only provided for development purposes. - * To ensure they are not activated accidentally, the associated - * parameter needs to set to the key (magic). - */ - -/** - * Circuit breaker for power supply check - * - * Setting this parameter to 894281 will disable the power valid - * checks in the commander. - * WARNING: ENABLING THIS CIRCUIT BREAKER IS AT OWN RISK - * - * @min 0 - * @max 894281 - * @category Developer - * @group Circuit Breaker - */ -PARAM_DEFINE_INT32(CBRK_SUPPLY_CHK, 0); - -/** - * Circuit breaker for IO safety - * - * Setting this parameter to 22027 will disable IO safety. - * WARNING: ENABLING THIS CIRCUIT BREAKER IS AT OWN RISK - * - * @min 0 - * @max 22027 - * @category Developer - * @group Circuit Breaker - */ -PARAM_DEFINE_INT32(CBRK_IO_SAFETY, 22027); - -/** - * Circuit breaker for flight termination - * - * Setting this parameter to 121212 will disable the flight termination action if triggered - * by the FailureDetector logic or if FMU is lost. - * This circuit breaker does not affect the RC loss, data link loss, geofence, - * and takeoff failure detection safety logic. - * - * @reboot_required true - * @min 0 - * @max 121212 - * @category Developer - * @group Circuit Breaker - */ -PARAM_DEFINE_INT32(CBRK_FLIGHTTERM, 121212); - -/** - * Circuit breaker for disabling buzzer - * - * Setting this parameter to 782097 will disable the buzzer audio notification. - * - * Setting this parameter to 782090 will disable the startup tune, while keeping - * all others enabled. - * - * @reboot_required true - * @min 0 - * @max 782097 - * @category Developer - * @group Circuit Breaker - */ -PARAM_DEFINE_INT32(CBRK_BUZZER, 0); - -/** - * Circuit breaker for USB link check - * - * Setting this parameter to 197848 will disable the USB connected - * checks in the commander, setting it to 0 keeps them enabled (recommended). - * - * We are generally recommending to not fly with the USB link - * connected and production vehicles should set this parameter to - * zero to prevent users from flying USB powered. However, for R&D purposes - * it has proven over the years to work just fine. - * - * @min 0 - * @max 197848 - * @category Developer - * @group Circuit Breaker - */ -PARAM_DEFINE_INT32(CBRK_USB_CHK, 197848); - -/** - * Circuit breaker for arming in fixed-wing mode check - * - * Setting this parameter to 159753 will enable arming in fixed-wing - * mode for VTOLs. - * WARNING: ENABLING THIS CIRCUIT BREAKER IS AT OWN RISK - * - * @min 0 - * @max 159753 - * @category Developer - * @group Circuit Breaker - */ -PARAM_DEFINE_INT32(CBRK_VTOLARMING, 0); diff --git a/src/lib/circuit_breaker/circuit_breaker_params.yaml b/src/lib/circuit_breaker/circuit_breaker_params.yaml new file mode 100644 index 0000000000..6ace492dd3 --- /dev/null +++ b/src/lib/circuit_breaker/circuit_breaker_params.yaml @@ -0,0 +1,83 @@ +module_name: circuit_breaker +parameters: +- group: Circuit Breaker + definitions: + CBRK_SUPPLY_CHK: + description: + short: Circuit breaker for power supply check + long: |- + Setting this parameter to 894281 will disable the power valid + checks in the commander. + WARNING: ENABLING THIS CIRCUIT BREAKER IS AT OWN RISK + category: Developer + type: int32 + default: 0 + min: 0 + max: 894281 + CBRK_IO_SAFETY: + description: + short: Circuit breaker for IO safety + long: |- + Setting this parameter to 22027 will disable IO safety. + WARNING: ENABLING THIS CIRCUIT BREAKER IS AT OWN RISK + category: Developer + type: int32 + default: 22027 + min: 0 + max: 22027 + CBRK_FLIGHTTERM: + description: + short: Circuit breaker for flight termination + long: |- + Setting this parameter to 121212 will disable the flight termination action if triggered + by the FailureDetector logic or if FMU is lost. + This circuit breaker does not affect the RC loss, data link loss, geofence, + and takeoff failure detection safety logic. + category: Developer + type: int32 + default: 121212 + reboot_required: true + min: 0 + max: 121212 + CBRK_BUZZER: + description: + short: Circuit breaker for disabling buzzer + long: |- + Setting this parameter to 782097 will disable the buzzer audio notification. + + Setting this parameter to 782090 will disable the startup tune, while keeping + all others enabled. + category: Developer + type: int32 + default: 0 + reboot_required: true + min: 0 + max: 782097 + CBRK_USB_CHK: + description: + short: Circuit breaker for USB link check + long: |- + Setting this parameter to 197848 will disable the USB connected + checks in the commander, setting it to 0 keeps them enabled (recommended). + + We are generally recommending to not fly with the USB link + connected and production vehicles should set this parameter to + zero to prevent users from flying USB powered. However, for R&D purposes + it has proven over the years to work just fine. + category: Developer + type: int32 + default: 197848 + min: 0 + max: 197848 + CBRK_VTOLARMING: + description: + short: Circuit breaker for arming in fixed-wing mode check + long: |- + Setting this parameter to 159753 will enable arming in fixed-wing + mode for VTOLs. + WARNING: ENABLING THIS CIRCUIT BREAKER IS AT OWN RISK + category: Developer + type: int32 + default: 0 + min: 0 + max: 159753