Skip to content

Fixed pluggable monitor specification to match the de-facto implementation #1748

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

Merged
merged 1 commit into from
Jun 6, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/pluggable-monitor-specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ port configuration, and which parameters are available to the user.
"baudrate": {
"label": "Baudrate",
"type": "enum",
"values": [
"value": [
"300", "600", "750", "1200", "2400", "4800", "9600",
"19200", "38400", "57600", "115200", "230400", "460800",
"500000", "921600", "1000000", "2000000"
Expand All @@ -80,19 +80,19 @@ port configuration, and which parameters are available to the user.
"parity": {
"label": "Parity",
"type": "enum",
"values": [ "N", "E", "O", "M", "S" ],
"value": [ "N", "E", "O", "M", "S" ],
"selected": "N"
},
"bits": {
"label": "Data bits",
"type": "enum",
"values": [ "5", "6", "7", "8", "9" ],
"value": [ "5", "6", "7", "8", "9" ],
"selected": "8"
},
"stop_bits": {
"label": "Stop bits",
"type": "enum",
"values": [ "1", "1.5", "2" ],
"value": [ "1", "1.5", "2" ],
"selected": "1"
}
}
Expand All @@ -111,7 +111,7 @@ types may be added in the future if needed), and the `selected` value for each p
The parameter name can not contain spaces, the allowed characters are alphanumerics, underscore `_`, dot `.`, and dash
`-`.

The `enum` types must have a list of possible `values`.
The `enum` types must have a list of possible values in the `value` list field.

The client/IDE may expose these configuration values to the user via a config file or a GUI, in this case the `label`
field may be used for a user readable description of the parameter.
Expand Down