Calibrations

Get

Retrieve a calibration by ID.

get/calibrations/{calibration_id}

Request

Base URL
https://api.mirurobotics.com/beta
URL
https://api.mirurobotics.com/beta/calibrations/{calibration_id}
Auth
API key in header X-API-Key

Path parameters

calibration_idstring required

Example:cal_123

The unique identifier of the calibration.

Query parameters

expandCalibrationExpansion[]

Fields to expand on the calibration.

[
  "content"
]

Response

Successfully retrieved the calibration.

object'calibration' required

The object type, which is always calibration.

idstring required

ID of the calibration, generated by Miru.

device_idstring required

ID of the device that reported the calibration.

componentstring required

Slug of the component the calibrated unit belongs to, as it was reported.

rolestring nullable required

Slug of the role the calibrated unit fills on the device, as it was reported; null if no role was reported.

aspectstring nullable required

Slug of the aspect of the unit that was calibrated, as it was reported; null if no aspect was reported.

serial_numberstring nullable required

Serial number of the physical unit that was calibrated, not of the device, such as SN-1234, or null if none was reported. Free text, at most 255 characters.

digeststring required

Digest of the content, formatted as sha256: followed by 64 lowercase hex characters.

report_idstring uuid required

ID the agent gave the report this calibration came from.

reported_atstring date-time required

Timestamp of when the calibration was reported to the agent on the device. The agent may upload it much later, for example after an outage, so this can be well before created_at.

created_atstring date-time required

Timestamp of when Miru recorded the calibration.

Example response

{
  "object": "calibration",
  "id": "cal_123",
  "device_id": "dvc_123",
  "component": "arm",
  "role": "front-left",
  "aspect": null,
  "serial_number": "SN-1234",
  "digest": "sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
  "report_id": "0b6f3c2e-6a51-4e0f-9a43-2f1d7c9e8b10",
  "reported_at": "2021-01-01T00:00:00Z",
  "created_at": "2021-01-01T00:00:00Z",
  "content": {
    "format": "json",
    "data": "{\n  \"x\": 0.412,\n  \"y\": -0.087,\n  \"z\": 0.256,\n  \"roll\": 0.0,\n  \"pitch\": 0.0,\n  \"yaw\": 1.571\n}\n"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.

Get