|
dsm-api-v2
|
|
dsm-api-v2
|
00001 00002 /* 00003 This file is part of the digitalSTROM dsm-api library. 00004 00005 Copyright (C) 2010 digitalSTROM.org, Schlieren, Switzerland 00006 00007 digitalSTROM dsm-api library is free software: you can redistribute it and/or modify 00008 it under the terms of the GNU Lesser General Public License as published by 00009 the Free Software Foundation, either version 3 of the License, or 00010 (at your option) any later version. 00011 00012 digitalSTROM dsm-api library is distributed in the hope that it will be useful, 00013 but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00015 GNU Lesser General Public License for more details. 00016 00017 You should have received a copy of the GNU Lesser General Public License 00018 along with digitalSTROM dsm-api library. If not, see <http://www.gnu.org/licenses/>. 00019 00020 NOTE: The dsm-api library and it's script bindings are unsupported interfaces and 00021 subject to change without further notice. 00022 00023 */ 00024 /* 00025 * DO NOT MANUALLY MODIFY! 00026 * 00027 * THIS FILE IS AUTOGENERATED FROM THE dSM-API XML DEFINITIONS IN 00028 * dsm-api.xml. 00029 * Make any changes in the XML definition and regenerate this file. 00030 */ 00031 #ifndef DSM_API_CONST_H 00032 #define DSM_API_CONST_H 00033 00034 #ifdef __cplusplus 00035 extern "C" { 00036 #endif 00037 00038 enum DsmApiMsgId { 00039 ZONE_COUNT = 0x00, 00040 ZONE_INFO = 0x01, 00041 ZONE_MODIFY = 0x02, 00042 ZONE_DEVICE_COUNT = 0x03, 00043 ZONE_PROPERTIES = 0x04, 00044 ZONE_GROUP_MODIFY = 0x10, 00045 ZONE_GROUP_INFO = 0x11, 00046 ZONE_GROUP_PROPERTIES = 0x12, 00047 ZONE_GROUP_SCENE_INFO = 0x18, 00048 ZONE_GROUP_SCENE_PROPERTIES = 0x19, 00049 ZONE_GROUP_ACTION_REQUEST = 0x50, 00050 ZONE_SENSOR_PUSH = 0x56, 00051 DEVICE_INFO = 0x20, 00052 DEVICE_STATE = 0x21, 00053 DEVICE_STATISTICS_REQUEST = 0x22, 00054 DEVICE_PROPERTIES = 0x23, 00055 DEVICE_BUTTON_INFO = 0x24, 00056 DEVICE_GROUP_MEMBERSHIP_MODIFY = 0x25, 00057 TEST_TRANSMISSION_QUALITY = 0x41, 00058 TEST_DEVICE_PRESENCE = 0x42, 00059 DEVICE_ACTION_REQUEST = 0x51, 00060 DEVICE_CONFIG = 0x53, 00061 DEVICE_SENSOR = 0x52, 00062 CIRCUIT_REMOVE_INACTIVE_DEVICES = 0x31, 00063 CIRCUIT_REMOVE_DEVICE = 0x35, 00064 EVENT_TEST_TRANSMISSION_QUALITY = 0x75, 00065 EVENT_TEST_DEVICE_PRESENCE = 0x7f, 00066 EVENT_DEVICE_ACCESSIBILITY = 0x71, 00067 EVENT_DEVICE_STATISTICS = 0x72, 00068 EVENT_DEVICE_ACTION = 0x73, 00069 EVENT_DEVICE_LOCAL_ACTION = 0x76, 00070 EVENT_DEVICE_CONFIG = 0x74, 00071 EVENT_DEVICE_SENSOR = 0x7d, 00072 EVENT_DEVICE_GIVE_UP = 0x78, 00073 EVENT_DEVICE_MODEL_CHANGED = 0x79, 00074 CIRCUIT_PING_DEVICES = 0x30, 00075 CIRCUIT_ENERGY_METER_VALUE = 0x34, 00076 CIRCUIT_CURRENT_METER_VALUE = 0x36, 00077 DSM_INFO = 0x90, 00078 DSM_PROPERTIES = 0x91, 00079 DSM_STATE = 0x92, 00080 DSM_CONFIG = 0xf0, 00081 DSM_STATISTICS = 0xf2, 00082 DSM_REBOOT = 0xf4, 00083 DSM_FACTORY_RESET = 0xf5, 00084 IMAGE_MAINTENANCE = 0xfe, 00085 IMAGE_TRANSFER = 0xff, 00086 ZONE_GROUP_DSLINK_SEND = 0x54, 00087 DEVICE_DSLINK_SEND = 0x55, 00088 EVENT_DSLINK = 0x7b, 00089 DSM_DEBUG_MODE = 0xf1, 00090 EVENT_COMMUNICATION_LOG = 0x77, 00091 EVENT_DSP_DEBUG_DATA = 0x7e, 00092 }; 00093 00094 00095 typedef enum { 00096 ZONE_INFO_BY_INDEX = 1, 00097 ZONE_INFO_BY_ID = 2, 00098 } ZoneInfoModifiers_t; 00099 00100 typedef enum { 00101 ZONE_MODIFY_ADD = 1, 00102 ZONE_MODIFY_REMOVE = 2, 00103 ZONE_MODIFY_CHANGE_ID = 3, 00104 } ZoneModifyModifiers_t; 00105 00106 typedef enum { 00107 ZONE_DEVICE_COUNT_ONLY_ACTIVE = 1, 00108 ZONE_DEVICE_COUNT_ONLY_INACTIVE = 2, 00109 ZONE_DEVICE_COUNT_ALL = 3, 00110 } ZoneDeviceCountModifiers_t; 00111 00112 typedef enum { 00113 ZONE_PROPERTIES_SET_NAME = 1, 00114 ZONE_PROPERTIES_GET_SCENE_HISTORY = 2, 00115 } ZonePropertiesModifiers_t; 00116 00117 typedef enum { 00118 ZONE_GROUP_MODIFY_ADD = 1, 00119 ZONE_GROUP_MODIFY_REMOVE = 2, 00120 } ZoneGroupModifyModifiers_t; 00121 00122 typedef enum { 00123 ZONE_GROUP_INFO_BY_INDEX = 1, 00124 ZONE_GROUP_INFO_BY_ID = 2, 00125 } ZoneGroupInfoModifiers_t; 00126 00127 typedef enum { 00128 ZONE_GROUP_PROPERTIES_SET_NAME = 1, 00129 ZONE_GROUP_PROPERTIES_SET_STOP_TIMEOUT = 2, 00130 } ZoneGroupPropertiesModifiers_t; 00131 00132 00133 00134 typedef enum { 00135 ZONE_GROUP_SCENE_PROPERTIES_SET_NAME = 1, 00136 } ZoneGroupScenePropertiesModifiers_t; 00137 00138 typedef enum { 00139 ZONE_GROUP_ACTION_REQUEST_ACTION_CALL_SCENE = 1, 00140 ZONE_GROUP_ACTION_REQUEST_ACTION_SAVE_SCENE = 2, 00141 ZONE_GROUP_ACTION_REQUEST_ACTION_UNDO_SCENE = 3, 00142 ZONE_GROUP_ACTION_REQUEST_ACTION_BLINK = 4, 00143 ZONE_GROUP_ACTION_REQUEST_ACTION_UNDO_SCENE_NUMBER = 5, 00144 ZONE_GROUP_ACTION_REQUEST_ACTION_FORCE_CALL_SCENE = 6, 00145 ZONE_GROUP_ACTION_REQUEST_ACTION_SET_OUTVAL = 7, 00146 ZONE_GROUP_ACTION_REQUEST_ACTION_SET_SCENE_LOCAL_PRIORITY = 8, 00147 ZONE_GROUP_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_ON = 9, 00148 ZONE_GROUP_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_OFF = 10, 00149 ZONE_GROUP_ACTION_REQUEST_ACTION_SELECT_GROUP = 11, 00150 ZONE_GROUP_ACTION_REQUEST_ACTION_REGISTER_SCENE_LOCAL_PRIORITY = 12, 00151 ZONE_GROUP_ACTION_REQUEST_ACTION_CALL_SCENE_MIN = 13, 00152 ZONE_GROUP_ACTION_REQUEST_ACTION_LOCAL_STOP = 14, 00153 } ZoneGroupActionRequestModifiers_t; 00154 00155 00156 00157 typedef enum { 00158 DEVICE_INFO_BY_INDEX_ONLY_ACTIVE = 1, 00159 DEVICE_INFO_BY_INDEX_ONLY_INACTIVE = 2, 00160 DEVICE_INFO_BY_INDEX = 3, 00161 DEVICE_INFO_BY_DEVICE_ID = 4, 00162 } DeviceInfoModifiers_t; 00163 00164 00165 00166 typedef enum { 00167 DEVICE_STATISTICS_REQUEST_GET = 1, 00168 } DeviceStatisticsRequestModifiers_t; 00169 00170 typedef enum { 00171 DEVICE_PROPERTIES_SET_ZONE = 1, 00172 DEVICE_PROPERTIES_SET_LOCKED_FLAG = 4, 00173 DEVICE_PROPERTIES_SET_NAME = 5, 00174 DEVICE_PROPERTIES_SET_BUTTON_ACTIVE_GROUP = 8, 00175 DEVICE_PROPERTIES_RESET_BUTTON_ACTIVE_GROUP = 9, 00176 DEVICE_PROPERTIES_SET_BUTTON_SET_LOCAL_PRIORITY = 10, 00177 } DevicePropertiesModifiers_t; 00178 00179 typedef enum { 00180 DEVICE_BUTTON_INFO_BY_DEVICE = 1, 00181 } DeviceButtonInfoModifiers_t; 00182 00183 typedef enum { 00184 DEVICE_GROUP_MEMBERSHIP_MODIFY_ADD = 1, 00185 DEVICE_GROUP_MEMBERSHIP_MODIFY_REMOVE = 2, 00186 } DeviceGroupMembershipModifyModifiers_t; 00187 00188 typedef enum { 00189 TEST_TRANSMISSION_QUALITY_GET = 1, 00190 } TestTransmissionQualityModifiers_t; 00191 00192 00193 00194 typedef enum { 00195 DEVICE_ACTION_REQUEST_ACTION_CALL_SCENE = 1, 00196 DEVICE_ACTION_REQUEST_ACTION_SAVE_SCENE = 2, 00197 DEVICE_ACTION_REQUEST_ACTION_UNDO_SCENE = 3, 00198 DEVICE_ACTION_REQUEST_ACTION_BLINK = 4, 00199 DEVICE_ACTION_REQUEST_ACTION_UNDO_SCENE_NUMBER = 5, 00200 DEVICE_ACTION_REQUEST_ACTION_FORCE_CALL_SCENE = 6, 00201 DEVICE_ACTION_REQUEST_ACTION_SET_OUTVAL = 7, 00202 DEVICE_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_ON = 9, 00203 DEVICE_ACTION_REQUEST_ACTION_PROGRAMMING_MODE_OFF = 10, 00204 } DeviceActionRequestModifiers_t; 00205 00206 typedef enum { 00207 DEVICE_CONFIG_GET = 1, 00208 DEVICE_CONFIG_SET = 2, 00209 } DeviceConfigModifiers_t; 00210 00211 typedef enum { 00212 DEVICE_SENSOR_GET_VALUE = 1, 00213 DEVICE_SENSOR_GET_TYPE = 2, 00214 } DeviceSensorModifiers_t; 00215 00216 00217 00218 typedef enum { 00219 CIRCUIT_REMOVE_DEVICE_ = 0, 00220 CIRCUIT_REMOVE_DEVICE_BY_ID = 1, 00221 CIRCUIT_REMOVE_DEVICE_BY_DSID = 2, 00222 } CircuitRemoveDeviceModifiers_t; 00223 00224 00225 00226 00227 00228 typedef enum { 00229 EVENT_DEVICE_ACCESSIBILITY_ON = 1, 00230 EVENT_DEVICE_ACCESSIBILITY_OFF = 2, 00231 } EventDeviceAccessibilityModifiers_t; 00232 00233 00234 00235 00236 00237 00238 00239 00240 00241 typedef enum { 00242 EVENT_DEVICE_SENSOR_VALUE = 1, 00243 EVENT_DEVICE_SENSOR_TYPE = 2, 00244 EVENT_DEVICE_SENSOR_EVENT = 3, 00245 } EventDeviceSensorModifiers_t; 00246 00247 00248 00249 00250 00251 typedef enum { 00252 CIRCUIT_PING_DEVICES_AUTOMATIC = 1, 00253 CIRCUIT_PING_DEVICES_ONE_TIME_AUTOMATIC = 2, 00254 CIRCUIT_PING_DEVICES_ONE_TIME_OFF = 3, 00255 CIRCUIT_PING_DEVICES_OFF = 4, 00256 } CircuitPingDevicesModifiers_t; 00257 00258 typedef enum { 00259 CIRCUIT_ENERGY_METER_VALUE_GET = 1, 00260 CIRCUIT_ENERGY_METER_VALUE_RESET = 2, 00261 CIRCUIT_ENERGY_METER_VALUE_CALIBRATION = 3, 00262 CIRCUIT_ENERGY_METER_VALUE_WS_GET = 4, 00263 } CircuitEnergyMeterValueModifiers_t; 00264 00265 typedef enum { 00266 CIRCUIT_CURRENT_METER_VALUE_GET = 1, 00267 } CircuitCurrentMeterValueModifiers_t; 00268 00269 00270 00271 typedef enum { 00272 DSM_PROPERTIES_SET_NAME = 1, 00273 DSM_PROPERTIES_SET_APARTMENT_ID = 2, 00274 DSM_PROPERTIES_SET_TEMPERATURE_LIMITS = 3, 00275 DSM_PROPERTIES_GET_APARTMENT_ID = 4, 00276 DSM_PROPERTIES_GET_TEMPERATURE_LIMITS = 5, 00277 DSM_PROPERTIES_GET_CURRENT_TEMPERATURE = 6, 00278 DSM_PROPERTIES_SET_FLAGS = 7, 00279 DSM_PROPERTIES_GET_FLAGS = 8, 00280 DSM_PROPERTIES_GET_POWER_DOWN_DURATION = 9, 00281 DSM_PROPERTIES_SET_PING_INTERVALS = 10, 00282 DSM_PROPERTIES_GET_PING_INTERVALS = 11, 00283 DSM_PROPERTIES_GET_MAX_TEMPERATURE = 12, 00284 DSM_PROPERTIES_RESET_MAX_TEMPERATURE = 13, 00285 DSM_PROPERTIES_SET_UPSTREAM_FREQUENCY = 14, 00286 DSM_PROPERTIES_GET_UPSTREAM_FREQUENCY = 15, 00287 } dSMPropertiesModifiers_t; 00288 00289 00290 00291 typedef enum { 00292 DSM_CONFIG_SET_DSM_CONFIG = 1, 00293 DSM_CONFIG_GET_DSP_CONFIG = 2, 00294 DSM_CONFIG_SET_DSP_CONFIG = 3, 00295 DSM_CONFIG_GET_HASH = 4, 00296 } dSMConfigModifiers_t; 00297 00298 typedef enum { 00299 DSM_STATISTICS_GET_DS485 = 1, 00300 DSM_STATISTICS_RESET_DS485 = 2, 00301 DSM_STATISTICS_GET_UPSTREAM = 3, 00302 DSM_STATISTICS_RESET_UPSTREAM = 4, 00303 DSM_STATISTICS_GET_INTERNALS = 5, 00304 DSM_STATISTICS_RESET_INTERNALS = 6, 00305 DSM_STATISTICS_GET_POOL_MARGINS = 7, 00306 DSM_STATISTICS_GET_STOP_TIMER = 8, 00307 } dSMStatisticsModifiers_t; 00308 00309 00310 00311 00312 00313 typedef enum { 00314 IMAGE_MAINTENANCE_CHECK_IMAGE = 1, 00315 IMAGE_MAINTENANCE_GET_IMAGE_INFO = 2, 00316 IMAGE_MAINTENANCE_START_UPDATE = 3, 00317 IMAGE_MAINTENANCE_REMOVE_IMAGE = 4, 00318 } ImageMaintenanceModifiers_t; 00319 00320 typedef enum { 00321 IMAGE_TRANSFER_WRITE_REQUEST = 1, 00322 IMAGE_TRANSFER_DATA = 2, 00323 } ImageTransferModifiers_t; 00324 00325 typedef enum { 00326 ZONE_GROUP_DSLINK_SEND_NOT_LAST_BYTE_NO_ANSWER = 1, 00327 ZONE_GROUP_DSLINK_SEND_LAST_BYTE_NO_ANSWER = 2, 00328 } ZoneGroupDslinkSendModifiers_t; 00329 00330 typedef enum { 00331 DEVICE_DSLINK_SEND_NOT_LAST_BYTE_NO_ANSWER = 1, 00332 DEVICE_DSLINK_SEND_LAST_BYTE_NO_ANSWER = 2, 00333 DEVICE_DSLINK_SEND_NOT_LAST_BYTE_WITH_ANSWER = 3, 00334 DEVICE_DSLINK_SEND_LAST_BYTE_WITH_ANSWER = 4, 00335 } DeviceDslinkSendModifiers_t; 00336 00337 typedef enum { 00338 EVENT_DSLINK_RESPONSE = 1, 00339 EVENT_DSLINK_INTERRUPT = 2, 00340 } EventDslinkModifiers_t; 00341 00342 typedef enum { 00343 DSM_DEBUG_MODE_SET_MMI_FLAG = 2, 00344 DSM_DEBUG_MODE_GET_MMI_FLAG = 1, 00345 DSM_DEBUG_MODE_STOP_SELECT_B = 3, 00346 DSM_DEBUG_MODE_RESTART_REGISTRATION = 4, 00347 DSM_DEBUG_MODE_RESTART_DSP = 5, 00348 DSM_DEBUG_MODE_READ_FLASH = 6, 00349 DSM_DEBUG_MODE_WRITE_FLASH = 7, 00350 DSM_DEBUG_MODE_GET_COMMUNICATION_LOG_STATE = 8, 00351 DSM_DEBUG_MODE_SET_COMMUNICATION_LOG_STATE = 9, 00352 DSM_DEBUG_MODE_DISABLE_JUMBLE = 10, 00353 DSM_DEBUG_MODE_INJECT_SHORT_UPSTREAM = 12, 00354 DSM_DEBUG_MODE_INJECT_LONG_UPSTREAM = 13, 00355 } dSMDebugModeModifiers_t; 00356 00357 typedef enum { 00358 EVENT_COMMUNICATION_LOG_UPSTREAM_SHORT = 1, 00359 EVENT_COMMUNICATION_LOG_UPSTREAM_LONG = 2, 00360 EVENT_COMMUNICATION_LOG_DOWNSTREAM_SHORT = 3, 00361 EVENT_COMMUNICATION_LOG_DOWNSTREAM_LONG_16BIT_PARAMETER = 4, 00362 EVENT_COMMUNICATION_LOG_DOWNSTREAM_LONG_8BIT_PARAMETER = 5, 00363 EVENT_COMMUNICATION_LOG_DOWNSTREAM_LONG_NO_PARAMETER = 6, 00364 } EventCommunicationLogModifiers_t; 00365 00366 00367 00368 enum DsmApiErrorCodes { 00369 ERROR_OK = 0x00, 00370 ERROR_WRONG_PARAMETER = 0x01, 00371 ERROR_ZONE_NOT_FOUND = 0x02, 00372 ERROR_DEVICE_NOT_FOUND = 0x03, 00373 ERROR_GROUP_NOT_FOUND = 0x04, 00374 ERROR_ZONE_CAN_NOT_BE_DELETED = 0x05, 00375 ERROR_GROUP_CAN_NOT_BE_DELETED = 0x06, 00376 ERROR_DEVICE_CAN_NOT_BE_DELETED = 0x07, 00377 ERROR_NO_FURTHER_ZONES = 0x08, 00378 ERROR_NO_FURTHER_GROUPS = 0x09, 00379 ERROR_ZONE_ALREADY_EXISTS = 0x0a, 00380 ERROR_GROUP_ALREADY_EXISTS = 0x0b, 00381 ERROR_ZONE_NOT_EMPTY = 0x0c, 00382 ERROR_TIMEOUT = 0x0d, 00383 ERROR_WRONG_SIZE = 0x0e, 00384 ERROR_WRONG_MSGID = 0x0f, 00385 ERROR_WRONG_MODIFIER = 0x10, 00386 ERROR_WRONG_PACKET_NR = 0x11, 00387 ERROR_WRONG_IMAGE_SIZE = 0x12, 00388 ERROR_NO_IMAGE_TRANSFER_ACTIVE = 0x13, 00389 ERROR_IMAGE_INVALID = 0x14, 00390 ERROR_NO_CONFIG = 0x15, 00391 ERROR_REQUEST_CAN_NOT_BE_EXECUTED = 0x16, 00392 ERROR_OUT_OF_RESOURCES = 0x17, 00393 ERROR_PROGRAMMING_MODE_IS_DISABLED = 0x18, 00394 }; 00395 enum DsmApiParameterLength { 00396 NAME_LEN = 21, 00397 DSID_LEN = 12, 00398 DATA_LEN_ = 122, 00399 CONFIG_LEN = 96, 00400 STATISTICS_LEN = 96, 00401 GROUPS_LEN = 8, 00402 DATA_LEN = 64, 00403 }; 00404 00405 #ifdef __cplusplus 00406 } 00407 #endif 00408 00409 #endif /* DSM_API_CONST_H */
1.7.6.1
