Abeeway Industrial Tracker, Reference Manual

Page 1: ...Industrial Tracker Reference Guide Industrial Tracker Firmware V1 8 ABEEWAY SAS contact abeeway com www abeeway com ...

Page 2: ...odes 14 5 1 Main operating modes and SOS mode 14 5 2 Side operations 14 5 3 Geolocation technology description 14 6 Uplink messages 19 6 1 LoRa uplink transmission 19 6 2 Encoded form 20 6 3 Common message header 22 6 4 Heartbeat messages 23 6 5 Position messages 23 6 6 Energy Status messages 26 6 7 Activity status messages 27 6 8 Configuration messages 27 6 9 Shock detection messages 28 6 10 Fram...

Page 3: ...tracker configuration 39 9 Configuration examples 40 9 1 Profile 1 Accurate on demand positioning 40 9 2 Profile 2 Accurate Daily periodic position 41 9 3 Profile 3 Hourly periodic position with medium accuracy 42 9 4 Profile 4 Accurate positions at start and stop moving including start stop events message 43 9 5 Profile 5 Motion tracking 44 9 6 Profile 6 Permanent tracking 45 Page 3 of 46 10th Ju...

Page 4: ... reserved to support team distributors and integrator teams to give a deeper knowledge of all the possible settings We do reserve the right to modify the contents in future releases 1 2 Product descripton The Abeetay Industrial Tracker is a multimode tracker combining GPS Lot poter GPS WIFI and LoRa radios tith embedded sensors to support accurate outdoor and indoor geolocaton Designed to tithstan...

Page 5: ...once per hour to once a day Configurable moton detecton SOS support Bump detecton Supported geolocaton technologies GPS Precise outdoor positon Low power GPS LPGPS Get quick positon outdoors and daylight indoor conditons WIFI Indoors positoning and urban area Temperature monitoring Battery monitoring Embedded antennas LoRa Class A radio Dust proof and powerful water jets IP66 The asset tracker V1 ...

Page 6: ...some actons need to be done to actvate the transfer of the data through Abeetay servers Please refer to your vendor for more informaton Note The provided trackers are in OTA confguraton only It can t be modifed by confguraton If you need trackers torking in ABP please refer to your vendor 3 2 Advice usage For optmum radio performance the tracker should be laid lat as shotn on the picture It can be...

Page 7: ... the confgured frequency lora_period The device positons can be obtained in this mode by using the side operatons features see the side operatons secton 4 1 3 Moton traciing mode The tracker provides positons at the ul_period frequency only then the device is moving The positons are given by the geolocaton strategy defned by geoloc_sensor parameter When the device is not moving the positon message...

Page 8: ...er Each moton detecton increases a counter if 3 moton events are detected during a 2seconds period interval and the counter value is reported at the ul_period frequency Heartbeat messages are sent if there are no other uplink messages during lora_period seconds Notes 1i The counter is reset then Any dotnlink message is received The tracker is turned on 2i When the tracker stops moving the number o...

Page 9: ...avior is the folloting The tracker sends contnuously its positon at a fxed period of 120 s The tracker uses the geolocaton strategy geoloc_sensor with a GPS tmeout fxed to 120 seconds The LoRa positon messages are tagged tith an alert lag see uplink descripton for more detail The tracker can enter this mode by receiving a SOS start LoRa dotnlink This mode is disabled by a SOS stop LoRa dotnlink Re...

Page 10: ...Industrial Tracker Reference Guide FW 1 8 V0 2 The range 1 100 gives the sensitvity in percentage Page 10 of 46 10th July 2019 Restricted distribution ...

Page 11: ...value accelerometer thresold mG Examples 1i High sensitvity motion_sensitiiitt 100 2i Lot sensitvity motion_sensitiiitt 1 4 4 3 Moton duraton The end of a moton is triggered by the absence of movement during a confgurable period called motion_duration This parameter is expressed in seconds and ranges tithin 60 3600 The factory default value is 120 seconds 4 4 4 Device orientaton The acceleraton va...

