refactor(simulation/battery_simulator): convert params.c to module.yaml

Convert 1 parameter file(s) from legacy C format to YAML
module configuration.
This commit is contained in:
Jacob Dahl 2026-03-17 21:55:35 -08:00 committed by Jacob Dahl
parent 32766cc355
commit 146f2b2331
3 changed files with 36 additions and 71 deletions

View File

@ -38,6 +38,8 @@ px4_add_module(
SRCS
BatterySimulator.cpp
BatterySimulator.hpp
MODULE_CONFIG
battery_simulator_params.yaml
DEPENDS
battery
mathlib

View File

@ -1,71 +0,0 @@
/****************************************************************************
*
* Copyright (c) 2020 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.
*
****************************************************************************/
/**
* Simulator Battery enabled
*
* Enable or disable the internal battery simulation. This is useful
* when the battery is simulated externally and interfaced with PX4
* through MAVLink for example.
*
* @boolean
* @group SITL
*/
PARAM_DEFINE_INT32(SIM_BAT_ENABLE, 1);
/**
* Simulator Battery drain interval
*
* @min 1
* @max 86400
* @increment 1
* @unit s
*
* @group SITL
*/
PARAM_DEFINE_FLOAT(SIM_BAT_DRAIN, 60);
/**
* Simulator Battery minimal percentage.
*
* Can be used to alter the battery level during SITL- or HITL-simulation on the fly.
* Particularly useful for testing different low-battery behaviour.
*
* @min 0
* @max 100
* @increment 0.1
* @unit %
*
* @group SITL
*/
PARAM_DEFINE_FLOAT(SIM_BAT_MIN_PCT, 50.0f);

View File

@ -0,0 +1,34 @@
module_name: battery_simulator
parameters:
- group: SITL
definitions:
SIM_BAT_ENABLE:
description:
short: Simulator Battery enabled
long: |-
Enable or disable the internal battery simulation. This is useful
when the battery is simulated externally and interfaced with PX4
through MAVLink for example.
type: boolean
default: 1
SIM_BAT_DRAIN:
description:
short: Simulator Battery drain interval
type: float
default: 60
min: 1
max: 86400
increment: 1
unit: s
SIM_BAT_MIN_PCT:
description:
short: Simulator Battery minimal percentage
long: |-
Can be used to alter the battery level during SITL- or HITL-simulation on the fly.
Particularly useful for testing different low-battery behaviour.
type: float
default: 50.0
min: 0
max: 100
increment: 0.1
unit: '%'