Action Types AIO

From OpenMotics
Revision as of 14:50, 6 December 2017 by Wilbert (talk | contribs) (Created page with "This page provides an overview of the action type bytes used in a Basic Action. A Basic Action always has 2 bytes: # the action type # the action number The Basic Action i...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This page provides an overview of the action type bytes used in a Basic Action. A Basic Action always has 2 bytes:

  1. the action type
  2. the action number

The Basic Action is used for special functions at input page level, group actions, simple decisions and others.

See Also:


Versioning

This document describes the Action Type Bytes available on the Gateway Module CLI interface.

Gateway Module FW version
3.140.x

Action Type Bytes

Action Byte Description
0
Simple Action (Old instruction set, please do not use anymore)
1
Simple Decision, ignore THEN/ELSE action, ignore previous decision (Old instruction set, please do not use anymore)
2
Execute Group Action
3
Put this Scheduled Action in the scheduled action queue
4
Used by the system (to indicate in the queue which input has triggered the actions in the queue)
7
Remove this Scheduled Action from the Scheduled action queue
9
Simple Decision, perform THEN/ELSE action, ignore previous decision (Old instruction set, please do not use anymore)
17
Simple Decision, ignore THEN/ELSE action, perform "OR" with previous decision (Old instruction set, please do not use anymore)
25
Simple Decision, perform THEN/ELSE action, perform "OR" with previous decision (Old instruction set, please do not use anymore)
49
Simple Decision, ignore THEN/ELSE action, perform "AND" with previous decision (Old instruction set, please do not use anymore)
57
Simple Decision, perform THEN/ELSE action, perform "AND" with previous decision (Old instruction set, please do not use anymore)
60
Will sent Event (API instruction EV) to the Beagle Bone Black and RTI RS232 port (when enabled) with Event Code x
64
x=0 Put all Modules in lower power state (switch off leds except power and status led), x=1 Normal power state, x=2 normal power state for 2 minutes
65
Flash led of output x
66
Flash led of input x
67
Flash led of sensor x
68
Press virtual input x
69
Release virtual input x
70
Switch OFF 5V out off all temperature modules (switch ON 5V will automatically happen after 5 minutes)
71
Switch ON 5V out off all temperature modules
72
Reset 12V out power on the gateway so all remote modules connected on BUS1 of the Gateway will get a power reset (Master will not respond during 5 seconds)
73
Switch ON DALI group x, see DALI Installation Guide for more details
74
Switch OFF DALI group x, see DALI Installation Guide for more details
75
Switch ON CAN power of all CAN controls (micro CAN's will receive power)
76
Switch OFF CAN power of all CAN controls (micro CAN's won't receive any power and will be switched off)
79
This Basic Action will set the CleanTimerQueue setting. When Basic actions are added to the timer queue (for delayed action for example), the Master processor will check for the same Basic actions and remove the previous one. When x=0 -> Clean Timer Queue is disabled, when x<>0 -> Clean Timer Queue is enabled (standard setting) - see #Delaying Instructions and see BA235
80
Sets the Cooling or Heating mode: x=0 -> Heating is enabled and Cooling is disabled, x=1 -> Cooling is enabled (but OFF) and Heating is disabled, x=2 -> Cooling is enabled (and ON) and Heating is disabled
81
Sets or clears the Airco Status Bit (ASB) to switch on/off the Airco unit with RTD-10 function: x<24 -> Switch on the Airco unit with RTD-10 function for thermostat x, x>99 and x<124 -> Switch off the airco unit with RTD-10 function for thermostat x-100.
82
Sets the permanent manual mode for an individual thermostat (heating or Cooling), see Virtual Sensors. x=0 to 23: Set permanent manual mode for Heating thermostat (0-23), x=32 to 55: Set permanent manual mode for Cooling thermostat (0-23).
83
Clears the permanent manual mode for an individual thermostat (heating or Cooling), See Virtual Sensors. x=0 to 23: Clear permanent manual mode for Heating thermostat (0-23), x=32 to 55: Clear permanent manual mode for Cooling thermostat (0-23).
90
Sets Auto mode for thermostat x (x<24) – (Only works in Thermostat Multi Tenant mode)
91
Sets Manual mode for thermostat x (x<24) - (Only works in Thermostat Multi Tenant mode)
100
Roller/Shutter x up (only to be used in Large Installation mode, x<120)
101
Roller/Shutter x down (only to be used in Large Installation mode, x<120)
102
Roller/Shutter x stop (only to be used in Large Installation mode, x<120)
103
Roller/Shutter x up/stop/down/stop... (only to be used in Large Installation mode, x<120)
104
All Roller/Shutters of group x up (only to be used in Large Installation mode, x<30)
105
All Roller/Shutters of group x down (only to be used in Large Installation mode, x<30)
106
All Roller/Shutters of group x stop (only to be used in Large Installation mode, x<30)
107
All Roller/Shutters of group x up/stop/down/stop... (only to be used in Large Installation mode, x<30)
108
Roller/Shutter x up/stop/up/stop... (only to be used in Large Installation mode, x<120)
109
Roller/Shutter x down/stop/down/stop... (only to be used in Large Installation mode, x<120)
110
All Roller/Shutters of group x up/stop/up/stop... (only to be used in Large Installation mode, x<30)
111
All Roller/Shutters of group x down/stop/down/stop... (only to be used in Large Installation mode, x<30)
116
Disable input x (0-239)
117
Enable input x (0-239)
118
Reset Pulse Counters of all Modules
120
Put free variable x (0-31) at zero
121
Decrease free variable x (0-31) with 1
122
Increase free variable x (0-31) with 1
123
Decrease free variable x (0-31) with 2
124
Increase free variable x (0-31) with 2
125
Decrease free variable x (0-31) with 3
126
Increase free variable x (0-31) with 3
128
Temperature Setpoint 0 for thermostat x (x<24) – Day 1
129
Temperature Setpoint 1 for thermostat x (x<24) – Night
130
Temperature Setpoint 2 for thermostat x (x<24) – Day 2
131
Temperature Setpoint 3 for thermostat x (x<24) - Away
132
Temperature Setpoint 4 for thermostat x (x<24) - Vacation
133
Temperature Setpoint 5 for thermostat x (x<24) - Party
134
Setpoint 0 for all thermostats – Day 1 (Only works in normal mode, not in Thermostat Multi Tenant mode)
135
Setpoint 1 for all thermostats - Night (Only works in normal mode, not in Thermostat Multi Tenant mode)
136
Setpoint 2 for all thermostats – Day 2 (Only works in normal mode, not in Thermostat Multi Tenant mode)
137
Setpoint 3 for all thermostats - Away (Works in normal mode and in Thermostat Multi Tenant mode)
138
Setpoint 4 for all thermostats - Vacation (Works in normal mode and in Thermostat Multi Tenant mode)
139
Setpoint 5 for all thermostats - Party (Works in normal mode and in Thermostat Multi Tenant mode)
140
Set ThermostatMode x (Only used in normal mode or when changing from normal to multi-tenant mode or visa versa, not in Thermostat Multi Tenant mode)
141
Set ThermostatMode for all thermostats to Manual (x=0 -> ThermostatMode.Bit3=0) or automatic (x>0) (Works in normal mode and in Thermostat Multi Tenant mode)
142
decrease current setpoint of thermostat x with 0,5 degree
143
Increase current setpoint of thermostat x with 0,5 degree
144
Reserved (for Oled)
145
"Day 1" Programmed Setpoint of that day for thermostat x – Day 1
146
"Day 2" Programmed Setpoint of that day for thermostat x – Day 2
147
"Night" Programmed Setpoint of that day for thermostat x – Night
148
Set setpoint of thermostat x at 16 degree Celsius
149
Set setpoint of thermostat x at 22.5 degree Celsius
154
Increase light/output level of output/light x with 1 step until programmed Maximum (63) light level is achieved (x<240)
155
Increase light/output level of output/light x with 2 steps until programmed Maximum (63) light level is achieved (x<240)
156
Increase light/output level of output/light x with 3 steps until programmed Maximum (63) light level is achieved (x<240)
157
Dim light/output x down with 1 step until programmed Minimum light level is achieved (x<240)
158
Dim light/output x down with 2 steps until programmed Minimum light level is achieved (x<240)
159
Dim light/output x down with 3 steps until programmed Minimum light level is achieved (x<240)
160
Light/Output x Off (x<240)
161
Light/Output x On (x<240, with standard timer setting, with last dimmer value)
162
Toggle light/Output x (x<240, with standard timer setting, with last dimmer value), see #Toggling Lights
163
All lights off (x=any value but <240)
164
All outputs including lights off (x=any value but <240)
165
Light/Output x On (x<240, with standard timer setting, at minimum dimmer value)
166
Light/Output x On (x<240, with standard timer setting, at maximum dimmer value)
167
Light/Output x On (x<240, with standard timer setting, decrease dimmer value with 5)
168
Light/Output x On (x<240, with standard timer setting, increase dimmer value with 5)
169
Set Dimmer value x at minimum (leaving the output at the current state)
170
Set Dimmer value x at maximum (leaving the output at the current state)
171
All lights OFF of a certain floor level or group (x=floor level or group, x=0..254, when x=255 then all lights are selected)
172
All lights ON of a certain floor level or group (x=floor level or group, x=0..254, when x=255 then all lights are selected)
173
Toggle all lights of a certain floor or group (x=floor level or group, x=0..254, when x=255 then all lights are selected), see #Toggling a Floor
174
Toggle Follow function ON (see #Toggling Lights), action number not used but must be < 240
175
Toggle Follow function OFF (see #Toggling Lights), action number not used but must be < 240
176
Light/Output x On with dimmer at 10% (x<240, with standard timer setting)
177
Light/Output x On with dimmer at 20% (x<240, with standard timer setting)
178
Light/Output x On with dimmer at 30% (x<240, with standard timer setting)
179
Light/Output x On with dimmer at 40% (x<240, with standard timer setting)
180
Light/Output x On with dimmer at 50% (x<240, with standard timer setting)
181
Light/Output x On with dimmer at 60% (x<240, with standard timer setting)
182
Light/Output x On with dimmer at 70% (x<240, with standard timer setting)
183
Light/Output x On with dimmer at 80% (x<240, with standard timer setting)
184
Light/Output x On with dimmer at 90% (x<240, with standard timer setting)
185
Toggle/Output light x with dimmer at 10% (x<240, with standard timer setting)
186
Toggle light/Output x with dimmer at 20% (x<240, with standard timer setting)
187
Toggle light/Output x with dimmer at 30% (x<240, with standard timer setting)
188
Toggle light/Output x with dimmer at 40% (x<240, with standard timer setting)
189
Toggle light/Output x with dimmer at 50% (x<240, with standard timer setting)
190
Toggle light/Output x with dimmer at 60% (x<240, with standard timer setting)
191
Toggle light/Output x with dimmer at 70% (x<240, with standard timer setting)
192
Toggle light/Output x with dimmer at 80% (x<240, with standard timer setting)
193
Toggle light/Output x with dimmer at 90% (x<240, with standard timer setting)
194
Toggle light/Output x with dimmer at 100% (x<240, with standard timer setting)
195
Light/Output x on with timer at 2 min 30 and overrule timer value when light is already switched on (x<240, with last dimmer value) - see #Timers
196
Light/Output x on with timer at 7 min 30 and overrule timer value when light is already switched on (x<240, with last dimmer value) - see #Timers
197
Light/Output x on with timer at 15 min and overrule timer value when light is already switched on (x<240, with last dimmer value) - see #Timers
198
Light/Output x on with timer at 25 min and overrule timer value when light is already switched on (x<240, with last dimmer value) - see #Timers
199
Light/Output x on with timer at 37 min and overrule timer value when light is already switched on (x<240, with last dimmer value) - see #Timers
200
Light/Output x on with timer at 52 min and overrule timer value when light is already switched on (x<240, with last dimmer value) - see #Timers
201
Light/Output x on with timer at 2 min 30 but doesn't overrule timer value when light is already switched on (x<240, with last dimmer value)
202
Light/Output x on with timer at 7 min 30 but doesn't overrule timer value when light is already switched on (x<240, with last dimmer value)
203
Light/Output x on with timer at 15 min but doesn't overrule timer value when light is already switched on (x<240, with last dimmer value)
204
Light/Output x on with timer at 25 min but doesn't overrule timer value when light is already switched on (x<240, with last dimmer value)
205
Light/Output x on with timer at 37 min but doesn't overrule timer value when light is already switched on (x<240, with last dimmer value)
206
Light/Output x on with timer at 52 min but doesn't overrule timer value when light is already switched on (x<240, with last dimmer value)
207
When current input is pressed for more than 2 seconds, execute group action x (See #Long Press)
208
When current input is pressed for more than 3 seconds, execute group action x (See #Long Press)
209
When current input is pressed for more than 4 seconds, execute group action x (See #Long Press)
210
When current input is pressed for more than 5 seconds, execute group action x (See #Long Press)
211
When current input is pressed for more than 6 seconds, execute group action x (See Note "Long Press")
212
Switch CAN led x OFF (see #Important Remarks)
213
Switch CAN led x ON (see #Important Remarks)
214
Fast blinking of CAN led x (see #Important Remarks)
215
Medium blinking of CAN led x (see #Important Remarks)
216
Slow blinking of CAN led x (see #Important Remarks)
217
Fade ON/OFF of CAN led x (see #Important Remarks)
218
Set minimum brightness of all CAN leds at value x (see #Important Remarks)
219
Set maximum brightness of all CAN leds at value x (see #Important Remarks)
232
Set Oled Display Time out (x=1 to 255) -> Timeout in seconds = x.1,2s. If x=0 then DisplayTimeout=255
233
Enable/Disable Touchscreen of Remote Oled screens (disabled when x=0, enabled when x>0)
234
Switch Remote Oled screens On (when x>=1) or Off (when x=0)
235
Delay all next instructions with x seconds (x>0 and <249), x=255 -> All next instruction will be executed normally (see #Delaying Instructions and see BA79)
236
Execute all next actions at button release (x=0), x=255 -> All next instructions will be executed normally (see #Additional Actions)
237
Set the freely assigned validation bit x to 1 (x=0 to 255)
238
Set the freely assigned validation bit x to 0 (x=0 to 255)
239
Toggle the freely assigned validation bit x (x=0 to 255)
240
IF THEN ELSE ENDIF (X=0 -> IF, X=1 -> AND, X=2 -> OR, X=3 -> XOR, X=4 -> NAND, X=5 -> NOR, X=6 -> NXOR, X=10 -> THEN, X=20 -> ELSE, X=255 -> ENDIF (See #If Then Else EndIf)
241
Check if input x is ON (To be used with IF THEN ELSE instruction)
242
Check if input x is OFF (To be used with IF THEN ELSE instruction)
243
Check if Light/Output x is ON (To be used with IF THEN ELSE instruction)
244
Check if Light/Output x is OFF (To be used with IF THEN ELSE instruction)
245
Check if Validation bit x is ON (To be used with IF THEN ELSE instruction)
246
Check if Validation bit x is OFF (To be used with IF THEN ELSE instruction)
247
Check if temperature sensor 0-31 (x=0-31) or if humidity sensor 0-31 (x=32-63) or if light sensor 0-31 (x=64-95) or if temperature setpoint 0-23 (x=96-119) or if free variable 0-31 (x=128-159) or if time hour (x=228) or if time minute (x=229) or if day (x=230) is or if thermostat mode (x=235)… (always to be followed by action type 248 or 249 or 250) (see #Additional Input Values). All environmental parameters are written in System Value
248
is equal to x (to be used always with action type 247) (see #Additional Input Values)
249
is higher than x (to be used always with action type 247) (see #Additional Input Values)
250
is lower than x (to be used always with action type 247) (see #Additional Input Values)
254
Reset the Master