dsm-api-v2
Main Page
Related Pages
Modules
Data Structures
Files
File List
Globals
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Groups
Pages
include
dsm-api-v2
dsm-api-const.h
Go to the documentation of this file.
1
2
/*
3
This file is part of the digitalSTROM dsm-api library.
4
5
Copyright (C) 2010 digitalSTROM.org, Schlieren, Switzerland
6
7
digitalSTROM dsm-api library is free software: you can redistribute it and/or modify
8
it under the terms of the GNU Lesser General Public License as published by
9
the Free Software Foundation, either version 3 of the License, or
10
(at your option) any later version.
11
12
digitalSTROM dsm-api library is distributed in the hope that it will be useful,
13
but WITHOUT ANY WARRANTY; without even the implied warranty of
14
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
GNU Lesser General Public License for more details.
16
17
You should have received a copy of the GNU Lesser General Public License
18
along with digitalSTROM dsm-api library. If not, see <http://www.gnu.org/licenses/>.
19
20
NOTE: The dsm-api library and it's script bindings are unsupported interfaces and
21
subject to change without further notice.
22
23
*/
24
/*
25
* DO NOT MANUALLY MODIFY!
26
*
27
* THIS FILE IS AUTOGENERATED FROM THE dSM-API XML DEFINITIONS IN
28
* dsm-api.xml.
29
* Make any changes in the XML definition and regenerate this file.
30
*/
31
#ifndef DSM_API_CONST_H
32
#define DSM_API_CONST_H
33
34
#ifdef __cplusplus
35
extern
"C"
{
36
#endif
37
38
enum
DsmApiMsgId
{
39
ZONE_COUNT
= 0x00,
40
ZONE_INFO
= 0x01,
41
ZONE_MODIFY
= 0x02,
42
ZONE_DEVICE_COUNT
= 0x03,
43
ZONE_PROPERTIES
= 0x04,
44
ZONE_GROUP_MODIFY
= 0x10,
45
ZONE_GROUP_INFO
= 0x11,
46
ZONE_GROUP_PROPERTIES
= 0x12,
47
ZONE_GROUP_SCENE_INFO
= 0x18,
48
ZONE_GROUP_SCENE_PROPERTIES
= 0x19,
49
ZONE_GROUP_ACTION_REQUEST
= 0x50,
50
ZONE_SENSOR_PUSH
= 0x56,
51
DEVICE_INFO
= 0x20,
52
DEVICE_STATE
= 0x21,
53
DEVICE_STATISTICS_REQUEST
= 0x22,
54
DEVICE_PROPERTIES
= 0x23,
55
DEVICE_BUTTON_INFO
= 0x24,
56
DEVICE_BINARY_INPUT
= 0x26,
57
DEVICE_GROUP_MEMBERSHIP_MODIFY
= 0x25,
58
TEST_TRANSMISSION_QUALITY
= 0x41,
59
TEST_DEVICE_PRESENCE
= 0x42,
60
DEVICE_ACTION_REQUEST
= 0x51,
61
DEVICE_CONFIG
= 0x53,
62
DEVICE_SENSOR
= 0x52,
63
CIRCUIT_REMOVE_INACTIVE_DEVICES
= 0x31,
64
CIRCUIT_REMOVE_DEVICE
= 0x35,
65
EVENT_TEST_TRANSMISSION_QUALITY
= 0x75,
66
EVENT_TEST_DEVICE_PRESENCE
= 0x7f,
67
EVENT_DEVICE_ACCESSIBILITY
= 0x71,
68
EVENT_DEVICE_STATISTICS
= 0x72,
69
EVENT_DEVICE_ACTION
= 0x73,
70
EVENT_DEVICE_LOCAL_ACTION
= 0x76,
71
EVENT_DEVICE_CONFIG
= 0x74,
72
EVENT_DEVICE_SENSOR
= 0x7d,
73
EVENT_DEVICE_GIVE_UP
= 0x78,
74
EVENT_DEVICE_MODEL_CHANGED
= 0x79,
75
CIRCUIT_PING_DEVICES
= 0x30,
76
CIRCUIT_ENERGY_METER_VALUE
= 0x34,
77
CIRCUIT_CURRENT_METER_VALUE
= 0x36,
78
DSM_INFO
= 0x90,
79
DSM_PROPERTIES
= 0x91,
80
DSM_STATE
= 0x92,
81
DSM_CONFIG
= 0xf0,
82
DSM_STATISTICS
= 0xf2,
83
DSM_REBOOT
= 0xf4,
84
DSM_FACTORY_RESET
= 0xf5,
85
IMAGE_MAINTENANCE
= 0xfe,
86
IMAGE_TRANSFER
= 0xff,
87
EVENT_DSM_STATE_CHANGE
= 0x80,
88
ZONE_GROUP_DSLINK_SEND
= 0x54,
89
DEVICE_DSLINK_SEND
= 0x55,
90
EVENT_DSLINK
= 0x7b,
91
DSM_DEBUG_MODE
= 0xf1,
92
EVENT_COMMUNICATION_LOG
= 0x77,
93
EVENT_DSP_DEBUG_DATA
= 0x7e,
94
};
95
96
97
typedef
enum
{
98
ZONE_INFO_BY_INDEX
= 1,
99
ZONE_INFO_BY_ID
= 2,
100
}
ZoneInfoModifiers_t
;
101
102
typedef
enum
{
103
ZONE_MODIFY_ADD
= 1,
104
ZONE_MODIFY_REMOVE
= 2,
105
ZONE_MODIFY_CHANGE_ID
= 3,
106
}
ZoneModifyModifiers_t
;
107
108
typedef
enum
{
109
ZONE_DEVICE_COUNT_ONLY_ACTIVE
= 1,
110
ZONE_DEVICE_COUNT_ONLY_INACTIVE
= 2,
111
ZONE_DEVICE_COUNT_ALL
= 3,
112
}
ZoneDeviceCountModifiers_t
;
113
114
typedef
enum
{
115
ZONE_PROPERTIES_SET_NAME
= 1,
116
ZONE_PROPERTIES_GET_SCENE_HISTORY
= 2,
117
ZONE_PROPERTIES_GET_ROOM_STATES
= 3,
118
}
ZonePropertiesModifiers_t
;
119
120
typedef
enum
{
121
ZONE_GROUP_MODIFY_ADD
= 1,
122
ZONE_GROUP_MODIFY_REMOVE
= 2,
123
}
ZoneGroupModifyModifiers_t
;
124
125
typedef
enum
{
126
ZONE_GROUP_INFO_BY_INDEX
= 1,
127
ZONE_GROUP_INFO_BY_ID
= 2,
128
}
ZoneGroupInfoModifiers_t
;
129
130
typedef
enum
{
131
ZONE_GROUP_PROPERTIES_SET_NAME
= 1,
132
ZONE_GROUP_PROPERTIES_SET_STOP_TIMEOUT
= 2,
133
ZONE_GROUP_PROPERTIES_SET_STATE_MACHINE
= 3,
134
}
ZoneGroupPropertiesModifiers_t
;
135
136
137
138
typedef
enum
{
139
ZONE_GROUP_SCENE_PROPERTIES_SET_NAME
= 1,
140
}
ZoneGroupScenePropertiesModifiers_t
;
141
142
typedef
enum
{
143
ZONE_GROUP_ACTION_REQUEST_ACTION_CALL_SCENE
= 1,
144
ZONE_GROUP_ACTION_REQUEST_ACTION_SAVE_SCENE
= 2,
145
ZONE_GROUP_ACTION_REQUEST_ACTION_UNDO_SCENE
= 3,
146
ZONE_GROUP_ACTION_REQUEST_ACTION_BLINK
= 4,
147
ZONE_GROUP_ACTION_REQUEST_ACTION_UNDO_SCENE_NUMBER
= 5,
148
ZONE_GROUP_ACTION_REQUEST_ACTION_FORCE_CALL_SCENE
= 6,
149
ZONE_GROUP_ACTION_REQUEST_ACTION_SET_OUTVAL
= 7,
150
ZONE_GROUP_ACTION_REQUEST_ACTION_SET_SCENE_LOCAL_PRIORITY
= 8,
151
ZONE_GROUP_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_ON
= 9,
152
ZONE_GROUP_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_OFF
= 10,
153
ZONE_GROUP_ACTION_REQUEST_ACTION_SELECT_GROUP
= 11,
154
ZONE_GROUP_ACTION_REQUEST_ACTION_REGISTER_SCENE_LOCAL_PRIORITY
= 12,
155
ZONE_GROUP_ACTION_REQUEST_ACTION_CALL_SCENE_MIN
= 13,
156
ZONE_GROUP_ACTION_REQUEST_ACTION_LOCAL_STOP
= 14,
157
}
ZoneGroupActionRequestModifiers_t
;
158
159
160
161
typedef
enum
{
162
DEVICE_INFO_BY_INDEX_ONLY_ACTIVE
= 1,
163
DEVICE_INFO_BY_INDEX_ONLY_INACTIVE
= 2,
164
DEVICE_INFO_BY_INDEX
= 3,
165
DEVICE_INFO_BY_DEVICE_ID
= 4,
166
}
DeviceInfoModifiers_t
;
167
168
169
170
typedef
enum
{
171
DEVICE_STATISTICS_REQUEST_GET
= 1,
172
}
DeviceStatisticsRequestModifiers_t
;
173
174
typedef
enum
{
175
DEVICE_PROPERTIES_SET_ZONE
= 1,
176
DEVICE_PROPERTIES_SET_LOCKED_FLAG
= 4,
177
DEVICE_PROPERTIES_SET_NAME
= 5,
178
DEVICE_PROPERTIES_SET_BUTTON_ACTIVE_GROUP
= 8,
179
DEVICE_PROPERTIES_RESET_BUTTON_ACTIVE_GROUP
= 9,
180
DEVICE_PROPERTIES_SET_BUTTON_SET_LOCAL_PRIORITY
= 10,
181
DEVICE_PROPERTIES_SET_BUTTON_SET_NO_COMING_HOME_CALL
= 11,
182
DEVICE_PROPERTIES_SET_BUTTON_SET_APARTMENT
= 12,
183
}
DevicePropertiesModifiers_t
;
184
185
typedef
enum
{
186
DEVICE_BUTTON_INFO_BY_DEVICE
= 1,
187
}
DeviceButtonInfoModifiers_t
;
188
189
typedef
enum
{
190
DEVICE_BINARY_INPUT_GET_COUNT
= 1,
191
DEVICE_BINARY_INPUT_GET_BY_INDEX
= 2,
192
}
DeviceBinaryInputModifiers_t
;
193
194
typedef
enum
{
195
DEVICE_GROUP_MEMBERSHIP_MODIFY_ADD
= 1,
196
DEVICE_GROUP_MEMBERSHIP_MODIFY_REMOVE
= 2,
197
}
DeviceGroupMembershipModifyModifiers_t
;
198
199
typedef
enum
{
200
TEST_TRANSMISSION_QUALITY_GET
= 1,
201
}
TestTransmissionQualityModifiers_t
;
202
203
204
205
typedef
enum
{
206
DEVICE_ACTION_REQUEST_ACTION_CALL_SCENE
= 1,
207
DEVICE_ACTION_REQUEST_ACTION_SAVE_SCENE
= 2,
208
DEVICE_ACTION_REQUEST_ACTION_UNDO_SCENE
= 3,
209
DEVICE_ACTION_REQUEST_ACTION_BLINK
= 4,
210
DEVICE_ACTION_REQUEST_ACTION_UNDO_SCENE_NUMBER
= 5,
211
DEVICE_ACTION_REQUEST_ACTION_FORCE_CALL_SCENE
= 6,
212
DEVICE_ACTION_REQUEST_ACTION_SET_OUTVAL
= 7,
213
DEVICE_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_ON
= 9,
214
DEVICE_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_OFF
= 10,
215
}
DeviceActionRequestModifiers_t
;
216
217
typedef
enum
{
218
DEVICE_CONFIG_GET
= 1,
219
DEVICE_CONFIG_SET
= 2,
220
}
DeviceConfigModifiers_t
;
221
222
typedef
enum
{
223
DEVICE_SENSOR_GET_VALUE
= 1,
224
DEVICE_SENSOR_GET_TYPE
= 2,
225
}
DeviceSensorModifiers_t
;
226
227
228
229
typedef
enum
{
230
CIRCUIT_REMOVE_DEVICE_
= 0,
231
CIRCUIT_REMOVE_DEVICE_BY_ID
= 1,
232
CIRCUIT_REMOVE_DEVICE_BY_DSID
= 2,
233
}
CircuitRemoveDeviceModifiers_t
;
234
235
236
237
238
239
typedef
enum
{
240
EVENT_DEVICE_ACCESSIBILITY_ON
= 1,
241
EVENT_DEVICE_ACCESSIBILITY_OFF
= 2,
242
}
EventDeviceAccessibilityModifiers_t
;
243
244
245
246
247
248
249
250
251
252
typedef
enum
{
253
EVENT_DEVICE_SENSOR_VALUE
= 1,
254
EVENT_DEVICE_SENSOR_TYPE
= 2,
255
EVENT_DEVICE_SENSOR_EVENT
= 3,
256
EVENT_DEVICE_SENSOR_BINARYINPUTEVENT
= 4,
257
}
EventDeviceSensorModifiers_t
;
258
259
260
261
262
263
typedef
enum
{
264
CIRCUIT_PING_DEVICES_AUTOMATIC
= 1,
265
CIRCUIT_PING_DEVICES_ONE_TIME_AUTOMATIC
= 2,
266
CIRCUIT_PING_DEVICES_ONE_TIME_OFF
= 3,
267
CIRCUIT_PING_DEVICES_OFF
= 4,
268
}
CircuitPingDevicesModifiers_t
;
269
270
typedef
enum
{
271
CIRCUIT_ENERGY_METER_VALUE_GET
= 1,
272
CIRCUIT_ENERGY_METER_VALUE_RESET
= 2,
273
CIRCUIT_ENERGY_METER_VALUE_CALIBRATION
= 3,
274
CIRCUIT_ENERGY_METER_VALUE_WS_GET
= 4,
275
}
CircuitEnergyMeterValueModifiers_t
;
276
277
typedef
enum
{
278
CIRCUIT_CURRENT_METER_VALUE_GET
= 1,
279
}
CircuitCurrentMeterValueModifiers_t
;
280
281
282
283
typedef
enum
{
284
DSM_PROPERTIES_SET_NAME
= 1,
285
DSM_PROPERTIES_SET_APARTMENT_ID
= 2,
286
DSM_PROPERTIES_SET_TEMPERATURE_LIMITS
= 3,
287
DSM_PROPERTIES_GET_APARTMENT_ID
= 4,
288
DSM_PROPERTIES_GET_TEMPERATURE_LIMITS
= 5,
289
DSM_PROPERTIES_GET_CURRENT_TEMPERATURE
= 6,
290
DSM_PROPERTIES_SET_FLAGS
= 7,
291
DSM_PROPERTIES_GET_FLAGS
= 8,
292
DSM_PROPERTIES_GET_POWER_DOWN_DURATION
= 9,
293
DSM_PROPERTIES_SET_PING_INTERVALS
= 10,
294
DSM_PROPERTIES_GET_PING_INTERVALS
= 11,
295
DSM_PROPERTIES_GET_MAX_TEMPERATURE
= 12,
296
DSM_PROPERTIES_RESET_MAX_TEMPERATURE
= 13,
297
DSM_PROPERTIES_SET_UPSTREAM_FREQUENCY
= 14,
298
DSM_PROPERTIES_GET_UPSTREAM_FREQUENCY
= 15,
299
}
dSMPropertiesModifiers_t
;
300
301
302
303
typedef
enum
{
304
DSM_CONFIG_SET_DSM_CONFIG
= 1,
305
DSM_CONFIG_GET_DSP_CONFIG
= 2,
306
DSM_CONFIG_SET_DSP_CONFIG
= 3,
307
DSM_CONFIG_GET_HASH
= 4,
308
}
dSMConfigModifiers_t
;
309
310
typedef
enum
{
311
DSM_STATISTICS_GET_DS485
= 1,
312
DSM_STATISTICS_RESET_DS485
= 2,
313
DSM_STATISTICS_GET_UPSTREAM
= 3,
314
DSM_STATISTICS_RESET_UPSTREAM
= 4,
315
DSM_STATISTICS_GET_INTERNALS
= 5,
316
DSM_STATISTICS_RESET_INTERNALS
= 6,
317
DSM_STATISTICS_GET_POOL_MARGINS
= 7,
318
DSM_STATISTICS_GET_STOP_TIMER
= 8,
319
}
dSMStatisticsModifiers_t
;
320
321
322
323
324
325
typedef
enum
{
326
IMAGE_MAINTENANCE_CHECK_IMAGE
= 1,
327
IMAGE_MAINTENANCE_GET_IMAGE_INFO
= 2,
328
IMAGE_MAINTENANCE_START_UPDATE
= 3,
329
IMAGE_MAINTENANCE_REMOVE_IMAGE
= 4,
330
}
ImageMaintenanceModifiers_t
;
331
332
typedef
enum
{
333
IMAGE_TRANSFER_WRITE_REQUEST
= 1,
334
IMAGE_TRANSFER_DATA
= 2,
335
}
ImageTransferModifiers_t
;
336
337
338
339
typedef
enum
{
340
ZONE_GROUP_DSLINK_SEND_NOT_LAST_BYTE_NO_ANSWER
= 1,
341
ZONE_GROUP_DSLINK_SEND_LAST_BYTE_NO_ANSWER
= 2,
342
}
ZoneGroupDslinkSendModifiers_t
;
343
344
typedef
enum
{
345
DEVICE_DSLINK_SEND_NOT_LAST_BYTE_NO_ANSWER
= 1,
346
DEVICE_DSLINK_SEND_LAST_BYTE_NO_ANSWER
= 2,
347
DEVICE_DSLINK_SEND_NOT_LAST_BYTE_WITH_ANSWER
= 3,
348
DEVICE_DSLINK_SEND_LAST_BYTE_WITH_ANSWER
= 4,
349
}
DeviceDslinkSendModifiers_t
;
350
351
typedef
enum
{
352
EVENT_DSLINK_RESPONSE
= 1,
353
EVENT_DSLINK_INTERRUPT
= 2,
354
}
EventDslinkModifiers_t
;
355
356
typedef
enum
{
357
DSM_DEBUG_MODE_SET_MMI_FLAG
= 2,
358
DSM_DEBUG_MODE_GET_MMI_FLAG
= 1,
359
DSM_DEBUG_MODE_STOP_SELECT_B
= 3,
360
DSM_DEBUG_MODE_RESTART_REGISTRATION
= 4,
361
DSM_DEBUG_MODE_RESTART_DSP
= 5,
362
DSM_DEBUG_MODE_READ_FLASH
= 6,
363
DSM_DEBUG_MODE_WRITE_FLASH
= 7,
364
DSM_DEBUG_MODE_GET_COMMUNICATION_LOG_STATE
= 8,
365
DSM_DEBUG_MODE_SET_COMMUNICATION_LOG_STATE
= 9,
366
DSM_DEBUG_MODE_DISABLE_JUMBLE
= 10,
367
DSM_DEBUG_MODE_INJECT_SHORT_UPSTREAM
= 12,
368
DSM_DEBUG_MODE_INJECT_LONG_UPSTREAM
= 13,
369
}
dSMDebugModeModifiers_t
;
370
371
typedef
enum
{
372
EVENT_COMMUNICATION_LOG_UPSTREAM_SHORT
= 1,
373
EVENT_COMMUNICATION_LOG_UPSTREAM_LONG
= 2,
374
EVENT_COMMUNICATION_LOG_DOWNSTREAM_SHORT
= 3,
375
EVENT_COMMUNICATION_LOG_DOWNSTREAM_LONG_16BIT_PARAMETER
= 4,
376
EVENT_COMMUNICATION_LOG_DOWNSTREAM_LONG_8BIT_PARAMETER
= 5,
377
EVENT_COMMUNICATION_LOG_DOWNSTREAM_LONG_NO_PARAMETER
= 6,
378
}
EventCommunicationLogModifiers_t
;
379
380
381
382
enum
DsmApiErrorCodes
{
383
ERROR_OK
= 0x00,
384
ERROR_WRONG_PARAMETER
= 0x01,
385
ERROR_ZONE_NOT_FOUND
= 0x02,
386
ERROR_DEVICE_NOT_FOUND
= 0x03,
387
ERROR_GROUP_NOT_FOUND
= 0x04,
388
ERROR_ZONE_CAN_NOT_BE_DELETED
= 0x05,
389
ERROR_GROUP_CAN_NOT_BE_DELETED
= 0x06,
390
ERROR_DEVICE_CAN_NOT_BE_DELETED
= 0x07,
391
ERROR_NO_FURTHER_ZONES
= 0x08,
392
ERROR_NO_FURTHER_GROUPS
= 0x09,
393
ERROR_ZONE_ALREADY_EXISTS
= 0x0a,
394
ERROR_GROUP_ALREADY_EXISTS
= 0x0b,
395
ERROR_ZONE_NOT_EMPTY
= 0x0c,
396
ERROR_TIMEOUT
= 0x0d,
397
ERROR_WRONG_SIZE
= 0x0e,
398
ERROR_WRONG_MSGID
= 0x0f,
399
ERROR_WRONG_MODIFIER
= 0x10,
400
ERROR_WRONG_PACKET_NR
= 0x11,
401
ERROR_WRONG_IMAGE_SIZE
= 0x12,
402
ERROR_NO_IMAGE_TRANSFER_ACTIVE
= 0x13,
403
ERROR_IMAGE_INVALID
= 0x14,
404
ERROR_NO_CONFIG
= 0x15,
405
ERROR_REQUEST_CAN_NOT_BE_EXECUTED
= 0x16,
406
ERROR_OUT_OF_RESOURCES
= 0x17,
407
ERROR_PROGRAMMING_MODE_IS_DISABLED
= 0x18,
408
};
409
enum
DsmApiParameterLength
{
410
NAME_LEN
= 21,
411
DSID_LEN
= 12,
412
DATA_LEN_
= 122,
413
CONFIG_LEN
= 96,
414
STATISTICS_LEN
= 96,
415
GROUPS_LEN
= 8,
416
DATA_LEN
= 64,
417
};
418
419
#ifdef __cplusplus
420
}
421
#endif
422
423
#endif
/* DSM_API_CONST_H */
Generated on Wed Apr 30 2014 08:56:32 for dsm-api-v2 by
1.8.4