Xeos Technologies Inc. Onyx, User Manual

Page 1: ...Onyx User Manual Miniature Iridium Asset Tracker with Relay Function Version 5 2 May 2018 ...

Page 2: ...ctions 3 0 Nov 2014 Updated commands 3 1 Jan 2015 Updated with Onyx R and I information 3 2 Feb 2015 Added info regarding in motion mode 3 3 Mar 2015 Added adv Config Options in appendices 3 4 Mar 2015 Corrected error in Appendix B 3 5 Apr 2015 Added OEM info 3 6 Nov 2015 Added LV OEM info to Appendix D 3 8 Feb 2016 Added Onyx M info 4 0 Sept 2017 Document overhaul 5 0 Apr 2018 Added Onyx WB info ...

Page 3: ...Account 6 Onyx Variants 7 Onyx 7 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 10 LED Indicators 10 Device Status LEDs 10 Recharging the Onyx R M 11 Serial Interface 11 Things to Remember 11 Testing Your Installation 12 Communicating with the Onyx 12 Sending Commands via Email 12 Command Format ...

Page 4: ...Diagram 18 Summary 18 Onyx Timer Intervals 19 Setting timers 19 In Motion Timer 20 In Motion Threshold 20 Additional Settings Commands and Messages 21 Version Type V 21 Position Type P 21 Information Message Type I 22 Settings 22 Timer 23 Lifetime Stats 23 Stats 24 Message Enable 24 Digital Output Pin 25 Encryption 25 Generating your Key 25 Enabling Encryption 26 Setting Up Encryption on XeosOnlin...

Page 5: ...nical Drawings 1 Onyx 1 Onyx I 2 Onyx R 3 Onyx M RH 4 Onyx WB 5 Onyx OEM 6 Onyx Low Voltage OEM 7 Appendix D Cable Drawings 8 Appendix E Specifications 1 Standard Onyx Onyx WB Onyx I 1 Onyx R Onyx M Low Voltage 1 Shared Characteristics 1 Appendix F Relay Function 2 Basic Functionality 2 Serial Relay 2 Mobile Originated SBD From Device 2 Mobile Terminated SBD To Device 4 Settings 5 Appendix G Warra...

Page 6: ... or periodic monitoring of high value assets globally The Onyx can facilitate instant and accurate location of assets for recovery or monitoring purposes The internal GPS determines location which is stored on board the Onyx An Iridium modem provides two way communications for retrieval of data live tracking and sending commands to the remote tracker The deployment is facilitated by the miniature ...

Page 7: ...t 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 Variants Onyx The standard Onyx has no internal power source It requires an external power supply of 7 to 24 Volts Onyx I The Onyx I has an internal power source consisting of four 3 Volt CR123A Lithium non rechargeable batteries in series This model...

Page 8: ...ottom of the Remote head and Battery pack are designed for 5 8 diameter magnets which are not included 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...

Page 9: ...t not be obstructed by metal or wood Thick amounts of other materials may also cause interference Testing of covert installation locations is strongly recommended Powering the Onyx Standard Onyx While the power source can be between 7 24 VDC it is recommended that users not use a power source very close to either extreme Once the power supply dips below 7V communication may not be possible with th...

Page 10: ...t 12VDC The Status LED functions identically to the Onyx R and M and is in the same location Onyx R The Onyx R features a hard wired internal Lithium battery pack at a nominal voltage of 3 6V Using the front connector of the Onyx R the device can be recharged and redeployed Onyx M The Onyx Marine shares the same battery characteristics and charging capabilities as the Onyx R Remote head versions o...

Page 11: ...top Bits 1 Note USB connection is not sufficient to power the Iridium system on the Onyx and will therefore always fail this check Sending any character to the Onyx bypasses this check to move onto configuration Things to Remember The configuration of the Onyx is saved in flash memory Any changes made will be saved even if the power is removed and reapplied later As soon as power is applied to the...

