4. Scenario Mapping to Specific PHYs: Z-Wave, BLE and ZigBee

This chapter describes use-cases or scenarios using the same Unify commands but showing the Protocol Controller translation details for several PHYs.

4.1. Adding a Node to a Network

This use case explains how to include a new node into a network. It is assumed that the implementations follow the lines described in Network Management Commands and Service discovery.

4.1.1. Z-Wave PAN

Figure 4.1 Adding a node with a Z-Wave PAN

4.1.2. BLE PAN

Figure 4.2 Adding a node with a BLE PAN

4.1.3. ZigBee PAN

The following section shows the Zigbee 3.0 Install Code based commissioning method. This method uses a Unify SmartStart DSK (Device-Specific Key) to convey the Install Code that is flashed out-of-band to a joining device. See the Zigbee Protocol Controller implementation references on how the DSK is formatted according to one of the formats specified in [Network Management](./Chapter03-network-management.md).

$' Allows simultaneous transmissions !pragma teoz true ' Style for the diagram !theme plain skinparam LegendBackgroundColor #F0F0F0 title SmartStart List based commissioning using Z3 Install Code based Device-Specific Keys (DSK) legend top MQTT Subscription Retained MQTT Publication Unretained MQTT Publication endlegend ' List of participants participant "IoT Service" as iot_service participant "Unify MQTT Broker" as mqtt_broker participant "Unify UPVL" as upvl participant "Zigbee Protocol Controller" as protocol_controller participant "Zigbee Node 1" as node_1 == Out-of-band Setup of Joining Device == node_1 -> node_1: Flash Installation Code note over node_1 Extract Install Code CRC to be included in DSK end note ... == Unify Initialization == upvl -> mqtt_broker: ucl/SmartStart/List/Remove upvl -> mqtt_broker: ucl/SmartStart/List/Update iot_service -> mqtt_broker: ucl/SmartStart/List iot_service -> mqtt_broker: ucl/by-unid/+/ProtocolController/NetworkManagement protocol_controller -> mqtt_broker: ucl/SmartStart/List ... upvl -> mqtt_broker: ucl/SmartStart/List \n {"value":[]} == Zigbee Protocol Controller advertises it's ready for Network Management Operations == protocol_controller -> mqtt_broker : ucl/by-unid/<PC_UNID>/ProtocolController/NetworkManagement \n{\n\t"State" : "idle", \n\t"SupportedStateList": ["remove node"], \n} & mqtt_broker -> iot_service ... == Add Node 1 Install Code/DSK via the UPVL == note over iot_service Format EUI64, Install Code, and CRC extracted from the joining device into a recognized DSK format. end note iot_service -> mqtt_broker : ucl/SmartStart/List/Update \n{\n\t"DSK" : "NODE_1_DSK" \n\t"Include" : true \n\t"Unid" : "" \n\t"ProtocolControllerUnid" : "" \n} & mqtt_broker -> upvl upvl -> mqtt_broker : ucl/SmartStart/List \n{"value":[{\n\t"DSK" : "NODE_1_DSK" \n\t"Include" : true \n\t"Unid" : "" \n\t"ProtocolControllerUnid" : "" \n}]} & mqtt_broker -> protocol_controller protocol_controller -> protocol_controller: NODE_1 Install Code based Link Key \nadded to Trust Center (TC) == Node 1 Starts Network Steering == node_1 -> node_1: Network Steering \nwith TC Link key update node_1 -> protocol_controller: Device Annouce + TC join protocol_controller -> mqtt_broker: ucl/by-unid/<PC_UNID>/ProtocolController/NetworkManagement \n{\n\t"State" : "add node", \n\t"SupportedStateList": ["idle"], \n} & mqtt_broker -> iot_service ... node_1 -> node_1: Perform TC Link key update node_1 -> protocol_controller: Replacement APS Link Key Verified on NODE_1 protocol_controller -> mqtt_broker: ucl/by-unid/<PC_UNID>/ProtocolController/NetworkManagement \n{\n\t"State" : "add node", \n\t"SupportedStateList": ["idle"], \n} & mqtt_broker -> iot_service protocol_controller -> mqtt_broker: ucl/by-unid/<NODE_1_UNID>/State \n{\n\t"NetworkStatus" : "Online interviewing", \n} & mqtt_broker -> iot_service == Update the Unid field in the SmartStart list via the UPVL == protocol_controller -> mqtt_broker: ucl/SmartStart/List/Update \n{\n\t"DSK" : "NODE_1_DSK" \n\t"Unid" : "NODE_1_UNID" \n}} mqtt_broker -> upvl upvl -> mqtt_broker : ucl/SmartStart/List \n{"value":[{\n\t"DSK" : "NODE_1_DSK" \n\t"Include" : true \n\t"Unid" : "NODE_1_UNID" \n\t"ProtocolControllerUnid" : "" \n}]} & mqtt_broker -> iot_service == Zigbee Protocol Controller advertises it's ready for Network Management Operations again == protocol_controller -> mqtt_broker : ucl/by-unid/<PC_UNID>/ProtocolController/NetworkManagement \n{\n\t"State" : "idle", \n\t"SupportedStateList": ["remove node"], \n} & mqtt_broker -> iot_service$

4.2. Special Requirements for BLE AoX Protocol Controllers

BLE-based AoX (Angle-of-X) solutions rely on AoX Locators to report the angle of arrival of beacons transmitted from asset tags. AoX Locators typically control radio boards connected to one or more antennas.

An additional Positioning helper application is used to infer the position of the tag based on the several angle information readings from one or more locators.

There are typically no network management operations available for such applications. The list of Asset Tags allowed in the Unify network can be configured using the AoX Locator cluster.

4.2.1. AoX Protocol Controller

The AoX Protocol Controller MUST publish a node state (ucl/by-unid/<unid>/State) for itself.

The Endpoint ID should always be 0 for an AoX locator.

Details on how the data is reported for AoXPCs is provided in Service Discovery.