module PlaceOS::Driver::Interface::Locatable
Overview
a driver or service that can provide location information for people
Direct including types
Defined in:
placeos-driver/interface/locatable.crInstance 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)
array of devices and their x, y coordinates, that are associated with this user
-
#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
Instance Method Detail
abstract
def check_ownership_of(mac_address : String) : OwnershipMAC | Nil
#
return nil
or {"location": "wireless", "assigned_to": "bob123", "mac_address": "abcd"}
abstract
def device_locations(zone_id : String, location : String | Nil = nil)
#
array of devices and their x, y coordinates
array of devices and their x, y coordinates, that are associated with this user
abstract
def 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