Skip to content

Latest commit

 

History

History
108 lines (88 loc) · 5.16 KB

mapping.md

File metadata and controls

108 lines (88 loc) · 5.16 KB
Raw

UDMI / Docs / Specs / Mapping

Mapping

The overall "mapping" flow consists of a number of separate subflows stitched together for a complete end-to-end process to take an "unknown" device and ensure that it's properly integrated with backend services.

At a high-level, the process involves different message subgroups that handle slightly different scopes of device data:

  • (Native): Device communication using some non-UDMI native protocol (e.g. BACnet, Modbus, etc...)
  • Discovery: Messages relating to the discovery (and provisioning) of devices (e.g. messy BACnet info)
  • Mapping: Messages relating to a 'resolved' device type and ID (e.g. the device is an AHU called AHU-1)
  • Pointset: Messages relating to actual data flow (e.g. temperature reading), essentially the interesting stuff
  • (Onboard): Interactions with an external (non-UDMI) entity of some kind to facilitate onboarding of devices

Sequence Diagram

The overall mapping sequence involves multiple components that work together to provide the overall flow:

  • Devices: The target things that need to be discovered, configured, and ultimately communicate point data.
  • Agent: Cloud-based agent responsible for managing the overall discovery and mapping process (how often, what color, etc...).
  • Mapper: Mapping engine that uses heuristics, ML, or a UI to convert discovery information into a concrete device/pipeline mapping.
  • Pipeline: Ultimate recipient of pointset information, The thing that cares about 'temperature' in a room.
sequenceDiagram
  %%{wrap}%%
  participant Devices as Devices<br/>(w/ Spotter)
  participant Agent
  participant Mapper
  participant Pipeline
  Note over Devices, Agent: Discovery Start
  activate Agent
  loop Devices
    Devices->>Mapper: DISCOVERY EVENT<br/>(*scan_id)<br/><properties: *uniqs>
  end
  deactivate Agent
  Note over Agent, Mapper: Mapping Start
  activate Mapper
  Agent->>Mapper: MAPPING CONFIG
  Mapper->>Agent: MAPPING STATE
  loop Devices
    Mapper->>Agent: MAPPING EVENT<br/>(*guid, scan_id, *device_id)<br/><translations>
    Agent->>Mapper: MAPPING COMMAND<br/>(device_id, *device_num_id)
    Agent-->>Pipeline: Onboard RPC<br/>(guid, device_id, device_num_id)<br/><translations>
  end
  deactivate Mapper
  Devices->>Pipeline: POINTSET EVENT<br/>(device_id, device_num_id)<br/><pointset>
Loading
  1. (Fieldbus Discovery) scan for fieldbus device information from devices (e.g. BACnet, format out of scope for UDMI):
  • "I am device 78F936 with points { room_temp, step_size, and operation_count }"
  1. Discovery Events wraps the device info from the discovery into a UDMI-normalized format, e.g.:
  • "Device 78F936 has points { }, with a public key XYZZYZ"
  1. Mapping Config from the agent indicates that the mapper should export responses.
  2. Mapping Events from the mapper contain actual calculated point mappings:
  • "Device 78F936 is an AHU called AHU-183, and room_temp is really a flow_temperatue"
  1. Mapping Command to the mapper contain results of initial provisioning:
  • "Device 78F936 has a numerical id 2198372198752
  1. (Onboard Info) are sent to the pipeline to onboard a device (contents are defined by pipeline and out of scope for UDMI).
  2. Telemetry Events are data events from device to pipeline... business as usual:
  • "I am AHU-183, and my room_temp is 73"

Example Test Setup

A standalone test-setup can be used to emulate all the requisite parts of the system.

Cloud PubSub subscriptions (the defaults) on the udmi_target topic (need to be manually added):

  • mapping-agent: Used by the agent to coordinate on-prem discovery and mapping engine activities.
  • mapping-engine: Used by the engine to process discovery and mapping information.

Local environment setup (e.g.):

  • project_id=test-gcp-project

Mock Device and Spotter

The pubber reference provides for both the device and spotter bits of functionality (AHU-1 in this case).

$ bin/pubber sites/udmi_site_model/ $project_id AHU-1 832172
...
INFO daq.pubber.Pubber - 2022-08-30T01:46:29Z Discovery scan starting virtual as 2022-08-30T01:46:29Z
...
INFO daq.pubber.Pubber - 2022-08-30T01:45:57Z Sent 1 discovery events from virtual for Mon Aug 29 18:45:43 PDT 2022
...

Mapping Agent

The mapping agent configures the on-prem discovery node (AHU-1) to perform periodic discovery runs.

$ validator/bin/mapping agent sites/udmi_site_model/ $project_id AHU-1
...
Received new family virtual generation Mon Aug 29 18:47:43 PDT 2022
...

Mock Mapping Engine

The mapping engine receives discovery and mapping events to perform the mapping function.

$ validator/bin/mapping engine sites/udmi_site_model/ $project_id
...
Received discovery event for generation Mon Aug 29 18:48:43 PDT 2022
...