Xirgo XT2500, Product Manual

Page 1: ...XT2500 Product Manual Page 1 92 CONFIDENTIALAND PROPRIETARY XT2500 Product Manual Firmware Version 1183DA2 4 Revised February 08 2021...

Page 2: ...Decel oad 9 4 3 OBD RPM and Speed Events ors 10 4 4 OTA Prevent ota 11 4 5 Bluetooth Enabled blt 12 4 6 Buzzer Songs bzr 13 4 7 Destination dst 13 4 8 Generic Config Value gcv 14 4 9 Input Default Po...

Page 3: ...5 2 Interpreter Scripting Trigger Block Examples 36 5 3 Packet Recipe 37 6 Command Language 76 6 1 Overview 76 6 2 Commands via UDP 76 6 3 Verb and Module 76 6 4 Object 76 6 5 Arguments 77 6 6 Device...

Page 4: ...ual client s desires The device can be expanded by connecting to an external XT1065 I O box The XT1065 I O box includes additional interfaces such as digital inputs digital outputs analog inputs RS232...

Page 5: ...er and pins 17 and 18 of the 24 pin connector NOTE A USB Serial Device and the associated COM number should appear under Ports If nothing shows up unplug the connection to the Device flip it over and...

Page 6: ...ming to the ITU T V 24 recommendation with CMOS compatible signal levels 0V for low data bit or ON state and 3 0V for high data bit or OFF state If the l The default baud rate is 115200 bits s l The d...

Page 7: ...lowing two commands will be most relevant when dealing with the following configurations l rycfg Used to read a system configuration l wycfg Used to write a system configuration When using either of t...

Page 8: ...Range Description apn_name 64 Char The name of the APN gateway used for GSM GPRS 3G and 4G cellular networks Examples of APN s are as follows internet t mobile wap cingular internet mnc012 mcc345 gpr...

Page 9: ...and rycfg oad x Response oad x accdec rate hex_val OK Parameter Descriptions rate rate is measured in 1 mph Instance Range Description oad 0 10 to 200 OBD acceleration threshold Speed rate of change t...

Page 10: ...ld hex_val time time sec hex_val OK Instance Description ors 0 RPM Threshold Parameter Range Description threshold 0 disable 100 to 20000 RPM in 1 rpm to exceed time sec 1 to 60 Time RPM must be great...

Page 11: ...sk Response OK READ Command rycfg ota enable_mask Response ota enable enable_mask OK Parameter Description enable_mask Hex Description 0x0 OTA is not prevented due to OBD Communications state or TPS T...

Page 12: ...ion sets the Bluetooth communication state Configuration instances 1 Command Type Syntax SET Command wycfg blt enable Response OK READ Command rycfg blt Response blt en enable hex_val OK Param Descrip...

Page 13: ...8 frequency8 hex_val dur8 duration8 hex_val OK Param Range Description frequencyX 0 to 65535 A frequency that corresponds to the Xth note to be played Hz 0 is silent durationX 0 disable 10 6535 The du...

Page 14: ...ocal serial ports are as follows l SERIAL_AUX0 l SERIAL_AUX1 l USB port_number 1 to 65533 If using an IP address or a hostname can be used to specify the port on which to connect 4 8 GENERIC CONFIG VA...

Page 15: ...ycfg idp x Response idp x polrty pullup_disable hex_val OK Parameter Range Description Input active level 0 to 1 Sets the corresponding user input active level by engaging an external pullup 0 or pull...

Page 16: ...rameter Range Description motion_ sensitivity_ value 1 to 2000 Configure accelerometer motion sensitivity in thousandths of a unit of gravity 4 11 SERIAL PORT SETTINGS SPS l sps 0 Aux port 0 l sps 1 A...

Page 17: ...l 19200 bit sec l 9600 bit sec l 4800 bit sec l 2400 bit sec l 1200 bit sec dps_value 3 Char Acceptable dps values 8N1 Mode_value N A Acceptable mode values Value Description 0 Console 3 Garmin 6 Aux...

Page 18: ...tart Response OK READ Command rycfg tmr x Response tmr x sec Duration hex_val flags auto_start hex_val OK Parameter Range Description Duration 0 to 4294967295 The time that is set as the duration of t...

Page 19: ...Parameter Description recipe_hex_string Refer to Packet Creation Recipe for configuration details 4 14 THIRD PARTY CONFIG VALUES TPV Configuration instances 1 Command Type Syntax SET Command wycfg tp...

