Engine

Table of Contents

getState([, propertyNames])

Declaration

hmkit.commands.Engine.getState()

Parameters

propertyNames

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

Returns

EngineResponse

Example

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

EngineResponse

Parameters

limpMode(Object)
data.value

(String) (enum) Indicates wheter the engine is in fail-safe mode.

timestamp

(Date)

preconditioningActive(Object)
data.value

(String) (enum) Pre-conditioning is running.

timestamp

(Date)

preconditioningEnabled(Object)
data.value

(String) (enum) Use of the engine pre-conditioning is enabled.

timestamp

(Date)

preconditioningError(Object)
data.value

(String) (enum) Reason for not carrying out pre-conditioning.

timestamp

(Date)

preconditioningRemainingTime(Object)
data.value

(Number) (duration) Remaining time of pre-conditioning.

timestamp

(Date)

preconditioningStatus(Object)
data.value

(String) (enum) Status of the pre-conditioning system.

timestamp

(Date)

startStopEnabled(Object)
data.value

(String) (enum) Indicates if the automatic start-stop system is enabled or not

timestamp

(Date)

startStopState(Object)
data.value

(String) (enum) Indicates wheter the start-stop system is currently active or not

timestamp

(Date)

status(Object)
data.value

(String) (enum)

timestamp

(Date)

Example

{
  "limpMode": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "inactive"
    }
  },
  "preconditioningActive": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "active"
    }
  },
  "preconditioningEnabled": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "enabled"
    }
  },
  "preconditioningError": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "low_fuel"
    }
  },
  "preconditioningRemainingTime": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 15.5,
      "unit": "minutes"
    }
  },
  "preconditioningStatus": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "standby"
    }
  },
  "startStopEnabled": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "enabled"
    }
  },
  "startStopState": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "active"
    }
  },
  "status": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "off"
    }
  }
}

getAvailability([, propertyNames])

Declaration

hmkit.commands.Engine.getAvailability()

Parameters

propertyNames

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

Example

// Get availability for all properties
hmkit.telematics.sendCommand(
  hmkit.commands.Engine.getAvailability(),
  accessCertificate
);
// Get availability for specific properties
hmkit.telematics.sendCommand(
  hmkit.commands.Engine.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"
      }
    }
  }
}

enableDisableStartStop({ startStopEnabled })

Parameters

startStopEnabled

(String) (enum) Indicates if the automatic start-stop system is enabled or not

Example

hmkit.telematics.sendCommand(
  hmkit.commands.Engine.enableDisableStartStop({
    "startStopEnabled": "enabled"
  }),
  accessCertificate
);

turnEngineOnOff({ status })

Parameters

status

(String) (enum)

Example

hmkit.telematics.sendCommand(
  hmkit.commands.Engine.turnEngineOnOff({
    "status": "off"
  }),
  accessCertificate
);