class Cisco::Meraki::Locations

• Cisco::Meraki::Locations
• PlaceOS::Driver
• Reference
• Object

Included Modules

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

Defined in:

cisco/meraki/meraki_locations.cr

Constant Summary

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

Class Method Summary

• .driver_interface : String

Instance Method Summary

• #building_zone : String
• #camera_analytics(serial : String)
• #cameras : Array(Cisco::Meraki::NetworkDevice)
• #check_ownership_of(mac_address : String) : OwnershipMAC | Nil

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

• #cleanup_caches : Nil
• #desk_details : Hash(String, DetectedDesks)

  serial => desks detected

• #desk_locations(zone_id : String)
• #desk_mappings : Hash(String, Array(CameraZone))

  Camera serial => [desk location]

• #desk_occupancy : Hash(String, Array(Tuple(Int64, Bool)))

  ================= Camera Desk data: ================= desk_id => [{time, occupied}]

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

  array of devices and their x, y coordinates

• #format_mac(address : String)
• #format_username(user : String)
• #hostname_ownership(hostname : String, username : String | Nil) : Nil
• #inspect_foorplans : Hash(String, Cisco::Meraki::FloorPlan)
• #inspect_network_devices : Hash(String, Cisco::Meraki::NetworkDevice)
• #inspect_state
• #ip_username_mappings(ip_map : Array(Tuple(String, String, String, String | Nil))) : Nil
• #locate_mac(address : String)
• #locate_user(email : String | Nil = nil, username : String | Nil = nil)

  returns locations based on most recently seen versus most accurate location

• #locateable

  Returns the list of users who can be located

• #lookup_ip(address : String)
• #lux : Hash(String, Float64)

  serial => lux

• #mac_address_mappings(username : String, macs : Array(String), domain : String = "")
• #mac_hostnames : Hash(String, String)

  User lookup helpers using device hostnames

• #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_users_to_macs(network_id : String | Nil = nil)
• #on_load
• #on_update
• #parse_new_locations(payload : String) : Nil

  Webhook endpoint for scanning API, expects version 3

• #poll_clients(network_id : String | Nil = nil, timespan : UInt32 = 900_u32, connection : ConnectionType | Nil = nil, device_serial : String | Nil = nil)
• #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)

• #sync_floorplan_sizes(network_id : String | Nil = nil)
• #update_desk_mappings
• #update_sensor_cache
• #wired_desk_locations(zone_id : String)

  grabs the wired desk data for a level

• #wireless_locations(zone_id : String)

Class Method Detail

Instance Method Detail