class KontaktIO::SensorService

• KontaktIO::SensorService
• PlaceOS::Driver
• Reference
• Object

Included Modules

• PlaceOS::Driver::Interface::Locatable
• PlaceOS::Driver::Interface::Sensor

Defined in:

kontakt_io/sensor_service.cr

Constant Summary

LOCATION = {"desk", "area"}

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

SENSOR_TYPES = {SensorType::PeopleCount, SensorType::Presence}

Class Method Summary

• .driver_interface : String

Instance Method Summary

• #check_ownership_of(mac_address : String) : OwnershipMAC | Nil

  return nil or {"location": "wireless", "assigned_to": "bob123", "mac_address": "abcd"}

• #device_locations(zone_id : String, location : String | Nil = nil)

  array of devices and their x, y coordinates

• #locate_user(email : String | Nil = nil, username : String | Nil = nil)

  =================================== Locatable Interface functions ===================================

• #macs_assigned_to(email : String | Nil = nil, username : String | Nil = nil) : Array(String)

  return an array of MAC address strings lowercase with no seperation characters abcdeffd1234 etc

• #map_ids : Hash(Int64, String)

  KIO room id => Map ID

• #on_load
• #on_update
• #sensor(mac : String, id : String | Nil = nil) : Detail | Nil

  =================================== Sensor Interface functions ===================================

• #sensors(type : String | Nil = nil, mac : String | Nil = nil, zone_id : String | Nil = nil) : Array(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)

• #system_map_ids : Hash(String, String)

  System id => Map ID

Class Method Detail

Instance Method Detail