Page 20: ...0x0800000 TPMS LR psi ppid 5 0x78 0x0400000 TPMS RR psi ppid 6 0x8E 0x0200000 TPMS LRI psi ppid 7 0x90 0x0100000 TPMS RRI psi ppid 8 0x90 0x0080000 TPMS SPR psi ppid 9 0x91 0x0040000 Seatbelt D ascii...

Page 21: ...y solution with an HDOP or PDOP on some systems above this value will be filtered out Units 0 1DOP 20 means 2 0 HACC 0 to 255 Horizontal accuracy Not applicable ignored for XT2500 speed_mask 0x0 to 0x...

Page 22: ...le 0x02 N A 0x04 Big hammer trip end start_mask 0x0 to 0xFFFF 16 bits hex mask Default 0xFFFF Hex Description 0x0001 Query Fuel level on trip start 0x0002 Query DTC on trip start 0x0004 N A 0x0008 OBD...

Page 23: ...Can SW Can Commlilnk2 Kline 2 Heavy Duty Mode Use this mode when you are sure you will be connected to a heavy duty truck Supported transports per commlink Commlink0 J1939 HS Can Vin collection Comml...

Page 24: ...ontain up to 2 comparisons NOTE Each Trigger Block can contain unlimited Conditional Action Blocks Conditional Action Each Conditional Action Block may optionally contain one Conditional Action Block...

Page 25: ...any InRange GPSHeading 3500 3600 Debounce 0 0 InRange GPSHeading 0 100 Debounce 0 0 actions 5 1 2 Compiling scripts with ILC 1 Type the script as noted above with your text editor and save as a text f...

Page 26: ...tead to always run ilc exe from a command line interface 5 1 3 Upload and Run Scripts 1 Connect to the device using standard USB to Serial or USB to RS232 cabling 2 Open the terminal emulator program...

Page 27: ...Specify element is only used following certain tests see below When a debounce is specified it means that a test is true only AFTER the comparison is true for hi seconds and false AFTER the compariso...

Page 28: ...t is Right Add a b Arithmetic addition of arguments a and b Subtract a b Arithmetic subtraction of argument b from a Multiply a b Arithmetic multiplication of arguments a and b Tests Script Language D...

Page 29: ...attVolts packet field ID 0x16 BattVoltage Maps directly to VehicleBattVolts_1byte packet field ID 0x17 GPSLifetimeOdom GPSOdom GPSOdom Maps directly to GpsLifetimeOdom packet field ID 0x18 OBDLifetime...

Page 30: ...ed 19 Device Powerup 20 OTA Reject not implemented ObdDtcEventIsActive 0 Evaluates to 1 when an OBD DTC event is detected otherwise 0 AccelCrashEventIsActive 0 Evaluates to 1 when an accelerometer cra...

Page 31: ...mplemented 9 Bluetooth Connected 10 Bluetooth Powered 11 Cellular Powered 12 GPS Powered 13 Garmin Powered 14 Motion Via Accel 15 Motion Via GPS 16 External Power GenericConfig index Evaluates to valu...

Page 32: ...d at min and max Meaning no matter the size of adjustment the value will never go lower than the minimum or higher than the maximum it will not roll over SetFlag flag_index Index range 0 to 31 ClearFl...

Page 33: ...ansitioned high 0x0004 Input 2 transitioned high 0x0008 Input 3 transitioned high 0x0010 Input 4 transitioned high 0x0020 Configured sleep timeout expired 0x0040 Vibration detected 0x0080 Main supply...

Page 34: ...ost recently received packet Actions Table Footnotes 1 BuildAndSendMsg example using command wycfg pcr 0 01050104030708 The item index 0 in pcr 0 is NOT the packet_id This should be considered the slo...

Page 35: ...lling this function while the spam filter is active does not perform the save 5 1 5 Wake Reason Masks Script Language Description EnterDeepSleep wake_mask wake_minutes Set the wake reason mask Value H...

Page 36: ...ndMsg 1 0 1 0 run ClearFlag 0 condact when Neq FlagIsSet 0 1 Debounce 5 0 NOTE debounce Hi for 5 seconds to keep these actions from executing due to the previous CondAct block clearing the flag action...

Page 37: ...its second argument of 0x02 which isolates the bit 1 position When bit 1 of Fld_ObdRunStatus PTO state is high the BitAnd resolves to a 1 Neq then takes that and compares it with its second argument...

Page 38: ...to 65535 0x06 UnixTime Unsigned integer representing number of seconds since Unix Epoch Bytes Units Resolution Range 4 N A 1 0x0 to 0xffffffff 0x07 Latitude Signed integer decimal value of 4byte hex s...

