bt-sensors-plugin-sk/spec/sensors.json

Bluetooth Sensors for Signalk - see https://www.npmjs.com/package/bt-sensors-plugin-sk#supported-sensors for a list of supported sensors

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "https://signalk.org/specification/1.5.1/schemas/groups/sensors.json#",
  "description": "An object describing an individual sensor. It should be an object in vessel, named using a unique name or UUID",
  "title": "sensor",
  "properties": {
    "name": {
      "type": "string",
      "description": "The common name of the sensor"
    },

    "sensorType": {
      "type": "string",
      "description": "The datamodel definition of the sensor data. FIXME - need to create a definitions lib of sensor datamodel types"
    },

    "sensorData": {
      "type": "string",
      "description": "The data of the sensor data. FIXME - need to ref the definitions of sensor types"
    },

    "fromBow": {
      "$ref": "../definitions.json#/definitions/numberValue",
      "description": "The distance from the bow to the sensor location"
    },

    "fromCenter": {
      "$ref": "../definitions.json#/definitions/numberValue",
      "description": "The distance from the centerline to the sensor location, -ve to starboard, +ve to port"
    },

    "class": {
      "$ref": "../definitions.json#/definitions/stringValue",
      "pattern_": "^[AB]\\Z",
      "description": "AIS transponder class in sensors.ais.class, A or B"
    }
  }
}