feat(cisco/spaces): add support for webex events

Author: stakach

drivers/cisco/dna_spaces.cr

@@ -183,9 +183,9 @@ class Cisco::DNASpaces < PlaceOS::Driver
   end
 
   # MAC Address => Location (including user)
-  @locations : Hash(String, DeviceLocationUpdate | IotTelemetry) = {} of String => DeviceLocationUpdate | IotTelemetry
+  @locations : Hash(String, DeviceLocationUpdate | IotTelemetry | WebexTelemetryUpdate) = {} of String => DeviceLocationUpdate | IotTelemetry | WebexTelemetryUpdate
   @loc_lock : Mutex = Mutex.new
-  @devices : Hash(String, IotTelemetry) = {} of String => IotTelemetry
+  @devices : Hash(String, IotTelemetry | WebexTelemetryUpdate) = {} of String => IotTelemetry | WebexTelemetryUpdate
   @dev_lock : Mutex = Mutex.new
 
   def locations
@@ -292,14 +292,14 @@ class Cisco::DNASpaces < PlaceOS::Driver
           when DeviceEntry
             # This is used entirely for
             @description_lock.synchronize { payload.location.descriptions(@location_descriptions) }
-          when DeviceLocationUpdate, IotTelemetry
+          when DeviceLocationUpdate, IotTelemetry, WebexTelemetryUpdate
             device_mac = format_mac(payload.device.mac_address)
 
             # we want timestamps in seconds
             payload.last_seen = payload.last_seen // 1000
 
-            if payload.is_a?(IotTelemetry)
-              iot_payload = payload.as(IotTelemetry)
+            if payload.is_a?(IotTelemetry) || payload.is_a?(WebexTelemetryUpdate)
+              iot_payload = payload.as(IotTelemetry | WebexTelemetryUpdate)
               self[device_mac] = iot_payload
               devices { |dev| dev[device_mac] = iot_payload }
 
@@ -436,6 +436,7 @@ class Cisco::DNASpaces < PlaceOS::Driver
 
       macs.compact_map { |mac|
         if location = locate_mac(mac)
+          next if location.is_a?(WebexTelemetryUpdate)
           if location.last_seen > location_max_age
             # we update the mac_address to a formatted version
             location.device.mac_address = mac
@@ -455,7 +456,7 @@ class Cisco::DNASpaces < PlaceOS::Driver
           "y"                => location.y_pos,
           "lon"              => lon,
           "lat"              => lat,
-          "s2_cell_id"       => S2Cells::LatLon.new(lat, lon).to_token(@s2_level),
+          "s2_cell_id"       => S2Cells::CellId.from_lat_lng(lat, lon).parent(@s2_level).to_token,
           "mac"              => location.device.mac_address,
           "variance"         => location.unc,
           "last_seen"        => location.last_seen,
@@ -592,7 +593,8 @@ class Cisco::DNASpaces < PlaceOS::Driver
         end
       end
 
-      locations.map do |loc|
+      locations.compact_map do |loc|
+        next if loc.is_a?(WebexTelemetryUpdate)
         lat = loc.latitude
         lon = loc.longitude
 
@@ -603,7 +605,7 @@ class Cisco::DNASpaces < PlaceOS::Driver
           y:                loc.y_pos - offset_y,
           lon:              lon,
           lat:              lat,
-          s2_cell_id:       S2Cells::LatLon.new(lat, lon).to_token(@s2_level),
+          s2_cell_id:       S2Cells::CellId.from_lat_lng(lat, lon).parent(@s2_level).to_token,
           mac:              loc.device.mac_address,
           variance:         loc.unc,
           last_seen:        loc.last_seen,

drivers/cisco/dna_spaces/events.cr

@@ -23,6 +23,7 @@ abstract class Cisco::DNASpaces::Events
     "DEVICE_COUNT"           => DeviceCountWrapper,
     "BLE_RSSI_UPDATE"        => BleRssiUpdateWrapper,
     "IOT_TELEMETRY"          => IotTelemetryWrapper,
+    "WEBEX_TELEMETRY"        => WebexTelemetryUpdateWrapper,
   }
 
   @[JSON::Field(key: "recordUid")]
@@ -132,3 +133,10 @@ class Cisco::DNASpaces::IotTelemetryWrapper < Cisco::DNASpaces::Events
   @[JSON::Field(key: "iotTelemetry")]
   getter payload : IotTelemetry
 end
+
+class Cisco::DNASpaces::WebexTelemetryUpdateWrapper < Cisco::DNASpaces::Events
+  getter eventType : String = "WEBEX_TELEMETRY"
+
+  @[JSON::Field(key: "webexTelemetryUpdate")]
+  getter payload : WebexTelemetryUpdate
+end

drivers/cisco/dna_spaces/sensor_interface.cr

