|
<< Click to Display Table of Contents >> Navigation: The API > Simple API > Communication Design > String basics |
Overview
Characteristic and structure of the SimpleAPI strings:
•all commands and their responses are formatted in the same way
•each command and response ends with a line break and with a chosen end character
•one line holds a complete object
•each command and response starts with the command or response name
•values in a line are separated with semicolons ‘;’
•function names and their values are separated with an equal sign ‘=’
•timestamps are precise down to the millisecond
Formatting example
send;deviceId=FFE60503;SetPoint=34(CR/LF)
send |
; |
deviceId |
= |
FFE60503 |
; |
SetPoint |
= |
34 |
command name |
separator |
device |
equal sign |
Id |
separator |
function key |
equal sign |
function value |
Timestamp example
2015-04-22T16:45:46.150+0200