Page 39: ...ate Bits table below Bytes Units Resolution Range 1 N A 1 0x0 to 0xff 0x0d OutputStates Bitfield see Output State bits Table below Bytes Units Resolution Range 1 N A 1 0x00 to 0x1f 0x0e DriverIdCode1...

Page 40: ...lularCarrierId Bytes Units Resolution Range 2 N A 1 0x0 to 0xffff 0x16 InternalBattVolts Possibly using a 2 byte unsigned integer representing mV 0 to 65535 Bytes Units Resolution Range 1 V 0 1 0 0 to...

Page 41: ...E 06 2147 483648 to 2147 483647 0x1c AccelStartSpeed Bytes Units Resolution Range 1 kmh 1 0 to 255 0x1d AccelStartHeading Bytes Units Resolution Range 2 Degrees 0 1 0 to 3599 0x1e MaxAccel Bytes Units...

Page 42: ...ees 0 1 0 to 3599 0x25 Not implemented Available for future use 0x26 GarminPacketSize Size of entire Garmin packet includes DLE pid size payload sum DLE ETX and DLE stuffing Bytes Units Resolution Ran...

Page 43: ...A 0 to 3 0x2e ObdDerivedTripOdom Unsigned integer see Odometer Details Table below Bytes Units Resolution Range 4 m 1 0 to 4294967295 0x2f ObdLifetimeOdom Unsigned integer see Odometer Details Table...

Page 44: ...integer Bytes Units Resolution Range 1 N A 1 128 to 127 0x37 UserVar8 5 8 bit signed integer Bytes Units Resolution Range 1 N A 1 128 to 127 0x38 UserVar8 6 8 bit signed integer Bytes Units Resolution...

Page 45: ...r Bytes Units Resolution Range 1 N A 1 128 to 127 0x3f UserVar8 13 8 bit signed integer Bytes Units Resolution Range 1 N A 1 128 to 127 0x40 UserVar8 14 8 bit signed integer Bytes Units Resolution Ran...

Page 46: ...Resolution Range 2 N A 1 32768 to 32767 0x47 UserVar16 5 16 bit signed integer Bytes Units Resolution Range 2 N A 1 32768 to 32767 0x48 UserVar16 6 16 bit signed integer Bytes Units Resolution Range 2...

Page 47: ...32 bit signed integer Bytes Units Resolution Range 4 N A 1 2147483648 to 2147483647 0x4f UserVar32 5 32 bit signed integer Bytes Units Resolution Range 4 N A 1 2147483648 to 2147483647 0x50 UserVar32...

Page 48: ...t unsigned integer Bytes Units Resolution Range 4 liters 1 0 to 4294967295 0x56 ObdTotEngHours 32 bit unsigned integer Bytes Units Resolution Range 4 hours 1 0 to 4294967295 0x57 ObdVehicleSpeed 16 bi...

Page 49: ...esolution Range 4 s 1 0 to 4294967295 0x5e ObdTotIdleFuel 32 bit unsigned integer Bytes Units Resolution Range 4 liters 1 0 to 4294967295 0x5f ObdHarshBreakTotCnt 32 bit unsigned integer Bytes Units R...

Page 50: ...A 0x66 ExternADC0_1byte Value caps at 25 5v Bytes Units Resolution Range 1 v 0 1 0 0 to 25 5 0x67 Reserved Bytes Units Resolution Range N A N A N A N A 0x68 Accel Metrics Rounded to nearest whole num...

Page 51: ...f Mode Table below Bytes Units Resolution Range 1 N A N A 0 to 3 0x6e ObdProtocols See OBD Protocol Table Secondary protocol in MS word Primary protocol in LS word e g secondary J1708 primary J1939 0x...

Page 52: ...imal value of 4 byte hex string divided by 10 Bytes Units Resolution Range 4 N A 0 1 2147483648 to 2147483647 0x75 OBDPidReserved2 Signed integer decimal value of 4byte hex string divided by 10 Bytes...

Page 53: ...ObdFuelTemp 16 bit signed integer Bytes Units Resolution Range 2 Celsius 1 40 to 215 0x7B ObdOilTemp 16 bit signed integer Bytes Units Resolution Range 2 Celsius 1 40 to 215 0x7C ObdThottlePos 16 bit...

Page 54: ...6 bit unsigned integer Bytes Units Resolution Range 2 kPa 1 0 to 100 0x83 ObdCoolantPressure 16 bit unsigned integer Bytes Units Resolution Range 2 kPa 1 0 to 100 0x84 ObdIntakeAirTemp 16 bit signed i...

