Chassis Settings

Table of Contents

getChassisSettings([, propertyNames])

Declaration

hmkit.commands.ChassisSettings.getChassisSettings()

Parameters

propertyNames

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

Returns

ChassisSettingsResponse

Example

hmkit.telematics.sendCommand(
  hmkit.commands.ChassisSettings.getChassisSettings(),
  accessCertificate
);

ChassisSettingsResponse

Parameters

currentChassisPosition(Object)
data.value

(Number) (length) The chassis position calculated from the lowest point

timestamp

(Date)

currentSpringRates(Object)
data.value

(Array) The current values for the spring rates

timestamp

(Date)

drivingMode(Object)
data.value

(String) (enum)

timestamp

(Date)

maximumChassisPosition(Object)
data.value

(Number) (length) The maximum possible value for the chassis position

timestamp

(Date)

maximumSpringRates(Object)
data.value

(Array) The maximum possible values for the spring rates

timestamp

(Date)

minimumChassisPosition(Object)
data.value

(Number) (length) The minimum possible value for the chassis position

timestamp

(Date)

minimumSpringRates(Object)
data.value

(Array) The minimum possible values for the spring rates

timestamp

(Date)

sportChrono(Object)
data.value

(String) (enum)

timestamp

(Date)

Example

{
  "currentChassisPosition": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 25.4,
      "unit": "millimeters"
    }
  },
  "currentSpringRates": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "axle": {
          "value": "front"
        },
        "springRate": {
          "value": 21,
          "unit": "newton_millimeters"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "axle": {
          "value": "rear"
        },
        "springRate": {
          "value": 23,
          "unit": "newton_millimeters"
        }
      }
    }
  ],
  "drivingMode": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "eco"
    }
  },
  "maximumChassisPosition": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": 55.5,
      "unit": "millimeters"
    }
  },
  "maximumSpringRates": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "axle": {
          "value": "front"
        },
        "springRate": {
          "value": 37,
          "unit": "newton_millimeters"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "axle": {
          "value": "rear"
        },
        "springRate": {
          "value": 39,
          "unit": "newton_millimeters"
        }
      }
    }
  ],
  "minimumChassisPosition": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": -28.4,
      "unit": "millimeters"
    }
  },
  "minimumSpringRates": [
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "axle": {
          "value": "front"
        },
        "springRate": {
          "value": 16,
          "unit": "newton_millimeters"
        }
      }
    },
    {
      "timestamp": "2021-06-01T15:48:04.887Z",
      "data": {
        "axle": {
          "value": "rear"
        },
        "springRate": {
          "value": 18,
          "unit": "newton_millimeters"
        }
      }
    }
  ],
  "sportChrono": {
    "timestamp": "2021-06-01T15:48:04.887Z",
    "data": {
      "value": "active"
    }
  }
}

getAvailability([, propertyNames])

Declaration

hmkit.commands.ChassisSettings.getAvailability()

Parameters

propertyNames

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

Example

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

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

setChassisPosition({ currentChassisPosition })

Parameters

currentChassisPosition

(Number) (length) The chassis position calculated from the lowest point

Example

hmkit.telematics.sendCommand(
  hmkit.commands.ChassisSettings.setChassisPosition({
    "currentChassisPosition": {
      "millimeters": 25.4
    }
  }),
  accessCertificate
);

setDrivingMode({ drivingMode })

Parameters

drivingMode

(String) (enum)

Example

hmkit.telematics.sendCommand(
  hmkit.commands.ChassisSettings.setDrivingMode({
    "drivingMode": "eco"
  }),
  accessCertificate
);

setSpringRates({ currentSpringRates })

Parameters

currentSpringRates

(Array) The current values for the spring rates

Example

hmkit.telematics.sendCommand(
  hmkit.commands.ChassisSettings.setSpringRates({
    "currentSpringRates": [
      {
        "axle": {
          "value": "front"
        },
        "springRate": {
          "value": 21,
          "unit": "newton_millimeters"
        }
      },
      {
        "axle": {
          "value": "rear"
        },
        "springRate": {
          "value": 23,
          "unit": "newton_millimeters"
        }
      }
    ]
  }),
  accessCertificate
);

startStopSportsChrono({ sportChrono })

Parameters

sportChrono

(String) (enum)

Example

hmkit.telematics.sendCommand(
  hmkit.commands.ChassisSettings.startStopSportsChrono({
    "sportChrono": "active"
  }),
  accessCertificate
);