class Cisco::DNASpaces

• Cisco::DNASpaces
• PlaceOS::Driver
• Reference
• Object

Included Modules

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

Defined in:

cisco/dna_spaces.cr
cisco/dna_spaces/sensor_interface.cr

Constant Summary

IOT_SENSORS = {SensorType::Presence, SensorType::PeopleCount, SensorType::Humidity, SensorType::AirQuality, SensorType::SoundPressure, SensorType::Temperature}

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

Class Method Summary

• .driver_interface : String

Instance Method Summary

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

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

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

  Will return an array of devices and their x, y coordinates

• #devices(&)
• #format_mac(address : String)
• #format_username(user : String)
• #get_location_info(location_id : String)
• #get_map_details(map_id : String)
• #inspect_state
• #locate_mac(address : String)
• #locate_user(email : String | Nil = nil, username : String | Nil = nil)

  ============================= Locatable interface =============================

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

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

• #on_load
• #on_unload
• #on_update
• #seen_locations
• #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)

• #update_monitoring_status(running : Bool = true) : Nil

  This provides the DNA Spaces dashboard with stream consumption status

• #user_lookup(&)
• #user_lookup(user_id : String)

Class Method Detail

Instance Method Detail