Diagnostics

getState([, propertyNames])

Declaration

hmkit.commands.Diagnostics.getState()

Parameters

propertyNames

(optional) Array of names of the properties you want returned.

Returns

DiagnosticsResponse

Example

hmkit.telematics.sendCommand(
  hmkit.commands.Diagnostics.getState(),
  accessCertificate
);

DiagnosticsResponse

Parameters

engineOilTemperature(Object)
data.value

(Number) (temperature) Engine oil temperature

timestamp

(Date)

speed(Object)
data.value

(Number) (speed) The vehicle speed

timestamp

(Date)

engineRPM(Object)
data.value

(Number) (angular_velocity) Engine RPM (revolutions per minute)

timestamp

(Date)

fuelLevel(Object)
data.value

(Number) (double) Fuel level percentage between 0.0-1.0

timestamp

(Date)

estimatedRange(Object)
data.value

(Number) (length) Estimated range (with combustion engine)

timestamp

(Date)

washerFluidLevel(Object)
data.value

(String) (enum)

timestamp

(Date)

batteryVoltage(Object)
data.value

(Number) (electric_potential_difference) Battery voltage

timestamp

(Date)

adBlueLevel(Object)
data.value

(Number) (double) AdBlue level percentage between 0.0-1.0

timestamp

(Date)

distanceSinceReset(Object)
data.value

(Number) (length) The distance driven since reset

timestamp

(Date)

distanceSinceStart(Object)
data.value

(Number) (length) The distance driven since trip start

timestamp

(Date)

fuelVolume(Object)
data.value

(Number) (volume) The fuel volume measured in liters

timestamp

(Date)

antiLockBraking(Object)
data.value

(String) (enum)

timestamp

(Date)

engineCoolantTemperature(Object)
data.value

(Number) (temperature) Engine coolant temperature

timestamp

(Date)

engineTotalFuelConsumption(Object)
data.value

(Number) (volume) The accumulated lifespan fuel consumption

timestamp

(Date)

brakeFluidLevel(Object)
data.value

(String) (enum)

timestamp

(Date)

engineTorque(Object)
data.value

(Number) (double) Current engine torque percentage between 0.0-1.0

timestamp

(Date)

engineLoad(Object)
data.value

(Number) (double) Current engine load percentage between 0.0-1.0

timestamp

(Date)

wheelBasedSpeed(Object)
data.value

(Number) (speed) The vehicle speed measured at the wheel base

timestamp

(Date)

batteryLevel(Object)
data.value

(Number) (double) Battery level in %, value between 0.0 and 1.0

timestamp

(Date)

checkControlMessages(Object)
data.value

(Array)

timestamp

(Date)

tirePressures(Object)
data.value

(Array)

timestamp

(Date)

tireTemperatures(Object)
data.value

(Array)

timestamp

(Date)

wheelRPMs(Object)
data.value

(Array)

timestamp

(Date)

troubleCodes(Object)
data.value

(Array)

timestamp

(Date)

odometer(Object)
data.value

(Number) (length) The vehicle odometer value in a given units

timestamp

(Date)

engineTotalOperatingTime(Object)
data.value

(Number) (duration) The accumulated time of engine operation

timestamp

(Date)

tirePressureStatuses(Object)
data.value

(Array)

timestamp

(Date)

brakeLiningWearPreWarning(Object)
data.value

(String) (enum) Status of brake lining wear pre-warning

timestamp

(Date)

engineOilLifeRemaining(Object)
data.value

(Number) (double) Remaining life of engine oil which decreases over time

timestamp

(Date)

oemTroubleCodeValues(Object)
data.value

(Array) Additional OEM trouble codes

timestamp

(Date)

dieselExhaustFluidRange(Object)
data.value

(Number) (length) Distance remaining until diesel exhaust fluid is empty

timestamp

(Date)

dieselParticulateFilterSootLevel(Object)
data.value

(Number) (double) Level of soot in diesel exhaust particulate filter

