BusDiagram
GitHub Download

Reference

#Ports

A communication object's port names its role in a device behavior. Each behavior accepts specific ports and DPTs; see behaviors.

Port Description Behaviors
input Object written by a button or numeric input, then transmitted. pushButton/v1, passive/v1, presenceDetector/v1
display Object that receives and displays a value, such as an indicator or supervisor. pushButton/v1, display/v1, passive/v1
switch Channel switch command (0 = off, 1 = on). switchActuator/v1, dimmerActuator/v1, daliGateway/v1, heatingActuator/v1
status Relay status feedback, sent after each effective change. switchActuator/v1, dimmerActuator/v1, daliGateway/v1
move Shutter: 0 raises toward 0%, 1 lowers toward 100%. shutterActuator/v1
stopStep Shutter: stop when moving; otherwise step by stepPct (0 up, 1 down). shutterActuator/v1
positionCommand Shutter target position in percent. shutterActuator/v1
positionStatus Actuator's estimated shutter position, sent after stopping. shutterActuator/v1
scene Scene number (bus byte 0–63 represents scenes 1–64); without a channel, apply to all channels. switchActuator/v1, shutterActuator/v1, dimmerActuator/v1, daliGateway/v1
forced Priority override (2 = force off, 3 = force on, 0/1 = end override). switchActuator/v1
dim Relative dimming (3.007): direction bit and step size 1–7; 0 stops dimming. dimmerActuator/v1, daliGateway/v1
value Brightness value in percent (5.001); zero switches off. dimmerActuator/v1, daliGateway/v1, heatingActuator/v1, systemGateway/v1
valueStatus Brightness value feedback (5.001), sent after a transition. dimmerActuator/v1, daliGateway/v1, heatingActuator/v1
error Lamp or ballast fault in a DALI group (1.005). daliGateway/v1
broadcastSwitch Switch all groups with a DALI broadcast. daliGateway/v1
broadcastValue Set all group levels with a DALI broadcast. daliGateway/v1
generalError Fault on the DALI line across all groups (1.005). daliGateway/v1
actualTemp Thermostat: measured temperature (9.001), sent on change. roomThermostat/v1
externalTemp Thermostat: temperature from an external sensor (9.001), replacing the internal sensor. roomThermostat/v1
baseSetpoint Thermostat: base heating comfort setpoint (9.001). roomThermostat/v1
setpointShift Thermostat: offset from the base setpoint (9.002, in K). roomThermostat/v1
setpointStatus Thermostat: current setpoint (9.001). roomThermostat/v1
hvacMode Thermostat: selected mode (20.102: 0 auto, 1 comfort, 2 standby, 3 economy, 4 protection). roomThermostat/v1
hvacModeStatus Thermostat: current mode (20.102). roomThermostat/v1
presence Thermostat: presence requests comfort mode. roomThermostat/v1
window Thermostat: an open window requests priority protection mode. roomThermostat/v1
heatCool Thermostat: 1 selects heating, 0 selects cooling (1.100). roomThermostat/v1
heatCoolStatus Thermostat: current heating or cooling mode. roomThermostat/v1
heatingValue Thermostat: continuous heating control value (5.001). roomThermostat/v1
heatingSwitch Thermostat: one-bit heating command (two-point or PWM). roomThermostat/v1
coolingValue Thermostat: continuous cooling control value (5.001). roomThermostat/v1
coolingSwitch Thermostat: one-bit cooling command. roomThermostat/v1
fault Heating actuator: missing control value triggers emergency mode (1.005). heatingActuator/v1
contact Window contact: 1.019 or 1.001 uses 1 for open; 1.009 uses 1 for closed. windowContact/v1
temperature Sensor: room temperature (9.001). temperatureSensor/v1, airQualitySensor/v1
power power switchActuator/v1, energyMeter/v1
energy energy switchActuator/v1, energyMeter/v1
totalPower totalPower switchActuator/v1, energyMeter/v1
powerLimit powerLimit switchActuator/v1
slatCommand slatCommand shutterActuator/v1
slatStatus slatStatus shutterActuator/v1
windAlarm windAlarm shutterActuator/v1, weatherStation/v1
brightness brightness presenceDetector/v1, weatherStation/v1
colourTemperature colourTemperature dimmerActuator/v1
colourTemperatureStatus colourTemperatureStatus dimmerActuator/v1
logicIn logicIn logicGate/v1
enable enable logicGate/v1
time time logicGate/v1, clockMaster/v1
logicOut logicOut logicGate/v1
wind wind weatherStation/v1
outdoorTemp outdoorTemp weatherStation/v1
sunProtection sunProtection weatherStation/v1
humidity humidity airQualitySensor/v1
co2 co2 airQualitySensor/v1
co2Alarm co2Alarm airQualitySensor/v1
humidityAlarm humidityAlarm airQualitySensor/v1
ventilation ventilation airQualitySensor/v1
date date clockMaster/v1
output output timeSwitch/v1
command command systemGateway/v1