Barrier Operator

Version supported : 1

Interview process

  1. Barrier Operator Get Signaling Capabilities Supported

  2. For each supported Subsystem type : Barrier Operator Event Signaling Get

  3. Barrier Operator Get

Command Class Commands

Barrier Operator Set

Trigger on new desired value of STATE

Mapping between attribute store and Set command :

Z-Wave Attribute Store

Attribute State

Z-Wave Set Field

STATE

Desired or Reported

Target Value

Barrier Operator Get

Trigger on undefined reported value of STATE

Barrier Operator Report

Mapping between Report command and attribute store :

Z-Wave Command Attribute

Z-Wave Attribute Store

State

STATE

Barrier Operator Get Signaling Capabilities Supported

Trigger on undefined reported value of BITMASK

Barrier Operator Report Signaling Capabilities Supported

Z-Wave Command Attribute

Z-Wave Attribute Store

BITMASK

Bitmask 1-N

Note

BITMASK is an array and each field will be put in this array.

Note

For each supported type, zpc will create an SUBSYSTEM_TYPE attribute that contains the value of the supported type. Also create SUBSYSTEM_STATE to it :

|__ SUBSYSTEM_TYPE (reported value defined)
    |__ SUBSYSTEM_STATE (no value defined)
|__ SUBSYSTEM_TYPE (reported value defined)
    |__ SUBSYSTEM_STATE (no value defined)
|__ SUBSYSTEM_TYPE (reported value defined)
    |__ SUBSYSTEM_STATE (no value defined)

Barrier Operator Event Signal Set

Trigger on new desired value of SUBSYSTEM_STATE

Mapping between attribute store and Set command :

Z-Wave Attribute Store

Attribute State

Z-Wave Set Field

SUBSYSTEM_TYPE

Reported

Subsystem Type

SUBSYSTEM_STATE

Desired or Reported

Subsystem State

Note

Structure of subsystem :

|__ SUBSYSTEM_TYPE
    |__ SUBSYSTEM_STATE

Barrier Operator Event Signaling Get

Trigger on undefined reported value of SUBSYSTEM_STATE

Mapping between attribute store and Get command :

Z-Wave Attribute Store

Attribute State

Z-Wave Get Field

SUBSYSTEM_TYPE

Reported

Subsystem Type

Note

Structure of subsystem :

|__ SUBSYSTEM_TYPE
    |__ SUBSYSTEM_STATE

Barrier Operator Event Signaling Report

Mapping between Report command and attribute store :

Z-Wave Command Attribute

Z-Wave Attribute Store

Subsystem Type

SUBSYSTEM_TYPE

Subsystem State

SUBSYSTEM_STATE

Unify Clusters

UAM files

UAM File

Cluster

Comments

BarrierControl_to_Barrier_Operator.uam

BarrierControl.xml

All of bound attributes a readonly.

Bindings

Z-Wave Attribute Store

Cluster attribute

Comments

0

BarrierControl SafetyStatus

Will be undefined if STATE == 0 otherwise 0. Z-Wave -> Cluster (Read only).

0

BarrierControl Capabilities

Will be undefined if STATE == 0 otherwise 0. Z-Wave -> Cluster (Read only).

STATE

BarrierControl MovingState

MovingState is determined by the value of current State. Z-Wave -> Cluster (Read only).

STATE

BarrierControl BarrierPosition

Map current position based on the current State. Z-Wave -> Cluster (Read only).

Command actions

Warning

Most of attributes are read only. You can only control the door opening and get the status back.

Action

MQTT Topic

Comments

Make the door open

ucl/by-unid/+/+/BarrierControl/Commands/GoToPercent { "PercentOpen": 12 }

Any value > 0 will be mapped to STATE = 0xFF

Make the door close

ucl/by-unid/+/+/BarrierControl/Commands/GoToPercent { "PercentOpen": 0 }

STATE will be 0x00