Ga naar hoofdinhoud

Sensor

idstringrequired

Deprecated, please use uuid instead

uuidstring<uuid>required
namestringrequired
typeTypeEnum (string)required
  • energy - SensorType.ENERGY
  • switch - SensorType.SWITCH
  • comfort - SensorType.COMFORT
  • status - SensorType.STATUS
  • key_value - SensorType.KEY_VALUE

Possible values: [energy, switch, comfort, status, key_value]

subtypeSubtypeEnum (string)required
  • electricity - SensorSubtype.ELECTRICITY
  • gas - SensorSubtype.GAS
  • heat - SensorSubtype.HEAT
  • water - SensorSubtype.WATER
  • motion - SensorSubtype.MOTION
  • contact - SensorSubtype.CONTACT
  • temperature - SensorSubtype.TEMPERATURE
  • humidity - SensorSubtype.HUMIDITY
  • illuminance - SensorSubtype.ILLUMINANCE
  • ev_socket - SensorSubtype.EV_SOCKET
  • any - SensorSubtype.ANY

Possible values: [electricity, gas, heat, water, motion, contact, temperature, humidity, illuminance, ev_socket, any]

minimum_intervalMinimumIntervalEnum (string)required
  • unknown - SensorIntervalType.UNKNOWN
  • all - SensorIntervalType.ALL
  • minute - SensorIntervalType.MINUTE
  • quarter - SensorIntervalType.QUARTER
  • day - SensorIntervalType.DAY

Possible values: [unknown, all, minute, quarter, day]

is_meter_readingbooleanrequired
subtype_methodSubtypeMethodEnum (string)
  • consumption - SensorSubtypeMethod.CONSUMPTION
  • production - SensorSubtypeMethod.PRODUCTION
  • return_delivery - SensorSubtypeMethod.RETURN_DELIVERY
  • delivery - SensorSubtypeMethod.DELIVERY
  • charge - SensorSubtypeMethod.CHARGE
  • discharge - SensorSubtypeMethod.DISCHARGE

Possible values: [consumption, production, return_delivery, delivery, charge, discharge]

sensor_hub_uuidstring<uuid>nullablerequired
unitstring
descriptionstring
value_typestring
Sensor
{
  "id": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "type": "energy",
  "subtype": "electricity",
  "minimum_interval": "unknown",
  "is_meter_reading": true,
  "subtype_method": "consumption",
  "sensor_hub_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "unit": "string",
  "description": "string",
  "value_type": "string"
}