1. Manuals
  2. Brands
  3. Xeos Technologies Inc. Manuals
  4. GPS
  5. Onyx
  6. User manual

Xeos Technologies Inc. Onyx User Manual

Miniature iridium asset tracker with relay function
Hide thumbs Also See for Onyx:
Table of Contents

Advertisement

Quick Links

Download this manual
Onyx User Manual
Miniature Iridium Asset Tracker with Relay Function
Version 6.1
January 2020
57

Advertisement

Table of Contents
loading

Related Manuals for Xeos Technologies Inc. Onyx

Summary of Contents for Xeos Technologies Inc. Onyx

  • Page 1 Onyx User Manual Miniature Iridium Asset Tracker with Relay Function Version 6.1 January 2020...

  • Page 2: Shipped From

    Phone (902) 444 7650 (902) 444 7651 Website www.xeostech.com Specifics This manual version is written with respect to Onyx Firmware builds 5886 to 6152. To acquire the latest firmware for your device, contact support@xeostech.com Version History Version No. Date Description...

  • Page 3: Table Of Contents

    Understanding Position Information ..................9 Iridium Doppler position......................9 Global Positioning System ....................11 Onyx Operation ..........................12 Powering the Onyx ........................12 Standard Onyx, Onyx-M2, Onyx-WB ................... 12 Onyx-I ........................... 12 Onyx-R..........................12 LED Indicators ........................... 12 Device Status LEDs ....................... 12 Recharging the Onyx-R ......................
  • Page 4 Information Message (Type I) ....................18 Motion Message ........................18 Communicating with the Onyx ..................... 19 Sending Commands via Email ....................19 Command Format ........................ 19 Command Structure ......................19 The Unlock Code ........................19 Sending the Command ......................20 Sending Commands Using XeosOnline ..................
  • Page 5 Mobile Terminated SBD (To Device) ................... 35 Settings ............................. 36 Other Commands .......................... 37 Testing the Onyx ........................... 38 Deployment of the Onyx ....................... 39 Troubleshooting ..........................40 Appendix A: Firmware Update Procedure ..................42 Appendix B: Pinout Diagrams ....................... 45 Appendix C: Mechanical Drawings ....................

  • Page 6: General Description

    Inside the Onyx is a 9603 Iridium satellite Short Burst Data core radio transceiver, a specialized low-power Xeos digital controller with GPS, Iridium & GPS antennas, and complex accelerometer for motion detection.

  • Page 7: Onyx Variants

    Onyx Variants Onyx The standard Onyx has no internal power source. It requires an external power supply of 7 to 32 Volts. The Standard Onyx is also available without an enclosure as the Onyx OEM. Onyx-I The Onyx-I has an internal power source, consisting of four 3 Volt CR123A Lithium non-rechargeable batteries in series.
  • Page 8 Onyx-WB The Onyx-WB (Work Boat) is the marine variant of the Onyx designed for static mounting. The enclosure of the Onyx-WB is rated IP-67 enclosure to prevent water ingress. The Onyx-WB Remote-head can be treated identically to an Onyx when considering installation. Like other Onyx variants, the Onyx-WB’s programming cable can power the unit when...

  • Page 9: Preliminary Setup

    Onyx makes use of the Iridium satellite system’s (www.iridium.com) Short Burst Data (SBD) service for the 9603 transceiver. This service is a global, two-way, real-time, email-based data delivery service that has a maximum outbound (from Onyx) message size of 340 bytes and a maximum inbound (to Onyx) message size of 270 bytes.
  • Page 10 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 6.1...

  • Page 11: Global Positioning System

    Iridium Gateway and can only be seen through the XeosOnline 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 6.1...

  • Page 12: Onyx Operation

    Device Status LEDs The Onyx-I, R, M2 and WB all have a small window on the side of the device to show its on/off status using an LED. It is to be used as an indicator for when the magnetic switch is used to turn the device on/off.

  • Page 13: Recharging The Onyx-R

    Data Bits Stop Bits USB connection is not sufficient to power the Iridium system on the Onyx and will therefore always fail the start-up self-test check during USB sessions. Sending any character to the Onyx bypasses this check to move onto configuration.

  • Page 14: Things To Remember

     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.

  • Page 15: Deployment Of The Onyx

     (Optional) An external serial device to be managed via the Onyx Antennas To deploy the Onyx, ensure that the top of the device, which is where the antennas are located, has a clear view of the sky. The top of the device appears differently between models: ...

  • Page 16: Messages From The Onyx

    Mobile Originating messages. Settings Summary Message On startup, the Onyx will send a summary of timers and a short list of GPS and Iridium settings to confirm to the user the immediate configuration of inactive (Timer Zero) and In-Motion (Timer Two) timers.

  • Page 17: Ascii Position (Type P)

    Type of message (Position) 44.71441 Latitude of fix, decimal degrees -63.60495 Longitude of fix, decimal degrees SNR (Signal-to-noise ratio) of GPS Fix, higher is better Unloaded voltage of device at the time of GPS Fix Onyx User Manual Version 6.1...

  • Page 18: Information Message (Type I)

    Motion Message At defaults, the Onyx will send a motion message when the device enters Motion Mode. A simple message, it can be used to bookend motion periods of interest. This message can be disabled by removing message type 11 from the list of used types via the $msgenable command.

  • Page 19: Communicating With The Onyx

    XeosOnline, or the unit can be queried for its unlock code by sending $unlock to the device as a command. The device will respond by sharing the 5-digit code with its provisioned destinations. Onyx User Manual Version 6.1...

  • Page 20: Sending The Command

    Commands can be sent from any email address, but responses will be returned only to email addresses on the unit’s forwarding list. Sending Commands Using XeosOnline Before using XeosOnline make sure that your account has been set up and your device added to your organization. Contact activations@xeostech.com for more information. Onyx User Manual Version 6.1...

  • Page 21: Setting Up To Send

    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 6.1...

  • Page 22: Messages To The Onyx

    Messages to the Onyx Settings The $settings command will return a truncated list of important Onyx settings aside from timers: Name Default Description GPS Settings (GPS) MxOn Maximum GPS session length in seconds MxPr Maximum GPS session length in poor conditions Temperature minimum 6.000...

  • Page 23: Lifetime Stats

    Successful GPS fix count GPS TTFF Average Average time to fix, in seconds High Temperature Not used with the Onyx Low Temperature Not used by the Onyx Stats The $stats command will return performance statistics recorded since the last power-up. The statistics are those found in $statsl but exclude Power Cycle Count and Watchdog Reset Count.

  • Page 24: Onyx Mode Diagram

    Onyx Mode Diagram The Onyx has a combination of preset behaviors and configurable parameters. Below is an outline of its normal behavior. The Low battery condition shown is used in the regular Onyx type (12V). Onyx User Manual Version 6.1...

  • Page 25: Onyx Timer Intervals

    Low Battery Used when Onyx’s battery drops below 7 Volts Timer 6 Geofence Triggers when the user’s defined Geofence settings are triggered Note: Timers 1, 3 and 7 are not used in the Onyx. Timer Parameter named ACP is not used. Setting timers $timer SYSTEM TIMER-MODE...

  • Page 26: Motion

    The default threshold is 100. Increasing this value will make the Onyx less likely to enter In-Motion mode. $athrs 200 Note: It is recommended that $athrs NOT be set to a value less than 100, as the Onyx is very sensitive to movement by default. Onyx User Manual Version 6.1...

  • Page 27: Message Enable

    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. These message formats can be changed using the $msgenable command.

  • Page 28: Geofencing

     The timer interval used when a geofence is in an alarm state; all geofences use the same timer (Timer 6). By default, the Onyx will remain in Timer 6 for a minimum of 20 minutes, plus any additional time that the Onyx is in a position that keeps any fence triggered.

  • Page 29: Clear Geofence

    $LiveTrack 0 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.

  • Page 30: Encryption

    Encryption The Onyx has some security features enabled by default, such as an unlock codes for receiving commands. Users can also enable end-to-end 256 bit AES encryption between their device and XeosOnline for an additional layer of security. Messages are zero-padded to fill out the 32 byte blocks.

  • Page 31: Setting Up Encryption On Xeosonline

    1. Log in to XeosOnline and click on the Admin button at the top of the screen. 2. Ensure that your organization is selected in the Organization List 3. Find your device and click the edit device button 4. Enter your passphrase into the appropriate text boxes and press Save Onyx User Manual Version 6.1...

  • Page 32: Flash Memory

    Flash Memory The Onyx comes equipped with internal flash memory, used to store logged events and GPS positions over the lifetime of the product. This information can be retrieved for data collection or troubleshooting purposes. Dumping the Flash Memory ...

  • Page 33: Data Relay

    The Onyx Relay can receive and transmit serially to a remote device in the field. To do so, the Onyx requires a cable capable of supplying both power and serial.

  • Page 34: Mobile Originated Sbd (From Device)

    Mobile Originated SBD (From Device) 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...

  • Page 35: Mobile Terminated Sbd (To Device)

    Following the “devData” line will be all or part of the payload, depending on the size of the payload. 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...

  • Page 36: Settings

    3 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 6.1...

  • Page 37: Other Commands

    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.

  • Page 38: Testing The Onyx

    The Onyx enters operation immediately on power-up. o The Onyx-R has an integrated battery pack; if the device is off (Red LED on magnet input) a magnet swipe is required to turn the device on.

  • Page 39: Deployment Of The Onyx

    Deployment of the Onyx Below are installation tips for the Onyx:  The top of the Onyx must have as good a view of the full sky as possible. o Alongside a wall or tall obstruction will cause coverage to suffer.

  • Page 40: Troubleshooting

    - Iridium - Modem cannot communicate with CPU of Onyx; if the self-test runs when the device is connected to a PC, this criteria will fail, as 5V-USB cannot power the Iridium modem.
  • Page 41 Changing the $athrs threshold value can make motion events less likely.  Geofences are set incorrectly (alarming at wrong times and locations) o Check the fence boundaries using $gfp X o Adjust fence characteristics as required Onyx User Manual Version 6.1...

  • Page 42: Appendix A: Firmware Update Procedure

    Appendix A: Firmware Update Procedure 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 ...
  • Page 43 COM port number previously noted (in our case, 8), and hit Enter. 11. The firmware will begin updating right away. Firmware update should take approximately 90 seconds. If the window closes immediately upon executing the file, the firmware update has failed. Onyx User Manual Version 6.1...
  • Page 44 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.

  • Page 45: Appendix B: Pinout Diagrams

    Digital I/O Data input to Onyx (Rx / D-) Data output from Onyx (Tx / D+) 5V USB power input Positive (+) Battery Input, 12V (12V Onyx-R Charging) Onyx-M, Onyx M-R (Teledyne Impulse IE55-1206-BCR) Pin Purpose No Connection Positive (+) Battery input, 12V (3.6V Low Voltage Variant)
  • Page 46 Top view (Antenna up) is displayed. J10, Onyx-OEM Port Purpose Positive Battery Input 5V-USB Data output from Onyx (Tx / D+) Data input to Onyx (Rx / D-) Digital I/O Ground (-) Battery input Onyx-OEM LV Pin 1 is indicated by square pads on board.

  • Page 47: Appendix C: Mechanical Drawings

    Appendix C: Mechanical Drawings Onyx...
  • Page 48 Onyx-I Onyx User Manual Version 6.1...
  • Page 49 Onyx-R Onyx User Manual Version 6.1...
  • Page 50 Onyx-M RH (Discontinued) Onyx User Manual Version 6.1...
  • Page 51 Onyx-M2 Onyx User Manual Version 6.1...
  • Page 52 Onyx-WB Onyx User Manual Version 6.1...
  • Page 53 Onyx OEM Onyx User Manual Version 6.1...
  • Page 54 Onyx Low Voltage OEM Onyx User Manual Version 6.1...

  • Page 55: Appendix D: Cable Drawings

    Appendix D: Cable Drawings A-05-007: Onyx Hirose Power Cable/Onyx-R Hirose Charging Cable Onyx User Manual Version 6.1...
  • Page 56 A-05-008: Onyx Hirose/Onyx-R Hirose Diagnostic Cable Onyx User Manual Version 6.1...

  • Page 57: Appendix E: Specifications

    A-05-009 - Onyx Hirose to Onyx Hirose Battery Pack interconnect Onyx User Manual Version 6.1...
  • Page 58 A-05-036 - Onyx Hirose Relay Cable (Power/GND/Tx/Rx) all flying leads Onyx User Manual Version 6.1...
  • Page 59 A-05-039 - Onyx-I Programming Adaptor Cable Onyx User Manual Version 6.1...
  • Page 60 A-05-041 - OnyxLV OEM Diagnostic Cable Onyx User Manual Version 6.1...
  • Page 61 A-05-063: Onyx Chogori Diagnostic Cable Onyx User Manual Version 6.1...
  • Page 62 A-05-064: Onyx Chogori Power Cable (Flying Leads) Onyx User Manual Version 6.1...
  • Page 63 A-05-075 – Onyx Chogori to Battery Pack Chogori Onyx User Manual Version 6.1...
  • Page 64 2.04" L Height) 1.44" W 1.71" W 1.7" W 1.7" W 1.10" H 1" H 1.1" H 1.1" H ** Onyx WB’s Width including tabs is 2.9 inches. Onyx-R, Onyx-M (Low Voltage), Onyx-LV-OEM Onyx-R Onyx-LV-OEM Onyx-M-R (Discontinued) Connector Hirose None Teledyne...
  • Page 65 0.50" H 0.50” H Shared Characteristics GPS Hardware Xeos Technologies 48 channel GPS (SiRFStarIV, SiRFStarV as of January 2018, hardware dependent) Antenna Integrated Iridium and GPS antennas Operating Temperature Operating Temperature: -20° C to +60° C Onyx User Manual Version 6.1...

  • Page 66: Appendix F: Accessories

     Slide the assembly from the surface fully and add the remaining screws Not all magnet cups require magnets; 2 for the regular Onyx and 4 for the Onyx-I/R are normally sufficient. Ensure that the magnetic reed switch on the device is still operational before deployment when mounting Onyx-I’s and R’s.
  • Page 67 The Onyx Serial Dongle allows for Bluetooth communication between an Android device with the Xeos Beacon app, and a connected Onyx device. It is only for use with Onyx models that are powered at the standard voltage (9 - 14 Volts).

  • Page 68: Appendix G: Gps Text Long

    Like GPS Text Short, only the most recent GPS position is sent, therefore this message format cannot be stacked. Greyed out fields are not used in the Onyx. GPS Text Long Readout 03251545 Date and Time, MMDDHHMM...

  • Page 69: Warranty, Support And Limited Liability

    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.

Table of Contents