timestamp

(Date)

confirmedTroubleCodes(Object)
data.value

(Array)

timestamp

(Date)

dieselExhaustFilterStatus(Object)
data.value

(Array)

timestamp

(Date)

engineTotalIdleOperatingTime(Object)
data.value

(Number) (duration) The accumulated time of engine operation

timestamp

(Date)

engineOilAmount(Object)
data.value

(Number) (volume) The current estimated oil tank liquid fill.

timestamp

(Date)

engineOilLevel(Object)
data.value

(Number) (double) The current estimated oil tank liquid fill in percentage.

timestamp

(Date)

estimatedSecondaryPowertrainRange(Object)
data.value

(Number) (length) Estimated secondary powertrain range

timestamp

(Date)

fuelLevelAccuracy(Object)
data.value

(String) (enum) This value includes the information, if the fuel level has been calculated or measured.

timestamp

(Date)

tirePressuresTargets(Object)
data.value

(Array) Target tire pressures for the vehicle.

timestamp

(Date)

tirePressuresDifferences(Object)
data.value

(Array) Tire pressures difference from the target pressure.

timestamp

(Date)

backupBatteryRemainingTime(Object)
data.value

(Number) (duration) Remaining time the backup battery can work.

timestamp

(Date)

engineCoolantFluidLevel(Object)
data.value

(String) (enum) Engine coolant fluid level

timestamp

(Date)

engineOilFluidLevel(Object)
data.value

(String) (enum) Engine oil fluid level

timestamp

(Date)

engineOilPressureLevel(Object)
data.value

(String) (enum) Engine oil pressure level

timestamp

(Date)

engineTimeToNextService(Object)
data.value

(Number) (duration) Engine time until next service of the vehicle

timestamp

(Date)

lowVoltageBatteryChargeLevel(Object)
data.value

(String) (enum) Indicates if the charge level of the low voltage battery is too low to use other systems

timestamp

(Date)

Example

