Tenix Open Data Platform API - MQTT v1

Schema Documentation

Operations

  • SEND tenix/vehicle/todp/{companyId}/{internalNumber}/telemetry

    Vehicle Telemetry Channel

    Get Vehicle Telemetry messages

    Operation IDgetVehicleTelemetry
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    A Vehicle internal number

      Examples values:
    • "2255"
    • "2067"

    Accepts the following message:

    A Vehicle Telemetry message

    A Vehicle Telemetry message

    object

    Examples

  • RECEIVE tenix/vehicle/{companyId}/todp/{internalNumber}/telemetry

    Vehicle Telemetry Channel

    Publish Vehicle Telemetry messages

    Operation IDpublishVehicleTelemetry
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    A Vehicle internal number

      Examples values:
    • "2255"
    • "2067"

    Accepts the following message:

    A Vehicle Telemetry message

    A Vehicle Telemetry message

    object

    Examples

  • SEND tenix/charge/todp/{companyId}/{depotId}/{chargerId}/{connectorId}/session

    Charger State Topic

    Receive Charger State messages

    Operation IDgetChargingSessionState
    object
    required
    string

    The unique identifier of the Company.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    required
    string

    The unique identifier of the Depot.

      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
    chargerId
    required
    string

    The unique identifier of the charger.

    connectorId
    required
    number

    The unique identifier of the connector.

    Accepts the following message:

    Charging Session State

    A message providing the complete state of a charging session.

    object

    Examples

Messages

  • #1A Vehicle Telemetry messagetelemetry

    A Vehicle Telemetry message

    Message IDtelemetry
    object
  • #2Charging Session StatechargingSessionState

    A message providing the complete state of a charging session.

    Message IDchargingSessionState
    object

Schemas

  • string
      Examples values:
    • "1877c37hcebb4c4f808628d99d7bs0df"
    • "4577c37hc4f808d28d99d7bsadfsebb4"
  • vin
    string
      Examples values:
    • "2GBE4C3126H66WC5A"
    • "KM8SGDKB3A847RKMX"
    • "5Y2SN65L661921TVB"
  • string
      Examples values:
    • "2255"
    • "2067"
  • bmsId
    string
      Examples values:
    • "FD43DE0DC4B6"
    • "51BEF9F0EFAE"
    • "A2987A5E09D0"
  • timestamp
    string
    format: date-time
      Examples values:
    • "2023-06-30T00:00:00.000Z"
  • object
  • object
  • object
  • object
  • object
  • object
  • chargingSessionStatus
    string
      Allowed values:
    • "PENDING"
    • "ACTIVE"
    • "COMPLETED"
    • "FAULTED"
  • object
  • object