class Xovis::SensorAPI

• Xovis::SensorAPI
• PlaceOS::Driver
• Reference
• Object

Included Modules

• PlaceOS::Driver::Interface::Sensor

Defined in:

xovis/sensor_api.cr

Constant Summary

NO_MATCH = [] of Interface::Sensor::Detail

TYPES = {"line-counts" => SensorType::QueueSize, "zone-occupancy-counts" => SensorType::PeopleCount, "zone-in-out-counts" => SensorType::Counter}

Class Method Summary

• .driver_interface : String

Instance Method Summary

• #capacity_data
• #count_data
• #device_status

  Combined /info and /info/status

• #get_logs
• #get_token

  Alternative to using basic auth, but here really only for testing with postman

• #is_alive?
• #on_update
• #reset_count
• #sensor(mac : String, id : String | Nil = nil) : Interface::Sensor::Detail | Nil

  return the specified sensor details

• #sensors(type : String | Nil = nil, mac : String | Nil = nil, zone_id : String | Nil = nil) : Array(Interface::Sensor::Detail)

  return an array of sensor details zone_id can be ignored if location is unknown by the sensor provider mac_address can be used to grab data from a single device (basic grouping)

Class Method Detail

Instance Method Detail