Page 12: ... operatng mode config flag bits Bit6 geolocaton start Bit 8 Moton start Bit 9 Moton end Message Beginning of moton 0 0 x Geoloc Start event x 1 x Moton Start event 1 0 x WIFI positon End of moton x x 1 Moton End event 4 5 3 In permanent traciing operatng mode config flag bits Bit6 geolocaton start Bit 8 Moton start Bit 9 Moton end Message Entering of the mode 0 x x Geoloc Start event 1 0 x WIFI po...

Page 13: ...called shock_detection This parameter gives the accelerometer sensitvity used to trigger the shock events The threshold can range from 0 to 100 Value 0 means no detecton Notes 1i The motion_sensitiiitt parameter must be confgured nonzero value 2i The shock_detection parameter must be loter than the motion_sensitiiitt othertise all motons events are considered as shocks 4 6 3 Shoci detecton message...

Page 14: ...od parameter are used for periodici reportng onidemand or alert operatons WIFI only Only WIFI scans are used for positon determinaton GPS only Only the GPS is used for positon determinaton LPGPS only GPS and LPGPS are used for positon determinaton Mult technologies modes o WIFI GPS only WIFI then GPS if WIFI fails in one geolocaton cycle o WIFI LPGPS only WIFI then lot poteriGPS if WIFI fails in o...

Page 15: ...When doing a cold start the tracker sends its frst positon using the gps_timeout value Afer this one the tracker uses systematcally a tmeout of 5 minutes instead of the confgured one except in SOS mode untl it succeeds in having a positon To complete a positon the GPS module expects one of the tto folloting conditons to be achieved The gps_coniergence tmeout tme let to the GPS module to compute a ...

Page 16: ...expires the GPS component is potered of This leads into a loss of all data and ephemeris In the case there the GPS module didn t succeed a GPS tmeout message is sent instead of a GPS positon message GPS state diagram Note In the case there the gps_timeout value is greater than the ul_period the actual GPS tmeout till be ul_period Page 16 of 46 10th July 2019 Restricted distribution ...

Page 17: ... are sent via LoRa tith the associated RSSI and the positon calculaton is done by the ABEEWAY server In a mult technology geolocaton a WIFI scan tith the number of BSSIDs greater than or equals to 3 is considered as successful and a WIFI positon message is reported via LoRa Less than 3 BSSIDs triggers a technology stitch move to GPS or LPGPS 5 3 5 Mult technologies These technologies use tto difer...

Page 18: ...imeout depending on the used technology If geoloc_tmeout WIFI_tme 5 seconds stitching techno tme 3 seconds is higher than ul_period geoloc_tmeout is adjusted and reduced to ft the ul_period 5 3 6 Mult technology switching state diagrams The multitechnology state diagram can be pictured as follot Page 18 of 46 10th July 2019 Restricted distribution ...

Page 19: ...server the tracker is operatonal and under LoRa coverage Actvity Status message 1 0x0 7 Reports the actvity counter Used only by the actvity tracking operatng mode Configuraton message 1 0x0 7 Reports the partal or thole confguraton of the trackers Shoci detecton message 1 0x0 7 Reports the accelerometer vector X Y Z of the detected shock Event message 2 0x0 A Sent event informaton about tracker D...

Page 20: ...n be confgured to request LoRa confrmatons for a collecton of uplink message types The parameter confirmed_ul_bitmap is used to select the message types that requires a confrmaton Only message types in the range 0x00 to 0x0F can be selected Example Confrmed uplink of message types 0x0 and 0x3 bitmap 20 23 1 8 9 The parameter confirmed_ul_retrt gives the number of retransmissions that the tracker s...

Page 21: ...ues calculated using this formula provides a truncated value rounding tithin a range of step_size Decoded value Real value decoded value step_size 2i if real value step size then a value of 0 is decoded Page 21 of 46 10th July 2019 Restricted distribution ...

