Skip to content

Command PARAMETER Supplementary Tables Broken #71

@tsjordan-eng

Description

@tsjordan-eng

In the Command PARAMETER documentation the formatting is broken so that the tables aren't rendered.

This the case for:

  • PARAMETER
  • APPEND_PARAMETER
  • ID_PARAMETER
  • APPEND_ID_PARAMETER

...
When Data Type is INT, UINT, FLOAT, DERIVED the remaining parameters are:

| Minimum Value | Minimum allowed value for this parameter | True | | Maximum Value | Maximum allowed value for this parameter | True | | ID Value | Identification value for this parameter. The binary data must match this value for the buffer to be identified as this packet. | True | | Description | Description for this parameter which must be enclosed with quotes | False | | Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format. See guide on Little Endian Bitfields.

Valid Values: BIG_ENDIAN, LITTLE_ENDIAN | False |

When Data Type is STRING, BLOCK the remaining parameters are:

| Default Value | Default value for this parameter. You must provide a default but if you mark the parameter REQUIRED then scripts will be forced to specify a value. | True | | Description | Description for this parameter which must be enclosed with quotes | False | | Endianness | Indicates if the data in this command is to be sent in Big Endian or Little Endian format

Valid Values: BIG_ENDIAN, LITTLE_ENDIAN | False |

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions