queclink-parser 1.5.0 → 1.8.5

package/src/utils.js

@@ -9,8 +9,8 @@ const langs = { es: langEs, en: langEn }
 */
 const patterns = {
   message: /^\+RESP.+\$$/,
-  ack: /^\+ACK.+\$$/,
   buffer: /^\+BUFF/,
+  ack: /^\+ACK.+\$$/,
   heartbeat: /^\+ACK:GTHBD.+\$$/
 }
 
@@ -42,7 +42,8 @@ const devices = {
   '3F': 'GMT100', // New version
   F8: 'GV800W',
   '41': 'GV75W',
-  FC: 'GV600W'
+  FC: 'GV600W',
+  '6E': 'GV310LAU'
 }
 
 /*
@@ -78,12 +79,161 @@ const OBDIIProtocols = {
 }
 
 /*
-  Uart Devices
+  Possible Uart Devices
 */
 const uartDeviceTypes = {
   '0': 'No device',
   '1': 'Digit Fuel Sensor',
-  '2': 'AC100 1 Wire Bus'
+  '2': 'AC100 1 Wire Bus',
+  '5': 'CANBUS device',
+  '6': 'AU100 device',
+  '7': 'RF433 accessory'
+}
+
+/*
+  Possible Data Types for DTT
+*/
+const dataTypes = {
+  '0': 'Binary',
+  '1': 'Hexadecimal'
+}
+/*
+  Possible Network Types
+*/
+const networkTypes = {
+  '0': '2G',
+  '1': '3G',
+  '2': '4G',
+  '99': 'Unknow'
+}
+
+/*
+  Possible GPS Antena Status
+*/
+const externalGPSAntennaOptions = {
+  '0': 'Working',
+  '1': 'Detected in open circuit state',
+  '3': 'Unknow state',
+  '': 'Unknow'
+}
+
+/*
+  Possible Peer roles in Bluetooth
+*/
+const peerRoles = {
+  '0': 'Master',
+  '1': 'Slave'
+}
+
+/*
+  Possible Peer addesses type for Bluetooth
+*/
+const peerAddressesTypes = {
+  '0': 'Public',
+  '1': 'Random'
+}
+
+/*
+  Possible Reasons for bluetooth disconnection
+*/
+const disconnectionReasons = {
+  '0': 'Normal',
+  '4': 'Device  pairing fails'
+}
+
+/*
+  Possible Accesories Types of Bluetooth
+*/
+const bluetoothAccessories = {
+  '0': 'No bluetooth Accessory',
+  '1': 'Escort sensor',
+  '2': 'Beacon temperature sensor',
+  '3': 'Bluetooth beacon accessory',
+  '6': 'Beacon Multi-Functional Sensor',
+  '11': 'Magnet Sensor',
+  '12': 'BLE TPMS sensor',
+  '13': 'Relay Sensor'
+}
+
+/*
+  Possible Accesories Models for Bluetooth Accessories
+*/
+const bluetoothModels = {
+  '1': {
+    '0': 'TD_BLE fuel sensor',
+    '3': 'Angle sensor'
+  },
+  '2': {
+    '0': 'WTS300 (Temperature sensor)',
+    '1': 'Temperature ELA'
+  },
+  '6': {
+    '2': 'WTH300 (Temperature and Humidity Sensor)',
+    '3': 'RHT ELA (Temperature and Humidity Sensor)',
+    '4': 'WMS301 (Door Sensor with embedded Temperature and Humidity Sensor)',
+    '5': 'WTH301 (Temperature and Humidity Sensor)'
+  },
+  '11': {
+    '0': 'MAG ELA (Door Sensor)'
+  },
+  '12': {
+    '0': 'MLD BLE TPMS (ATP100/ATP102)'
+  },
+  '13': {
+    '0': 'WRL300 (Bluetooth Relay)'
+  }
+}
+
+/*
+  Possible Beacon ID Models
+*/
+const beaconModels = {
+  '0': 'WKF300',
+  '1': 'iBeacon E6',
+  '2': 'ID ELA',
+  '4': 'WID310'
+}
+
+/*
+  Possible Beacon Types
+*/
+const beaconTypes = {
+  '0': 'ID',
+  '1': 'iBeacon',
+  '2': 'Eddystone'
+}
+
+/*
+  Possible Driving Time Related States
+*/
+const dTimeStates = {
+  0: 'Sin límites alcanzados',
+  1: 'Conducción sobre 4 horas y 15 minutos',
+  2: 'Conducción sobre 4 horas y 30 minutos',
+  3: 'Conducción sobre 8 horas y 45 minutos',
+  4: 'Conducción sobre 9 horas',
+  5: 'Conducción sobre 15 horas y 45 minutos (con descanso menor a 8 horas en las últimas 24 horas)',
+  6: 'Conducción sobre 16 horas',
+  7: 'Otro límite'
+}
+
+/*
+  Possible Driving Working States
+*/
+const dWorkingStates = {
+  0: 'Normal',
+  1: 'En descanso - Durmiendo',
+  2: 'Conductor disponible - Descanso corto',
+  3: 'Conduciendo - En el volante'
+}
+
+/*
+  Possible port N Types for AU100
+*/
+const portNTypes = {
+  '0': 'Deshabilitado',
+  '1': 'RS232',
+  '3': '1-wire'
 }
 
 /*
@@ -112,6 +262,18 @@ const getProtocolVersion = protocol => {
   }
 }
 
+/*
+  Gets the software/hardware version
+*/
+const getVersion = hexVersion => {
+  if (hexVersion === '') {
+    return 'no disponible'
+  }
+  const X = parseInt(hexVersion.substring(0, 2), 16)
+  const Y = parseInt(hexVersion.substring(2, 4), 16)
+  return `${X}.${Y}`
+}
+
 /*
   Checks if the location has a valid gps position
 */
@@ -123,6 +285,14 @@ const checkGps = (lng, lat) => {
   return false
 }
 
+/*
+  Returns if the number of satellites is
+  included in the report
+*/
+const includeSatellites = positionAppendMask => {
+  return positionAppendMask === '01'
+}
+
 /*
   Gets the temperature from AC100 device in celcious degrees
 */
@@ -138,6 +308,24 @@ const getTempInCelciousDegrees = hexTemp => {
   return parseFloat(hex2dec(hexTemp)) * 0.0625
 }
 
+/*
+  Gets the Two's Complement for hex numbers
+*/
+const getAccelerationMagnitude = (hexNumber, n) => {
+  let binNumber = nHexDigit(hex2bin(hexNumber), n * 4)
+  if (binNumber.substring(0, 5) !== '11111') {
+    return Number((parseInt(hexNumber, 16) / 82 * 9.80665).toFixed(2))
+  }
+  return Number(
+    (
+      (parseInt('F'.repeat(n), 16) - parseInt(hexNumber, 16) + 1) *
+      -1 /
+      82 *
+      9.80665
+    ).toFixed(2)
+  )
+}
+
 /*
   Gets fuel consumption from string
 */
@@ -172,6 +360,53 @@ const getHoursForHourmeter = hourmeter => {
   }
 }
 
+/*
+  Returns the dBm signal strength
+*/
+const getSignalStrength = (networkType, value) => {
+  if (value === 99) {
+    return null
+  }
+
+  let calc, dBm
+  if (networkType === '2G' || networkType === '3G') {
+    calc = 2 * value - 113
+    dBm = calc < -113 ? 0 : calc > -51 ? 100 : calc
+  } else if (networkType === '4G') {
+    calc = 96 / 97 * value - 140
+    dBm = calc < -140 ? 0 : calc > -44 ? 100 : calc
+  } else if (networkType === 'GSM') {
+    calc = value - 110
+    dBm = calc < -110 ? 0 : calc > -47 ? 100 : calc
+  } else {
+    dBm = null
+  }
+
+  return dBm
+}
+
+/*
+  Returns the percentage of signal strength
+*/
+const getSignalPercentage = (networkType, value) => {
+  if (value === 99) {
+    return null
+  }
+
+  let perc
+  if (networkType === '2G' || networkType === '3G') {
+    perc = value / 31 * 100
+  } else if (networkType === '4G') {
+    perc = value / 97 * 100
+  } else if (networkType === 'GSM') {
+    perc = value / 63 * 100
+  } else {
+    perc = null
+  }
+
+  return Math.round((perc + Number.EPSILON) * 100) / 100
+}
+
 /*
   Gets the alarm type
 */