@@ -5,7 +5,7 @@ class Cisco::DNASpaces
   }
   NO_MATCH = [] of Interface::Sensor::Detail
 
-  protected def to_sensors(zone_id, filter, device : IotTelemetry)
+  protected def to_sensors(zone_id, filter, device : IotTelemetry | WebexTelemetryUpdate)
     if level_loc = device.location_mappings["FLOOR"]?
       if floorplan = @floorplan_mappings[level_loc]?
         building = floorplan["building"]?.as(String?)
@@ -22,6 +22,7 @@ class Cisco::DNASpaces
 
     IOT_SENSORS.each do |type|
       next if filter && filter != type
+      # next if device.is_a?(WebexTelemetryUpdate) && !filter.in?({SensorType::PeopleCount, SensorType::Presence})
 
       unit = nil
       value = nil
@@ -96,7 +97,7 @@ class Cisco::DNASpaces
       device = devices { |dev| dev[mac]? }
       return NO_MATCH unless device
       return case device
-      in IotTelemetry
+      in IotTelemetry, WebexTelemetryUpdate
         to_sensors(zone_id, filter, device)
       in DeviceLocationUpdate
         NO_MATCH
@@ -106,7 +107,7 @@ class Cisco::DNASpaces
     device_values = devices &.values
     device_values.flat_map do |device|
       case device
-      in IotTelemetry
+      in IotTelemetry, WebexTelemetryUpdate
         to_sensors(zone_id, filter, device)
       in DeviceLocationUpdate
         NO_MATCH
@@ -124,7 +125,7 @@ class Cisco::DNASpaces
 
     filter = SensorType.parse(id)
     case device
-    in IotTelemetry
+    in IotTelemetry, WebexTelemetryUpdate
       to_sensors(nil, filter, device).first?
     in DeviceLocationUpdate
     end

drivers/cisco/dna_spaces/webex_telemetry.cr

@@ -0,0 +1,114 @@
+require "./events"
+require "./location"
+
+# https://partners.dnaspaces.io/docs/v1/basic/c-dnas-firehose-api-references.html#!c-firehose-proto-buf-doc.html
+class Cisco::DNASpaces::WebexDeviceInfo
+  include JSON::Serializable
+
+  @[JSON::Field(key: "deviceId")]
+  getter id : String
+
+  @[JSON::Field(key: "macAddress")]
+  property mac_address : String
+
+  @[JSON::Field(key: "ipAddress")]
+  getter ip_address : String
+
+  # these fields are named to be compatible with the IoT field names
+  @[JSON::Field(key: "product")]
+  getter type : String
+
+  @[JSON::Field(key: "displayName")]
+  getter device_name : String
+
+  @[JSON::Field(key: "serialNumber")]
+  getter serial_number : String
+
+  @[JSON::Field(key: "softwareVersion")]
+  getter software_version : String
+
+  @[JSON::Field(key: "workspaceId")]
+  getter workspace_id : String
+
+  @[JSON::Field(key: "orgId")]
+  getter org_id : String
+end
+
+struct Cisco::DNASpaces::WebexTelemetry
+  include JSON::Serializable
+
+  getter presence : Bool?
+
+  @[JSON::Field(key: "peopleCount")]
+  getter count : Int32?
+end
+
+class Cisco::DNASpaces::WebexTelemetryUpdate
+  include JSON::Serializable
+
+  @[JSON::Field(key: "deviceInfo")]
+  getter device : WebexDeviceInfo
+  getter location : Location
+  getter telemetries : Array(WebexTelemetry) { [] of WebexTelemetry }
+
+  @[JSON::Field(ignore: true)]
+  getter people_count : Int32 do
+    telemetries.compact_map(&.count).first? || 0
+  end
+
+  @[JSON::Field(ignore: true)]
+  getter presence : Bool do
+    telemetries.compact_map(&.presence).first? || (people_count > 0)
+  end
+
+  @[JSON::Field(ignore: true)]
+  property last_seen : Int64 do
+    Time.utc.to_unix_ms
+  end
+
+  def has_position?
+    true
+  end
+
+  @[JSON::Field(ignore: true)]
+  property map_id : String = ""
+
+  def visit_id
+    nil
+  end
+
+  def raw_user_id : String
+    ""
+  end
+
+  @[JSON::Field(ignore: true)]
+  @location_mappings : Hash(String, String)? = nil
+
+  # Ensure we only process these once
+  def location_mappings : Hash(String, String)
+    if mappings = @location_mappings
+      mappings
+    else
+      mappings = location.details
+      @location_mappings = mappings
+      mappings
+    end
+  end
+
+  # these are unused but here for compilation reasons
+  def humidity
+    nil
+  end
+
+  def air_quality
+    nil
+  end
+
+  def temperature
+    nil
+  end
+
+  def ambient_noise
+    nil
+  end
+end