class Freespace::SensorAPI

• Freespace::SensorAPI
• PlaceOS::Driver
• Reference
• Object

Included Modules

• PlaceOS::Driver::Interface::Locatable

Defined in:

freespace/sensor_api.cr

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"}

• #client : STOMP::Client
• #client? : STOMP::Client | Nil
• #connected
• #device_locations(zone_id : String, location : String | Nil = nil)

  array of devices and their x, y coordinates

• #disconnected
• #get_location(location_id : String | Int64) : Array(Space)
• #get_token : String

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

• #heart_beat
• #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

• #on_update
• #received(bytes, task)
• #spaces_details : Hash(Int64, Freespace::Space)
• #spaces_state : Hash(Int64, Freespace::SpaceActivity)
• #websocket_headers

  We need an API key to connect to the websocket

Class Method Detail

Instance Method Detail