Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Command PARAMETER Supplementary Tables Broken #71

Open
tsjordan-eng opened this issue Jan 13, 2024 · 0 comments
Open

Command PARAMETER Supplementary Tables Broken #71

tsjordan-eng opened this issue Jan 13, 2024 · 0 comments

Comments

@tsjordan-eng
Copy link
Contributor

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 |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant