bt-sensors-plugin-sk
Version:
Bluetooth Sensors for Signalk - see https://www.npmjs.com/package/bt-sensors-plugin-sk#supported-sensors for a list of supported sensors
220 lines (204 loc) • 6.75 kB
JSON
{
"params":{
"name":{
"title": "Name",
"description": "Sensor name"
},
"location":{
"title": "Location",
"description": "Sensor location on boat",
"examples": ["inside", "outside", "galley", "freezer", "refrigerator", "head", "cabin", "engine", "deck", "cockpit"]
},
"zone":{
"title":"Zone",
"description": "Zone where sensor operates on boat AKA location ",
"examples": ["inside", "outside", "galley", "freezer", "refrigerator", "head", "cabin", "engine", "deck", "cockpit"]
},
"batteryID":{
"title": "Battery ID",
"examples": ["starter", "house"]
},
"id":{
"title": "ID",
"description": "Sensor ID"
}
},
"environment":{
"temperature":
{
"title": "Temperature",
"description":"Current zone's temperature",
"unit":"K",
"default": "environment.{zone}.temperature"
},
"humidity":
{
"title": "Humidity",
"description":"Current zone's humidity",
"unit":"ratio",
"default":"environment.{zone}.humidity"
},
"relativeHumidity":
{
"description":"Current zone's relative humidity",
"unit":"ratio",
"default":"environment.{zone}.relativeHumidity"
},
"pressure":
{
"description": "Current zone's ambient air pressure",
"unit":"Pa",
"default":"environment.{zone}.pressure"
}
},
"navigation": {
"attitude": {
"pitch":
{
"description":"Current pitch",
"unit":"rad",
"default":"navigation.attitude.pitch"
},
"roll":
{
"description":"Current pitch",
"unit":"rad",
"default":"navigation.attitude.roll"
},
"yaw":
{
"description":"Current pitch",
"unit":"rad",
"default":"navigation.attitude.yaw"
}
}
},
"electrical":{
"inverters":{
"ac":{
"current":{
"unit": "A",
"default":"electrical.inverters.{id}.ac.current"
},
"voltage":
{
"unit": "V",
"default":"electrical.inverters.{id}.ac.voltage"
},
"power":
{
"unit": "W",
"default":"electrical.inverters.{id}.ac.power"
}
},
"dc":{
"current":{
"unit": "A",
"default":"electrical.inverters.{id}.dc.current"
},
"voltage":
{
"unit": "V",
"default":"electrical.inverters.{id}.dc.voltage"
}
}
},
"batteries":{
"current":{
"unit": "A",
"default":"electrical.batteries.{batteryID}.current"
},
"voltage":
{
"unit": "V",
"default": "electrical.batteries.{batteryID}.voltage"
},
"power":
{
"unit": "W",
"default": "electrical.batteries.{batteryID}.power"
},
"impedance":
{
"unit": "Ohm",
"default": "electrical.batteries.{batteryID}.impedance"
},
"temperature":{
"unit": "K",
"default": "electrical.batteries.{batteryID}.temperature"
},
"cycles":{
"unit": "",
"default": "electrical.batteries.{batteryID}.cycles"
},
"capacity":{
"remaining":{
"unit":"C",
"default": "electrical.batteries.{batteryID}.capacity.remaining"
},
"actual":{
"unit":"C",
"default": "electrical.batteries.{batteryID}.capacity.actual"
},
"discharge":{
"unit":"KWh",
"default": "electrical.batteries.{batteryID}.capacity.dischargeSinceFull"
},
"charge":{
"unit":"KWh",
"default": "electrical.batteries.{batteryID}.capacity.totalCharge"
},
"stateOfCharge":{
"description": "Battery's state of charge as ratio",
"unit":"ratio",
"default": "electrical.batteries.{batteryID}.capacity.stateOfCharge"
},
"stateOfHealth":{
"description": "Battery's state of health as ratio",
"unit":"ratio",
"default": "electrical.batteries.{batteryID}.capacity.stateOfHealth"
},
"timeRemaining":{
"description": "Time in seconds until battery reaches its discharge floor at current usage",
"unit":"s",
"default": "electrical.batteries.{batteryID}.capacity.timeRemaining"
}
}
}
},
"sensors":{
"RSSI":
{
"unit":"db",
"default":"sensors.{macAndName}.RSSI",
"description": "Sensor signal strength in decibels"
},
"batteryStrength":
{
"title": "Battery Strength",
"unit":"ratio",
"default":"sensors.{macAndName}.battery.strength",
"zones":[
{ "upper": 0.5,
"lower": 0.3,
"state": "alert",
"message": "Battery low - change soon"
},
{
"upper": 0.3,
"lower": 0,
"state": "warn",
"message": "Battery very low - change now"
}
],
"description":"Sensor battery strength"
},
"batteryVoltage":
{
"title":"Battery Voltage",
"unit":"V",
"default":"sensors.{macAndName}.battery.voltage",
"description":"Sensor battery voltage"
}
}
}