Page 12: ...mail addresses to which the Iridium account is sending notifications or Xeos Online Xeos Online will display the last known position of the device as well as the time stamp of the GPS position Communicating with the Onyx Sending Commands via Email To receive commands from the Iridium network the device in use must have a clear view of the sky If the device is unable to communicate with the Iridium...

Page 13: ...rom 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 Navigate to your unit and click on the Message Log Tab The unlock code can be seen in the most recent outgoing messages Sending the Command To send an sbd command create a new email message with the followin...

Page 14: ...ing Xeos Online Before using Xeos Online make sure that your account has been set up and your device added to your organization Contact activations xeostech com for more information Setting up to Send Navigate to the Send Command window From the Home Tab choose File Send Select the units you wish to target with commands and move them over to the right hand target list using the button Type your co...

Page 15: ...Iridium transceivers position on earth when it receives a transmission using Doppler technology As a result it is often very inaccurate This location is only visible to users getting emails directly from the device as opposed to emails forwarded by 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 nam...

Page 16: ...rementing serial number Since the message in the example is from an Iridium device the MT number is zero Time of Session UTC The time the message arrived at the Iridium Gateway Session Status Each message will have a code determined by how well the message was received codes 00 01 and 02 are acceptable and will always have their code name ex Transfer OK next to this number Message Size bytes The s...

Page 17: ...EPradius value the larger the circle and therefore the less accurate that position These items can be enabled disabled by your Iridium provider if desired Global Positioning System Location information generated by the device itself is embedded in the SBD attachment sent via the Iridium Gateway and can only be seen through the Xeos Online system or situations where the position information is sent...

Page 18: ...s until the Onyx accelerometer senses motion vibration When motion is sensed it enters In Motion mode for a set period even if motion stops If motion has stops and In Motion mode period ends the Onyx reverts to Normal mode If motion is still occurring and the In Motion mode period ends the Onyx remains In Motion mode and restarts the In Motion mode period If the battery voltage drops below 7 VDC t...

Page 19: ...is timer Timers Timer 0 Normal Used if none of the following modes are triggered Timer 2 In Motion Used when the device has detected sufficient motion Timer 4 No GPS Fix 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 TI...

Page 20: ...a period of several minutes This motion check timer can be adjusted through the ACS timer Example To set the motion check to a 10 second interval during normal mode issue the following command timer ACS 0 10s In Motion Threshold The magnitude of motion required to enter In Motion mode can also be adjusted with the athrs command The default threshold is 100 Increasing this value will make the Onyx ...

Page 21: ...re version of GPS chip Iridium Version Firmware version of Iridium modem Reset Count The number of resets since firmware was uploaded Current Cause of last power off Previous Cause of previous power off not used in Onyx Position Type P Typical position messages are sent in compressed binary format Message Type 10 to save on data usage and are parsed in XeosOnline If XeosOnline is not used GPS Text S...

Page 22: ...io of the last GPS attempt nSats 7 Number of connected satellites during last GPS attempt GPS 25 1 729 Quantity of good fixes since powerup fails Quantity of failed fixes Seconds total GPS has been powered on since power up Ird 30 29 764 Quantity of Iridium messages Quantity of Iridium sessions Seconds total on time for Iridium RSSI 5 Value reported back from the modem Always a number between zero...

Page 23: ...reshold Secs Tilt Seconds USec Untilt Seconds Timer The timer command will return all timer intervals The response will also be returned when timers are changed The timer string returned includes a summary of GPS and SBD timers Lifetime Stats The statsl command will return various performance statistics recorded since the last firmware install as well as current statistics Lifetime Statistics Read...

Page 24: ...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 stats are like 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 com...

Page 25: ...V 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 Parameter Purpose dOut Base Command X Capability to turn the pin on off Enabled 1 or disabled 0 Y High 1 or Low 0 Command Pin Enable Disable Output High Low Result dOut 0 0 Output Low dOut 0 1 Output Low dOut 1 0 Output Low dOut 1 1 Output High Encryption ...

Page 26: ... Config Miscellaneous 5 Enter your encryption passphrase by entering aky pass phrase The pass phrase must be exactly 32 characters long Note This step cannot be done through Iridium Enabling Encryption 1 Using Xeos Online or an SBD email message send the command aenbl 1 2 To disable encryption send the command aenbl 0 Setting Up Encryption on XeosOnline 1 Log in to Xeos Online and click on the Adm...

Page 27: ...are versions Status Show operating status sysInf GPS Ird summary FactoryDefaults Reset all to defaults and reset batt Show battery status switch X 1 0 Switch component X on off No parameter lists components enable Y 1 0 Enable component Y on off Requires entry to Eng Mode ReportHour Hour 0 23 Set Show Daily Reporting Hour offset from UTC RepMinute Minute 0 55 Minutes offset past the hour for GPS I...

Page 28: ... package Tools for disassembly Loading Firmware into the Onyx 1 Connect the Onyx to your PC via the Onyx to USB cable 2 Take not of the COM port number in Control Panel Device Manager In this case COM8 3 If the Silicon Labs CP210x does not appear in the device manager under Ports see Installing the Serial to USB Driver 4 Extract the zipped folder from the Xeos website containing the firmware updat...

Page 29: ... external power source 4 Check the email account to see if a transmission has been received If no message is received within 20 minutes please check operating manual to ensure it is setup as required 5 If no message is received please contact Xeos for assistance in troubleshooting 6 DO NOT redeploy the Onyx until you have confirmed Iridium transmission Installing the Serial to USB Driver 1 Navigat...

Page 30: ...6 Positive Battery Input 12V 12V Onyx R Charging Onyx M Pin Purpose 1 No Connection 2 Positive Battery input 12V 3 6V Low Voltage Variant 3 5V USB power input 4 Data output from Onyx 5 Data input to Onyx 6 Ground Battery input Onyx WB Pin Purpose 1 Ground Battery input 2 Data output from Onyx 3 Data input to Onyx 4 5V USB power input 5 Positive Battery Input 12V 6 Digital I O Onyx OEM ...

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 38: ...Onyx User Manual Version 5 2 8 Appendix D Cable Drawings A 05 007 Onyx Power Cable Onyx R Charging Cable ...

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

Page 42: ...nput Standard Onyx Onyx WB 7 32 VDC Onyx I 4 x CR123A Lithium Batteries 1 8Ah Onyx R Onyx M Low Voltage Mechanical Material Onyx R Onyx M Delrin Dimensions Onyx R 12cm x 4 2cm x 2 5cm 4 72 x 1 65 x 0 98 Onyx M Head 5 03cm x 4 31cm x 2 79cm 1 98 x 1 70 x 1 10 Connector Onyx R Hirose 6 pin HR 30 series Onyx M Impulse IE55 1206 BCR Electrical Currents measured 3 6V Sleep Current 100µA Between Transmi...

Page 43: ...ept most commands Diagnostics can be enabled by issuing the command diag 1 and disabled with diag 0 over the serial line The Onyx Relay will always accept commands over Iridium Serial Relay After the device is configured to your specifications you can now use it to relay data to and from a connected serial device over the Iridium Satellite Network To send data to or from the connected serial devic...

Page 44: ...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 requi...

Page 45: ...each device Its purpose is to prevent accidental or malicious commands from being processed by either the Onyx Relay or your connected device When the data to be sent is compiled normal methods of sending commands to Iridium devices can be implemented either through email or a web service such as XeosOnline All lines after the outPort line will be delivered to the connected serial device the next ...

Page 46: ...l Version 5 2 5 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 ...

Page 47: ...d Warranty is void if failure of the product has resulted from accident abuse or misapplication Any replacement product will be warranted for the remainder of the original warranty period or ninety 90 days whichever is longer NO OTHER WARRANTIES Xeos Technologies Inc disclaims all other warranties either express or implied including but not limited to implied warranties of merchantability and fitn...