Phone (902) 444 7650 (902) 444 7651 Website www.xeostech.com Specifics This manual version is written with respect to Onyx Firmware build 3595. To acquire the latest firmware for your device, contact support@xeostech.com Version History Version No. Date Description Jun 2013...
Onyx-I ............................7 Onyx-R ............................7 Onyx-LV OEM ..........................7 Onyx-M ............................8 Onyx-WB ............................. 8 Deployment of the Onyx ......................... 9 Antennas ............................ 9 Powering the Onyx .......................... 9 Standard Onyx ..........................9 Onyx-I ............................10 Onyx-R ............................10 Onyx-M .............................
Page 4
Setting up to Send ....................... 14 Understanding Position Information .................... 15 Iridium Doppler position ......................15 Global Positioning System ......................17 Configuration of the Onyx......................18 Onyx Mode Diagram ........................ 18 Summary ..........................18 Onyx Timer Intervals ........................19 Setting timers ........................... 19 In-Motion Timer ........................
Page 5
Requirements ........................... 28 Loading Firmware into the Onyx ....................28 Testing the Onyx ........................29 Installing the Serial to USB Driver .................... 29 Appendix B: Pinout Diagrams ....................... 30 Onyx, Onyx-R ..........................30 Onyx-M ............................. 30 Onyx-WB ........................... 30 Onyx-OEM ..........................30 Appendix C: Mechanical Drawings ....................
Inside the Onyx is a 9603 Iridium satellite Short Burst Data core radio transceiver, a specialized low-power Xeos digital controller with GPS, Iridium antenna, GPS antenna, and complex accelerometer for motion detection.
While any email application can be used to send and receive messages between the user and the Onyx, Xeos Online is the easiest way to manage and monitor multiple Onyx devices. Xeos Online presents the information in a readable format and displays it on street level maps.
Onyx-M The Onyx-M is the marine variant of the Onyx and is submersible to 10m. The Remote-Head and Battery pack are both waterproof, but cables should remain attached while underwater to prevent pin corrosion. The Onyx-M Remote-head can be treated identically to an Onyx when considering installation.
(Optional) An external serial device to be managed via the Onyx Antennas To deploy the Onyx, ensure that the surface with the beveled edge, which is where the antennas are located, has a clear view of the sky. For a covert deployment, the antenna surface must not be obstructed by metal or wood.
Device Status LEDs The Onyx-I, R and M all have a small window on the side of the device to show its on/off status using an LED. This same LED also pulses red in the event of a self-test failure at start-up.
As soon as power is applied to the Onyx, it will attempt to get a GPS fix and transmit a report. Once it successfully makes that report, it will go to “sleep” for 1 hour according to the default settings.
Commands must be structured in the following way: 1. Each command MUST have a dollar sign ($) before each command. 2. The unit’s unlock code in the following format: $unlock XXXXX where XXXXX is the unit’s five digit unlock code. Onyx User Manual Version 5.2...
SBD commands without an unlock code will be ignored by devices that require it. These devices include the Apollo, XMI, Onyx, Rover, and Osker. The unlock code is generated by the device itself and can be retrieved from XeosOnline, or the unit can be queried for its unlock code by sending $unlock to the device as a command.
Type your command(s) into the command box and press Send. Remember to include the dollar sign ($) ahead of each command and enter each command on a separate line. Outgoing messages will appear in the Message Log for the commanded device. Onyx User Manual Version 5.2...
XeosOnline. An example of a “raw” Iridium message via email is below and will always have the IMEI of the device in the subject line, regardless of its name on XeosOnline. Onyx User Manual Version 5.2...
Page 16
The size of the actual message sent by the Iridium device, which is in the attachment in the email. *Unit Location The Doppler position of the device as estimated by Iridium’s network. It is the GPS position measured by the device. Onyx User Manual Version 5.2...
Iridium Gateway and can only be seen through the Xeos Online system or situations where the position information is sent in a plain-text format (XeosOnline message forwarder or using the $msgenable command). This position information is accurate to within several feet of the true position. Onyx User Manual Version 5.2...
Onyx Mode Diagram Summary When the Onyx starts up (has power applied to it), it goes into Normal mode Normal mode runs until the Onyx accelerometer senses motion (vibration) When motion is sensed, it enters In Motion mode for a set period, even if motion stops ...
Used when the GPS module fails to acquire a fix Timer 5 Low Battery Used when Onyx’s battery drops below 7 Volts Note: Timers 1, 3, 6, and 7 are not used in the Onyx. Timer Parameter named ACP is not used. Setting timers $timer SYSTEM...
In-Motion Timer The motion detection functionality can be adjusted or disabled. By default, once motion is detected, the Onyx will continue to check for motion every two seconds until no motion is measured for a period of several minutes. This motion check timer can be adjusted through the ACS timer.
Additional Settings, Commands, and Messages There are many commands that can be sent to the Onyx in addition to changing timers. These commands can be sent locally or remotely. However, the response from remote commands is often less detailed to save bandwidth. Modifying these settings will affect the performance of the Onyx.
Value reported back from the modem. Always a number between zero and five; five being the strongest signal. Settings The $settings command will return a truncated list of important Onyx settings aside from timers: GPS Settings (GPS) MxOn Maximum GPS session length in seconds...
Last measured battery voltage (Loaded) Last measured battery voltage (Unloaded) Uptime Total unit uptime in minutes Power Cycle Count Number of power cycles Watchdog Reset Count Number of errors Lowest Battery Voltage Lowest measured battery voltage Onyx User Manual Version 5.2...
$statsl but exclude Power Cycle Count and Watchdog Reset Count. Message Enable The Onyx has several message types that can be enabled for GPS and event messages. At factory defaults, the Onyx will send compressed binary GPS (not human readable) and event (startup and battery) messages.
Onyx will use additional Iridium data. Digital Output Pin The Digital I/O pin of the Onyx can be toggled via command to have a high or low logic output of 3V at a maximum of 5mA. The command is as follows: $dOut X Y As seen below, only one of the possible four number combinations leads to a high output.
1. Connect the Onyx to your PC via the Onyx to USB cable. 2. Take note of the COM port number in Control Panel → Device Manager In this case: COM8 Connect Using Terminal Emulator (uCon) 1. Download the uCon Serial Console software 2.
Other Commands Below is a list of other commands that can be sent via Iridium or serially to acquire additional information, or configure the Onyx. Remember to add the $ symbol ahead of any commands. Command Parameters Description Show hardware and firmware versions.
Appendix A: Firmware Update Procedure Introduction If you have been notified that the firmware in your Onyx needs to be updated, please use the instructions below. Please note, the Onyx must be removed from the field. Process Remove unit from field ...
Ensure you have access to one of the email addresses to which messages are sent. 3. Place the Onyx outside in a location where it has a clear view of the sky and connect it to an external power source.
Ground (-) Battery input Digital I/O Data output from Onyx Data input to Onyx 5V USB power input Positive (+) Battery Input, 12V (12V Onyx-R Charging) Onyx-M Pin Purpose No Connection Positive (+) Battery input, 12V (3.6V Low Voltage Variant)
Onyx-WB, Onyx-I - Delrin Dimensions Standard Onyx – 4.75cm x 3.66cm x 2.79cm (1.87” x 1.44” x 1.10”) Onyx-WB – 7.62cm x 4.7cm x 2.8cm (1.56” x 1.85” x 1.10”) Onyx-I - 12cm x 4.2cm x 2.5cm (4.72” x 1.65” x 0.98”)
The Onyx-Relay can receive and transmit serially to a remote device in the field. To do so, the Onyx requires a Y-cable, with an attachment for both power and serial.
Page 44
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.
Mobile Terminated SBD (To Device) To send a payload of data to your connected serial device via the Onyx-Relay, create a file with the extension “.sbd” with its contents adhering to the following format: $unlock 12345 $outPort X (where 'X' is the alphabetic port number of the connected device)
Settings By default, the Onyx-Relay’s serial settings are identical to what is detailed with other Onyx types. It is recommended that relay functionality be tested over a USB connection before deployment. Onyx User Manual Version 5.2...
Appendix G: Warranty, Support and Limited Liability Xeos Technologies Inc. warranties the Onyx to be free of defects in material or manufacturing for a period of one year following delivery. Liability is limited to repair or replacement of the defective part and will be done free of charge.