Sha256: 1e4b7653f75bbf62d74ebb6c90b2e17a2b1ecae2d91bc0434ac5cbc140bc6726
Contents?: true
Size: 1.64 KB
Versions: 22
Compression:
Stored size: 1.64 KB
Contents
---
COMMAND:
# Prevent prettier from removing the newline after modifiers:
# prettier-ignore
modifiers:
<%= MetaConfigParser.load('command_modifiers.yaml').to_meta_config_yaml(4) %>
summary: Defines a new command packet
example: COMMAND INST COLLECT BIG_ENDIAN "Start collect"
parameters:
- name: Target
required: true
description: Name of the target this command is associated with
values: .+
- name: Command
required: true
description: Name of this command. Also referred to as its mnemonic.
Must be unique to commands to this target. Ideally will be as short and clear as possible.
values: \D\S*
- name: Endianness
required: true
description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format
values: ["BIG_ENDIAN", "LITTLE_ENDIAN"]
- name: Description
required: false
description: Description of this command which must be enclosed with quotes
values: '[''"].*[''"]'
SELECT_COMMAND:
# prettier-ignore
modifiers:
<%= MetaConfigParser.load('command_modifiers.yaml').to_meta_config_yaml(4) %>
summary: Selects an existing command packet for editing
description:
Typically used in a separate configuration file from where the original
command is defined to override or add to the existing command definition
example: SELECT_COMMAND INST COLLECT
parameters:
- name: Target Name
required: true
description: Name of the target this command is associated with
values: .+
- name: Command Name
required: true
description: Name of the command to select
values: .*
Version data entries
22 entries across 22 versions & 2 rubygems