/usr/include/openzwave/Defs.h is in libopenzwave1.5-dev 1.5+ds-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | //-----------------------------------------------------------------------------
//
// Defs.h
//
// Basic types and preprocessor directives
//
// Copyright (c) 2010 Mal Lansell <openzwave@lansell.org>
//
// SOFTWARE NOTICE AND LICENSE
//
// This file is part of OpenZWave.
//
// OpenZWave is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// OpenZWave is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
#ifndef _Defs_H
#define _Defs_H
#include <assert.h>
#include <stdio.h>
#include <string>
#include <stdint.h>
// Compilation export flags
#if (defined _WINDOWS || defined WIN32 || defined _MSC_VER) && !defined MINGW
# if defined OPENZWAVE_MAKEDLL // Create the dynamic library.
# define OPENZWAVE_EXPORT __declspec(dllexport)
# elif defined OPENZWAVE_USEDLL // Use the dynamic library
# define OPENZWAVE_EXPORT __declspec(dllimport)
# else // Create/Use the static library
# define OPENZWAVE_EXPORT
# endif
// Disable export warnings
# define OPENZWAVE_EXPORT_WARNINGS_OFF __pragma( warning(push) )\
__pragma( warning(disable: 4251) ) \
__pragma( warning(disable: 4275) )
# define OPENZWAVE_EXPORT_WARNINGS_ON __pragma( warning(pop) )
#else
# define OPENZWAVE_EXPORT
# define OPENZWAVE_EXPORT_WARNINGS_OFF
# define OPENZWAVE_EXPORT_WARNINGS_ON
#endif
#ifdef __GNUC__
#define DEPRECATED __attribute__((deprecated))
#elif defined(_MSC_VER)
#define DEPRECATED __declspec(deprecated)
#else
#pragma message("WARNING: You need to implement DEPRECATED for this compiler")
#define DEPRECATED
#endif
#ifdef NULL
#undef NULL
#endif
#define NULL 0
// Basic types
typedef signed char int8;
typedef unsigned char uint8;
typedef signed short int16;
typedef unsigned short uint16;
typedef signed int int32;
typedef unsigned int uint32;
#ifdef _MSC_VER
typedef signed __int64 int64;
typedef unsigned __int64 uint64;
#endif
#ifdef __GNUC__
typedef signed long long int64;
typedef unsigned long long uint64;
#endif
typedef float float32;
typedef double float64;
typedef struct ozwversion {
uint32_t _v; /* major << 16 | minor */
} ozwversion;
/**
* \brief version_major - return the major version of the given struct
* \param v: the version number to obtain the major number from
* \return the Major Version Number
*/
static inline uint16_t version_major(struct ozwversion v) {
return (v._v & 0xFFFF0000) >> 16;
}
/**
* \brief version_minor - return the minor version of the given struct
* \param v: the version number to obtain the minor number from
* \return the Minor Version Number
*/
static inline uint16_t version_minor(const struct ozwversion &v) {
return v._v & 0xFFFF;
}
/**
* \brief version - create a new version number
* \param major: major version number
* \param minor: minor version number
* \return the Version Number Struct
*/
static inline struct ozwversion version(uint16_t major, uint16_t minor)
{
struct ozwversion v;
v._v = (uint32_t)(major << 16) | (uint32_t)minor;
return v;
}
/**
* \brief version_cmp - compare two versions
* \param a: the first version number
* \param b: the second version number
* \return a number greater, equal, or less than 0 if a is greater, equal or
* less than b, respectively
*
* Example:
* struct version a = version(1, 0);
* struct version b = version(1, 3);
* if (version_cmp(a, b) < 0)
* printf("b is smaller than b\n");
*/
static inline int version_cmp(struct ozwversion a, struct ozwversion b)
{
return (a._v == b._v) ? 0 : (a._v > b._v) ? 1 : - 1;
}
#include "OZWException.h"
#define OPENZWAVE_DISABLE_EXCEPTIONS
#if defined(_MSC_VER)
# define __MYFUNCTION__ __FUNCTION__
#else
# define __MYFUNCTION__ __FILE__
#endif
// Exceptions : define OPENZWAVE_DISABLE_EXCEPTIONS in compiler flags to enable exceptions instead of exit function
#ifndef OPENZWAVE_DISABLE_EXCEPTIONS
# define OZW_FATAL_ERROR(exitCode, msg) Log::Write( LogLevel_Error,"Exception: %s:%d - %d - %s", std::string(__MYFUNCTION__).substr(std::string(__MYFUNCTION__).find_last_of("/\\") + 1).c_str(), __LINE__, exitCode, msg); \
throw OZWException(__MYFUNCTION__, __LINE__, exitCode, msg)
# define OZW_ERROR(exitCode, msg) Log::Write( LogLevel_Warning,"Exception: %s:%d - %d - %s", std::string(__MYFUNCTION__).substr(std::string(__MYFUNCTION__).find_last_of("/\\") + 1).c_str(), __LINE__, exitCode, msg); \
throw OZWException(__MYFUNCTION__, __LINE__, exitCode, msg)
#else
# define OZW_FATAL_ERROR(exitCode, msg) Log::Write( LogLevel_Error,"Exception: %s:%d - %d - %s", std::string(__MYFUNCTION__).substr(std::string(__MYFUNCTION__).find_last_of("/\\") + 1).c_str(), __LINE__, exitCode, msg); \
std::cerr << "Error: "<< std::string(__MYFUNCTION__).substr(std::string(__MYFUNCTION__).find_last_of("/\\") + 1) << ":" << __LINE__ << " - " << msg << std::endl; exit(exitCode)
# define OZW_ERROR(exitCode, msg) Log::Write( LogLevel_Warning,"Exception: %s:%d - %d - %s", std::string(__MYFUNCTION__).substr(std::string(__MYFUNCTION__).find_last_of("/\\") + 1).c_str(), __LINE__, exitCode, msg);
#endif
// Declare the OpenZWave namespace
namespace std {}
namespace OpenZWave
{
// Include the STL namespace
using namespace std;
}
// Modifications for Microsoft compilers
#ifdef _MSC_VER
// Fix for namespace-related compiler bug
namespace OpenZWave
{
}
// Rename safe versions of sprintf etc
#define snprintf sprintf_s
#define strcasecmp _stricmp
#define sscanf sscanf_s
#endif
// Modifications for MiNGW32 compiler
#ifdef MINGW
// Replace "safe" versions of sprintf
#define sprintf_s snprintf
// seems some MINGW versions don't have a errno_t
#ifndef errno_t
#define errno_t int
#endif
#define fopen_s fopen
#endif
//#define MAX_TRIES 3 // Retry sends up to 3 times
#define MAX_TRIES 1 // set this to one, as I believe now that a ACK failure is indication that the device is offline, hence additional attempts will not work.
#define MAX_MAX_TRIES 7 // Don't exceed this retry limit
#define ACK_TIMEOUT 1000 // How long to wait for an ACK
#define BYTE_TIMEOUT 150
//#define RETRY_TIMEOUT 40000 // Retry send after 40 seconds
#define RETRY_TIMEOUT 10000 // Retry send after 10 seconds (we might need to keep this below 10 for Security CC to function correctly)
#define SOF 0x01
#define ACK 0x06
#define NAK 0x15
#define CAN 0x18
#define NUM_NODE_BITFIELD_BYTES 29 // 29 bytes = 232 bits, one for each possible node in the network.
#define REQUEST 0x00
#define RESPONSE 0x01
#define ZW_CLOCK_SET 0x30
#define TRANSMIT_OPTION_ACK 0x01
#define TRANSMIT_OPTION_LOW_POWER 0x02
#define TRANSMIT_OPTION_AUTO_ROUTE 0x04
#define TRANSMIT_OPTION_NO_ROUTE 0x10
#define TRANSMIT_OPTION_EXPLORE 0x20
#define TRANSMIT_COMPLETE_OK 0x00
#define TRANSMIT_COMPLETE_NO_ACK 0x01
#define TRANSMIT_COMPLETE_FAIL 0x02
#define TRANSMIT_COMPLETE_NOT_IDLE 0x03
#define TRANSMIT_COMPLETE_NOROUTE 0x04
#define RECEIVE_STATUS_ROUTED_BUSY 0x01
#define RECEIVE_STATUS_TYPE_BROAD 0x04
#define FUNC_ID_SERIAL_API_GET_INIT_DATA 0x02
#define FUNC_ID_SERIAL_API_APPL_NODE_INFORMATION 0x03
#define FUNC_ID_APPLICATION_COMMAND_HANDLER 0x04
#define FUNC_ID_ZW_GET_CONTROLLER_CAPABILITIES 0x05
#define FUNC_ID_SERIAL_API_SET_TIMEOUTS 0x06
#define FUNC_ID_SERIAL_API_GET_CAPABILITIES 0x07
#define FUNC_ID_SERIAL_API_SOFT_RESET 0x08
#define FUNC_ID_ZW_SEND_NODE_INFORMATION 0x12
#define FUNC_ID_ZW_SEND_DATA 0x13
#define FUNC_ID_ZW_GET_VERSION 0x15
#define FUNC_ID_ZW_R_F_POWER_LEVEL_SET 0x17
#define FUNC_ID_ZW_GET_RANDOM 0x1c
#define FUNC_ID_ZW_MEMORY_GET_ID 0x20
#define FUNC_ID_MEMORY_GET_BYTE 0x21
#define FUNC_ID_ZW_READ_MEMORY 0x23
#define FUNC_ID_ZW_SET_LEARN_NODE_STATE 0x40 // Not implemented
#define FUNC_ID_ZW_GET_NODE_PROTOCOL_INFO 0x41 // Get protocol info (baud rate, listening, etc.) for a given node
#define FUNC_ID_ZW_SET_DEFAULT 0x42 // Reset controller and node info to default (original) values
#define FUNC_ID_ZW_NEW_CONTROLLER 0x43 // Not implemented
#define FUNC_ID_ZW_REPLICATION_COMMAND_COMPLETE 0x44 // Replication send data complete
#define FUNC_ID_ZW_REPLICATION_SEND_DATA 0x45 // Replication send data
#define FUNC_ID_ZW_ASSIGN_RETURN_ROUTE 0x46 // Assign a return route from the specified node to the controller
#define FUNC_ID_ZW_DELETE_RETURN_ROUTE 0x47 // Delete all return routes from the specified node
#define FUNC_ID_ZW_REQUEST_NODE_NEIGHBOR_UPDATE 0x48 // Ask the specified node to update its neighbors (then read them from the controller)
#define FUNC_ID_ZW_APPLICATION_UPDATE 0x49 // Get a list of supported (and controller) command classes
#define FUNC_ID_ZW_ADD_NODE_TO_NETWORK 0x4a // Control the addnode (or addcontroller) process...start, stop, etc.
#define FUNC_ID_ZW_REMOVE_NODE_FROM_NETWORK 0x4b // Control the removenode (or removecontroller) process...start, stop, etc.
#define FUNC_ID_ZW_CREATE_NEW_PRIMARY 0x4c // Control the createnewprimary process...start, stop, etc.
#define FUNC_ID_ZW_CONTROLLER_CHANGE 0x4d // Control the transferprimary process...start, stop, etc.
#define FUNC_ID_ZW_SET_LEARN_MODE 0x50 // Put a controller into learn mode for replication/ receipt of configuration info
#define FUNC_ID_ZW_ASSIGN_SUC_RETURN_ROUTE 0x51 // Assign a return route to the SUC
#define FUNC_ID_ZW_ENABLE_SUC 0x52 // Make a controller a Static Update Controller
#define FUNC_ID_ZW_REQUEST_NETWORK_UPDATE 0x53 // Network update for a SUC(?)
#define FUNC_ID_ZW_SET_SUC_NODE_ID 0x54 // Identify a Static Update Controller node id
#define FUNC_ID_ZW_DELETE_SUC_RETURN_ROUTE 0x55 // Remove return routes to the SUC
#define FUNC_ID_ZW_GET_SUC_NODE_ID 0x56 // Try to retrieve a Static Update Controller node id (zero if no SUC present)
#define FUNC_ID_ZW_REQUEST_NODE_NEIGHBOR_UPDATE_OPTIONS 0x5a // Allow options for request node neighbor update
#define FUNC_ID_ZW_EXPLORE_REQUEST_INCLUSION 0x5e // supports NWI
#define FUNC_ID_ZW_REQUEST_NODE_INFO 0x60 // Get info (supported command classes) for the specified node
#define FUNC_ID_ZW_REMOVE_FAILED_NODE_ID 0x61 // Mark a specified node id as failed
#define FUNC_ID_ZW_IS_FAILED_NODE_ID 0x62 // Check to see if a specified node has failed
#define FUNC_ID_ZW_REPLACE_FAILED_NODE 0x63 // Remove a failed node from the controller's list (?)
#define FUNC_ID_ZW_GET_ROUTING_INFO 0x80 // Get a specified node's neighbor information from the controller
#define FUNC_ID_SERIAL_API_SLAVE_NODE_INFO 0xA0 // Set application virtual slave node information
#define FUNC_ID_APPLICATION_SLAVE_COMMAND_HANDLER 0xA1 // Slave command handler
#define FUNC_ID_ZW_SEND_SLAVE_NODE_INFO 0xA2 // Send a slave node information frame
#define FUNC_ID_ZW_SEND_SLAVE_DATA 0xA3 // Send data from slave
#define FUNC_ID_ZW_SET_SLAVE_LEARN_MODE 0xA4 // Enter slave learn mode
#define FUNC_ID_ZW_GET_VIRTUAL_NODES 0xA5 // Return all virtual nodes
#define FUNC_ID_ZW_IS_VIRTUAL_NODE 0xA6 // Virtual node test
#define FUNC_ID_ZW_SET_PROMISCUOUS_MODE 0xD0 // Set controller into promiscuous mode to listen to all frames
#define FUNC_ID_PROMISCUOUS_APPLICATION_COMMAND_HANDLER 0xD1
#define ADD_NODE_ANY 0x01
#define ADD_NODE_CONTROLLER 0x02
#define ADD_NODE_SLAVE 0x03
#define ADD_NODE_EXISTING 0x04
#define ADD_NODE_STOP 0x05
#define ADD_NODE_STOP_FAILED 0x06
#define ADD_NODE_STATUS_LEARN_READY 0x01
#define ADD_NODE_STATUS_NODE_FOUND 0x02
#define ADD_NODE_STATUS_ADDING_SLAVE 0x03
#define ADD_NODE_STATUS_ADDING_CONTROLLER 0x04
#define ADD_NODE_STATUS_PROTOCOL_DONE 0x05
#define ADD_NODE_STATUS_DONE 0x06
#define ADD_NODE_STATUS_FAILED 0x07
#define REMOVE_NODE_ANY 0x01
#define REMOVE_NODE_CONTROLLER 0x02
#define REMOVE_NODE_SLAVE 0x03
#define REMOVE_NODE_STOP 0x05
#define REMOVE_NODE_STATUS_LEARN_READY 0x01
#define REMOVE_NODE_STATUS_NODE_FOUND 0x02
#define REMOVE_NODE_STATUS_REMOVING_SLAVE 0x03
#define REMOVE_NODE_STATUS_REMOVING_CONTROLLER 0x04
#define REMOVE_NODE_STATUS_DONE 0x06
#define REMOVE_NODE_STATUS_FAILED 0x07
#define CREATE_PRIMARY_START 0x02
#define CREATE_PRIMARY_STOP 0x05
#define CREATE_PRIMARY_STOP_FAILED 0x06
#define CONTROLLER_CHANGE_START 0x02
#define CONTROLLER_CHANGE_STOP 0x05
#define CONTROLLER_CHANGE_STOP_FAILED 0x06
#define LEARN_MODE_STARTED 0x01
#define LEARN_MODE_DONE 0x06
#define LEARN_MODE_FAILED 0x07
#define LEARN_MODE_DELETED 0x80
#define REQUEST_NEIGHBOR_UPDATE_STARTED 0x21
#define REQUEST_NEIGHBOR_UPDATE_DONE 0x22
#define REQUEST_NEIGHBOR_UPDATE_FAILED 0x23
#define FAILED_NODE_OK 0x00
#define FAILED_NODE_REMOVED 0x01
#define FAILED_NODE_NOT_REMOVED 0x02
#define FAILED_NODE_REPLACE_WAITING 0x03
#define FAILED_NODE_REPLACE_DONE 0x04
#define FAILED_NODE_REPLACE_FAILED 0x05
#define FAILED_NODE_REMOVE_STARTED 0x00
#define FAILED_NODE_NOT_PRIMARY_CONTROLLER 0x02
#define FAILED_NODE_NO_CALLBACK_FUNCTION 0x04
#define FAILED_NODE_NOT_FOUND 0x08
#define FAILED_NODE_REMOVE_PROCESS_BUSY 0x10
#define FAILED_NODE_REMOVE_FAIL 0x20
#define SUC_UPDATE_DONE 0x00
#define SUC_UPDATE_ABORT 0x01
#define SUC_UPDATE_WAIT 0x02
#define SUC_UPDATE_DISABLED 0x03
#define SUC_UPDATE_OVERFLOW 0x04
#define SUC_FUNC_BASIC_SUC 0x00
#define SUC_FUNC_NODEID_SERVER 0x01
#define UPDATE_STATE_NODE_INFO_RECEIVED 0x84
#define UPDATE_STATE_NODE_INFO_REQ_DONE 0x82
#define UPDATE_STATE_NODE_INFO_REQ_FAILED 0x81
#define UPDATE_STATE_ROUTING_PENDING 0x80
#define UPDATE_STATE_NEW_ID_ASSIGNED 0x40
#define UPDATE_STATE_DELETE_DONE 0x20
#define UPDATE_STATE_SUC_ID 0x10
#define APPLICATION_NODEINFO_LISTENING 0x01
#define APPLICATION_NODEINFO_OPTIONAL_FUNCTIONALITY 0x02
#define SLAVE_ASSIGN_COMPLETE 0x00
#define SLAVE_ASSIGN_NODEID_DONE 0x01 // Node ID has been assigned
#define SLAVE_ASSIGN_RANGE_INFO_UPDATE 0x02 // Node is doing neighbor discovery
#define SLAVE_LEARN_MODE_DISABLE 0x00 // disable add/remove virtual slave nodes
#define SLAVE_LEARN_MODE_ENABLE 0x01 // enable ability to include/exclude virtual slave nodes
#define SLAVE_LEARN_MODE_ADD 0x02 // add node directly but only if primary/inclusion controller
#define SLAVE_LEARN_MODE_REMOVE 0x03 // remove node directly but only if primary/inclusion controller
#define OPTION_HIGH_POWER 0x80
#define OPTION_NWI 0x40 // NWI Inclusion
//Device request related
#define BASIC_SET 0x01
#define BASIC_REPORT 0x03
#define COMMAND_CLASS_BASIC 0x20
#define COMMAND_CLASS_CONTROLLER_REPLICATION 0x21
#define COMMAND_CLASS_APPLICATION_STATUS 0x22
#define COMMAND_CLASS_HAIL 0x82
#endif // _Defs_H
|