Schemas / I/O

rig.sensor.gnss

v1.0.0 · stable maturity: draft 4 fields 0 required

Fields

FieldTypeMeaning
rateHz number> 0 optional Optional. Fixes per second. Absent = the host default
horizontalMetres number0 – * optional Optional. Horizontal accuracy, metres. Absent = unknown
verticalMetres number0 – * optional Optional. Vertical accuracy, metres. Absent = unknown
device entity optional Optional. Absent = local

Satellite fix. Format when present.

The coordinates are rig.place.geo on this entity. This component is the receiver: rate and accuracy. Do not copy latitude onto it.

Accuracy is metres whatever document.defaultUnit says. Absent rig.place.geo means no fix was measured. The satellite list and the NMEA stream stay in the host.

Scene pose of the antenna is rig.spatial.transform. Geodetic and scene coordinates are different homes.

JSON Schema

Resolves at https://rig.works/schemas/rig.sensor.gnss.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.sensor.gnss.schema.json",
  "title": "rig.sensor.gnss",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "rateHz": {
      "type": "number",
      "exclusiveMinimum": 0
    },
    "horizontalMetres": {
      "type": "number",
      "minimum": 0
    },
    "verticalMetres": {
      "type": "number",
      "minimum": 0
    },
    "device": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    }
  },
  "x-rig-maturity": "draft"
}

Seen in

record-civic.json · robot-lab.json