ADAS

getState([, propertyNames])

Declaration

hmkit.commands.Adas.getState()

Parameters

propertyNames

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

Returns

AdasResponse

Example

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

AdasResponse

Parameters

status(Object)
data.value

(String) (enum) Indicates whether the driver assistance system is active or not.

timestamp

(Date)

alertnessSystemStatus(Object)
data.value

(String) (enum) Indicates if the driver alertness warning is active or inactive.

timestamp

(Date)

forwardCollisionWarningSystem(Object)
data.value

(String) (enum) Indicates whether the forward collision warning system is active or inactive.

timestamp

(Date)

blindSpotWarningState(Object)
data.value

(String) (enum) Indicates whether the blind spot warning system is active or not.

timestamp

(Date)

blindSpotWarningSystemCoverage(Object)
data.value

(String) (enum) Blind spot warning system coverage.

timestamp

(Date)

rearCrossWarningSystem(Object)
data.value

(String) (enum) Indicates whether the rear cross warning system is active or not.

timestamp

(Date)

automatedParkingBrake(Object)
data.value

(String) (enum) Automatic brake state

timestamp

(Date)

laneKeepAssistSystem(Object)
data.value

(String) (enum) Indicates if the lane keep assist system is turned on or not.

timestamp

(Date)

laneKeepAssistsStates(Object)
data.value

(Array) Lane keeping assist state indicating the vehicle is actively controlling the wheels.

timestamp

(Date)

parkAssists(Object)
data.value

(Array) If the alarm is active and the driver has muted or not park assists.

timestamp

(Date)

blindSpotWarningSystem(Object)
data.value

(String) (enum) Indicates whether the blind spot warning system is turned on or not.

timestamp

(Date)

Example

{
  "status": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "on"
    }
  },
  "alertnessSystemStatus": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "active"
    }
  },
  "forwardCollisionWarningSystem": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "active"
    }
  },
  "blindSpotWarningState": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "active"
    }
  },
  "blindSpotWarningSystemCoverage": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "regular"
    }
  },
  "rearCrossWarningSystem": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "active"
    }
  },
  "automatedParkingBrake": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "active"
    }
  },
  "laneKeepAssistSystem": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "on"
    }
  },
  "laneKeepAssistsStates": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "left"
        },
        "state": {
          "value": "inactive"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "right"
        },
        "state": {
          "value": "active"
        }
      }
    }
  ],
  "parkAssists": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "front"
        },
        "alarm": {
          "value": "inactive"
        },
        "muted": {
          "value": "not_muted"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "location": {
          "value": "rear"
        },
        "alarm": {
          "value": "active"
        },
        "muted": {
          "value": "not_muted"
        }
      }
    }
  ],
  "blindSpotWarningSystem": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "on"
    }
  }
}

getAvailability([, propertyNames])

Declaration

hmkit.commands.Adas.getAvailability()

Parameters

propertyNames

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

Example

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

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