You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-22Lines changed: 2 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -113,28 +113,8 @@ The StreamCommander has several standard commands which implement basic function
113
113
| status | Returns the current status of the device ||
114
114
| commands | Returns all registered commands of the device ||
115
115
# Message format
116
-
To make the communication more easy and consistent, a simple message format has been defined, which is used by the ArduinoStreamCommander.
117
-
118
-
Format:
119
-
**type<delimiter>content**
120
-
121
-
| Component | Meaning |
122
-
| --------- | ------- |
123
-
| type | Contains the type of the message |
124
-
|<delimiter>| Containts the delimiter, without the angle brackets. Default is `:`|
125
-
| conent | Contains the message body |
126
-
127
-
Example:
128
-
* type: `error`
129
-
* delimiter: `:`
130
-
* content: `ExampleError 123`
131
-
* Whole message: `error:ExampleError 123`
132
-
## Interpretation of messages
133
-
Type and content could be extracted with the following regular expression, using the default delimiter `:`:
134
-
* type: ^[^:]*
135
-
* content: (?<=:).*$
136
-
137
-
The message type is always the part **before** the first occurence of the delimiter, while the content is usually the part **after** the first occurence of the delimiter until the end of the message.
116
+
To make the communication more easy and consistent, a simple message format has been defined, which is used by the ArduinoStreamCommander.\
117
+
The definition can be found here: [SerialMessageFormat](https://github.com/je-s/SerialMessageFormat)
138
118
## Standard Message Types
139
119
The StreamCommander uses several standard message types, which are defined in [ArduinoStreamCommander-MessageTypes](https://github.com/je-s/ArduinoStreamCommander-MessageTypes).
0 commit comments