High Mobility Push API 1.0.0

This document specifies the JSON format for each vehicle property that is made available through High Mobility's streaming and push interfaces.

Servers

  • sandbox.mqtt.high-mobility.com:{port}mqttsandbox

    Sandbox broker

    port
    required
    string

    Secure connection (TLS) is available through port 8883.

    Default value:"8883"
      Allowed values:
    • "8883"
    Security:
    • API key
      • In: user

      Provide your API key as the user and leave the password empty.

    • #instance:sandbox

  • mqtt.high-mobility.com:{port}mqttproduction

    Production broker

    port
    required
    string

    Secure connection (TLS) is available through port 8883.

    Default value:"8883"
      Allowed values:
    • "8883"
    Security:
    • API key
      • In: user

      Provide your API key as the user and leave the password empty.

    • #instance:live

Operations

  • SUB {instance}/{auto_api_level}/{app_id}/{vin}/wi_fi/{action}/{property}

    Operation IDlive
    instance
    required
    string
    uid: instance

    live/sandbox

      Allowed values:
    • "live"
    • "sandbox"
    auto_api_level
    required
    string
    uid: auto_api_level

    AutoAPI level

    Const:"level13"
    app_id
    required
    string
    uid: app_id

    Application id

    vin
    required
    string
    uid: vin

    VIN

    capability
    required
    string
    uid: capability

    Capability

    Const:"wi_fi"
    action
    required
    string
    uid: action

    Action

    Const:"get"
    property
    required
    string
    uid: property

    Property

    qos
    1

    Accepts one of the following messages:

    • #0Wi Fi Network Connected
      object
      uid: wi_fi_get_network_connected
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"wi_fi"
      property
      required
      string
      Const:"network_connected"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Network connected

      data
      required
      string

      Connection state

        Allowed values:
      • "disconnected"
      • "connected"
      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
  "version": 1,
  "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
  "vin": "VFXXXXXXXXXXXXXXX",
  "capability": "wi_fi",
  "property": "network_connected",
  "data": {
    "wi_fi": {
      "network_connected": {
        "data": "connected",
        "timestamp": "2019-08-24T14:15:22Z"
      }
    }
  }
}
      This example has been generated automatically.
    • #1Wi Fi Network Security
      object
      uid: wi_fi_get_network_security
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"wi_fi"
      property
      required
      string
      Const:"network_security"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Network security

      data
      required
      string

      Network security

        Allowed values:
      • "none"
      • "wep"
      • "wpa"
      • "wpa2_personal"
      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
  "version": 1,
  "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
  "vin": "VFXXXXXXXXXXXXXXX",
  "capability": "wi_fi",
  "property": "network_security",
  "data": {
    "wi_fi": {
      "network_security": {
        "data": "wpa2_personal",
        "timestamp": "2019-08-24T14:15:22Z"
      }
    }
  }
}
      This example has been generated automatically.
    • #2Wi Fi Network Ssid
      object
      uid: wi_fi_get_network_ssid
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"wi_fi"
      property
      required
      string
      Const:"network_ssid"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      The network SSID

      data
      required
      string
      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
  "version": 1,
  "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
  "vin": "VFXXXXXXXXXXXXXXX",
  "capability": "wi_fi",
  "property": "network_ssid",
  "data": {
    "wi_fi": {
      "network_ssid": {
        "data": "Excepteur mollit cillum amet",
        "timestamp": "2019-08-24T14:15:22Z"
      }
    }
  }
}
      This example has been generated automatically.
    • #3Wi Fi Status
      object
      uid: wi_fi_get_status
      version
      required
      number
      uid: version
      message_id
      required
      string
      uid: message_id
      vin
      required
      string
      uid: vin
      capability
      required
      string
      Const:"wi_fi"
      property
      required
      string
      Const:"status"
      required
      object
      non-empty
      required
      restricted any
      object
      non-empty

      Status

      data
      required
      string

      Enabled state

        Allowed values:
      • "disabled"
      • "enabled"
      timestamp
      required
      string
      format: date-timeuid: timestamp

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Additional properties are NOT allowed.

      Examples

      {
  "version": 1,
  "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911",
  "vin": "VFXXXXXXXXXXXXXXX",
  "capability": "wi_fi",
  "property": "status",
  "data": {
    "wi_fi": {
      "status": {
        "data": "disabled",
        "timestamp": "2019-08-24T14:15:22Z"
      }
    }
  }
}
      This example has been generated automatically.

Messages

  • #1Wi Fi Network Connected
    object
    uid: wi_fi_get_network_connected
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"wi_fi"
    property
    required
    string
    Const:"network_connected"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Network connected

    data
    required
    string

    Connection state

      Allowed values:
    • "disconnected"
    • "connected"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #2Wi Fi Network Security
    object
    uid: wi_fi_get_network_security
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"wi_fi"
    property
    required
    string
    Const:"network_security"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Network security

    data
    required
    string

    Network security

      Allowed values:
    • "none"
    • "wep"
    • "wpa"
    • "wpa2_personal"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #3Wi Fi Network Ssid
    object
    uid: wi_fi_get_network_ssid
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"wi_fi"
    property
    required
    string
    Const:"network_ssid"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    The network SSID

    data
    required
    string
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • #4Wi Fi Status
    object
    uid: wi_fi_get_status
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"wi_fi"
    property
    required
    string
    Const:"status"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Status

    data
    required
    string

    Enabled state

      Allowed values:
    • "disabled"
    • "enabled"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

Schemas

  • version
    number
    uid: version
  • message_id
    string
    uid: message_id
  • vin
    string
    uid: vin
  • timestamp
    string
    format: date-timeuid: timestamp
  • object
    uid: wi_fi_get_network_connected
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"wi_fi"
    property
    required
    string
    Const:"network_connected"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Network connected

    data
    required
    string

    Connection state

      Allowed values:
    • "disconnected"
    • "connected"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: wi_fi_get_network_security
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"wi_fi"
    property
    required
    string
    Const:"network_security"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Network security

    data
    required
    string

    Network security

      Allowed values:
    • "none"
    • "wep"
    • "wpa"
    • "wpa2_personal"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: wi_fi_get_network_ssid
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"wi_fi"
    property
    required
    string
    Const:"network_ssid"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    The network SSID

    data
    required
    string
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

  • object
    uid: wi_fi_get_status
    version
    required
    number
    uid: version
    message_id
    required
    string
    uid: message_id
    vin
    required
    string
    uid: vin
    capability
    required
    string
    Const:"wi_fi"
    property
    required
    string
    Const:"status"
    required
    object
    non-empty
    required
    restricted any
    object
    non-empty

    Status

    data
    required
    string

    Enabled state

      Allowed values:
    • "disabled"
    • "enabled"
    timestamp
    required
    string
    format: date-timeuid: timestamp

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.

    Additional properties are NOT allowed.