Page 22: ...0 Set for a positon on demand message Note 1 The moton bit setng can be pictured as follot Battery Batery voltage expressed in volt Encoded form using lo 2 8 hi 4 2 nbits 8 nresv 2 It is given tith a step of 5 5mV Temperature Temperature measured in the device expressed in degree Celsius Encoded form using lo i44 hi 85 nbits 8 nresv 0 It is given tith a step of 0 5 C ACK opt Bit 7i4 ACK Acknotledg...

Page 23: ...sion Byte 7 Firmtare minor revision Byte 8 Firmtare iteraton Note The felds Major Minor and Revision form the frmtare version as follot Major MinoriIteraton Example 1 8i0 is coded as 0x010800 6 5 Positon messages Common header Data Byte 0 Byte 1i3 Byte 4 1 Type 0x03 Status Bat Temp ACK Opt Positon Informaton Note 1 The size of data part depends on the type of positon message Opt type of positon me...

Page 24: ...ngitude 107 EHPE Estmated Horizontal Positon Error expressed in meters Encoded form using lo 0 hi 1000 nbits 8 nresv 0 The step is 3 9 meters Encoded form is detailed in the Encoded form secton 6 5 2 GPS tmeout payload Common header Positon informaton data Byte 0i4 Byte 5 Byte 6 Byte 7 Byte 8 Byte 9 Header tith Opt 1 Cause C N 0 C N 1 C N 2 C N 3 Cause Timeout cause 0 User tmeout cause C N 0 Carri...

Page 25: ...ailed in the Encoded form secton 6 5 4 WIFI failure payload Common header Positon informaton data Byte 0i4 Byte 5 Byte 6 Byte 7 Byte 8 Byte 9 Byte 10 Byte 11 Header tith Opt 4 v_bat1 v_bat2 v_bat3 v_bat4 v_bat5 v_bat6 Error V_bat1 encoded voltage at the start tme T0 of the WIFI scan V_bat2 encoded voltage at T0 0 5 second V_bat3 encoded voltage at T0 1 second V_bat4 encoded voltage at T0 1 5 secon...

Page 26: ...ontains the listened WIFI statons up to 4 2i If less than 4 statons are listened the payload till be reduced 3i BSSID address is provided in big endian format So the byte 6 of the payload contains the MSB of the BSSID0 thile the byte 11 contains its LSB 4i Encoded form is detailed in the Encoded form secton 6 6 Energy Status messages This message should be used for the primary batery life estmaton...

Page 27: ...er Window x value containing the actvity counter during the xth tme tindot The tindot 6 is the most recent one and the tindot 1 is the oldest Global counter Global actvity counter it contains the actvity since the beginning 6 8 Configuraton messages This message reports the parameter values confgured in the trackers If the complete list is requested several UL messages till be transmited Common he...

Page 28: ...hoci detecton messages Common header Data Byte 0i4 Byte 5 Byte 6 Byte 7i8 Byte 9i10 Byte 11i12 Header tith Type 0x07 0x03 Nb of shocks Accelerometer shock data X Axis Y Axis Z Axis Nb of shocis Number of shocks having an accelerometer value above the confgured thresholds Accelerometer shoci data X Axis Value measured on axis X of the accelerometer it is expressed in mG Y Axis Value measured on axi...

Page 29: ...start message If actvated bit 8 of config_flags set the event message is sent then the tracker begins a moton 0x02 moton_end message If actvated bit 9 of config_flags set the event message is sent then the end of a moton is detected Additonal data provides the orientaton of the tracker only valid in moton_end messages The orientaton can be negatve refer to the secton Tto s complement Encoding for ...