@@ -208,6 +443,13 @@ const getAlarm = (command, report, extra = false) => {
     }
   } else if (command === 'GTOPN') {
     return { type: 'OBDII_Connected', status: true, message: messages[command] }
+  } else if (command === 'GTAUR') {
+    return {
+      id: report[0] !== '' ? parseInt(report[0]) : null,
+      type: portNTypes[report[1]],
+      status: report[2] === '0',
+      message: messages[command]
+    }
   } else if (command === 'GTOPF') {
     return {
       type: 'OBDII_Connected',
@@ -229,7 +471,9 @@ const getAlarm = (command, report, extra = false) => {
     if (extra === true && reportID === 1) {
       reportID = 2
     } else if (
-      ['gv800w', 'gv600w', 'gv300w', 'gv75w', 'GMT100'].includes(extra)
+      ['gv800w', 'gv600w', 'gv300w', 'gv310lau', 'gv75w', 'GMT100'].includes(
+        extra
+      )
     ) {
       reportID += 1
     }
@@ -237,7 +481,7 @@ const getAlarm = (command, report, extra = false) => {
       type: 'DI',
       number: reportID,
       status: reportType === 1,
-      message: messages[command][reportType].replace('port', reportID)
+      message: messages[command][reportType].replace('id',reportID)
     }
   } else if (command === 'GTNMR') {
     const reportType = report[1]
@@ -266,6 +510,27 @@ const getAlarm = (command, report, extra = false) => {
       status: reportType === 0,
       message: messages[command][reportType === 0 ? '1' : '0']
     }
+  } else if (command === 'GTVGL') {
+    let reportID = parseInt(report[0], 16)
+    const reportType = parseInt(report[1], 16)
+    if (reportID === 1) {
+      reportID = 'por seYansor de movimiento'
+    } else if (reportID === 2) {
+      reportID = 'por voltaje de batería'
+    } else if (reportID === 4) {
+      reportID = 'por acelerómetro'
+    } else if (reportID === 7) {
+      reportID = 'por metodología combinada'
+    } else {
+      reportID = ''
+    }
+    return {
+      type: 'DI',
+      number: 1,
+      status: reportType === 0,
+      reason: reportID,
+      message: messages[command][reportType === 0 ? '1' : '0']
+    }
   } else if (command === 'GTIGN') {
     const duration = report !== '' ? parseInt(report, 10) : null
     return {
@@ -284,10 +549,34 @@ const getAlarm = (command, report, extra = false) => {
       duration: duration,
       message: messages[command]
     }
+  } else if (command === 'GTVGN') {
+    const duration = report[0] !== '' ? parseInt(report[0], 10) : null
+    return {
+      type: 'DI',
+      number: 1,
+      status: true,
+      duration: duration,
+      message: messages[command][report[1]]
+    }
+  } else if (command === 'GTVGF') {
+    const duration = report[0] !== '' ? parseInt(report[0], 10) : null
+    return {
+      type: 'DI',
+      number: 1,
+      status: false,
+      duration: duration,
+      message: messages[command][report[1]]
+    }
   } else if (command === 'GTPNA') {
     return { type: 'Power', status: true, message: messages[command] }
   } else if (command === 'GTPFA') {
     return { type: 'Power', status: false, message: messages[command] }
+  } else if (command === 'GTPNR' || command === 'GTPFR') {
+    return {
+      type: 'Power_Reason',
+      status: command === 'GTPNR',
+      message: messages[command][report]
+    }
   } else if (command === 'GTMPN' || command === 'GTEPN') {
     // Change for connected to power supply
     return { type: 'Charge', status: true, message: messages[command] }
@@ -333,6 +622,12 @@ const getAlarm = (command, report, extra = false) => {
     }
   } else if (command === 'GTEPS') {
     return { type: 'External_Low_battery', message: messages[command] }
+  } else if (command === 'GTSVR') {
+    return {
+      type: 'Stolen_Vehicle_Alarm',
+      status: report === '0',
+      message: messages[command][report]
+    }
   } else if (command === 'GTAIS' || command === 'GTMAI') {
     const reportID = parseInt(report[0], 10)
     const reportType = parseInt(report[1], 10)
@@ -370,6 +665,18 @@ const getAlarm = (command, report, extra = false) => {
     return { type: 'Motion_State_Changed', message: messages[command] }
   } else if (command === 'GTPDP') {
     return { type: 'GPRS_Connection_Established', message: messages[command] }
+  } else if (command === 'GTAVC') {
+    return {
+      type: 'Serial_Communication_Status',
+      status: report === '1',
+      message: messages[command][report]
+    }
+  } else if (command === 'GTCRG') {
+    return {
+      type: 'Crash_Information',
+      before: report === '0',
+      message: messages[command][report]
+    }
   } else if (command === 'GTGSS') {
     return {
       type: 'Gps_Status',
@@ -417,7 +724,16 @@ const getAlarm = (command, report, extra = false) => {
       type: 'DO',
       number: outputId,
       status: outputStatus === '1',
-      message: messages[command][outputStatus].replace('port', outputId)
+      message: messages[command][outputStatus]
+    }
+  } else if (command === 'GTDOM') {
+    const waveShape = report[0] !== '' ? parseInt(report[0]) : null
+    const outputId = report[1] !== '' ? parseInt(report[1]) : null
+    return {
+      type: 'DO',
+      number: outputId,
+      wave: waveShape,
+      message: messages[command]
     }
   } else if (command === 'GTDAT') {
     return {
@@ -428,7 +744,7 @@ const getAlarm = (command, report, extra = false) => {
   } else if (command === 'GTDTT') {
     return {
       type: 'Transparent_Data',
-      dataType: extra,
+      dataType: dataTypes[extra],
       data: report,
       message: messages[command]
     }
@@ -453,30 +769,137 @@ const getAlarm = (command, report, extra = false) => {
         4: acceleration turning
         5: unknown harsh behavior
       */
-    // const reportID = parseInt(report[0], 10)
+    let reportID = parseInt(report[0], 16)
+    let vel
+    if (reportID === 1) {
+      vel = 'baja'
+    } else if (reportID === 2) {
+      vel = 'media'
+    } else if (reportID === 3) {
+      vel = 'alta'
+    } else {
+      vel = ''
+    }
     const reportType = report[1]
     return {
       type: 'Harsh_Behavior',
       status: parseInt(reportType, 10),
+      velocity: vel !== '' ? vel : null,
       message: messages[command][reportType]
     }
+  } else if (command === 'GTHBE') {
+    /*
+      status:
+        0: braking
+        1: acceleration
+        2: turning
+        3: braking turning
+        4: acceleration turning
+        5: unknown harsh behavior
+      */
+    let x = getAccelerationMagnitude(extra[0].substring(0, 4), 4)
+    let y = getAccelerationMagnitude(extra[0].substring(4, 8), 4)
+    let z = getAccelerationMagnitude(extra[0].substring(8, 12), 4)
+    return {
+      type: 'Harsh_Behavior_Data',
+      calibration: report[0] === '2',
+      duration: extra[1],
+      magnitude: Number(
+        Math.sqrt(Math.pow(x, 2) + Math.pow(y, 2) + Math.pow(z, 2)).toFixed(2)
+      ).toString(),
+      message: messages[command][report[1]]
+    }
   } else if (command === 'GTCRA') {
     return {
       type: 'Crash',
       status: true,
-      counter: report,
+      counter: parseInt(report, 16),
+      message: messages[command]
+    }
+  } else if (command === 'GTCRD') {
+    return {
+      type: '3Axis_Information  ',
+      message: messages[command]
+    }
+  } else if (command === 'GTACC') {
+    return {
+      type: 'Accelerometer_Info',
       message: messages[command]
     }
+  } else if (command === 'GTDOG') {
+    /*
+      status:
+        1: Reboot for time based working mode
+        2: Reboot for ignition on workinkg mode
+        3: Input triggered reboot
+        4: GSM watchdog reboot
+        5: GPRS watchdog reboot
+        6: Reboot because of fail in sending message
+      */
+    // const reportID = parseInt(report[0], 10)
+    const reportType = report[1]
+    return {
+      type: 'Watchdog_Protocol',
+      status: parseInt(reportType, 10),
+      message: messages[command][reportType]
+    }
   } else if (command === 'GTGEO') {
     return {
       type: 'Device_Geofence'
     }
-  } else if (command === 'GTALC' || command === 'GTALM') {
+  } else if (
+    command === 'GTALC' ||
+    command === 'GTALM' ||
+    command === 'GTALS'
+  ) {
     return {
       type: command,
       status: 'CONFIG',
       message: report
     }
+  } else if (command === 'GTCID') {
+    return {
+      type: command,
+      status: 'CONFIG',
+      message: messages[command].replace('data', report)
+    }
+  } else if (command === 'GTLBA') {
+    let type = report[0]
+    let serial = report[1]
+    return {
+      type: command,
+      status: 'BT_Low_Battery',
+      serialNumber: serial !== '' ? parseInt(serial, 16) : null,
+      message: messages[command][type]
+    }
+  } else if (command === 'GTCSQ') {
+    return {
+      type: command,
+      status: 'CONFIG',
+      // message: messages[command].replace(
+      //   'data',
+      //   report !== '' ? 100 * parseInt(parseFloat(report) / 7, 10) : '--'
+      // )
+    }
+  } else if (command === 'GTVER') {
+    return {
+      type: command,
+      status: 'CONFIG',
+      firmware: {raw: report[0], value: parseFloat(getVersion(report[0]))},
+      hardware: {raw: report[1], value: parseFloat(getVersion(report[1]))},
+      message: messages[command]
+        .replace('data0', getVersion(report[0]))
+        .replace('data1', getVersion(report[1]))
+    }
+  } else if (command === 'GTBCS') {
+    return { type: 'Bluetooth_Connected', message: messages[command] }
+  } else if (command === 'GTBDS') {
+    return { type: 'Bluetooth_Disonnected', message: messages[command] }
+  } else if (command === 'GTBAA') {
+    return {
+      type: 'Bluetooth_Alarm',
+      message: messages[command][report]
+    }
   } else {
     return {
       type: command,
@@ -565,6 +988,18 @@ const nHexDigit = (num, n) => {
   return hex
 }
 
+/*
+  Return the sum of ones in hexadecimal number
+*/
+const sumOnes = num => {
+  let sum = 0
+  let hex = hex2bin(num)
+  for (let i = 0; i < hex.length; i++) {
+    sum += parseInt(hex[i])
+  }
+  return sum
+}
+
 /*
   Parses date
 */
@@ -583,12 +1018,27 @@ module.exports = {
   OBDIIProtocols: OBDIIProtocols,
   states: states,
   uartDeviceTypes: uartDeviceTypes,
+  networkTypes: networkTypes,
+  externalGPSAntennaOptions: externalGPSAntennaOptions,
+  peerRoles: peerRoles,
+  peerAddressesTypes: peerAddressesTypes,
+  disconnectionReasons: disconnectionReasons,
+  bluetoothAccessories: bluetoothAccessories,
+  bluetoothModels: bluetoothModels,
+  beaconModels: beaconModels,
+  beaconTypes: beaconTypes,
+  dTimeStates: dTimeStates,
+  dWorkingStates: dWorkingStates,
   getDevice: getDevice,
   getProtocolVersion: getProtocolVersion,
   checkGps: checkGps,
+  includeSatellites: includeSatellites,
+  getAccelerationMagnitude: getAccelerationMagnitude,
   getTempInCelciousDegrees: getTempInCelciousDegrees,
   getFuelConsumption: getFuelConsumption,
   getHoursForHourmeter: getHoursForHourmeter,
+  getSignalStrength: getSignalStrength,
+  getSignalPercentage: getSignalPercentage,
   getAlarm: getAlarm,
   bin2dec: bin2dec,
   bin2hex: bin2hex,
@@ -597,5 +1047,6 @@ module.exports = {
   hex2bin: hex2bin,
   hex2dec: hex2dec,
   nHexDigit: nHexDigit,
+  sumOnes: sumOnes,
   parseDate: parseDate
 }