Page 55: ...its Resolution Range 4 N A 1 0 to 4294967295 0x8b GenCfgVal2 Generic Configuration Value set via paramset Bytes Units Resolution Range 4 N A 1 0 to 4294967295 0x8c GenCfgVal3 Generic Configuration Val...

Page 56: ...2147483648 to 2147483647 0x92 OBDPidReserved10 Signed integer decimal value of 4 byte hex string divided by 10 Bytes Units Resolution Range 4 N A 0 1 2147483648 to 2147483647 0x93 OBDHarshAccelValue U...

Page 57: ...clusion of a configured length variable content section defined by the corresponding pct config entry Bytes Units Resolution Range variable N A N A N A 0x9a TPSFields3 Inclusion of a configured length...

Page 58: ...Units Resolution Range 4 ascii N A N A 0xa0 OBDPidReserved15 4 byte ascii normalization of the vehicle response Bytes Units Resolution Range 4 ascii N A N A 0xa1 Debug PacketSize Unsigned integer Byte...

Page 59: ...N A 1 128 to 127 0xa8 UserVar8 21 8 bit signed integer Bytes Units Resolution Range 1 N A 1 128 to 127 0xa9 UserVar8 22 8 bit signed integer Bytes Units Resolution Range 1 N A 1 128 to 127 0xaa UserVa...

Page 60: ...128 to 127 0xb0 UserVar8 29 8 bit signed integer Bytes Units Resolution Range 1 N A 1 128 to 127 0xb1 UserVar8 30 8 bit signed integer Bytes Units Resolution Range 1 N A 1 128 to 127 0xb2 UserVar8 31...

Page 61: ...A 1 32768 to 32767 0xb8 UserVar16 13 16 bit signed integer Bytes Units Resolution Range 2 N A 1 32768 to 32767 0xb9 UserVar16 14 16 bit signed integer Bytes Units Resolution Range 2 N A 1 32768 to 32...

Page 62: ...integer Bytes Units Resolution Range 4 N A 1 2147483648 to 2147483647 0xc0 UserVar32 13 32 bit signed integer Bytes Units Resolution Range 4 N A 1 2147483648 to 2147483647 0xc1 UserVar32 14 32 bit sig...

Page 63: ...olution Range 2 N A 1 N A 0xc6 TpsTagPayload Payload Bytes Units Resolution Range variable N A N A N A 0xc7 OBD Seat Belt Status Bytes Units Resolution Range 1 N A N A N A 0xc8 VehicleBattery_2byte 2...

Page 64: ...te of active geofences 32 to 49 where 1 is inside and 0 is outside or inactive Bytes Units Resolution Range 4 N A 1 0 to 4294967295 0xce Script version Version number of currently loaded script Bytes...

Page 65: ...es Units Resolution Range 4 seconds 1 0 to 4294967295 0xd7 InputActiveStates Same as the Input States bitfield only the reported states are determined by the IDP config settings see Input State Bits t...

Page 66: ...0 0 to 256 0 0xdf GPS Harsh Accel Violations Cnt Bytes Units Resolution Range 4 1 0 to 4294967295 0xe0 GPS Harsh Accel Value Bytes Units Resolution Range 2 kph s 0 01 0 00 to 655 35 0xe1 GPS Harsh Dec...

Page 67: ...Output State Bits Input Bit Input State 0 Ignition 1 Input 1 2 Input 2 3 Input 3 4 Input 4 5 Device In Motion Accel 6 Main supply voltage available 7 Accelerometer Reorientation Valid output Bit Outpu...

Page 68: ...rip Odom Reset by script Distance calculated based on averaged subsequent OBD speed readings GPS Lifetime Odom Never resets Great circle distance between subsequent sets of GPS latitude and longitude...

Page 69: ...Value dBm 0 113 0 1 111 8 2 110 5 3 109 3 4 108 1 5 106 8 6 105 6 7 104 4 8 103 1 9 101 9 10 100 7 11 99 4 12 98 2 13 97 0 14 95 7 15 94 5 16 93 3 17 92 0 18 90 8 19 89 6 20 88 3 21 87 1 22 85 9 23 8...

Page 70: ...1 Valid IP 2 Valid GPS 3 Valid Script 4 DM Session Active 5 Accel Oriented 6 Bluetooth Discoverable TBD 7 Bluetooth Paired TBD 8 Bluetooth Authenticated TBD 9 Bluetooth Connected TBD 10 Bluetooth Powe...

