1. Manuals
  2. Brands
  3. Xirgo Manuals
  4. GPS
  5. XT6384-1
  6. Product manual

Xirgo XT6384-1 Product Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
XT6384-1
Product Manual
Firmware Version: 1133MA3
Revised October 24, 2022

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XT6384-1 and is the answer not in the manual?

Questions and answers

Related Manuals for Xirgo XT6384-1

Summary of Contents for Xirgo XT6384-1

  • Page 1 XT6384-1 Product Manual Firmware Version: 1133MA3 Revised October 24, 2022...

  • Page 2: Table Of Contents

    XT6384-1 Product Manual ABLE OF ONTENTS 1. Release Notes 1.1. Firmware 1.2. Manual 2. Functional Description 2.1. Overview 2.2. Mechanical 3. Device Setup 3.1. Configure Device Via PC (RS232 to USB) 4. Interfaces 4.1. UART 4.2. LED Behavior 5. Bluetooth®/BLE 5.1.
  • Page 3 XT6384-1 Product Manual 6.8. OBD Backoff (bko) 6.9. Bluetooth Enabled (blt) 6.10. Bluetooth Transmit Power (btp) 6.11. Buzzer Songs (bzr) 6.12. CAN Controller Settings (can) 6.13. Crash Event Parameters (cep) 6.14. Accelerometer Confidence Slew (csl) 6.15. Accelerometer Confidence Threshold (cth) 6.16.
  • Page 4 XT6384-1 Product Manual 6.35. NMEA Stream Output (nso) 6.36. OBD Accel and Decel (oad) 6.37. OBD Feature Enable/Disable (obd) 6.38. OBD Ign Off Accum (oio) 6.39. OBD RPM and Speed Events (ors) 6.40. OTA Prevent (ota) 6.41. OBD Override (ovr) 6.42.
  • Page 5 XT6384-1 Product Manual 7.2. Device Manager Packet 7.3. Device Manager Header 7.4. Packet-Specific Data 7.5. Device Manager Check-in 8. Interpreter 8.1. Language 8.2. Interpreter Scripting Trigger Block Examples 8.3. Packet Recipe 8.4. DTC Packet Parsing 9. Command Language 9.1. Overview 9.2.

  • Page 6: Release Notes

    XT6384-1 Product Manual 1. R ELEASE OTES 1.1. F IRMWARE Firmware: 1133MA3 1.2. M ANUAL Firmware: 1133MA3 Doc improvements and stability Added ClearDriverID(<index>) interpreter command Added diesel pcrs and driver ID pcrs Added DTC packet parsing information Added TPM configuration Page 6 | 194 ©...

  • Page 7: Functional Description

    One key benefit of the XT6384-1 is the ability to easily adjust the device’s operation to suit an individual client’s desires. The XT6384-1 devices can be controlled through various channels, ranging from simple system parameters to more complex device interpreter scripts, which offer maximum customization as they are written completely by the customer.

  • Page 8: Device Setup

    XT6384-1 Product Manual 3. D EVICE ETUP 3.1. C PC (RS232 USB) ONFIGURE EVICE 1. Connect the device to a variable power supply. 2. Set the power supply to output average 12 volts and verify the device is drawing current after it has powered up (the device will automatically switch on when it receives power).

  • Page 9: Interfaces

    NTERFACES 4.1. UART XT6384-1 devices include a 2-wire asynchronous serial interface (UART) operated through RS232 for communication with a host device. RS232 interface is TIA/EIA-232-F compliant and will accept 0-5V signaling. The UART interface is a 3.0V TTL interface conforming 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).
  • Page 10 XT6384-1 Product Manual Override Operation When ignition state is off, the LED will flash continuously at 0.5 Hz. When ignition state is on, the LED will revert to Primary Operation. When ignition state is off and there is no cellular registration, the LED will double-flash at 0.33Hz. When the ignition state is off and there is cellular registration, the LED will flash continuously at 0.5 Hz.
  • Page 11 XT6384-1 Product Manual 4.2.3. Blue LED Primary Operation Indicate bluetooth connection status BT Status LED Status Off or unconnected Connected Slow blink (0.5Hz) Secondary Operation Indicate System Module Faults If a system module fault is detected in firmware, the LED will flash at 1 Hz, the number of times corresponding to the fault index defined below, with a pause before repeating.

  • Page 12: Bluetooth®/Ble

    XT6384-1 Product Manual 5. B ®/BLE LUETOOTH 5.1. O VERVIEW The XT6384-1 uses Bluetopia provided by StoneStreet one; the GAP and GATT profiles are of specific interest. 5.1.1. Security There are several layers Target Pairing Authentication Encryption Android/iOS Advertising Name...

  • Page 13: Aab1/Aab6 Ble

    XT6384-1 Product Manual 5.2. AA 1/AA 6 BLE 5.2.1. HOS Service UUID The HOS service does not have encrypted characteristics Description UUID a59611ba-78b7-4fd2-96fb-9b0f66d2311e 5.2.2. HOS Service UUID List Descriptions UUID GPS Info e7737830-1018-11e6-a148-3e1d05defe78 Speed 5eed6ea2-0390-11e5-8418-1697f925ec7b True Odo 5eed6d4e-0390-11e5-8418-1697f925ec7b Derived Odo...
  • Page 14 XT6384-1 Product Manual Descriptions Type Size Encr. Size Data / Units Type: Notify on lock or time change Speed Read 0.1 KPH + 1 byte updated indicator True Odo Read Meters + 1 byte updated indicator Derived Odo Read Meters + 1 byte updated indicator...
  • Page 15 XT6384-1 Product Manual Descriptions Type Size Encr. Size Data / Units Start Trip GPS Read See Below (but now historically info flavored!) Start Trip True Read Meters + 1 byte updated indicator Start Trip Eng Read Seconds (Defaults to persist when on...

  • Page 16: Aab3 Ble

    XT6384-1 Product Manual 5.3. AA 3 BLE AAb3 BLE implementation supports three services: Identity Engine Authentication 5.3.1. Identity Service Information Description UUID Identity decc0000-dc4f-4376-9df9-8de1f845b254 5.3.2. Identity Service UUID List Descriptions UUID Device ID decc0001-dc4f-4376-9df9-8de1f845b254 Product ID decc0002-dc4f-4376-9df9-8de1f845b254 Interface Version decc0003-dc4f-4376-9df9-8de1f845b254 5.3.3.
  • Page 17 XT6384-1 Product Manual Descriptions UUID Speed 5eed6ea2-0390-11e5-8418-1697f925ec7b True Odo 5eed6d4e-0390-11e5-8418-1697f925ec7b Derived Odo 5eed6719-0390-11e5-8418-1697f925ec7b Eng/Ign 5eed665c-0390-11e5-8418-1697f925ec7b 31e6e24b-f2fb-4bb9-a16b-9d17a9c4e4ad Protocol 5eed6477-0390-11e5-8418-1697f925ec7b a9b9f487-5e60-43d5-a249-4d1d3f317d7e Eng Hours 95dbace5-fcee-467f-bbe9-fe42e195bb04 Moving 5eed659a-0390-11e5-8418-1697f925ec7b 5eed70e6-0390-11e5-8418-1697f925ec7b Fuel Level 1c3917a6-7d33-4152-9a33-858b6f1fc99b Eng Run Time b71eb3aa-4ed7-4990-ab22-ced09cf58f34 Eng Hours Seconds 87e22dd2-e27b-4094-968a-03e1537e7eb7 External Power 0dd2af9d-7220-474f-8b34-4a94a6a97498 Start Trip GPS info...
  • Page 18 XT6384-1 Product Manual Encr. Descriptions Type Size Data / Units Data Type Size ‡ True Odo Read Meters uint32 + uint8 ‡ Derived Odo Read Meters uint32 + uint8 Eng/Ign Read uint8 Index Description Notify Engine off Engine on Type:...
  • Page 19 XT6384-1 Product Manual Encr. Descriptions Type Size Data / Units Data Type Size Derived unless ECU is available External Power Read sint8 (value Index Description will not No external change if power interpeted as External power uint8) Start Trip GPS...
  • Page 20 XT6384-1 Product Manual 5.3.7. Authentication Service Process 5.3.8. Authentication Service UUID SHA256 is used for the authentication service on the AAb3 target. The input for each response includes the two challenges along with the customer AES key. Description UUID Authentication...
  • Page 21 XT6384-1 Product Manual Descriptions UUID Server_response 5eed4793-0390-11e5-8418-1697f925ec7b Client_accepts 5eed58ad-0390-11e5-8418-1697f925ec7b 5.3.9. Authentication Service Characteristics Table Descriptions Type Size Data / Units Server_challenge Read Randomly generated challenge value Client_response Write SHA256 Response computed by client sha256( cat(client_challenge, server_ challenge, secret_key ) ) Client_challenge...

  • Page 22: Legacy Aab2 Ble

    XT6384-1 Product Manual 5.4. L 2 BLE EGACY Legacy AAb2 BLE implementation supports three services: Engine Timer Pass-Through 5.4.1. Engine Service Information Description UUID Engine 1b19b844-038f-11e5-8418-1697f925ec7b 5.4.2. Engine Service UUID List Descriptions UUID a9b9f487-5e60-43d5-a249-4d1d3f317d7e ECM Status 5eed70e6-0390-11e5-8418-1697f925ec7b Ignition 5eed665c-0390-11e5-8418-1697f925ec7b 31e6e24b-f2fb-4bb9-a16b-9d17a9c4e4ad...
  • Page 23 XT6384-1 Product Manual Descriptions Type Size Data / Units Index Description Connected Active Disabled by config Ignition Read Index Description Notify Ignition off Ignition On Read Engine RPM Engine Time Read Seconds since last engine on. Once a trip ends, it reports the trip length and then restart to 0 on next ignition on.
  • Page 24 XT6384-1 Product Manual Descriptions Type Size Data / Units 5.4.4. Timer Service Information Description UUID Timer 1b19bb5a-038f-11e5-8418-1697f925ec7b 5.4.5. Timer Service UUID List Descriptions UUID Timer 1B19BB5A-038F-11E5-8418-1697F925EC7B Interval 5eed73b6-0390-11e5-8418-1697f925ec7b 5.4.6. Timer Service Characteristic Table Types available are Read, Write, and Notify...

  • Page 25: Aab4 Ble

    XT6384-1 Product Manual Descriptions Type Size Data / Units R/W/N See documentation Read Notify Header Read Write Cell State Read Notify 5.5. AA 4 BLE 5.5.1. Overview AAb4 BLE supports two services: Info 5.5.2. EDL Service UUID Description UUID 4117a79a-6c31-4ecc-a779-f1c9b177177b 5.5.3.
  • Page 26 XT6384-1 Product Manual 5.5.4. EDL Service Characteristic table Types available are Read, Write, and Notify Size is measured in bytes Descriptions Type Size Data / Units Read char[18] (Null Terminated) Moving Read Notify Bool Description Stopped Moving Mileage/Odo Read Write...
  • Page 27 XT6384-1 Product Manual Descriptions Type Size Data / Units Buffer Full Read Notify Bool Description Not full Full 5.5.5. Info Service UUID Description UUID Info ede3469c-f706-11e7-8c3f-9a214cf093ae 5.5.6. Info Service UUID List Descriptions UUID Main FW Version 75ee1b84-f707-11e7-8c3f-9a214cf093ae Bootloader FW Version...

  • Page 28: Aab5 Ble

    XT6384-1 Product Manual Name Type Size Description HDOP uint16 HDOP*10 Sats uchar Number of Satellites Lock uchar Value Description Unknown Unlocked Locked Sleep LockedGood Altitude sint32 meters*10 5.6. AA 5 BLE 5.6.1. Overview AAb5 BLE supports two services: Info 5.6.2. EDL Service UUID...
  • Page 29 XT6384-1 Product Manual Descriptions UUID Date/Time ("Unix") 2A08 Buffer Full 7beb654c-98dc-4d8b-8cce-a427c8f3187f 5.6.4. EDL Service Characteristic table Types available are Read, Write, and Notify Size is measured in bytes Descriptions Type Size Data / Units Read char[18] (Null Terminated) Moving Read Notify...
  • Page 30 XT6384-1 Product Manual Descriptions Type Size Data / Units Driver ID Read Write 4(R)/8 char[8]** Date/Time Read (See GATT Standard) ("Unix") Buffer Full Read Notify Bool Description Not full Full 5.6.5. Info Service UUID Description UUID Info ede3469c-f706-11e7-8c3f-9a214cf093ae 5.6.6. Info Service UUID List...
  • Page 31 XT6384-1 Product Manual Name Type Size Description SINT32 degrees * 1e6 SINT32 degrees *1e6 Speed UCHAR 0.1 KPH Heading SINT16 Degrees*10 HDOP UINT16 HDOP*10 Sats UCHAR Number of Satellites LOCK UCHAR Value Description Unknown Unlocked Locked Sleep LockedGood Altitude SINT32...

  • Page 32: Device Configuration

    XT6384-1 Product Manual 6. D EVICE ONFIGURATION System parameters are designed to be non-volatile and have the ability to be updated through a serial connection, USB, SMS, UDP and are used for many modules within the device. All system parameters (aka configs, params) have a default value that can always be restored in case the device ends up in an unknown state. ...

  • Page 33: Acceleration Event Threshold (Aet)

    XT6384-1 Product Manual 6.1. A CCELERATION VENT HRESHOLD The Acceleration Event Threshold parameter determines which conditions must be met for an event to register. Configuration instances: 8 Command Type Syntax Command :wycfg aet[x] <direction> <start_duration> <end_duration> <mg_thresh> Response READ Command...

  • Page 34: Acceleration Filter Coefficients (Afc)

    XT6384-1 Product Manual Target Default Value(s) AAb3 aet[0] 0 1000 1000 240 aet[1] 1 1000 1000 280 aet[2] 2 2000 1000 900 aet[3] 3 2000 1000 900 aet[4] 0 60000 1000 100 aet[5] 1 60000 1000 100 aet[6] 2 60000 1000 100 aet[7] 3 60000 1000 100 6.2.

  • Page 35: Acceleration Percent Correction (Apc)

    XT6384-1 Product Manual 6.3. A CCELERATION ERCENT ORRECTION The Acceleration Percent Correction parameter is a scalar value multiplied by the filter output to produce gain or attenuation. APC is input as the explicit percent change interested in. Configuration instances: 1 NOTE: apc (and arc) corrections are only applied to the max mg value at the end of the event.

  • Page 36: Apns (Apn)

    XT6384-1 Product Manual 6.4. APN The APN parameter contains settings for APN gateway, username, and password. The device will hunt through the APNs in sequence (0, 1, 2, 3), attempting to activate context once on each, until it is successful.
  • Page 37 XT6384-1 Product Manual Target Default Value(s) apn[2] "" "user" "passwd" apn[3] "" "user" "passwd" NOTE: Network carriers are inconsistent with handling special characters (~`!@$%^&*()-_+={};/?,.) over SMS. It is recommended to only use UDP commands to set passwords that contain special characters. Page 37 | 194...

  • Page 38: Acceleration Report Correction (Arc)

    XT6384-1 Product Manual 6.5. A CCELERATION EPORT ORRECTION The acceleration report correction factor is a scalar value that is added to the output of the filter to add a DC offset to the signal. It can be input as a decimal number (1.234567), the internal system representation of the decimal value multiplied by one million (1234567), or as the raw hex of the system representation of the decimal value (0x12D687).

  • Page 39: Alternator State Threshold (Ast)

    XT6384-1 Product Manual 6.6. A LTERNATOR TATE HRESHOLD The Alternator State Threshold configuration determines the voltage and time thresholds that cause logic events. There are four alternator state thresholds, each with their own parameter ranges: ast[0] -> Alternator On Threshold ast[1] ->...
  • Page 40 XT6384-1 Product Manual Instance Range Description Time_val (seconds) Number of seconds voltage is above threshold to detect 24V system ast[3] 0 (disable), 3 Threshold (0.1 V per bit) -- See Dynamic Alternator on p. 188 to 10 1 to 10...

  • Page 41: Ble Authentication Disable (Bad)

    XT6384-1 Product Manual 6.7. BLE A UTHENTICATION ISABLE Disables or enables BLE authentication and encryption of characteristics for the AAb3 target only Configuration instances: 1 Command Type Syntax Command :wycfg bad <disable> Response READ Command :rycfg bad Response | bad: disable:<disable> (hex_val)
  • Page 42 XT6384-1 Product Manual Parameter Description enable OBD stops vehicle bus communication when feature is enabled. Index Description Disable (default) Enable Instance Description bko[0] Scantool Detect Enable (retries communication in 60 seconds) bko[1] New MIL Status Detect Enable (end communication until next...

  • Page 43: Bluetooth Enabled (Blt)

    XT6384-1 Product Manual 6.9. B LUETOOTH NABLED The Bluetooth Enabled configuration sets the Bluetooth communication state. Configuration instances: 1 Command Type Syntax Command :wycfg blt <enable> Response READ Command :rycfg blt Response | blt: en:<enable> (hex_val) Param Description enable Enables Bluetooth:...

  • Page 44: Bluetooth Transmit Power (Btp)

    XT6384-1 Product Manual 6.10. B LUETOOTH RANSMIT OWER Configuration instances: 1 Command Type Syntax Command :wycfg btp <power_val> Response READ Command :rycfg btp Response | btp: power:<power_val> (hex_val) Parameter Range Description power_val 0 to 4 The Bluetooth Transmit Power setting; requires a reset to take effect.

  • Page 45: Buzzer Songs (Bzr)

    XT6384-1 Product Manual 6.11. B UZZER ONGS The Buzzer Songs configuration sets the frequency and duration of up to 8 notes on the device buzzer. Configuration instances: 10 Command Type Syntax Command :wycfg bzr[x] <frequency1> <duration1> ... <frequency8> <duration8> Response...

  • Page 46: Can Controller Settings (Can)

    XT6384-1 Product Manual 6.12. CAN C ONTROLLER ETTINGS Configuration instances: 6 Command Type Syntax Command :wycfg can[x] <param_val> Response READ Command :rycfg can[x] Response can[x]: value:<param_val> Parameter Description param_val Voltage threshold in 0.1 V per bit Instance Range Description can[0]...

  • Page 47: Crash Event Parameters (Cep)

    XT6384-1 Product Manual Target Default Value(s) can[1] 0 can[2] 8 can[3] 6 can[4] 4 can[5] 8 6.13. C RASH VENT ARAMETERS Configuration instances: 1 Command Type Syntax Command :wycfg cep <delta_mg_thresh> <poll_freq> <hist_depth> Response READ Command :rycfg cep Response | cep: mg:<delta_mg_thresh> (hex_val), freq:<poll_freq> (hex_val), depth:<hist_ depth>...
  • Page 48 XT6384-1 Product Manual Command Type Syntax Command :wycfg csl <rate_val> Response READ Command :rycfg csl Response | csl: rate:<rate_val> (hex_val) Parameter Range Description rate_val 1 to Scalar for accelerometer orientation falling slew. 4294967295 Target Default Value(s) AAb3 csl 10000 Page 48 | 194...

  • Page 49: Accelerometer Confidence Threshold (Cth)

    XT6384-1 Product Manual 6.15. A CCELEROMETER ONFIDENCE HRESHOLD Configuration instances: 1 Command Type Syntax Command :wycfg cth <confidence_threshold> <hysteresis> Response READ Command :rycfg cth Response | cth: conf:<confidence_threshold> (hex_val), hyst:<hysteresis> (hex_val) Parameter Range Description confidence_ 1 to 255 A value, above which accelerometer events will be reported to the threshold interpreter.
  • Page 50 XT6384-1 Product Manual Parameter Range Description <ip>|<hostname>| 64 Characters This id is the location specified by the dst. It can take the form <local serial> of an IP address (192.0.0.0), a hostname limited to 64 characters, or a local serial port. The valid local serial ports are as follows: "SERIAL_AUX0"...

  • Page 51: Obd Dtc Threshold (Dtc)

    XT6384-1 Product Manual 6.17. OBD DTC T HRESHOLD Configuration instances: 1 Command Type Syntax Command :wycfg dtc <poll period> <speed threshold 1mph/bit> Response READ Command :rycfg dtc Response | dtc: polfreq:<poll period> (hex_val), thresh:<speed threshold 1mph/bit> (hex_val) Parameter Range Description poll period 0 to 30 When vehicle speed is at or below <speed threshold>, periodically poll for...

  • Page 52: Flag Save Mask (Fsm)

    XT6384-1 Product Manual 6.18. F Configuration instances: 1 Command Type Syntax Command :wycfg fsm <32bit_mask> Response READ Command :rycfg fsm Response fsm: mask:<32bit_mask> Parameter Range Description 32bit_mask: 0x0 to A bitmask value corresponding to which scriptable user flags will be 0xFFFFFFFF saved in persist data.

  • Page 53: Ftp Configuration (Ftp)

    XT6384-1 Product Manual 6.19. FTP C ONFIGURATION FTP is only supported on SARA-R410M, LARA-4202 and ELS61-US cellular modules at this time. Configuration instances: 1 Command Type Syntax Command :wycfg ftp "<ip>|<hostname>" <port_number> "<directory>" "<username>" "<password>" <mode_val> <retry_max> Response READ Command...

  • Page 54: Garmin™ Blacklist (Gbl)

    XT6384-1 Product Manual Target Default Value(s) AAb1, AAb3, AAa4, AAb5, AAb6 ftp "0.0.0.0" 21 "dir" "usn" "pwd" 0 3 6.20. G ™ B ARMIN LACKLIST Configuration instances: 16 Command Type Syntax Command :wycfg gbl[x] <flags_hex> <pid_hex> <size_val> <byte0_hex> <byte1_hex> Response...

  • Page 55: Generic Config Value (Gcv)

    XT6384-1 Product Manual 6.21. G ENERIC ONFIG ALUE Configuration instances: 64 Command Type Syntax Command :wycfg gcv[x] <unsigned_long> Response READ Command :rycfg gcv[x] Response | gcv[x]: value:<unsigned_long> (hex_val) Parameter Range Description unsigned_ 0 to A generic configuration value accessible within a script.
  • Page 56 XT6384-1 Product Manual Polygonal Fence At least 3, but no more than 11 coordinate pairs needed Command Type Syntax Command :wycfg gfn[x] <latitude0> <longitude0>...<latitude10> <longitude10> Response READ Command :rycfg gfn[x] Response | gfn[x]: lat0:<latitude0> (hex_val), lon0<longitude0> (hex_val), ... lat10:<latitude10> (hex_val), lon10:<longitude10> (hex_val) NOTE: This parameter does not have a factory default setting.

  • Page 57: Gps Motion Thresholds (Gps)

    XT6384-1 Product Manual 6.23. GPS M OTION HRESHOLDS Configuration instances: 1 Command Type Syntax Command :wycfg gps <motion_start> <motion_stop> Response READ Command :rycfg gps Response | gps: start:<motion_start> (hex_val), stop:<motion_stop> (hex_val) Parameter Range Description motion_start 0 to 200 Configure GPS motion detection start speed threshold in tenths of MPH.

  • Page 58: Garmin™ Configuration (Grm)

    XT6384-1 Product Manual 6.24. G ™ C ARMIN ONFIGURATION Configuration instances: 1 Command Type Syntax Command :wycfg grm<filter_enable> Response READ Command :rycfg grm Response | grm: enable:<filter_enable> (hex_val) Parameter Range Description filter_enable Activates Garmin message filter that drops the first delete all stops request and the first stop 1 status request in a session.

  • Page 59: Impede Device Manager (Idm)

    XT6384-1 Product Manual 6.25. I MPEDE EVICE ANAGER Configuration instances: 1 Command Type Syntax Command :wycfg idm <select> Response READ Command :rycfg idm Response | idm: sel:<select> (hex_val) Parameter Range Description select Index Description DM service operates normally DM checkin messages and interactions are disabled...

  • Page 60: Input Default Polarity (Idp)

    XT6384-1 Product Manual 6.26. I NPUT EFAULT OLARITY idp[0] -> PUD on user input 1 idp[1] -> PUD on user input 2 idp[2] -> PUD on user input 3 idp[3] -> PUD on user input 4 Configuration instances: 4 Command Type...

  • Page 61: Ignition Sense (Ign)

    XT6384-1 Product Manual 6.27. I GNITION ENSE Configuration instances: 1 Command Type Syntax Command :wycfg ign <type> <onsec> <offsec> :wycfg ign <type> <andmask> <ormask> Response READ Command :rycfg ign Response | ign: type:<type> (hex_val), param1:<param1> (hex_val), param2:<param2> (hex_val) Parameter Range...
  • Page 62 XT6384-1 Product Manual Parameter Range Description NOTE: Ignition sources above will attempt to have a 1:1 with Input/Output State Bits on p. 158 Index Description 0x0100 Vehicle Bus 0x0200 Virtual Battery (Configured by Alternator State Threshold (ast) on p. 39)

  • Page 63: Iot Destination Address/Port (Iip)

    XT6384-1 Product Manual 6.28. I ESTINATION DDRESS Configuration instances: 1 Command Type Syntax Command :wycfg iip "<ip>|<hostname>" <port_number> <QoS Level> <Keep Alive> Response READ Command :rycfg iip Response | iip: addr:"<ip>|<hostname>", port:<port_number> (hex_val), qoslev:<QoS Level> (hex_val), keepa:<Keep Alive> (hex_val) Parameter...

  • Page 64: Iot Shadow Params (Ish)

    XT6384-1 Product Manual 6.29. I HADOW ARAMS Configuration instances: 1 Command Type Syntax Command :wycfg ish "<topic_string>" <shadow trim val> Response READ Command :rycfg ish Response | ish: topic:“<topic_string>”, shadtrm:<shadow trimval> (hex_val) Parameter Range Description topic_string AWS Shadow topic string...

  • Page 65: Input State Source (Iss)

    XT6384-1 Product Manual 6.30. I NPUT TATE OURCE iss[0] -> Source for user input 1 iss[1] -> Source for user input 2 iss[2] -> Source for user input 3 iss[3] -> Source for user input 4 Configuration instances: 4 Command Type Syntax Command :wycfg iss[x] <source_val>...

  • Page 66: Iot Thing String (Its)

    XT6384-1 Product Manual 6.31. I HING TRING Configuration instances: 1 Command Type Syntax Command :wycfg its "<topic_string>" "<client id string>" Response READ Command :rycfg its Response | its: topic:"<topic_string>", clntid:"<client id string>" Parameter Range Description topic_string AWS topic string Characters...

  • Page 67: Mip/Sip Control (Mip)

    XT6384-1 Product Manual 6.32. MIP/SIP C ONTROL Configuration instances: 1 Command Type Syntax Command :wycfg mip <mode_value> Response READ Command :rycfg mip Response | mip: mode:<mode_value> (hex_val) Parameter Description mode value Select cellular mobile IP mode: Index Description Simple IP only...

  • Page 68: Mpg Control (Mpg)

    XT6384-1 Product Manual 6.33. MPG C ONTROL This is a user configuration for MPG calculations. Configuration instances: 1 Command Type Syntax Command :wycfg mpg <fuel type value> <use type value> <EFR coefficient> <MAF coefficient> Response READ Command :rycfg mpg Response | mpg: fueltyp:<fuel type value> (hex_val), usetype:<use type value> (hex_val), efrcoef:<EFR coefficient>...

  • Page 69: Motion Sensitivity (Mst)

    XT6384-1 Product Manual 6.34. M OTION ENSITIVITY Configuration instances: 1 Command Type Syntax Command :wycfg mst <motion_sensitivity_value> Response READ Command :rycfg mst Response | mst: motion:<motion_sensitivity_value> (hex_val) Parameter Range Description motion_ 1 to 2000 Configure accelerometer motion sensitivity in thousandths of a unit of sensitivity_ gravity.

  • Page 70: Nmea Stream Output (Nso)

    XT6384-1 Product Manual 6.35. NMEA S TREAM UTPUT nso[0] -> USB nso[1] -> Aux0 nso[2] -> Aux1 Configuration instances: 3 Command Type Syntax Command :wycfg nso[x] <8bit_mask> Response READ Command :rycfg nso[x] Response | nso[x]: mask:<8bit_mask> Parameter Description 8bit_mask One bit for each of the available NMEA sentences; values can be added to stream more than one sentence type.

  • Page 71: Obd Accel And Decel (Oad)

    XT6384-1 Product Manual 6.36. OBD A CCEL AND ECEL Configuration instances: 2 Command Type Syntax Command :wycfg oad[x] <rate> Response READ Command :rycfg oad[x] Response | oad[x]: accdec:<rate> (hex_val) Parameter Descriptions rate rate is measured in .1 mph Instance Range...

  • Page 72: Obd Feature Enable/Disable (Obd)

    XT6384-1 Product Manual 6.37. OBD F EATURE NABLE ISABLE Configuration instances: 8 Command Type Syntax Command :wycfg obd[x] <flags_index> <mode_index> Response READ Command :rycfg obd[x] Response | obd[x]: flags:<flags_index> (hex_val), mode:<mode_index> (hex_val) NOTE: This parameter does not have a factory default setting.
  • Page 73 XT6384-1 Product Manual Instance Description Index Description VIN enable Ford VIN Read enable Ford VIN Read enable and VIN Read enable obd[2] Obd Debug Enable (OBD Datalogger). flags_index Index Description Enable mode_index Index Description Overwrite old debug data continuously Cease logging when memory is full obd[3] Obd Monitor Only (no bus requests) Enable.
  • Page 74 XT6384-1 Product Manual Instance Description obd[6] Obd Wake Listen Enable. flags_index Index Description Disable Enable obd[7] Obd Wake GPS Movement Enable. flags_index Index Description Disable Enable Target Default Value(s) AAb1, AAb3, AAa4, AAb5, AAb6 obd[0] 1 1 obd[1] 1 1...

  • Page 75: Obd Ign Off Accum (Oio)

    XT6384-1 Product Manual 6.38. OBD I CCUM oio[0] -> Gps Lifetime Odometer ignition off accumulation oio[1] -> Gps Trip Odometer 1 ignition off accumulation oio[2] -> Gps Trip Odometer 2 ignition off accumulation Configuration instances: 3 Command Type Syntax Command :wycfg oio[x] <accum>...

  • Page 76: Obd Rpm And Speed Events (Ors)

    XT6384-1 Product Manual 6.39. OBD RPM PEED VENTS Configuration instances: 2 Command Type Syntax Command :wycfg ors[x] <threshold> <time sec> Response READ Command :rycfg ors[x] Response | ors[x]: thresh:<threshold> (hex_val), time:<time sec> (hex_val) Instance Description ors[0] RPM Threshold Parameter Range...

  • Page 77: Ota Prevent (Ota)

    XT6384-1 Product Manual 6.40. OTA P REVENT Configuration instances: 1 Command Type Syntax Command :wycfg ota <enable_mask> Response READ Command :rycfg ota <enable_mask> Response | ota: enable:<enable_mask> Parameter Description enable_mask Description OTA is not prevented due to OBD Communications state or TPS Transfer Prevent OTA when OBD Communications are Active (OBD...
  • Page 78 XT6384-1 Product Manual Parameter Description enable_value Instance Description ovr[0] Override Engine Hours Index Description use derived engine hours if ECU engine hours not available use Derived Engine Hours only – ignore ECU engine hours use ECU Engine Hours only (keep in persist) –...

  • Page 79: Packet Creation Append (Pca)

    XT6384-1 Product Manual 6.42. P ACKET REATION PPEND Configuration instances: 16 Command Type Syntax Command :wycfg pca[x] "<append_hex_string>" Response READ Command :rycfg pca[x] Response | pca[x]: append_hex_string:"<append_hex_string>" NOTE: This parameter does not have a factory default setting. Parameter Description append_hex_string...

  • Page 80: Packet Creation Recipe (Pcr)

    XT6384-1 Product Manual 6.43. P ACKET REATION ECIPE Configuration instances: 128 Command Type Syntax Command :wycfg pcr[x] "<recipe_hex_string>" Response READ Command :rycfg pcr[x] Response | pcr[x]: resipe_hex_string:"<recipe_hex_string>" NOTE: This parameter does not have a factory default setting. Parameter Description recipe_hex_string See Packet Recipe on p.

  • Page 81: Packet Configure Tps (Pct)

    XT6384-1 Product Manual 6.44. P TPS ( ACKET ONFIGURE Configuration instances: 5 Command Type Syntax Command :wycfg pct[x] <reason_lo> <reason_hi> <Tps_Tag0> <Sz_size0> ... <Tps_Tag9> <Sz_ size9> Response READ Command :rycfg pct[x] Response | pct[x]: rsnlo:<reason_lo> (hex_val), rsnhi:<reason_hi> (hex_val), tag0:<Tps_Tag0> (hex_val), size0:<Sz_size0> (hex_val), ... tag9:<Tps_Tag9> (hex_val), size9:<Sz_size9>...

  • Page 82: Pdp Reset (Pdp)

    XT6384-1 Product Manual 6.45. PDP R ESET Configuration instances: 1 Command Type Syntax Command :wycfg pdp <minutes> <sessions> Response READ Command :rycfg pdp Response | pdp: rsttime:<minutes> (hex_val), rsstintv:<sessions> (hex_val) Parameter Range Description minutes 0 to Time threshold to issue a PDP connection reset...

  • Page 83: Packet Retry (Prt)

    XT6384-1 Product Manual 6.46. P ACKET ETRY prt[0] -> Ignition off prt[1] -> Ignition on Configuration instances: 2 Command Type Syntax Command :wycfg prt[x] <seconds> Response READ Command :rycfg prt[x] Response | prt[x]: sec:<seconds> (hex_val) Parameter Range Description seconds 0 to...

  • Page 84: Sms Receive Mask (Sms)

    XT6384-1 Product Manual 6.47. SMS R ECEIVE Configuration instances: 1 Command Type Syntax Command :wycfg sms "<sms source match>" Response READ Command :rycfg sms <sms source match> Response | sms: numb:"<sms source match>" Parameter Range Description sms source 32 Char...
  • Page 85 XT6384-1 Product Manual Parameter Range Description baudrate Acceptable baudrates: 115200 bit/sec 57600 bit/sec 38400 bit/sec 19200 bit/sec 9600 bit/sec 4800 bit/sec 2400 bit/sec 1200 bit/sec dps_value 3 Char Acceptable dps values: 8N1 Mode_value Acceptable mode values: Value Description Console Garmin Aux Passthru -- Only one serial port can be an Aux Passthru at any given time.

  • Page 86: Serial Pass Thru Settings (Sts)

    XT6384-1 Product Manual 6.49. S ERIAL ETTINGS Configuration instances: 1 Command Type Syntax Command :wycfg sts <PktTimeoutMs> <PktByteCount><PktDataFormat> Response READ Command :rycfg sts Response | sts: timeout:<PktTimeoutMs> (hex_val), numbyte:<PktByteCount> (hex_val), datafmt:<PktDataFormat> (hex_val) Parameter Range Description PktTimeoutMs 0 to A non-zero value defines a passthru packet with an inter-byte timeout.

  • Page 87: Synch Time Threshold (Stt)

    XT6384-1 Product Manual 6.50. S YNCH HRESHOLD Configuration instances: 1 Command Type Syntax Command :wycfg stt <threshold> Response READ Command :rycfg stt <threshold> Response | stt: thresh:<threshold> (hex_val) Parameter Range Description threshold 3 to 255 If the current system time is more than +/- thresh seconds different than the latest GPS sourced time, an automatic system time-sync will occur.

  • Page 88: Tps Config Values (Tcv)

    XT6384-1 Product Manual 6.51. TPS C ONFIG ALUES Configuration instances: 1 Command Type Syntax Command :wycfg tcv <destination_index> <timeout> <retries_value> <discovery_time> Response READ Command :rycfg tcv Response | tcv: index:<destination_index> (hex_val), seconds:<timeout> (hex_val), retries:<retries_value> (hex_val), distime:<discovery_time> (hex_val) Parameter Range Description Destination_...

  • Page 89: Timer Duration (Tmr)

    XT6384-1 Product Manual Parameter Range Description enable 0 to 1 Enables tester present message. Value Description Disables OBDII tester present message Enables OBDII tester present message Target Default Value(s) AAb1, AAb3, AAa4, AAb5 tpm 0 6.53. T IMER URATION Configuration instances: 32...

  • Page 90: Third-Party Config Values (Tpv)

    (hex_val) Parameter Range Description dst_index 0 to 9 Destination config index that points to the Xirgo Gateway Server checkin_freq 0 to 255 Time in hours for periodic check to gateway server Pid_list_1 0x0 to Bit list for supported pids 1 to 32...

  • Page 91: Obd Transmit Delay (Txd)

    XT6384-1 Product Manual Parameter Range Description Pid_list_2 0x0 to Bit list for supported PIDs (32 to 32) <reserved> 0xFFFFFFFF Flag 0 to 255 Reserved Target Default Value(s) AAb1, AAb3, AAa4, AAb5, AAb6 tpv 8 24 0x00 0x00 0 6.55. OBD T...

  • Page 92: Version Info (Ver)

    XT6384-1 Product Manual 6.56. V ERSION ver[0] -> Script ver[1] -> Paramset ver[2] -> Overlay0 ver[3] -> Overlay1 ver[4] -> Overlay2 ver[5] -> Overlay3 ver[6] -> Overlay4 ver[7] -> Tps Configuration instances: 8 Command Type Syntax Command :wycfg ver[x] "<string>" <revision no> <flags_hex>...

  • Page 93: Vin (Vin)

    XT6384-1 Product Manual Target Default Value(s) ver[2] "~unused" 0 64 ver[3] "~unused" 0 64 ver[4] "~unused" 0 64 ver[5] "~unused" 0 64 ver[6] "~unused" 0 64 ver[7] "~unknown" 0 128 6.57. VIN ( Configuration instances: 1 Command Type Syntax Command :wycfg vin "<string>"...

  • Page 94: Variable Save Mask (Vsm)

    XT6384-1 Product Manual 6.58. V ARIABLE vsm[0] > covers uservar8 0-15, uservar16 0-7, and uservar32 0-7 vsm[1] > covers uservar8 16-32, uservar16 8-15, and uservar32 8-15 Configuration instances: 2 Command Type Syntax Command :wycfg vsm[x] <32bit_mask> Response READ Command :rycfg vsm[x] Response | vsm[x]: mask:<32bit_mask>...

  • Page 95: Wake Battery Voltage (Wbv)

    XT6384-1 Product Manual 6.59. W ATTERY OLTAGE Configuration instances: 1 Command Type Syntax Command :wycfg wbv <millivolts> Response READ Command :rycfg wbv <millivolts> Response | wbv: wakemv:<millivolts> (hex_val) Parameter Range Description millivolts 10000 to Configures the voltage threshold at which the device will wake from sleep if 16000 exceeded.

  • Page 96: Device Manager Protocol

    XT6384-1 Product Manual 7. D EVICE ANAGER ROTOCOL 7.1. D EFINITIONS 7.1.1. ACK/NAK An ACK is used to signal that a command has been accepted. The ACK packet is an echo of the CMD packet's header with the Packet Type changed to ACK. A NAK is used any time a command cannot be accepted (due to improper command formatting, device busy, etc.).
  • Page 97 XT6384-1 Product Manual Packet Info Register View Bit Range/Type Description Action/Info Code: 0 - Description SessionAvailable SessionOpen SessionClose QueryContent Query MultiBlockSetup MultiBlockSend MultiBlockResend BlockSend RunCMDLang (TBD) CheckInNow (TBD) SessionReject Content Type: 0 - 15 Description Bootloader Application Script ParamSet CheckIn...
  • Page 98 XT6384-1 Product Manual Bit Range/Type Description Description Page 98 | 194 © 2022 Sensata Technologies, Inc. All rights reserved.

  • Page 99: Packet-Specific Data

    XT6384-1 Product Manual 7.4. P ACKET PECIFIC 7.4.1. BROADCAST: Session Available Byte(s) Description 8 to 11 Content Mask: one but flipped for each content type in session 12 to 15 Session IP(v4) 16 to 17 Session port 7.4.2. CMD: Multi-block Setup...
  • Page 100 XT6384-1 Product Manual 7.4.6. RESP: Query Content Byte(s) Description 8 to 11 Content Mask: Each bit from LSB to MSB represents one instance of available content (32 possible). Example: if three overlays are available, content mask = 0x7 (0b111). 7.4.7. RESP: Query NOTE: Bytes 12-N are only used for Script/ParamSet/Overlays/TPS, NOT for BootLoader/Application/ThirdParty.
  • Page 101 XT6384-1 Product Manual Found below are the messages exchanged in the device manager session: Broadcast:SessionAvail 50 80 ef be 15 cd 5b 07 04 00 00 00 7e 3c f1 32 57 30 ----------------------------------------------------------------------------------- > SessionOpen 51 40 ef be 15 cd 5b 07 <----------------------------------------------------------------------------------...

  • Page 102: Device Manager Check-In

    XT6384-1 Product Manual SessionClose 52 80 ef be 15 cd 5b 07 <---------------------------------------------------------------------------------- 7.5. D EVICE ANAGER HECK NOTE: all 2 to 4 byte items are little endian byte-order. Page 102 | 194 © 2022 Sensata Technologies, Inc. All rights reserved.
  • Page 103 XT6384-1 Product Manual Bit(s) Description 0 – 7 DM Header (see description above) Check-in Format Version 9 – N Check-in Data 7.5.1. Check-in Data Byte(s) Size Format Version Description Bootloader Version string size 10 - x variable Bootloader Version string...
  • Page 104 XT6384-1 Product Manual Byte(s) Size Format Version Description Cell Module FW Version string size x - x variable Cell Module FW Version string I/O Box FW version string size (XT2500 Only) x - x variable I/O Box FW version string (XT2500 Only) I/O Box ESN (XT2500 Only)

  • Page 105: Interpreter

    8.1.1. Interpreter Language Basics Overview Certain Xirgo products contain functionality to run user-created scripts. This allows functionality to be tuned and changed without needing Firmware updates. The device runs an interpreter which ‘interprets’ byte code that has been compiled from a human readable script. This document describes the language/syntax used for this script.
  • Page 106 XT6384-1 Product Manual NOTE: if the speed oscillates between 80.0 and 80.1 km/h it is possible to cause the actions to be executed as frequently as the speed oscillates. In order to avoid this, make use of the debounce specifiers.
  • Page 107 XT6384-1 Product Manual TOK_NUMBER: “2” 0x42 SMALL_CONST_VALUE (value: 2) 0xe0 INTERP_END binary script size: 134 file size: 142 file name: network_testing_script.bin Interpreter script format OK ilc v2.16 NOTE: Using Windows to drag the .txt file onto the ilc.exe as a means of execution will always result in a .bin file being generated, even if the compiler failed.
  • Page 108 XT6384-1 Product Manual :grscr x 0 Erasing FLASH memory Waiting for Xmodem Start (Ctrl-D twice to cancel) Starting xmodem transfer. Press Ctrl+C to cancel. Transferring V_Script_Nov_102015_JB.bin... 100%    572 bytes  572 bytes/sec 00:00:01       0 Errors Interpreter Script Download Successful Interpreter Script Stored in ChipFlash 8.1.4.
  • Page 109 XT6384-1 Product Manual Keyword Description Action Block will ALWAYS run when the Trigger Block's test(s) are true. actions Denotes the start of an Action Block Denotes the start of a single Action Transforms Script Language Description BitNot(<a>) Bitwise NOT (one's compliment) of argument a BitAnd(<a>, <b>)
  • Page 110 XT6384-1 Product Manual System Values Script Language Description SystemVal(<index>) Pass the enumeration index of the desired System Value to be accessed (see Packet Recipe Fields for acceptable range) UnixTime  Maps directly to UnixTime packet field (ID: 0x06) GPSLat  Maps directly to Latitude packet field (ID: 0x07) GPSLon ...
  • Page 111 XT6384-1 Product Manual Script Language Description Range: 0 to 7 GarminResponseReceived Evaluates to 1 when a non-blacklisted Garmin response is received (and (<index>) Garmin is active), otherwise 0 Range: 0 to 5 Value Description Ack (or Nak) packet (only triggered when specified in SendGarminMsg())
  • Page 112 XT6384-1 Product Manual Script Language Description Value Description UDPReceived UDPSendOK UDPSendFailure PacketStorageEmpty PacketStorageFull PdpConnectionReset (not implemented) Device Powerup 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 crash event is detected, otherwise 0.
  • Page 113 XT6384-1 Product Manual Script Language Description GeofenceState(<index>) Index Description <index> is not configured Outside fence Inside fence Index range: 0 to 49 InputState(<index>) Evaluates to 1 when input is high/when condition is true, otherwise 0 Index range 0 to 7:...
  • Page 114 XT6384-1 Product Manual Script Language Description GenericConfig(<index>) Evaluates to value stored in gcv[<index>] config parameters. Index range: 0 to 63 PacketsPending(<index>) Evaluates to number of unsent packets stored in the log Index Description Normal Packet Space UDR Packet Space NoAckRxRetryCount(0) Evaluates to number of retried failed ACK packets...
  • Page 115 XT6384-1 Product Manual Script Language Description GetVarPktSize(<default value>) Evaluates to generated variable packet byte count, otherwise 0. Index Description 0x26 Garmin Packet 0xca Aux Passthru Packet 0x6f Crash Packet 0x6b Vehicle Bus DTC Packet 0x28 Bluetooth Payload Packet 0x2a Command Payload Packet 0xc5 TPS Payload...
  • Page 116 XT6384-1 Product Manual Script Language Description Value Description -32768 to 32767 16-bit variables -2147483648 to 2147483647 32-bit variables AdjustUserVar Type range: 0 to 2 (<type>, <index>, Type Description <adjust_amount>) 8bit variable 16bit variable 32bit variable Index range: Index Description 0 to 31...
  • Page 117 XT6384-1 Product Manual Script Language Description Parameter Range Description destination_id 0 to 9 Should be one of the destinations configured range with :wycfg dst[x] ... Ack range 0 to 2 See Ack table below Ack table: Range Description No acknowledgement needed...
  • Page 118 XT6384-1 Product Manual Script Language Description Range Description SendGarminMsg (<msg_id>, <flags>) Range Description Unit ID Request (Garmin ESN Request) Product ID Request Ping FMI Enable Set Auto Arrival to defaults (30 sec, 100 meters) Disable Status Message Disable ETA Message...
  • Page 119 XT6384-1 Product Manual Script Language Description ClearDriverIds() ClearDriverID <index> of 0 or 1 (<index>) CheckInNow() SetInput(<input_ Input_index range: 0 to 3 index>) If input state source is not configured to “script”, it is ignored ClearInput(<input_ Input_index range: 0 to 3 index>)
  • Page 120 XT6384-1 Product Manual Script Language Description VehicleBusListen Listen for traffic on vehicle bus for <timeout_s> (<timeout_s>) TpsRequestBlock Request the given TPS block on the vehicle bus (<block_id>) AuxPassthruScratchp Load the Aux Passthru scratchpad with the most recently-received packet adLoad() GsmSleep()

  • Page 121: Interpreter Scripting Trigger Block Examples

    XT6384-1 Product Manual the command to be executed in quick procession. The required time to wait between saves is one second, doubling with every proceeding save; it will not extend above 60 seconds. 60 seconds after the last successful save this is reduced back to 1 second. Calling this function while the spam filter is active does not perform the save.
  • Page 122 XT6384-1 Product Manual actions run BuildAndSendMsg(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.
  • Page 123 XT6384-1 Product Manual 8.2.3. Set User Flag 3 if OBD Reports PTO On PTO status resides in the bit 1 position of Fld_ObdRunStatus (0x2c). The example below uses the BitAnd() operator with a hex mask isolating the desired bit, comparing it to 0 for rising edge trigger.
  • Page 124 XT6384-1 Product Manual Field Assigned Data OBDPidReserved6 RR Tire Pressure OBDPidReserved7 LR Tire Pressure OBDPidReserved8 RRI Tire Pressure OBDPidReserved9 SPARE Tire Pressure OBDPidReserved10 Driver Seatbelt Status OBDPidReserved11 Passenger Seatbelt Status OBDPidReserved12 Airbag Lamp OBDPidReserved13 PRNDL OBDPidReserved14 Parking Brake State OBDPidReserved15...

  • Page 125: Packet Recipe

    XT6384-1 Product Manual 8.3. P ACKET ECIPE 8.3.1. Fields Name Description 0x01 PacketID Packet recipes can be labeled from 0-255, but there are only 128 recipe slots Bytes Units Resolution Range 0 to 255 0x02 FmCustomHeader value TBD (currently zero)
  • Page 126 XT6384-1 Product Manual Name Description Bytes Units Resolution Range to 2147.483647 0x08 Longitude Signed integer decimal value of 4-byte hex string divided by 1000000 (useful range -180.0 to 180.0) Bytes Units Resolution Range Degrees 1.00E-06 -2147.483648 to 2147.483647 0x09 Altitude...
  • Page 127 XT6384-1 Product Manual Name Description 0x0f DriverIdCode2 Unsigned integer representing unique iButton ID Bytes Units Resolution Range 0 to 4294967295 0x10 GSPTripOdom1 See Odometer Details Table. Bytes Units Resolution Range 0 to 4294967295 0x11 Flags Bitfield Bytes Units Resolution Range 0 to 4294967295...
  • Page 128 XT6384-1 Product Manual Name Description Bytes Units Resolution Range 0.0 to 25.5 0x18 GpsLifetimeOdom Unsigned integer; see Odometer Details Table. Bytes Units Resolution Range 0 to 4294967295 0x19 AccelStartDateTime Unsigned integer representing time from Unix Epoch (s) Bytes Units Resolution Range 0x0 to 0xffffffff...
  • Page 129 XT6384-1 Product Manual Name Description 0x20 AccelEndDateTime Unsigned integer representing time from Unix Epoch (s) Bytes Units Resolution Range 0x0 to 0xffffffff 0x21 AccelEndLat Signed integer decimal value of 4-byte hex string divided by 1000000 (useful range -90.0 to 90.0)
  • Page 130 XT6384-1 Product Manual Name Description Bytes Units Resolution Range 0x29 BluetoothPayload * Bytes Bytes Units Resolution Range Variable 0x2a CommandPayloadSize * Bytes Units Resolution Range 0x2b CommandPayload * Bytes Units Resolution Range Variable 0x2c OBDRunStates Bitfield; see OBD Run States Bits...
  • Page 131 XT6384-1 Product Manual Name Description 0x31 TempSensor1 Bytes Units Resolution Range 0x32 UserVar8[0] 8-bit signed integer Bytes Units Resolution Range -128 to 127 0x33 UserVar8[1] 8-bit signed integer Bytes Units Resolution Range -128 to 127 0x34 UserVar8[2] 8-bit signed integer...
  • Page 132 XT6384-1 Product Manual Name Description Bytes Units Resolution Range -128 to 127 0x3a UserVar8[8] 8-bit signed integer Bytes Units Resolution Range -128 to 127 0x3b UserVar8[9] 8-bit signed integer Bytes Units Resolution Range -128 to 127 0x3c UserVar8[10] 8-bit signed integer...
  • Page 133 XT6384-1 Product Manual Name Description Bytes Units Resolution Range -128 to 127 0x42 UserVar16[0] 16-bit signed integer Bytes Units Resolution Range -32768 to 32767 0x43 UserVar16[1] 16-bit signed integer Bytes Units Resolution Range -32768 to 32767 0x44 UserVar16[2] 16-bit signed integer...
  • Page 134 XT6384-1 Product Manual Name Description Bytes Units Resolution Range -32768 to 32767 0x4a UserVar32[0] 32-bit signed integer Bytes Units Resolution Range  N/A -2147483648 to 2147483647 0x4b UserVar32[1] 32-bit signed integer Bytes Units Resolution Range  N/A -2147483648 to 2147483647 0x4c UserVar32[2]...
  • Page 135 XT6384-1 Product Manual Name Description Bytes Units Resolution Range  N/A -2147483648 to 2147483647 0x51 UserVar32[7] 32-bit signed integer Bytes Units Resolution Range  N/A -2147483648 to 2147483647 0x52 SystemStates Bitfield; see System State Bits Table Bytes Units Resolution Range  N/A 0 to 4294967295...
  • Page 136 XT6384-1 Product Manual Name Description 0x58 ObdEngRpm 16-bit unsigned integer Bytes Units Resolution Range 0 to 65535 0x59 ObdEngCoolantTemp 16-bit signed integer Bytes Units Resolution Range Celsius -40 to 215 0x5a ObdFuelLevelPct 16-bit unsigned integer Bytes Units Resolution Range 0 to 1000...
  • Page 137 XT6384-1 Product Manual Name Description 0x60 ObdSpeedExceedTotCnt 32-bit unsigned integer Bytes Units Resolution Range 0 to 4294967295 0x61 ObdRPMExceedTotCnt 32-bit unsigned integer Bytes Units Resolution Range 0 to 4294967295 0x62 ObdHarshAccelTotCnt 32-bit unsigned integer Bytes Units Resolution Range 0 to 4294967295...
  • Page 138 XT6384-1 Product Manual Name Description 0x68 Accel Metrics Rounded to nearest whole number Bytes Units Resolution Range 0x69 Boot Status 8-bit unsigned integer; see Boot Status Values Table Bytes Units Resolution Range 0 to 7 0x6a Apn Index 8-bit unsigned integer Bytes...
  • Page 139 XT6384-1 Product Manual Name Description 0x70 CrashPacket A collection of configurable historical reoriented basic accelerometer vectors structured in little Endian 2 byte values as x, y, z in milli-G's Bytes Units Resolution Range Variable 0x71 ObdTotPTOTime 32-bit unsigned integer Bytes...
  • Page 140 XT6384-1 Product Manual Name Description Bytes Units Resolution Range -2147483648 to 2147483647 0x77 OBDPidReserved4 Signed integer decimal value of 4byte hex string divided by 10 Bytes Units Resolution Range -2147483648 to 2147483647 0x78 OBDPidReserved5 Signed integer decimal value of 4byte hex string divided by 10...
  • Page 141 XT6384-1 Product Manual Name Description Bytes Units Resolution Range 0.0 to 256.0 0x7E ObdAccelPos 16-bit unsigned integer Bytes Units Resolution Range 0 to 100 0x7F ObdEngLoad 16-bit unsigned integer Bytes Units Resolution Range 0 to 250 0x80 ObdEngTorque 16-bit signed integer...
  • Page 142 XT6384-1 Product Manual Name Description Bytes Units Resolution Range Celsius -40 to 215 0x86 ObdCoolantLevel 16-bit unsigned integer Bytes Units Resolution Range 0 to 100 0x87 LinkageVer 32-bit unsigned integer; see Linkage Version Table Bytes Units Resolution Range 0x0 to 0xffffffff 0x88 GSPTripOdom2 See Odometer...
  • Page 143 XT6384-1 Product Manual Name Description Bytes Units Resolution Range 0 to 4294967295 0x8e OBDPidReserved6 Signed integer decimal value of 4-byte hex string divided by 10 Bytes Units Resolution Range -2147483648 to 2147483647 0x8f OBDPidReserved7 Signed integer decimal value of 4-byte hex string divided by 10...
  • Page 144 XT6384-1 Product Manual Name Description Bytes Units Resolution Range Mph/s 0 to 255 0x95 CellSerialId 24-byte null-terminated ascii string Bytes Units Resolution Range ascii 0x96 PktChkSum Check sum for the packet, calculated so all bytes sum to 0x00 Bytes Units...
  • Page 145 XT6384-1 Product Manual Name Description Bytes Units Resolution Range variable 0x9c OBDPidReserved11 4-byte ascii normalization of the vehicle response Bytes Units Resolution Range ascii 0x9d OBDPidReserved12 4-byte ascii normalization of the vehicle response Bytes Units Resolution Range ascii 0x9e OBDPidReserved13...
  • Page 146 XT6384-1 Product Manual Name Description Bytes Units Resolution Range -128 to 127 0xa4 UserVar8[17] 8-bit signed integer Bytes Units Resolution Range -128 to 127 0xa5 UserVar8[18] 8-bit signed integer Bytes Units Resolution Range -128 to 127 0xa6 UserVar8[19] 8-bit signed integer...
  • Page 147 XT6384-1 Product Manual Name Description Bytes Units Resolution Range -128 to 127 0xac UserVar8[25] 8-bit signed integer Bytes Units Resolution Range -128 to 127 0xad UserVar8[26] 8-bit signed integer Bytes Units Resolution Range -128 to 127 0xae UserVar8[27] 8-bit signed integer...
  • Page 148 XT6384-1 Product Manual Name Description Bytes Units Resolution Range  N/A -32768 to 32767 0xb4 UserVar16[9] 16-bit signed integer Bytes Units Resolution Range  N/A -32768 to 32767 0xb5 UserVar16[10] 16-bit signed integer Bytes Units Resolution Range  N/A -32768 to 32767 0xb6...
  • Page 149 XT6384-1 Product Manual Name Description Bytes Units Resolution Range -2147483648 to 2147483647 0xbc UserVar32[9] 32-bit signed integer Bytes Units Resolution Range -2147483648 to 2147483647 0xbd UserVar32[10] 32-bit signed integer Bytes Units Resolution Range -2147483648 to 2147483647 0xbe UserVar32[11] 32-bit signed integer...
  • Page 150 XT6384-1 Product Manual Name Description 0xc2 UserVar32[15] 32-bit signed integer Bytes Units Resolution Range -2147483648 to 2147483647 0xc3 OBD Start Reason 16-bit signed integer; see OBD Trip Start Reason (bit mask) table below Bytes Units Resolution Range -2147483648 to 2147483647 0xc4 OBD End Reason 32-bit signed integer;...
  • Page 151 XT6384-1 Product Manual Name Description Bytes Units Resolution Range 0.0 to 6553.5 0xca AuxPassthruPacketSize Size of entire aux passthru packet Bytes Units Resolution Range 1 to 256 0xcb AuxPassthruPacket Bytes Units Resolution Range variable 0xcc Geofence States Bitfield 1 Bitfield representing current state of active geofences 0 to 31, where 1 is inside, and 0 is outside or inactive.
  • Page 152 XT6384-1 Product Manual Name Description Bytes Units Resolution Range ascii 0xd2 OBD debug packet size Unsigned integer Bytes Units Resolution Range 0xd3 OBD debug packet Bytes Units Resolution Range variable 0xd4 Cell Access Technology  Cell Access Technology values Bytes Units...
  • Page 153 XT6384-1 Product Manual Name Description Bytes Units Resolution Range 0x0 to 0xff 0xd8 CellularEnvironment Each byte represents a different value [CSQ] [RSRP] [RSRQ] [CINR] CINR is not currently implemented (always 0xFF). RSRP & RSRQ are always 0xFF for modules that do not support AT+CESQ.
  • Page 154 XT6384-1 Product Manual Name Description 0xde OBD MPG 5 second Averaging synchronized with OBD derived lifetime odometer average timing. Bytes Units Resolution Range 0.0 to 256.0 0xdf GPS Harsh Accel Violations Bytes Units Resolution Range 0 to 4294967295 0xe0 GPS Harsh Accel Value...
  • Page 155 XT6384-1 Product Manual Name Description Bytes Units Resolution Range 0 to 65535 0xeb Upper bytes of DriverId2 Unigned integer represent of the upper two bytes of unique six byte iButton ID. Bytes Units Resolution Range 0 to 65535 Page 155 | 194...

  • Page 156: Dtc Packet Parsing

    XT6384-1 Product Manual 8.4. DTC P ACKET ARSING DTC data is reported via two PCR fields: ObdDtcPacketSize (0x6b) and ObdDtcPacket (0x6c). DTC data can be included in any of the messages sent to the backend and it must include both fields.
  • Page 157 XT6384-1 Product Manual 8.4.3. J1708 Field Description <ascii_x> 'S' or ‘0' <dtc_code_x> <fmi_0> FMI reported by ECU 8.4.4. Examples Vehicle rporting no DTCs, MIL off: ObdDtcPacketSize: 0002 ObdDtcPacket: 0000     <mil_status> - MIL off     <num_ecu_dtc> - 0 ECUs reporting DTCs Vehicle reporting two DTCs on ECU 7E8 and one DTC on ECU 7E9, MIL on:...
  • Page 158 XT6384-1 Product Manual Heavy-duty Vehicle reporting one DTC (J1939), Amber Warning Lamp on ObdDtcPacketSize: 000A (10 bytes) ObdDtcPacket: 2001330130000003A10C     <mil_status> - 20 (Amber Warning Lamp on)     <num_ecu_dtc> - 1 (1 ECU reporting DTC)     <ecu_id_0> - 33 (ECU 33)     <num_dtc_0> - 1 (1 DTC)         <ascii_0>...
  • Page 159 XT6384-1 Product Manual 8.4.6. OBD Run States Bits State Engine Running PTO On Moving Ignition On 8.4.7. OBD Comms State Value Description OBD comms off OBD comms pending (ECU detected, initiating connection) OBD comms connected (waiting for RPM change or vehicle motion) OBD comms active 8.4.8.
  • Page 160 XT6384-1 Product Manual 8.4.10. OBD Trip Start Reason (Bit Mask) Value (Hex) Description 0x0001 Detected Alternator On or Switched Ignition Input 0x0002 Detected GPS Movement 0x0004 Detected Vehicle Bus Traffic 0x0008 Detected Changing Vehicle Speed 0x0010 Detected Changing RPM 8.4.11. OBD Trip End Reason (Bit Mask)
  • Page 161 XT6384-1 Product Manual 8.4.12. Odometer Details Odometer Reset Description GPS Trip Reset by script Great-circle distance between subsequent sets of GPS latitude Odom 1 and longitude GPS Trip Reset by script Great-circle distance between subsequent sets of GPS latitude Odom 2...
  • Page 162 XT6384-1 Product Manual 8.4.14. BuildAndSend Message ACK Byte(s) Value Type Description 0x8888 The first 2 bytes of the ACK must be set to 0x8888. PacketSerialNum 16-bit This value is the unique packet serial/sequence unsigned int, number (Packet recipe ID: 0x05).
  • Page 163 XT6384-1 Product Manual <slot_index> is in range of 0 to 15 <recipe_hex_string> is a quoted string of hex bytes (represented by two ASCII characters) String Structure: <reason_lo><reason_hi><flags><num_fields><field_0><field_1>...<field_N> <reason_lo> to <reason_hi> is the reason code range NOTE: A single reason code assignment is possible when <reason_lo> = <reason_hi>...
  • Page 164 XT6384-1 Product Manual 8.4.19. Signal Quality Measure (SQM) Table SQM Value -113.0 -111.8 -110.5 -109.3 -108.1 -106.8 -105.6 -104.4 -103.1 -101.9 -100.7 -99.4 -98.2 -97.0 -95.7 -94.5 -93.3 -92.0 -90.8 -89.6 -88.3 -87.1 -85.9 -84.6 -83.4 -82.2 -80.9 -79.7 -78.5 -77.2...
  • Page 165 XT6384-1 Product Manual 8.4.20. System State Bits State Valid Registration Valid IP Valid GPS Valid Script DM Session Active Accel Oriented Bluetooth Discoverable (TBD) Bluetooth Paired (TBD) Bluetooth Authenticated (TBD) Bluetooth Connected (TBD) Bluetooth Powered (TBD) Cellular Powered GPS Powered...

  • Page 166: Command Language

    9.1. O VERVIEW The XT6384-1 device utilizes commands that can be sent over various methods such as USB, RS232, and SMS. This command language can be utilized to configure nearly all the device's parameters and morph its functionality to fit the requirements of a client. The implemented command language has been designed to be easy to learn/remember, human readable, and flexible.

  • Page 167: Arguments

    XT6384-1 Product Manual 9.4. A RGUMENTS The following are rules regarding the syntax of arguments: Arguments have multiple valid formats: Strings Strings representing enumerated values of valid chars Hexadecimal or decimal values Arguments must be separated by a single valid separator: "[space],()[tab]"...
  • Page 168 XT6384-1 Product Manual Module Code Bluetooth Device Geofence Flash Watchdog GPIO Third Party Backend CMDLang Motion Garmin Processor Flash Interpreter Buzzer Telematics/Cell Aux Passthru One-Wire-Bus Accelerometer System Zigbee Main Processor 2nd Processor available q3-0 9.4.3. Object Codes Object Code Bootloader...

  • Page 169: Device Commands

    XT6384-1 Product Manual Object Code Firmware Heap hp (OR) heap Info i (OR) info Monitor Memory Mode md (OR) mode Message Option Override ovrd Properties p (OR) prop RAM Console Record Script scr (OR) script Simulation Stack stk (OR) stack...
  • Page 170 XT6384-1 Product Manual Command Function <mod> Val Definition 0x00 CW (Pattern must be 0x03 or 0x04) 0x01 GFSK (BR) 0x02 (pi)/4-DQPSK (2-EDR) 0x03 8DPSK (3-EDR) 0x04 <pat> Val Definition 0x00 0x01 PN15 0x02 0x5555 (0101 0101 0101 0101) 0x03 All 1's...
  • Page 171 XT6384-1 Product Manual Command Function <coef1> <coef2> ... <coefX> :wxval coef <coef_index> Write filter coefficient at index X <coef> :qxi Query accelerometer info :exm Enable accelerometer debug channel monitoring :dxm Disable accelerometer debug channel monitoring :ext Enable accelerometer motion test...
  • Page 172 XT6384-1 Product Manual 9.5.7. Third Party Command Function :ejm Enable Third Party debug channel monitoring :djm Disable Third Party debug channel monitoring :djdbg Disable Third Party XVBMG debug trace :ejdbg Enable Third Party XVBMG debug trace :qji Print out parameter tag information :qji diag Print out tag transaction diagnostic info :gjfw x <serial_port_id>...
  • Page 173 XT6384-1 Product Manual Command Function :rdval serial Read device serial number :rdval uptime Read device uptime (seconds since reset) :rdval wake Read device wake reason (only accurate if device has slept) :wdval serial "<serial_no>" Write the device serial number :qdi Query device info ("vtu query")
  • Page 174 XT6384-1 Product Manual Command Function :edm Enable device debug channel monitoring :ddm Disable device debug channel monitoring 9.5.9. Flash Command Function :efm Enable Flash debug channel monitoring :dfm Disable Flash debug channel monitoring :cfmem [all | <addr> <size>] all = erase entire flash chip, <addr>,<size>...
  • Page 175 XT6384-1 Product Manual 9.5.11. Geofence Command Function :eem Enable Geofence debug channel monitoring :dem Disable Geofence debug channel monitoring :redm Read GPS debug mask :wedm <mask> Write the GPS debug mask 9.5.12. GPIO Command Function :qii Query GPIO info (GPIO pin IDs and default states) :rival <pin_id>...
  • Page 176 XT6384-1 Product Manual Command Function :sgsim coord <lat> <long> GPS simulator force coordinates :sgsim speed <speed> GPS simulator force speed Values are in tenths (e.g. 300 = 30 mph) :sgsim head <heading> GPS simulator force heading Values are in tenths (e.g. 900 = 90 degrees) :sgsim lock <lock>...
  • Page 177 XT6384-1 Product Manual Command Function :wtovrd apn ["<apn_ <apn_overrride>"] Override class 3 APN Only applicable to: overrride>"] XT6372, XT6374 XT6369 XT6383 :etm Enable transport debug channel monitoring :dtm Disable transport debug channel monitoring :ett Enable transport test mode (‘ct’ mode)
  • Page 178 XT6384-1 Product Manual Command Function "<filename>" is arbitrary and optional name reported in :q1i response <rev> is the user determined revision value :utota s3 "<full S3 presigned Request HTTPS file transfer (only on AAb6 currently). link>" <port> <type>[[[  "<full S3 presigned link>" https server string and path including file <index>] "<filename>"]...
  • Page 179 XT6384-1 Product Manual Command Function :rrval odom <index> Read an odometer Index Description GPS Trip 1 GPS Trip 2 OBD Trip GPS Life OBD Life :rrval flags Read user script flags :rrval uservar <type> <index> Read a uservar :rrval timer <index>...
  • Page 180 XT6384-1 Product Manual 9.5.17. Main Processor Command Function :d1dbg [<lock_code>] Lock-out JTAG (disable debug); two stage command: 1. Issue :d1dbg (returns <lock_code>) 2. Issue :d1dbg <lock_code> :g1bl x <serial_port_id> Upgrade main bootloader via xmodem NOTE: Command cannot be sent via SMS or UDP :g1fw x <serial_port_id>...
  • Page 181 XT6384-1 Product Manual Command Function • The first number is the raw value from the ECU (units vary by protocol) • The second number is the converted value our device calulated • The third number is the "lowest ECU" (address) that...
  • Page 182 XT6384-1 Product Manual Command Function (units vary by protocol) • The second number is the converted value our device calulated • The third number is the "lowest ECU" (address) that reported the value gear 0 = neutral 1 = forward 2 = reverse...
  • Page 183 XT6384-1 Product Manual Command Function OBII and J1939: -40 + 1°C x bits J1708: 0.25°F/bit mantemp OBDII and J1939: -40 + 1°C x bits J1708: 1°F/bit brake 0 = parking brake off 3 = parking brake set NOTE: if low ECU = 0xFE, converted...
  • Page 184 XT6384-1 Product Manual Command Function :qycfg ... Query parameter information :uycfg revert Revert all system configs in RAM (reload from FLASH; must be used before :vycfg) :vycfg Save system configuration :uyscr x <serial_port_id> Run system script (after upload via xmodem)
  • Page 185 XT6384-1 Product Manual 9.5.21. TPS Command Function :ecm Enable TPS debug prints :dcm Disable TPS debug prints :wcdm <mask> Set debug mask :wcsim hdr Write into the TPS simulator header :wcsim tags <protocol> <link> Write a TPS simulator tag :rctest vin...

  • Page 186: Electrical Characteristics

    LECTRICAL HARACTERISTICS The XT6384-1 has two electrical connectors on the body of the device which contain all necessary power and data communication lines. One of these connectors is a Molex 24-pin female header (43045-2421) and the other is a Molex 14-pin female header (43045-1421).

  • Page 187: 14-Pin Connector

    XT6384-1 Product Manual Description ADC IN 1 ADC IN 2 (THIS IS SHUNTED TO GROUND ON ALL KNOWN XT6300 HARDWARE) 10.2. 14-P ONNECTOR Description CAN (J-2234) High J-1708 RX J-1708 TX ISO 9141-2 Low J-1850 Bus - J-1850 Bus + CAN (J-2234) Low...

  • Page 188: Appendix

    XT6384-1 Product Manual 11. A PPENDIX 11.1. UDPC 1. Open a standard udp server to the configuration of dst[<dst_index>].  2. Issue the command :ukcmd tunnel cmd <dst_index> via console to the device. NOTE: This will send out a hello message to dst[<dst_index>] and open a temporary socket for an “ack”...
  • Page 189 XT6384-1 Product Manual configured voltage delta (ast[3]) is detected, the device attempts to start vehicle communications. If successful, a trip is started. When vehicle communications stop, the trip is ended and the battery voltage is captured (End of Trip Voltage - EOT).

  • Page 190: J1939 And J1708 Test Setup Block Diagram

    XT6384-1 Product Manual 11.3. J1939 J1708 T ETUP LOCK IAGRAM Page 190 | 194 © 2022 Sensata Technologies, Inc. All rights reserved.

  • Page 191: J1939 Dual Can Test Setup Block Diagram

    XT6384-1 Product Manual 11.4. J1939 D ETUP LOCK IAGRAM Page 191 | 194 © 2022 Sensata Technologies, Inc. All rights reserved.

  • Page 192: Regulatory Statements

    Consult the dealer or an experienced radio/TV technician for help. Radio frequency radiation exposure Information: This equipment, XT6384-1, complies with FCC and ISED radiation exposure limits set forth for an uncontrolled environment. This equipment must be installed and operated with minimum distance of 20cm between the XT6384-1 and your body.
  • Page 193 XT6384-1 Product Manual 12.2. IC Antenna Statement Under Industry Canada regulations, this radio transmitter may only operate using an antenna of a type and maximum (or lesser) gain approved for the transmitter by Industry Canada. To reduce potential radio interference to other users, the antenna type and its gain should be so chosen that the equivalent isotropically radiated power (e.i.r.p.) is not more than that necessary for successful communication.

  • Page 194: California Proposition 65 Warning

    XT6384-1 Product Manual 12.3. C 65 W ALIFORNIA ROPOSITION ARNING 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 cause birth defects or other reproductive harm.

This manual is also suitable for:

Xt6383

Table of Contents