Page 30: ...ed Hotever the ack token is updated even if the message is discarded if the payload is at least 2 bytes long 2i The LoRa port to be used for dotnlink is 2 7 1 Acinowledge toien It provides a tay to indicate to the applicaton that a given message has been received by the tracker The acknotledge token is transmited in every uplink message and it is updated then the tracker receives a LoRa message Th...

Page 31: ...ted from the tracker using the message Byte 0 Byte 1 0x01 ACK ACK Acknotledge token Refer to the secton Acknotledge token Max value is 0x0F Example Positon on demand message tith ack token of 2 0x0102 The tracker till anster tith a positon message 7 4 Request device configuraton Byte 0 Byte 1 Byte 2 21 0x03 ACK Parameter ID list optonal ACK Acknotledge token Refer to the secton Acknotledge token M...

Page 32: ...fulfll the request 7 5 SOS mode configuraton Turn on SOS mode of the tracker Byte 0 Byte 1 0x04 ACK Turn of SOS mode of the tracker Byte 0 Byte 1 0x05 ACK ACK Acknotledge token Refer to the secton Acknotledge token Max value is 0x0F See secton SOS mode to have more informaton about the SOS mode behavior 7 6 Parameters configuraton Any parameter can be remotely modifed tith a dotnlink LoRa message ...

Page 33: ...s for operatonal modes Parameter ID Unit Range Descripton ul_period 0x00 secon d 60 i 86400 min 30 for US Period of positon or actvity messages in moton start end actvity or permanent operatng mode lora_period 0x01 secon d 300 i 86400 Period of LoRa heartbeat messages geoloc_sensor 0x05 none 0 i 9 Geolocaton sensor profle used in main operatng mode and SOS mode 0i WIFI only 1i GPS only 2i LPGPS AG...

Page 34: ...caton cycle 4i WIFIiLPGPS only WIFI then LPGPS if WIFI fails in one geolocaton cycle periodic_actiiitt_period 0x16 seco nd 0 1800i86400 Period of the periodic activity report The value must be a multiple of 6 When set to 0 the reportng is disabled Example To modify the periodic positon period to 12 hours the command 0x0B01030000A8C0 should be sent Descripton 0x0B set the parameter 0x01 tith an ack...

Page 35: ... parameter 0x04 tith an ack token of 4 0x0C gps_convergence tme 0x 00 00 01 2C to a value of 300s 5 minutes 7 6 4 LoRa parameters Parameter ID Unit Range Descripton transmit_strat 1 0x0E none 0i4 Transmit strategy in moton 0 i Single fxed Single TX Use provisioned data rate 1 i Single random Single TX Rate in SF7 SF12 2 i Dual random First TX tith rate in SF7 SF8 next TX tith rate in SF9 SF12 3 i ...

Page 36: ...ed not used in industrial tracker bit 6 First WIFI scan then geolocaton starts If disabled 0 WIFI positon is replaced by a geoloc start message 3 bit 7 Reserved not used in industrial tracker bit 8 Set to enable the sending of a moton start message 3 bit 9 Set to enable the sending of a moton end message 3 bit 10 Reserved not used in industrial tracker bit 11 Reserved not used in industrial tracke...

Page 37: ...r provides the confguraton of the sensitvity of the shock detecton from 1 to 100 A value of 0 disables the shock detecton Note When enabled the motion_sensitiiitt parameter must be set to a nonzero value and shock_detection should be strictly less than motion_sensitiiitt Page 37 of 46 10th July 2019 Restricted distribution ...

Page 38: ...omplement This encoding provides positves and negatves values depending on the setng of the MSB Most Signifcant Bit MSB 0 the number is positve and doesn t need any transformaton MSB 1 the number is negatve To have the actual value each bit of the hexadecimal number should be toggled transforming the 0 bit to 1 and the 1 bit to 0 then add 1 to the result Examples In the folloting the notaton prefx...

