supla-device
•All Classes Functions Variables Pages
actions.h
1/*
2 Copyright (C) AC SOFTWARE SP. Z O.O.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
12 You should have received a copy of the GNU General Public License
13 along with this program; if not, write to the Free Software
14 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
15*/
16
17#ifndef SRC_SUPLA_ACTIONS_H_
18#define SRC_SUPLA_ACTIONS_H_
19
20// Actions are used in ActionHandler elements. They are grouped by most common
21// usage, but you should not rely on it. Please check exact supported actions
22// in ActionHandler's element documentation
23
24namespace Supla {
25enum Action {
26 // Relays
27 TURN_ON,
28 TURN_ON_WITHOUT_TIMER, // used with staircase timer function, when
29 // timer should not be used this time
30 TURN_OFF,
31 TOGGLE,
32
33 // Settable binary sensors
34 SET,
35 CLEAR,
36
37 // Roller shutters
38 OPEN,
39 CLOSE,
40 STOP,
41 OPEN_OR_STOP,
42 CLOSE_OR_STOP,
43 COMFORT_UP_POSITION,
44 COMFORT_DOWN_POSITION,
45 STEP_BY_STEP,
46 MOVE_UP,
47 MOVE_DOWN,
48 MOVE_UP_OR_STOP,
49 MOVE_DOWN_OR_STOP,
50 INTERNAL_BUTTON_MOVE_UP_OR_STOP,
51 INTERNAL_BUTTON_MOVE_DOWN_OR_STOP,
52
53 // Dimmable light, RGB(W) LEDs
54 BRIGHTEN_ALL,
55 DIM_ALL,
56 BRIGHTEN_R,
57 BRIGHTEN_G,
58 BRIGHTEN_B,
59 BRIGHTEN_W,
60 BRIGHTEN_RGB,
61 DIM_R,
62 DIM_G,
63 DIM_B,
64 DIM_W,
65 DIM_RGB,
66 TURN_ON_RGB,
67 TURN_OFF_RGB,
68 TOGGLE_RGB,
69 TURN_ON_W,
70 TURN_OFF_W,
71 TOGGLE_W,
72 TURN_ON_RGB_DIMMED,
73 TURN_ON_W_DIMMED,
74 TURN_ON_ALL_DIMMED,
75 ITERATE_DIM_RGB,
76 ITERATE_DIM_W,
77 ITERATE_DIM_ALL,
78
79 // Impulse counter
80 RESET,
81 INCREMENT,
82 DECREMENT,
83 ENABLE,
84 DISABLE,
85
86 // Action trigger
87 SEND_AT_TURN_ON,
88 SEND_AT_TURN_OFF,
89 SEND_AT_TOGGLE_x1,
90 SEND_AT_TOGGLE_x2,
91 SEND_AT_TOGGLE_x3,
92 SEND_AT_TOGGLE_x4,
93 SEND_AT_TOGGLE_x5,
94 SEND_AT_HOLD,
95 SEND_AT_SHORT_PRESS_x1,
96 SEND_AT_SHORT_PRESS_x2,
97 SEND_AT_SHORT_PRESS_x3,
98 SEND_AT_SHORT_PRESS_x4,
99 SEND_AT_SHORT_PRESS_x5,
100
101 // SuplaDevice
102 ENTER_CONFIG_MODE,
103 TOGGLE_CONFIG_MODE,
104 RESET_TO_FACTORY_SETTINGS,
105 SOFT_RESTART,
106 START_LOCAL_WEB_SERVER,
107 STOP_LOCAL_WEB_SERVER,
108 CHECK_SW_UPDATE,
109 LEAVE_CONFIG_MODE_AND_RESET,
110 ENTER_CONFIG_MODE_OR_RESET_TO_FACTORY,
111
112 // Weight sensor
113 TARE_SCALES,
114
115 VOLUME_UP,
116 VOLUME_DOWN,
117 MUTE_SOUND_ALARM,
118 ENABLE_EXTERNAL_SOUND_ALARM,
119 DISABLE_EXTERNAL_SOUND_ALARM,
120
121 // Thermostat
122 INCREASE_TEMPERATURE,
123 DECREASE_TEMPERATURE,
124 INCREASE_HEATING_TEMPERATURE,
125 DECREASE_HEATING_TEMPERATURE,
126 INCREASE_COOLING_TEMPERATURE,
127 DECREASE_COOLING_TEMPERATURE,
128 SWITCH_TO_MANUAL_MODE,
129 SWITCH_TO_WEEKLY_SCHEDULE_MODE,
130 SWITCH_TO_MANUAL_MODE_HEAT,
131 SWITCH_TO_MANUAL_MODE_COOL,
132 SWITCH_TO_MANUAL_MODE_HEAT_COOL,
133 TOGGLE_MANUAL_WEEKLY_SCHEDULE_MODES,
134 TOGGLE_OFF_MANUAL_WEEKLY_SCHEDULE_MODES,
135};
136}; // namespace Supla
137
138#endif // SRC_SUPLA_ACTIONS_H_
Generated by doxygen 1.13.2