Windscreen

getState([, propertyNames])

Declaration

hmkit.commands.Windscreen.getState()

Parameters

propertyNames

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

Returns

WindscreenResponse

Example

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

WindscreenResponse

Parameters

wipersStatus(Object)
data.value

(String) (enum)

timestamp

(Date)

wipersIntensity(Object)
data.value

(String) (enum)

timestamp

(Date)

windscreenDamage(Object)
data.value

(String) (enum)

timestamp

(Date)

windscreenZoneMatrix(Object)
data.value

(Object) Representing the size of the matrix, seen from the inside of the vehicle

timestamp

(Date)

windscreenDamageZone(Object)
data.value

(Object) Representing the position in the zone, seen from the inside of the vehicle (1-based index)

timestamp

(Date)

windscreenNeedsReplacement(Object)
data.value

(String) (enum)

timestamp

(Date)

windscreenDamageConfidence(Object)
data.value

(Number) (double) Confidence of damage detection, 0% if no impact detected

timestamp

(Date)

windscreenDamageDetectionTime(Object)
data.value

(Date) (timestamp) Windscreen damage detection date

timestamp

(Date)

Example

{
  "wipersStatus": {
    "timestamp": "2020-12-21T15:48:04.887Z",
    "data": {
      "value": {
        "value": "automatic"
      }
    }
  },
  "wipersIntensity": {
    "timestamp": "2020-12-21T15:48:04.887Z",
    "data": {
      "value": {
        "value": "level_3"
      }
    }
  },
  "windscreenDamage": {
    "timestamp": "2020-12-21T15:48:04.887Z",
    "data": {
      "value": {
        "value": "impact_but_no_damage_detected"
      }
    }
  },
  "windscreenZoneMatrix": {
    "timestamp": "2020-12-21T15:48:04.887Z",
    "data": {
      "value": {
        "horizontal": {
          "value": 4
        },
        "vertical": {
          "value": 3
        }
      }
    }
  },
  "windscreenDamageZone": {
    "timestamp": "2020-12-21T15:48:04.887Z",
    "data": {
      "value": {
        "horizontal": {
          "value": 1
        },
        "vertical": {
          "value": 2
        }
      }
    }
  },
  "windscreenNeedsReplacement": {
    "timestamp": "2020-12-21T15:48:04.887Z",
    "data": {
      "value": {
        "value": "no_replacement_needed"
      }
    }
  },
  "windscreenDamageConfidence": {
    "timestamp": "2020-12-21T15:48:04.887Z",
    "data": {
      "value": {
        "value": 0.95
      }
    }
  },
  "windscreenDamageDetectionTime": {
    "timestamp": "2020-12-21T15:48:04.887Z",
    "data": {
      "value": {
        "value": "2017-01-10T16:32:05.000Z"
      }
    }
  }
}

getAvailability([, propertyNames])

Declaration

hmkit.commands.Windscreen.getAvailability()

Parameters

propertyNames

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

Example

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

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

setWindscreenDamage({ windscreenDamage, windscreenDamageZone })

Parameters

windscreenDamage

(String) (enum)

windscreenDamageZone

(Object) Representing the position in the zone, seen from the inside of the vehicle (1-based index)

Example

hmkit.telematics.sendCommand(
  hmkit.commands.Windscreen.setWindscreenDamage({
    "windscreenDamage": "impact_but_no_damage_detected",
    "windscreenDamageZone": {
      "horizontal": 1,
      "vertical": 2
    }
  }),
  accessCertificate
);

setWindscreenReplacementNeeded({ windscreenNeedsReplacement })

Parameters

windscreenNeedsReplacement

(String) (enum)

Example

hmkit.telematics.sendCommand(
  hmkit.commands.Windscreen.setWindscreenReplacementNeeded({
    "windscreenNeedsReplacement": "no_replacement_needed"
  }),
  accessCertificate
);

controlWipers({ wipersStatus, wipersIntensity })

Parameters

wipersStatus

(String) (enum)

wipersIntensity

(String) (enum)

Example

hmkit.telematics.sendCommand(
  hmkit.commands.Windscreen.controlWipers({
    "wipersStatus": "automatic",
    "wipersIntensity": "level_3"
  }),
  accessCertificate
);