class Floorsense::LockerLocationService

• Floorsense::LockerLocationService
• PlaceOS::Driver
• Reference
• Object

Included Modules

• PlaceOS::Driver::Interface::Lockers

Defined in:

floorsense/locker_location_service.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"}

• #controllers : Hash(Int32, ControllerInfo)

  Controller id => Controller info

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

  array of devices and their x, y coordinates

• #get_floorsense_user(place_user_id : String) : String
• #get_locker_bank(locker_key : String)
• #get_place_user_id(floorsense_id : String | Int64) : String
• #get_user_email(floorsense_id : String | Int64) : String
• #locate_user(email : String | Nil = nil, username : String | Nil = nil)

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

• #locker_allocate(user_id : String, bank_id : String | Int64, locker_id : String | Int64 | Nil = nil, expires_at : Int64 | Nil = nil) : PlaceLocker

  allocates a locker now, the allocation may expire

• #locker_banks
• #locker_release(bank_id : String | Int64, locker_id : String | Int64, owner_id : String | Nil = nil) : Nil

  return the locker to the pool

• #locker_share(bank_id : String | Int64, locker_id : String | Int64, owner_id : String, share_with : String) : Nil
• #locker_shared_with(bank_id : String | Int64, locker_id : String | Int64, owner_id : String) : Array(String)

  a list of user-ids that the locker is shared with.

• #locker_unlock(bank_id : String | Int64, locker_id : String | Int64, owner_id : String | Nil = nil, open_time : Int32 = 60, pin_code : String | Nil = nil) : Nil
• #locker_unshare(bank_id : String | Int64, locker_id : String | Int64, owner_id : String, shared_with_id : String | Nil = nil) : Nil
• #lockers_allocated_to(user_id : String) : Array(PlaceLocker)

  a list of lockers that are allocated to the 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

• #on_update
• #zone_building : String | Nil
• #zone_mappings : Hash(String, Array(Int32))

  level zone_id => controller ids

Class Method Detail

Instance Method Detail