Page 71: ...ackoff 1 OBD Backoff Scantool Detect 2 OBD Backoff MIL Detect 3 OBD Backoff MIL Persisted 4 OBD Backoff Protocol Fail Detect 5 OBD Backoff Scantool Detect until Ignition Off 5 3 10 OBD Protocol Table...

Page 72: ...known protocol 0x00000008 Failed all attempts at vehicle protocol communications 0x00000010 Trip was active failed to monitor any valid messages for x seconds or failed all requests for mode 1 pid 0 0...

Page 73: ...ed 6 FW Upgrade with Invalid Missing Backup current FW stored to Backup FW New FW loaded 7 Normal FW Upgrade current FW stored to Backup FW New FW loaded 5 3 14 Proprietary PID Recipe Slots Field Assi...

Page 74: ...D 0 254 0x0 to 0xfe l Each append recipe is assigned a range of reason codes Example It s possible to create an append recipe adding fields x y z to the end of the message The designer can assign a ra...

Page 75: ...appended fields with the message in non volatile memory AND send the appended fields to the backend server 5 3 19 Examples Packet Recipe Creation The table below represents three example packet recipe...

Page 76: ...for a command is shown below verb module object arg1 arg2 argN Valid characters for verb module and objects are as follows _abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 The subseque...

Page 77: ...ingle valid separator space tab l Arguments must not contain the characters l Anything following the symbol is considered a comment and ignored by the interpreter l Decimal values have an optional pre...

Page 78: ...ckend k CMDLang l Motion m Garmin n OBD o Processor Flash p Interpreter r Buzzer s Telematics Cell t USB u Aux Passthru v One Wire Bus w Accelerometer x System y Zigbee z Main Processor 1 2nd Processo...

Page 79: ...State st OR state Table tab Task tsk OR task Test t OR test Truststore trst Value val 6 6 DEVICE COMMAND MODULES 6 6 1 ADC Command Function raval Read ADC values 6 6 2 Accelerometer Command Function r...

Page 80: ...ce void of current reorientation 6 6 3 Buzzer Command Function uscmd play song_index volume loops Play a buzzer song out of the config uscmd stop Stop a buzzer song that is currently playing 6 6 4 Bac...

Page 81: ...S file found downloads VIS first edm ekm ujcmd init Initialize Third Party functions edm ujcmd exec Displays Third Party FW version edm 6 6 7 Device Command Function rdval reset Read device reset reas...

Page 82: ...sage to dst 9 udcmd factory Reset device to factory state udcmd factory keys Reset device to factory state plus revert AES keys to defaults This is the only command available outside the AES console l...

Page 83: ...to address addr qfmem Query flash memory layoutNOTE Only available on debug devices qfi Query flash info device type qfrec Query number of pending messages records rfrec Read pending messages records...

Page 84: ...wival pin_id 0 1 x Control the state of GPIO pin x give control back to micro 6 6 12 GPS Command Function rgdm Read GPS debug mask wgdm mask Write the GPS debug mask egm Enable GPS debug channel moni...

Page 85: ...Description 0 None 1 Unlocked 2 Locked 3 Sleep 4 LockedGood sgsim hdop hdop GPS simulator force hdop sgsim clear Disable GPS simulator 6 6 14 Cellular Command Function rtdm Read transport debug mask...

Page 86: ...nsfer only on SARA R410M and LARA R202 HB1 cell modules currently Arg Details Type Description 0 Bootloader firmware 1 Application firmware 2 Script binary firmware 3 Parameter text file 6 TPS 8 Overl...

Page 87: ...ty data index only applies to overlays filename is arbitrary and optional name reported in q1i response rev is the user determined revision value rtval mno wtval mno profile See Hardware ID and MNO se...

Page 88: ...ipt flags wrval uservar type index value Write a uservar drtask Suspend interpreter task ertask Resume interpreter task urcmd bs packet id reason code dst index ack qty Force a build and send of a pac...

Page 89: ...ry OBD snapshot additional parameter information qoval Query OBD calculated information qoi viol Query OBD Violations qost Query OBD state roval dtc Read OBD DTC List woval p protocol cll Set OBD prot...

Page 90: ...Print out current network gps and system times qyi Print out system information uycmd resync new_ system_time_s Force system time to resync with available source If time argument is passed use as new...

Page 91: ...ta Read TPS tag data qci block bock_id Read TPS block qccmd sync Sync TPS file with AAb3 target servers gcfw x serial_port_id name Upgrade TPS file via xmodem 6 6 21 Aux Passthru Command Function qvi...

Page 92: ...G WARNING This product can expose you to chemicals including Nickel Metallic which is known to the State of California to cause cancer and Bisphenol A BPA which is known to the State of California to...