dark0707
/
px4-firmware
forked from Archive/PX4-Autopilot
1
0
Fork 0
Code Pull Requests Activity

module_schema.yaml: add actuator_output section 

The parameter additions are only used internally for the pwm generator.
This commit is contained in:
Beat Küng 2021-09-20 07:36:13 +02:00 committed by Daniel Agar
parent 8b3ab7e36d
commit 563cf61126
2 changed files with 124 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -464,7 +464,7 @@ shellcheck_all:
@make px4_fmu-v5_default shellcheck
validate_module_configs:
@find "$(SRC_DIR)"/src/modules "$(SRC_DIR)"/src/drivers "$(SRC_DIR)"/src/lib -name *.yaml -type f -print0 | xargs -0 "$(SRC_DIR)"/Tools/validate_yaml.py --schema-file "$(SRC_DIR)"/validation/module_schema.yaml
@find "$(SRC_DIR)"/src/modules "$(SRC_DIR)"/src/drivers "$(SRC_DIR)"/src/lib -name *.yaml -type f -not -path "$(SRC_DIR)/src/lib/mixer_module/*" -print0 | xargs -0 "$(SRC_DIR)"/Tools/validate_yaml.py --schema-file "$(SRC_DIR)"/validation/module_schema.yaml
# Cleanup
# --------------------------------------------------------------------

125
validation/module_schema.yaml
View File

@ -97,11 +97,14 @@ parameters:
definitions:
type: dict
keyschema:
# Parameter name
type: string
regex: '[0-9A-Z_]+(\$\{i\}[0-9A-Z_]*)?'
valueschema:
type: dict
schema:
type: dict # This can also be a list containing multiple definitions
# (for multi-instance params with different instance_start)
# Not currently used in any yaml config file.
schema: &parameter_definition
description:
type: dict
required: true
@ -211,9 +214,127 @@ parameters:
# [0, N-1]
# Default: 0
type: integer
instance_start_label:
# Allows to use a different instance start for
# labels vs parameter name.
# Default: equal to 'instance_start'
type: integer
requires_ethernet:
# param is only added if the board has ethernet
# support
type: boolean
# Configuration for output drivers
actuator_output:
type: dict
schema:
output_groups:
type: list
minlength: 1
schema:
type: dict
schema:
generator:
# Optional generator that uses additional information for
# param generation (e.g. board-specific config)
type: string
allowed: [ pwm ]
param_prefix:
# parameter prefix for the min/max/disarmed/func params, e.g. PWM_FMU.
# This also needs to be specified in the source code.
type: string
regex: '([0-9A-Z_]+|\$\{PWM_FMU_OR_HIL\})'
required: true
channel_label:
# Human-readable per-channel label (index will be added), e.g. 'PWM Main'
type: string
num_channels:
# (maximum) number of channels
type: integer
standard_params:
type: dict
schema:
disarmed:
type: dict
schema:
min:
# Minimum disarmed value
type: integer
min: 0
max: 65536
max:
# Maximum disarmed value
type: integer
min: 0
max: 65536
default:
# Default disarmed value
type: integer
min: 0
max: 65536
min:
type: dict
schema:
min:
# Minimum minimum value
type: integer
min: 0
max: 65536
max:
# Maximum minimum value
type: integer
min: 0
max: 65536
default:
# Default minimum value
type: integer
min: 0
max: 65536
max:
type: dict
schema:
min:
# Minimum maximum value
type: integer
min: 0
max: 65536
max:
# Maximum maximum value
type: integer
min: 0
max: 65536
default:
# Default maximum value
type: integer
min: 0
max: 65536
failsafe:
type: dict
schema:
min:
# Minimum failsafe value
type: integer
min: 0
max: 65536
max:
# Maximum failsafe value
type: integer
min: 0
max: 65536
extra_function_groups:
# Additional function groups to add, defined in output_functions.yaml
type: list
schema:
type: string
channel_labels:
# Only used for 'pwm' generator, specifies PWM and Capture pins
type: list
minlength: 2
maxlength: 2
schema:
type: string
pwm_timer_param:
# Only used for 'pwm' generator, per-timer config param
type: dict
schema: *parameter_definition