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