Onyx User Manual Version 5.2
3
To send a payload of data from your connected serial device via the Onyx-Relay to the user, the
device will send the payload in the following format:
$$sendSBD
payload line 1
payload line 2
payload line 3
$finished
All lines are terminated with either a carriage return, line feed, or both.
For example, using a carriage return as the line terminator for the same content as the previous
example (represented with “\R”):
$$sendSBD\R
payload line 1
\R
payload line 2
\R
payload line 3
\R $finished\R
$$sendSBD\R
The payload of the message can be single-lined as well
\R $finished\R
The $$sendSBD and $finished commands must be immediately preceded and followed by a
line terminator character. The payload can be data of any type and is not limited to ASCII
characters.
Any data that exceeds the 330 byte SBD message limit will be split into several chunks and sent
according to the Iridium device’s SBD interval. Each Iridium transmission can send up to 8 SBD
messages of 330 bytes each.
At default settings, the maximum sized message that can be queued for transmission is 4
kilobytes; this limit can be increased to 24 kilobytes, but this can cause loss of data and other
issues if transmission conditions are not ideal. Contact Xeos Technologies if your requirements
exceed default settings.
Mobile-originated messages will be transmitted over the Iridium satellite network from the
Iridium device and arrive as an e-mail attachment. The first line in the e-mail attachment will
have the following format:
devData
X
,
S
,
Y
,
Z
PAYLOAD
devData
a
,
1
,
1
,
1
The payload of the message can be single-lined as well
X
The alphabetic representation of the port the device is connected to
S
The sequence number of the incremented with each new $$sendSBD command
Y
The message part number
Z
The total number of parts to the complete message
Following the “devData” line will be all or part of the payload, depending on the size of the
payload.
Summary of Contents for Onyx
Page 1: ...Onyx User Manual Miniature Iridium Asset Tracker with Relay Function Version 5 2 May 2018 ...
Page 31: ...Appendix C Mechanical Drawings Onyx ...
Page 32: ...Onyx User Manual Version 5 2 2 Onyx I ...
Page 33: ...Onyx User Manual Version 5 2 3 Onyx R ...
Page 34: ...Onyx User Manual Version 5 2 4 Onyx M RH ...
Page 35: ...Onyx User Manual Version 5 2 5 Onyx WB ...
Page 36: ...Onyx User Manual Version 5 2 6 Onyx OEM ...
Page 37: ...Onyx User Manual Version 5 2 7 Onyx Low Voltage OEM ...
Page 39: ...Onyx User Manual Version 5 2 9 A 05 008 Onyx Onyx R Diagnostic Cable ...
Page 40: ...Onyx User Manual Version 5 2 10 A 05 063 Onyx WB Diagnostic Cable ...
Page 41: ...Onyx User Manual Version 5 2 11 A 05 064 Onyx WB Power Cable Flying Leads ...