Firmware Version

getFirmwareVersion([, propertyNames])

Declaration

hmkit.commands.FirmwareVersion.getFirmwareVersion()

Parameters

propertyNames

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

Returns

FirmwareVersionResponse

Example

hmkit.telematics.sendCommand(
  hmkit.commands.FirmwareVersion.getFirmwareVersion(),
  accessCertificate
);

FirmwareVersionResponse

Parameters

hmKitVersion(Object)
data.value

(Object) HMKit version

timestamp

(Date)

hmKitBuildName(Object)
data.value

(String) HMKit version build name

timestamp

(Date)

applicationVersion(Object)
data.value

(String) Application version

timestamp

(Date)

Example

{
  "hmKitVersion": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "major": {
        "value": 1
      },
      "minor": {
        "value": 15
      },
      "patch": {
        "value": 33
      }
    }
  },
  "hmKitBuildName": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "btstack-uart"
    }
  },
  "applicationVersion": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "v1.5-prod"
    }
  }
}

getAvailability([, propertyNames])

Declaration

hmkit.commands.FirmwareVersion.getAvailability()

Parameters

propertyNames

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

Example

// Get availability for all properties
hmkit.telematics.sendCommand(
  hmkit.commands.FirmwareVersion.getAvailability(),
  accessCertificate
);
// Get availability for specific properties
hmkit.telematics.sendCommand(
  hmkit.commands.FirmwareVersion.getAvailability(['hmkit_version']),
  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

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