Page 39: ...message Actvated o WIFI payload tithout Cypher Enabled o First WIFI scan then geolocaton starts Disabled Send a geoloc start message instead o Moton start message Disabled o Moton end message Disabled gps_ehpe 5 gps_convergence 150 seconds gps_standby_tmeout 7800 seconds moton_duraton 120 seconds transmit_strat 2 Dual random periodic_actvity_period 0 disabled confrmed_uplink_bitmap 0 none confrmed...

Page 40: ...gy Indoor WIFI Operatng mode Standby Standby Standby lora_period 600 seconds 600 seconds 600 seconds ul_period 120 seconds 120 seconds 120 seconds geoloc_sensor 1 GPS 6 WGPS 0 WIFI geoloc_method 1 GPS 3 WGPS 0 WIFI period_pos_period 0 disabled 0 disabled 0 disabled pt_stat_period 43200 seconds 43200 seconds 43200 seconds gps_tmeout 300 seconds 300 seconds 300 seconds agps_tmeout 55 seconds 55 seco...

Page 41: ... period_pos_period 86400 seconds 1 per day 86400 seconds 1 per day 86400 seconds 1 per day pt_stat_period 43200 seconds 43200 seconds 43200 seconds gps_tmeout 300 seconds 300 seconds 300 seconds agps_tmeout 55 seconds 55 seconds 55 seconds antenna 0 0 0 moton_nb_pos 3 3 3 moton_duraton 120 seconds 120 seconds 120 seconds gps_ehpe 5 meters 5 meters 5 meters gps_convergence 180 seconds 180 seconds 1...

Page 42: ...00 seconds gps_tmeout 300 seconds 300 seconds 300 seconds agps_tmeout 55 seconds 55 seconds 55 seconds antenna 0 0 0 moton_nb_pos 3 3 3 moton_duraton 120 seconds 120 seconds 120 seconds gps_ehpe 10 meters 10 meters 10 meters gps_convergence 90 seconds 90 seconds 90 seconds confg_lags 0x1F 0x1F 0x1F transmit_strat 2 Dual random 2 Dual random 2 Dual random periodic_actvity_period 0 disabled 0 disabl...

Page 43: ...0 disabled pt_stat_period 43200 seconds 43200 seconds 43200 seconds gps_tmeout 180 seconds 180 seconds 180 seconds agps_tmeout 55 seconds 55 seconds 55 seconds antenna 0 0 0 moton_nb_pos 3 3 3 moton_duraton 120 seconds 120 seconds 120 seconds gps_ehpe 5 meters 5 meters 5 meters gps_convergence 90 seconds 90 seconds 90 seconds confg_lags 0xB1F 0xB1F 0xB1F transmit_strat 2 Dual random 2 Dual random ...

Page 44: ...econds agps_tmeout 55 seconds 55 seconds 55 seconds antenna 0 0 0 moton_nb_pos 3 3 3 moton_duraton 120 seconds 120 seconds 120 seconds gps_ehpe 10 meters 10 meters 10 meters gps_convergence 120 seconds 120 seconds 120 seconds confg_lags 0x1F 0x1F 0x1F transmit_strat 2 Dual random 2 Dual random 2 Dual random periodic_actvity_period 0 disabled 0 disabled 0 disabled gps_standby_tmeout 7200 seconds 72...

Page 45: ...ed pt_stat_period 43200 seconds 43200 seconds 43200 seconds gps_tmeout 180 seconds 180 seconds 180 seconds agps_tmeout 55 seconds 55 seconds 55 seconds antenna 0 0 0 moton_nb_pos 3 3 3 moton_duraton 120 seconds 120 seconds 120 seconds gps_ehpe 10 meters 10 meters 10 meters gps_convergence 30 seconds 30 seconds 30 seconds confg_lags 0x1F 0x1F 0x1F transmit_strat 2 Dual random 2 Dual random 2 Dual r...

Page 46: ...Industrial Tracker Reference Guide FW 1 8 V0 2 Page 46 of 46 10th July 2019 Restricted distribution ...