{
  "engineOilTemperature": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 99.5,
      "unit": "celsius"
    }
  },
  "speed": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 60,
      "unit": "kilometers_per_hour"
    }
  },
  "engineRPM": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 2500,
      "unit": "revolutions_per_minute"
    }
  },
  "fuelLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 0.9
    }
  },
  "estimatedRange": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 265,
      "unit": "kilometers"
    }
  },
  "washerFluidLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "filled"
    }
  },
  "batteryVoltage": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 12.1,
      "unit": "volts"
    }
  },
  "adBlueLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 0.9
    }
  },
  "distanceSinceReset": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 1500.1,
      "unit": "kilometers"
    }
  },
  "distanceSinceStart": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 12.4,
      "unit": "kilometers"
    }
  },
  "fuelVolume": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 35.5,
      "unit": "liters"
    }
  },
  "antiLockBraking": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "active"
    }
  },
  "engineCoolantTemperature": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 20,
      "unit": "celsius"
    }
  },
  "engineTotalFuelConsumption": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 27587,
      "unit": "liters"
    }
  },
  "brakeFluidLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "low"
    }
  },
  "engineTorque": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 0.2
    }
  },
  "engineLoad": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 0.1
    }
  },
  "wheelBasedSpeed": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 65,
      "unit": "kilometers_per_hour"
    }
  },
  "batteryLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 0.56
    }
  },
  "checkControlMessages": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "ID": {
          "value": 1
        },
        "remainingTime": {
          "value": 105592,
          "unit": "minutes"
        },
        "text": {
          "value": "Check engine"
        },
        "status": {
          "value": "Alert"
        }
      }
    }
  ],
  "tirePressures": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_left"
        },
        "pressure": {
          "value": 2.31,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_right"
        },
        "pressure": {
          "value": 2.31,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right"
        },
        "pressure": {
          "value": 2.24,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left"
        },
        "pressure": {
          "value": 2.24,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right_outer"
        },
        "pressure": {
          "value": 2.25,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left_outer"
        },
        "pressure": {
          "value": 2.25,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "spare"
        },
        "pressure": {
          "value": 2.25,
          "unit": "bars"
        }
      }
    }
  ],
  "tireTemperatures": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_left"
        },
        "temperature": {
          "value": 40.1,
          "unit": "celsius"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_right"
        },
        "temperature": {
          "value": 40.2,
          "unit": "celsius"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right"
        },
        "temperature": {
          "value": 40.3,
          "unit": "celsius"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left"
        },
        "temperature": {
          "value": 40.4,
          "unit": "celsius"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right_outer"
        },
        "temperature": {
          "value": 40.5,
          "unit": "celsius"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left_outer"
        },
        "temperature": {
          "value": 40.6,
          "unit": "celsius"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "spare"
        },
        "temperature": {
          "value": 10.2,
          "unit": "celsius"
        }
      }
    }
  ],
  "wheelRPMs": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_left"
        },
        "RPM": {
          "value": 737,
          "unit": "revolutions_per_minute"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_right"
        },
        "RPM": {
          "value": 747,
          "unit": "revolutions_per_minute"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right"
        },
        "RPM": {
          "value": 777,
          "unit": "revolutions_per_minute"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left"
        },
        "RPM": {
          "value": 787,
          "unit": "revolutions_per_minute"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right_outer"
        },
        "RPM": {
          "value": 797,
          "unit": "revolutions_per_minute"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left_outer"
        },
        "RPM": {
          "value": 807,
          "unit": "revolutions_per_minute"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "spare"
        },
        "RPM": {
          "value": 0,
          "unit": "revolutions_per_minute"
        }
      }
    }
  ],
  "troubleCodes": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "occurrences": {
          "value": 2
        },
        "ID": {
          "value": "C1116FA"
        },
        "ecuID": {
          "value": "RDU_212FR"
        },
        "status": {
          "value": "PENDING"
        },
        "system": {
          "value": "unknown"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "occurrences": {
          "value": 2
        },
        "ID": {
          "value": "C163AFA"
        },
        "ecuID": {
          "value": "DTR212"
        },
        "status": {
          "value": "PENDING"
        },
        "system": {
          "value": "body"
        }
      }
    }
  ],
  "odometer": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 2050,
      "unit": "kilometers"
    }
  },
  "engineTotalOperatingTime": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 1500.65,
      "unit": "hours"
    }
  },
  "tirePressureStatuses": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_left"
        },
        "status": {
          "value": "normal"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_right"
        },
        "status": {
          "value": "low"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right"
        },
        "status": {
          "value": "alert"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left"
        },
        "status": {
          "value": "normal"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right_outer"
        },
        "status": {
          "value": "normal"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left_outer"
        },
        "status": {
          "value": "normal"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "spare"
        },
        "status": {
          "value": "normal"
        }
      }
    }
  ],
  "brakeLiningWearPreWarning": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "inactive"
    }
  },
  "engineOilLifeRemaining": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 0.88
    }
  },
  "oemTroubleCodeValues": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "ID": {
          "value": "123ID"
        },
        "keyValue": {
          "key": {
            "value": "some_error"
          },
          "value": {
            "value": "some_value"
          }
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "ID": {
          "value": "1B3C"
        },
        "keyValue": {
          "key": {
            "value": "important_error"
          },
          "value": {
            "value": "system fault 32"
          }
        }
      }
    }
  ],
  "dieselExhaustFluidRange": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 2233,
      "unit": "kilometers"
    }
  },
  "dieselParticulateFilterSootLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 0.16
    }
  },
  "confirmedTroubleCodes": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "ID": {
          "value": "801C10"
        },
        "ecuAddress": {
          "value": "16"
        },
        "ecuVariantName": {
          "value": "CAS"
        },
        "status": {
          "value": "ACTIVE"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "ID": {
          "value": "D52C44"
        },
        "ecuAddress": {
          "value": "48"
        },
        "ecuVariantName": {
          "value": "CAS"
        },
        "status": {
          "value": "ACTIVE"
        }
      }
    }
  ],
  "dieselExhaustFilterStatus": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "status": {
          "value": "unknown"
        },
        "component": {
          "value": "exhaust_filter"
        },
        "cleaning": {
          "value": "unknown"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "status": {
          "value": "normal_operation"
        },
        "component": {
          "value": "exhaust_filter"
        },
        "cleaning": {
          "value": "unknown"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "status": {
          "value": "overloaded"
        },
        "component": {
          "value": "exhaust_filter"
        },
        "cleaning": {
          "value": "unknown"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "status": {
          "value": "at_limit"
        },
        "component": {
          "value": "exhaust_filter"
        },
        "cleaning": {
          "value": "unknown"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "status": {
          "value": "over_limit"
        },
        "component": {
          "value": "exhaust_filter"
        },
        "cleaning": {
          "value": "unknown"
        }
      }
    }
  ],
  "engineTotalIdleOperatingTime": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 213.56,
      "unit": "hours"
    }
  },
  "engineOilAmount": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 3.5,
      "unit": "liters"
    }
  },
  "engineOilLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 0.8
    }
  },
  "estimatedSecondaryPowertrainRange": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 265,
      "unit": "kilometers"
    }
  },
  "fuelLevelAccuracy": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "measured"
    }
  },
  "tirePressuresTargets": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_left"
        },
        "pressure": {
          "value": 2.31,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_right"
        },
        "pressure": {
          "value": 2.31,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right"
        },
        "pressure": {
          "value": 2.24,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left"
        },
        "pressure": {
          "value": 2.24,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right_outer"
        },
        "pressure": {
          "value": 2.25,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left_outer"
        },
        "pressure": {
          "value": 2.25,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "spare"
        },
        "pressure": {
          "value": 2.25,
          "unit": "bars"
        }
      }
    }
  ],
  "tirePressuresDifferences": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_left"
        },
        "pressure": {
          "value": 0.1,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front_right"
        },
        "pressure": {
          "value": 0.1,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right"
        },
        "pressure": {
          "value": 0.1,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left"
        },
        "pressure": {
          "value": 0.1,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_right_outer"
        },
        "pressure": {
          "value": 0.1,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear_left_outer"
        },
        "pressure": {
          "value": 0.1,
          "unit": "bars"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "spare"
        },
        "pressure": {
          "value": 0.1,
          "unit": "bars"
        }
      }
    }
  ],
  "backupBatteryRemainingTime": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 15,
      "unit": "minutes"
    }
  },
  "engineCoolantFluidLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "high"
    }
  },
  "engineOilFluidLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "normal"
    }
  },
  "engineOilPressureLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "normal"
    }
  },
  "engineTimeToNextService": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 501,
      "unit": "hours"
    }
  },
  "lowVoltageBatteryChargeLevel": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "ok"
    }
  }
}

getAvailability([, propertyNames])

Declaration

hmkit.commands.Diagnostics.getAvailability()

Parameters

propertyNames

(optional) Array of names of the properties you want returned.

Example

// Get availability for all properties
hmkit.telematics.sendCommand(
  hmkit.commands.Diagnostics.getAvailability(),
  accessCertificate
);
// Get availability for specific properties
hmkit.telematics.sendCommand(
  hmkit.commands.Diagnostics.getAvailability(['engine_oil_temperature']),
  accessCertificate
);

Response

Parameters

availability(Object)
updateRate.value

(String) enum

rateLimit.value

(Number)

rateLimit.unit

(String)

appliesPer.value

(String)

Discussion

The response contains an availability object for each property, as shown in the example

Example

{
  "engine_oil_temperature": {
    "availability": {
      "updateRate": {
        "value": "trip_high"
      },
      "rateLimit": {
        "value": 64,
        "unit": "hertz"
      },
      "appliesPer": {
        "value": "vehicle"
      }
    }
  }
}