Skip to content

Commit

Permalink
component_information: fix parameter.schema.json array type (mavlink#…
Browse files Browse the repository at this point in the history 
…1519)

* component_information: fix parameter.schema.json array type
* component_information: add bitmask to parameter.schema.json
* component_information: allow '.' and '-' in param name
* component_information: remove uid from parameter.schema.json
  • Loading branch information
@bkueng
bkueng authored Nov 5, 2020
1 parent 98cca84 commit dc761be
Showing 1 changed file with 112 additions and 96 deletions.
208 changes: 112 additions & 96 deletions component_information/parameter.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,117 +3,133 @@
"$schema": "http://json-schema.org/draft-07/schema",
"description": "Schema for COMP_METADATA_TYPE_PARAMETER",
"type": "object",

"properties": {
"version": {
"description": "Version number for the format of this file.",
"type": "integer",
"minimum": 1
},
"uid": {
"description": "Unique id for this metadata. Same as ```COMPONENT_INFORMATION. comp_metadata_uid```.",
"type": "integer"
},
"scope": {
"description": "Scope to which this metadata applies. Firmware: Any vehicle running this same vehicles firmware type. VehicleGroup: Any vehicle running this same firmware and this vehicles group type (Fixed Wing, Multi-Rotor, VTOL, Rover). VehicleType: Any vehicle match this vehicles firmware type and specific vehicle type. Vehicle: Only applies to this specific vehicle.",
"type": "string",
"enum": [ "Firmware", "VehicleGroup", "VehicleType", "Vehicle" ]
},
"parameters": {
"type": "array",

"properties": {
"name": {
"description": "Parameter Name.",
"type": "string",
"pattern": "^[a-zA-Z0-9_\\{\\}]{1,16}$",
"comment": "FOO{n}_BAR for name will match actual name of FOO1_BAR, FOO3_BAR and so forth."
},
"type": {
"description": "Parameter type.",
"type": "string",
"enum": [ "Uint8", "Int8", "Uint16", "Int16", "Uint32", "Int32", "Float" ]
},
"shortDesc": {
"description": "Short user facing description/name for parameter. Used in UI intead of internal parameter name.",
"type": "string",
"default": "",
"comment": "{n} index tagging will be replaced by name index. Example: 'FOO3_BAR': 'Description for foo element {n}' will turn into 'Description for foo element 1'."
},
"longDesc": {
"description": "Long user facing documentation of how the parameters works.",
"type": "string",
"default": "",
"comment": "{n} index tagging will be replaced by name index. Example: 'FOO3_BAR': 'Description for foo element {n}' will turn into 'Description for foo element 1'."
},
"units": {
"description": "Units for parameter value.",
"type": "string",
"default": "",
"comment": "A 'Known Unit' allows a GCS to convert between units like meters to feet as needed. Known Units are: 'm/meter/meter', 'vertical m' - vertical distance, 'cm/px', 'm/s', 'C' - celcius, 'm^2', 'g' - grams, 'centi-degrees', 'radians', 'norm'."
},
"default": {
"description": "Default value for parameter.",
"type": "number",
"comment": "If a defaultValue is not specified, there is no default for the parameter available at all. A GCS should not provide an option to reset this parameter to default."
},
"decimalPlaces": {
"description": "Number of decimal places to show for user facing display.",
"type": "integer",
"minimum": 0,
"default": 7
},
"min": {
"description": "Minimum valid value",
"type": "number",
"comment": "If 'min' is not specified the minimum value is the minimum numeric value which can be represented by the type."
},
"max": {
"description": "Maximum valid value",
"type": "number",
"comment": "If 'max' is not specified the minimum value is the maximum numeric value which can be represented by the type."
},
"increment": {
"description": "Increment to use for user facing UI which increments a value",
"type": "number"
},
"rebootRequired": {
"description": "true: Vehicle must be rebooted if this value is changed",
"type": "boolean",
"default": false
},
"group": {
"description": "User readable name for a group of parameters which are commonly modified together. For example a GCS can shows params in a hierarchical display based on group ",
"type": "string",
"default": ""
},
"category": {
"description": "User readable name for a 'type' of parameter. For example 'Developer', 'System', or 'Advanced'.",
"type": "string",
"default": ""
},
"volatile": {
"description": "true: value is volatile. Should not be included in creation of a CRC over param values for example.",
"type": "boolean",
"default": false
},
"values": {
"description": "Array of values and textual descriptions for use by GCS ui.",
"type": "array",
"properties": {
"value": {
"type": "number"
},
"description": {
"type": "string"
"type": "array",

"items": {
"type": "object",
"properties": {
"name": {
"description": "Parameter Name.",
"type": "string",
"pattern": "^[\\.\\-a-zA-Z0-9_\\{\\}]{1,16}$",
"comment": "FOO{n}_BAR for name will match actual name of FOO1_BAR, FOO3_BAR and so forth."
},
"type": {
"description": "Parameter type.",
"type": "string",
"enum": [ "Uint8", "Int8", "Uint16", "Int16", "Uint32", "Int32", "Float" ]
},
"shortDesc": {
"description": "Short user facing description/name for parameter. Used in UI intead of internal parameter name.",
"type": "string",
"default": "",
"comment": "{n} index tagging will be replaced by name index. Example: 'FOO3_BAR': 'Description for foo element {n}' will turn into 'Description for foo element 1'."
},
"longDesc": {
"description": "Long user facing documentation of how the parameters works.",
"type": "string",
"default": "",
"comment": "{n} index tagging will be replaced by name index. Example: 'FOO3_BAR': 'Description for foo element {n}' will turn into 'Description for foo element 1'."
},
"units": {
"description": "Units for parameter value.",
"type": "string",
"default": "",
"comment": "A 'Known Unit' allows a GCS to convert between units like meters to feet as needed. Known Units are: 'm/meter/meter', 'vertical m' - vertical distance, 'cm/px', 'm/s', 'C' - celcius, 'm^2', 'g' - grams, 'centi-degrees', 'radians', 'norm'."
},
"default": {
"description": "Default value for parameter.",
"type": "number",
"comment": "If a defaultValue is not specified, there is no default for the parameter available at all. A GCS should not provide an option to reset this parameter to default."
},
"decimalPlaces": {
"description": "Number of decimal places to show for user facing display.",
"type": "integer",
"minimum": 0,
"default": 7
},
"min": {
"description": "Minimum valid value",
"type": "number",
"comment": "If 'min' is not specified the minimum value is the minimum numeric value which can be represented by the type."
},
"max": {
"description": "Maximum valid value",
"type": "number",
"comment": "If 'max' is not specified the minimum value is the maximum numeric value which can be represented by the type."
},
"increment": {
"description": "Increment to use for user facing UI which increments a value",
"type": "number"
},
"rebootRequired": {
"description": "true: Vehicle must be rebooted if this value is changed",
"type": "boolean",
"default": false
},
"group": {
"description": "User readable name for a group of parameters which are commonly modified together. For example a GCS can shows params in a hierarchical display based on group ",
"type": "string",
"default": ""
},
"category": {
"description": "User readable name for a 'type' of parameter. For example 'Developer', 'System', or 'Advanced'.",
"type": "string",
"default": ""
},
"volatile": {
"description": "true: value is volatile. Should not be included in creation of a CRC over param values for example.",
"type": "boolean",
"default": false
},
"values": {
"description": "Array of values and textual descriptions for use by GCS ui.",
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"description": {
"type": "string"
}
}
}
},
"bitmask": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer"
},
"description": {
"type": "string"
}
}
}
}
}
},
"required": [ "name", "type" ],
"additionalProperties": false
},
"required": [ "name", "type" ],
"additionalProperties": false
}
}
},
"required": [ "version", "uid", "scope", "parameters" ],
"required": [ "version", "scope", "parameters" ],
"additionalProperties": false
}

0 comments on commit dc761be

Please sign in to comment.