Skip to content

Commit 2a1cc89

Browse files
committed
Renamed 'prefs' field to 'properties'
1 parent afac1cc commit 2a1cc89

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

RFCs/0002-pluggable-discovery.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The pluggable discovery aims to provide a solution to these problems.
3232

3333
- Each port may provide metadata to identify the board model (**identification properites**)
3434

35-
- Each port may provide metadata to identify a specific instance of the board (**serial number / MAC address**)
35+
- Each port may provide **properties relative to the port** (USB serial number / MAC address)
3636

3737
- Each port must have an **unique address and protocol pair**
3838

@@ -98,8 +98,8 @@ The `LIST` command executes an enumeration of the ports and returns a list of th
9898
"label": <-- HOW THE PORT IS DISPLAYED ON THE GUI
9999
"protocol": <-- THE PROTOCOL USED BY THE BOARD
100100
"protocolLabel": <-- HOW THE PROTOCOL IS DISPLAYED ON THE GUI
101-
"prefs": {
102-
<-- A LIST OF PROPERTIES FOR THAT SPECIFIC BOARD
101+
"properties": {
102+
<-- A LIST OF PROPERTIES OF THE PORT
103103
},
104104
"identificationPrefs": {
105105
<-- A LIST OF PROPERTIES TO IDENTIFY THE BOARD MODEL
@@ -123,7 +123,7 @@ Each port has:
123123

124124
- `protocolLabel` is the `protocol` in human readable form (for example `Serial port` or `DFU USB` or `Network (ssh)`)
125125

126-
- `prefs` is a list of key/value pairs that represent information relative to the specific instance of the board
126+
- `properties` is a list of key/value pairs that represent information relative to the specific port
127127

128128
- `identificationPrefs` is a list of key value pairs that represent information to identify the board **model**
129129

@@ -138,7 +138,7 @@ To make the above more clear let’s show an example with the `serial_discovery`
138138
"label": "ttyACM0",
139139
"protocol": "serial",
140140
"protocolLabel": "Serial Port (USB)",
141-
"prefs": {
141+
"properties": {
142142
"pid": "0x804e",
143143
"vid": "0x2341",
144144
"serialNumber": "EBEABFD6514D32364E202020FF10181E"
@@ -152,7 +152,7 @@ To make the above more clear let’s show an example with the `serial_discovery`
152152
}
153153
```
154154

155-
In this case the serial port metadata comes from an USB serial converter. The USB VID/PID and USB SERIAL NUMBER properties are also reported inside `prefs`. Inside the `identificationPrefs` instead we have only the properties useful for product identification (in this case only USB VID/PID is useful to identify the board model).
155+
In this case the serial port metadata comes from an USB serial converter. The USB VID/PID and USB SERIAL NUMBER properties are also reported inside `properties`. Inside the `identificationPrefs` instead we have only the properties useful for product identification (in this case only USB VID/PID is useful to identify the board model).
156156

157157
The `LIST` command performs a one-shot polling of the ports. If you need continuous monitoring of ports you should use the `START_SYNC` command.
158158

@@ -172,7 +172,7 @@ The `add` event looks like the following:
172172
"port": {
173173
"address": "/dev/ttyACM0",
174174
"label": "ttyACM0",
175-
"prefs": {
175+
"properties": {
176176
"pid": "0x804e",
177177
"vid": "0x2341",
178178
"serialNumber": "EBEABFD6514D32364E202020FF10181E"
@@ -396,17 +396,17 @@ For example, the following port metadata coming from a pluggable discovery:
396396
"address": "/dev/ttyACM0",
397397
"label": "ttyACM0",
398398
"protocol": "serial",
399-
"protocolLabel": "Serial Port (USB)"
400-
"prefs": {
401-
"pid": "0x804e",
402-
"vid": "0x2341",
403-
"serialNumber": "EBEABFD6514D32364E202020FF10181E"
404-
},
405-
"identificationPrefs": {
406-
"pid": "0x804e",
407-
"vid": "0x2341"
408-
}
409-
}
399+
"protocolLabel": "Serial Port (USB)",
400+
"properties": {
401+
"pid": "0x804e",
402+
"vid": "0x2341",
403+
"serialNumber": "EBEABFD6514D32364E202020FF10181E"
404+
},
405+
"identificationPrefs": {
406+
"pid": "0x804e",
407+
"vid": "0x2341"
408+
}
409+
}
410410
}
411411
```
412412

@@ -432,7 +432,7 @@ Here another example:
432432
"label": "SSH on my-board ()192.168.1.232)",
433433
"protocol": "ssh",
434434
"protocolLabel": "SSH Network port"
435-
"prefs": {
435+
"properties": {
436436
"macprefix": "AA:BB:CC",
437437
"macaddress": "AA:BB:CC:DD:EE:FF"
438438
},

0 commit comments

Comments
 (0)