Skip to main content

Types of Data

Telemetry Data

Telemetry data topics can be searched from the document provided by May Mobility.

For Realtime API

Pass the list of topics comma seperated topics in the url as a query parameter.

eg: domain/topics=/.vehicle.testvehicle.TOPICNAME1,/.vehicle.examplevehicle.TOPICNAME2

Topic - /.vehicle.{vehicleID}.{topicName}

  • {vehicleID} is the id of the May vehicle that will be provided by May Mobility.

  • {topicName} depends on the type of telemetry data and will be provided by May.

info

The maximum number of topics that can be subscribed to in a single connection or request is 20. If you make a request with more than 20 topics, the connection will not go through and it will throw an error.

For Batch (Rest Endpoints) api

To access the Batch API, you need to include the vehicle name and topic name as path parameters in the URL. The timestamps between which the data is to be requested should be added as url parameters. The URL format should be as follows:

Initial Request eg: domain/vehicles/{vehicleID}/topics/{topicName}?startTime=1687289580&endTime=1687289580

Subsequent Request eg: domain/vehicles/{vehicleID}/topics/{topicName}?meta={metaToken}

Insert the metaToken returned from initial response in subsequent requests.

The startTime and endTime parameters are unix timestamps in seconds and are in UTC.

info

The following are the conditions for the Batch api:

  • The maximum duration you can request is 10 minutes.
  • When you make a request, the data will be split into pages, with each page containing 30 seconds of information (the number of records will depend on the frequency of the topic requested). For all subsequent requests only the meta token (which is returned from the latest response) is required.
  • We can only retrieve data starting from 7 days ago up to the current day.
note
  • No data is available for the current day via Batch (REST endpoints) api, please use Realtime API for that.

Sample Response from Batch (REST endpoint) api for POSE: 

    {
    data: [{
        "acc": [
            -0.0043220240622758865,
            -0.0,
            9.824821472167969
        ],
        "avel": [
            0.0005888862069696188,
            0.00013308988127391783,
            0.0
        ],
        "pos": [
            -4052.685791015625,
            -5623.0927734375,
            -14.119114875793455
        ],
        "quat": [
            -0.9030252695083618,
            -0.0010318123968318105,
            0.01629677601158619,
            -0.4292769432067871
        ],
        "topic": "POSE",
        "utime": "1683642288801633",
        "vehicle": "vehiclename",
        "vel": [
            -0.00006605481030419469,
            0.0,
            0.0
        ]}
        ]
        "metaToken": "use this token in subsequent requests",
        "meta": {
            "totalPages": 6,
            "totalRecords": 900,
            "frequency": 5,
            "currentPage": 1,
            "currentStartTime": 1687289640.002,
            "currentEndTime": 1687289670.002
        }
    }

To view available vehicles and topics

For vehicles

eg: domain/vehicles

For topics

eg: domain/vehicles/{vehicleID}/topics

  • {vehicleID} is the id of the May vehicle that will be provided by May Mobility.

  • {topicName} depends on the type of telemetry data and will be provided by May.

Video Data

To consume external camera feeds of a vehicle in real time this mode can be use

For Realtime

Pass the comma seperated vehicle(s) name as a query parameter in the url.

eg: domain/vehicles=vehiclename1,vehiclename2

Output

Video streaming data output is in the form of serialized protobuf for efficiency purposes

Information on how to decode can be found here