Open Lighting Architecture  0.9.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RDMEnums.h
Go to the documentation of this file.
1 /*
2  * This library is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU Lesser General Public
4  * License as published by the Free Software Foundation; either
5  * version 2.1 of the License, or (at your option) any later version.
6  *
7  * This library is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10  * Lesser General Public License for more details.
11  *
12  * You should have received a copy of the GNU Lesser General Public
13  * License along with this library; if not, write to the Free Software
14  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15  *
16  * RDMEnums.h
17  * Provide a generic RDM ENUMS that can use different implementations.
18  * Copyright (C) 2010 Simon Newton
19  */
20 
29 #ifndef INCLUDE_OLA_RDM_RDMENUMS_H_
30 #define INCLUDE_OLA_RDM_RDMENUMS_H_
31 
32 #include <stdint.h>
33 
34 namespace ola {
35 namespace rdm {
36 
37 static const uint16_t ROOT_RDM_DEVICE = 0;
38 static const uint16_t ALL_RDM_SUBDEVICES = 0xffff;
39 static const uint16_t MAX_SUBDEVICE_NUMBER = 0x0200;
40 static const uint8_t MAX_RDM_STRING_LENGTH = 32;
41 static const uint16_t ZERO_FOOTPRINT_DMX_ADDRESS = 0xffff;
42 static const uint8_t MAX_QUEUED_MESSAGE_COUNT = 255;
43 // This is separated out because we never propagate OVERFLOWs up to the
44 // clients.
45 static const uint8_t ACK_OVERFLOW = 3;
46 
47 typedef enum {
48  RDM_VERSION_1_0 = 0x100,
49 } rdm_protocol_version;
50 
51 typedef enum {
52  // discovery
53  PID_DISC_UNIQUE_BRANCH = 0x0001,
54  PID_DISC_MUTE = 0x0002,
55  PID_DISC_UN_MUTE = 0x0003,
56  // network management
57  PID_PROXIED_DEVICES = 0x0010,
58  PID_PROXIED_DEVICE_COUNT = 0x0011,
59  PID_COMMS_STATUS = 0x0015,
60  // status collection
61  PID_QUEUED_MESSAGE = 0x0020,
62  PID_STATUS_MESSAGES = 0x0030,
63  PID_STATUS_ID_DESCRIPTION = 0x0031,
64  PID_CLEAR_STATUS_ID = 0x0032,
65  PID_SUB_DEVICE_STATUS_REPORT_THRESHOLD = 0x0033,
66  // RDM information
67  PID_SUPPORTED_PARAMETERS = 0x0050,
68  PID_PARAMETER_DESCRIPTION = 0x0051,
69  // production information
70  PID_DEVICE_INFO = 0x0060,
71  PID_PRODUCT_DETAIL_ID_LIST = 0x0070,
72  PID_DEVICE_MODEL_DESCRIPTION = 0x0080,
73  PID_MANUFACTURER_LABEL = 0x0081,
74  PID_DEVICE_LABEL = 0x0082,
75  PID_FACTORY_DEFAULTS = 0x0090,
76  PID_LANGUAGE_CAPABILITIES = 0x00A0,
77  PID_LANGUAGE = 0x00B0,
78  PID_SOFTWARE_VERSION_LABEL = 0x00C0,
79  PID_BOOT_SOFTWARE_VERSION_ID = 0x00C1,
80  PID_BOOT_SOFTWARE_VERSION_LABEL = 0x00C2,
81  // DMX512
82  PID_DMX_PERSONALITY = 0x00E0,
83  PID_DMX_PERSONALITY_DESCRIPTION = 0x00E1,
84  PID_DMX_START_ADDRESS = 0x00F0,
85  PID_SLOT_INFO = 0x0120,
86  PID_SLOT_DESCRIPTION = 0x0121,
87  PID_DEFAULT_SLOT_VALUE = 0x0122,
88  // sensors
89  PID_SENSOR_DEFINITION = 0x0200,
90  PID_SENSOR_VALUE = 0x0201,
91  PID_RECORD_SENSORS = 0x0202,
92  // power/lamp settings
93  PID_DEVICE_HOURS = 0x0400,
94  PID_LAMP_HOURS = 0x0401,
95  PID_LAMP_STRIKES = 0x0402,
96  PID_LAMP_STATE = 0x0403,
97  PID_LAMP_ON_MODE = 0x0404,
98  PID_DEVICE_POWER_CYCLES = 0x0405,
99  // display settings
100  PID_DISPLAY_INVERT = 0x0500,
101  PID_DISPLAY_LEVEL = 0x0501,
102  // configuration
103  PID_PAN_INVERT = 0x0600,
104  PID_TILT_INVERT = 0x0601,
105  PID_PAN_TILT_SWAP = 0x0602,
106  PID_REAL_TIME_CLOCK = 0x0603,
107  // control
108  PID_IDENTIFY_DEVICE = 0x1000,
109  PID_RESET_DEVICE = 0x1001,
110  PID_POWER_STATE = 0x1010,
111  PID_PERFORM_SELFTEST = 0x1020,
112  PID_SELF_TEST_DESCRIPTION = 0x1021,
113  PID_CAPTURE_PRESET = 0x1030,
114  PID_PRESET_PLAYBACK = 0x1031,
115 
116  // E1.37-1 PIDS
117  // DMX512 setup
118  PID_DMX_BLOCK_ADDRESS = 0x0140,
119  PID_DMX_FAIL_MODE = 0x0141,
120  PID_DMX_STARTUP_MODE = 0x0142,
121 
122  // Dimmer Settings
123  PID_DIMMER_INFO = 0x0340,
124  PID_MINIMUM_LEVEL = 0x0341,
125  PID_MAXIMUM_LEVEL = 0x0342,
126  PID_CURVE = 0x0343,
127  PID_CURVE_DESCRIPTION = 0x0344,
128 
129  // Control
130  PID_OUTPUT_RESPONSE_TIME = 0x0345,
131  PID_OUTPUT_RESPONSE_TIME_DESCRIPTION = 0x0346,
132  PID_MODULATION_FREQUENCY = 0x0347,
133  PID_MODULATION_FREQUENCY_DESCRIPTION = 0x0348,
134 
135  // Power/Lamp Settings
136  PID_BURN_IN = 0x0440,
137 
138  // Configuration
139  PID_LOCK_PIN = 0x0640,
140  PID_LOCK_STATE = 0x0641,
141  PID_LOCK_STATE_DESCRIPTION = 0x0642,
142  PID_IDENTIFY_MODE = 0x1040,
143  PID_PRESET_INFO = 0x1041,
144  PID_PRESET_STATUS = 0x1042,
145  PID_PRESET_MERGEMODE = 0x1043,
146  PID_POWER_ON_SELF_TEST = 0x1044,
147 
148  // Draft E1.33 PIDs - DO NOT USE
149  PID_ENDPOINT_LIST = 0x7FE0,
150  PID_ENDPOINT_TO_UNIVERSE = 0x7FE1,
151  PID_RDM_TRAFFIC_ENABLE = 0x7FE2,
152  PID_ENDPOINT_MODE = 0x7FE3,
153  PID_ENDPOINT_LABEL = 0x7FE4,
154  PID_DISCOVERY_STATE = 0x7FE5,
155  PID_ENDPOINT_TIMING = 0x7FE6,
156  PID_ENDPOINT_TIMING_DESCRIPTION = 0x7FE7,
157  PID_BINDING_CONTROL_FIELDS = 0x7FE8,
158  PID_ENDPOINT_IDENTIFY = 0x7FE9,
159  PID_BACKGROUND_DISCOVERY = 0x7FEA,
160  PID_ENDPOINT_DEVICE_LIST_CHANGE = 0x7FEB,
161  PID_ENDPOINT_DEVICES = 0x7FEC,
162  PID_TCP_COMMS_STATUS = 0x7FED,
163  PID_ENDPOINT_LIST_CHANGE = 0x7FEE,
164  PID_BACKGROUND_QUEUED_STATUS_POLICY = 0x7FD0,
165  PID_BACKGROUND_QUEUED_STATUS_POLICY_DESCRIPTION = 0x7FD1,
166  PID_BACKGROUND_STATUS_TYPE = 0x7FD2,
167  PID_QUEUED_STATUS_ENDPOINT_COLLECTION = 0x7FD3,
168  PID_QUEUED_STATUS_UID_COLLECTION = 0x7FD4,
169 
170  // Draft E1.37-2 PIDs - DO NOT USE, values will change
171  PID_LIST_INTERFACES = 0xFFE0,
172  PID_INTERFACE_LABEL = 0xFFE1,
173  PID_INTERFACE_HARDWARE_ADDRESS_TYPE1 = 0xFFE2,
174  PID_IPV4_DHCP_MODE = 0xFFE3,
175  PID_IPV4_ZEROCONF_MODE = 0xFFE4,
176  PID_IPV4_CURRENT_ADDRESS = 0xFFE5,
177  PID_IPV4_STATIC_ADDRESS = 0xFFE6,
178  PID_INTERFACE_RENEW_DHCP = 0xFFE7,
179  PID_INTERFACE_RELEASE_DHCP = 0xFFE8,
180  PID_INTERFACE_APPLY_CONFIGURATION = 0xFFE9,
181  PID_IPV4_DEFAULT_ROUTE = 0xFFEA,
182  PID_DNS_NAME_SERVER = 0xFFEB,
183  PID_DNS_HOSTNAME = 0xFFEC,
184  PID_DNS_DOMAIN_NAME = 0xFFED,
185 } rdm_pid;
186 
187 
188 typedef enum {
189  STATUS_NONE = 0x0,
190  STATUS_GET_LAST_MESSAGE = 0x1,
191  STATUS_ADVISORY = 0x2,
192  STATUS_WARNING = 0x3,
193  STATUS_ERROR = 0x4,
194  STATUS_ADVISORY_CLEARED = 0x12,
195  STATUS_WARNING_CLEARED = 0x13,
196  STATUS_ERROR_CLEARED = 0x14,
197 } rdm_status_type;
198 
199 
200 typedef enum {
201  SENSOR_TEMPERATURE = 0x00,
202  SENSOR_VOLTAGE = 0x01,
203  SENSOR_CURRENT = 0x02,
204  SENSOR_FREQUENCY = 0x03,
205  SENSOR_RESISTANCE = 0x04,
206  SENSOR_POWER = 0x05,
207  SENSOR_MASS = 0x06,
208  SENSOR_LENGTH = 0x07,
209  SENSOR_AREA = 0x08,
210  SENSOR_VOLUME = 0x09,
211  SENSOR_DENSITY = 0x0A,
212  SENSOR_VELOCITY = 0x0B,
213  SENSOR_ACCELERATION = 0x0C,
214  SENSOR_FORCE = 0x0D,
215  SENSOR_ENERGY = 0x0E,
216  SENSOR_PRESSURE = 0x0F,
217  SENSOR_TIME = 0x10,
218  SENSOR_ANGLE = 0x11,
219  SENSOR_POSITION_X = 0x12,
220  SENSOR_POSITION_Y = 0x13,
221  SENSOR_POSITION_Z = 0x14,
222  SENSOR_ANGULAR_VELOCITY = 0x15,
223  SENSOR_LUMINOUS_INTENSITY = 0x16,
224  SENSOR_LUMINOUS_FLUX = 0x17,
225  SENSOR_ILLUMINANCE = 0x18,
226  SENSOR_CHROMINANCE_RED = 0x19,
227  SENSOR_CHROMINANCE_GREEN = 0x1A,
228  SENSOR_CHROMINANCE_BLUE = 0x1B,
229  SENSOR_CONTACTS = 0x1C,
230  SENSOR_MEMORY = 0x1D,
231  SENSOR_ITEMS = 0x1E,
232  SENSOR_HUMIDITY = 0x1F,
233  SENSOR_COUNTER_16BIT = 0x20,
234  SENSOR_OTHER = 0x7F,
235 } rdm_sensor_type;
236 
237 typedef enum {
238  UNITS_NONE = 0x00,
239  UNITS_CENTIGRADE = 0x01,
240  UNITS_VOLTS_DC = 0x02,
241  UNITS_VOLTS_AC_PEAK = 0x03,
242  UNITS_VOLTS_AC_RMS = 0x04,
243  UNITS_AMPERE_DC = 0x05,
244  UNITS_AMPERE_AC_PEAK = 0x06,
245  UNITS_AMPERE_AC_RMS = 0x07,
246  UNITS_HERTZ = 0x08,
247  UNITS_OHM = 0x09,
248  UNITS_WATT = 0x0A,
249  UNITS_KILOGRAM = 0x0B,
250  UNITS_METERS = 0x0C,
251  UNITS_METERS_SQUARED = 0x0D,
252  UNITS_METERS_CUBED = 0x0E,
253  UNITS_KILOGRAMMES_PER_METER_CUBED = 0x0F,
254  UNITS_METERS_PER_SECOND = 0x10,
255  UNITS_METERS_PER_SECOND_SQUARED = 0x11,
256  UNITS_NEWTON = 0x12,
257  UNITS_JOULE = 0x13,
258  UNITS_PASCAL = 0x14,
259  UNITS_SECOND = 0x15,
260  UNITS_DEGREE = 0x16,
261  UNITS_STERADIAN = 0x17,
262  UNITS_CANDELA = 0x18,
263  UNITS_LUMEN = 0x19,
264  UNITS_LUX = 0x1A,
265  UNITS_IRE = 0x1B,
266  UNITS_BYTE = 0x1C,
267 } rdm_pid_unit;
268 
269 
270 typedef enum {
271  PREFIX_NONE = 0x00,
272  PREFIX_DECI = 0x01,
273  PREFIX_CENTI = 0x02,
274  PREFIX_MILLI = 0x03,
275  PREFIX_MICRO = 0x04,
276  PREFIX_NANO = 0x05,
277  PREFIX_PICO = 0x06,
278  PREFIX_FEMPTO = 0x07,
279  PREFIX_ATTO = 0x08,
280  PREFIX_ZEPTO = 0x09,
281  PREFIX_YOCTO = 0x0A,
282  PREFIX_DECA = 0x11,
283  PREFIX_HECTO = 0x12,
284  PREFIX_KILO = 0x13,
285  PREFIX_MEGA = 0x14,
286  PREFIX_GIGA = 0x15,
287  PREFIX_TERRA = 0x16,
288  PREFIX_PETA = 0x17,
289  PREFIX_EXA = 0x18,
290  PREFIX_ZETTA = 0x19,
291  PREFIX_YOTTA = 0x1A,
292 } rdm_pid_prefix;
293 
294 
295 typedef enum {
296  CC_GET = 0x01,
297  CC_SET = 0x02,
298  CC_GET_SET = 0x03,
299 } rdm_command_class;
300 
301 
302 typedef enum {
303  DS_NOT_DEFINED = 0x0,
304  DS_BIT_FIELD = 0x01,
305  DS_ASCII = 0x02,
306  DS_UNSIGNED_BYTE = 0x03,
307  DS_SIGNED_BYTE = 0x04,
308  DS_UNSIGNED_WORD = 0x05,
309  DS_SIGNED_WORD = 0x06,
310  DS_UNSIGNED_DWORD = 0x07,
311  DS_SIGNED_DWORD = 0x08,
312 } rdm_data_type;
313 
314 
315 typedef enum {
316  NR_UNKNOWN_PID = 0x0000,
317  NR_FORMAT_ERROR = 0x0001,
318  NR_HARDWARE_FAULT = 0x0002,
319  NR_PROXY_REJECT = 0x0003,
320  NR_WRITE_PROTECT = 0x0004,
321  NR_UNSUPPORTED_COMMAND_CLASS = 0x0005,
322  NR_DATA_OUT_OF_RANGE = 0x0006,
323  NR_BUFFER_FULL = 0x0007,
324  NR_PACKET_SIZE_UNSUPPORTED = 0x0008,
325  NR_SUB_DEVICE_OUT_OF_RANGE = 0x0009,
326  NR_PROXY_BUFFER_FULL = 0x000A,
327  NR_ACTION_NOT_SUPPORTED = 0x0010,
328  NR_ENDPOINT_NUMBER_INVALID = 0x0011
329 } rdm_nack_reason;
330 
331 
332 typedef enum {
333  PRODUCT_CATEGORY_NOT_DECLARED = 0x0000,
334  PRODUCT_CATEGORY_FIXTURE = 0x0100,
335  PRODUCT_CATEGORY_FIXTURE_FIXED = 0x0101,
336  PRODUCT_CATEGORY_FIXTURE_MOVING_YOKE = 0x0102,
337  PRODUCT_CATEGORY_FIXTURE_MOVING_MIRROR = 0x0103,
338  PRODUCT_CATEGORY_FIXTURE_OTHER = 0x01FF,
339  PRODUCT_CATEGORY_FIXTURE_ACCESSORY = 0x0200,
340  PRODUCT_CATEGORY_FIXTURE_ACCESSORY_COLOR = 0x0201,
341  PRODUCT_CATEGORY_FIXTURE_ACCESSORY_YOKE = 0x0202,
342  PRODUCT_CATEGORY_FIXTURE_ACCESSORY_MIRROR = 0x0203,
343  PRODUCT_CATEGORY_FIXTURE_ACCESSORY_EFFECT = 0x0204,
344  PRODUCT_CATEGORY_FIXTURE_ACCESSORY_BEAM = 0x0205,
345  PRODUCT_CATEGORY_FIXTURE_ACCESSORY_OTHER = 0x02FF,
346  PRODUCT_CATEGORY_PROJECTOR = 0x0300,
347  PRODUCT_CATEGORY_PROJECTOR_FIXED = 0x0301,
348  PRODUCT_CATEGORY_PROJECTOR_MOVING_YOKE = 0x0302,
349  PRODUCT_CATEGORY_PROJECTOR_MOVING_MIRROR = 0x0303,
350  PRODUCT_CATEGORY_PROJECTOR_OTHER = 0x03FF,
351  PRODUCT_CATEGORY_ATMOSPHERIC = 0x0400,
352  PRODUCT_CATEGORY_ATMOSPHERIC_EFFECT = 0x0401,
353  PRODUCT_CATEGORY_ATMOSPHERIC_PYRO = 0x0402,
354  PRODUCT_CATEGORY_ATMOSPHERIC_OTHER = 0x04FF,
355  PRODUCT_CATEGORY_DIMMER = 0x0500,
356  PRODUCT_CATEGORY_DIMMER_AC_INCANDESCENT = 0x0501,
357  PRODUCT_CATEGORY_DIMMER_AC_FLUORESCENT = 0x0502,
358  PRODUCT_CATEGORY_DIMMER_AC_COLDCATHODE = 0x0503,
359  PRODUCT_CATEGORY_DIMMER_AC_NONDIM = 0x0504,
360  PRODUCT_CATEGORY_DIMMER_AC_ELV = 0x0505,
361  PRODUCT_CATEGORY_DIMMER_AC_OTHER = 0x0506,
362  PRODUCT_CATEGORY_DIMMER_DC_LEVEL = 0x0507,
363  PRODUCT_CATEGORY_DIMMER_DC_PWM = 0x0508,
364  PRODUCT_CATEGORY_DIMMER_CS_LED = 0x0509,
365  PRODUCT_CATEGORY_DIMMER_OTHER = 0x05FF,
366  PRODUCT_CATEGORY_POWER = 0x0600,
367  PRODUCT_CATEGORY_POWER_CONTROL = 0x0601,
368  PRODUCT_CATEGORY_POWER_SOURCE = 0x0602,
369  PRODUCT_CATEGORY_POWER_OTHER = 0x06FF,
370  PRODUCT_CATEGORY_SCENIC = 0x0700,
371  PRODUCT_CATEGORY_SCENIC_DRIVE = 0x0701,
372  PRODUCT_CATEGORY_SCENIC_OTHER = 0x07FF,
373  PRODUCT_CATEGORY_DATA = 0x0800,
374  PRODUCT_CATEGORY_DATA_DISTRIBUTION = 0x0801,
375  PRODUCT_CATEGORY_DATA_CONVERSION = 0x0802,
376  PRODUCT_CATEGORY_DATA_OTHER = 0x08FF,
377  PRODUCT_CATEGORY_AV = 0x0900,
378  PRODUCT_CATEGORY_AV_AUDIO = 0x0901,
379  PRODUCT_CATEGORY_AV_VIDEO = 0x0902,
380  PRODUCT_CATEGORY_AV_OTHER = 0x09FF,
381  PRODUCT_CATEGORY_MONITOR = 0x0A00,
382  PRODUCT_CATEGORY_MONITOR_ACLINEPOWER = 0x0A01,
383  PRODUCT_CATEGORY_MONITOR_DCPOWER = 0x0A02,
384  PRODUCT_CATEGORY_MONITOR_ENVIRONMENTAL = 0x0A03,
385  PRODUCT_CATEGORY_MONITOR_OTHER = 0x0AFF,
386  PRODUCT_CATEGORY_CONTROL = 0x7000,
387  PRODUCT_CATEGORY_CONTROL_CONTROLLER = 0x7001,
388  PRODUCT_CATEGORY_CONTROL_BACKUPDEVICE = 0x7002,
389  PRODUCT_CATEGORY_CONTROL_OTHER = 0x70FF,
390  PRODUCT_CATEGORY_TEST = 0x7100,
391  PRODUCT_CATEGORY_TEST_EQUIPMENT = 0x7101,
392  PRODUCT_CATEGORY_TEST_EQUIPMENT_OTHER = 0x71FF,
393  PRODUCT_CATEGORY_OTHER = 0x7FFF,
394 } rdm_product_category;
395 
396 
397 // product details
398 typedef enum {
399  PRODUCT_DETAIL_NOT_DECLARED = 0x0000,
400  PRODUCT_DETAIL_ARC = 0x0001,
401  PRODUCT_DETAIL_METAL_HALIDE = 0x0002,
402  PRODUCT_DETAIL_INCANDESCENT = 0x0003,
403  PRODUCT_DETAIL_LED = 0x0004,
404  PRODUCT_DETAIL_FLUORESCENT = 0x0005,
405  PRODUCT_DETAIL_COLDCATHODE = 0x0006,
406  PRODUCT_DETAIL_ELECTROLUMINESCENT = 0x0007,
407  PRODUCT_DETAIL_LASER = 0x0008,
408  PRODUCT_DETAIL_FLASHTUBE = 0x0009,
409  PRODUCT_DETAIL_COLORSCROLLER = 0x0100,
410  PRODUCT_DETAIL_COLORWHEEL = 0x0101,
411  PRODUCT_DETAIL_COLORCHANGE = 0x0102,
412  PRODUCT_DETAIL_IRIS_DOUSER = 0x0103,
413  PRODUCT_DETAIL_DIMMING_SHUTTER = 0x0104,
414  PRODUCT_DETAIL_PROFILE_SHUTTER = 0x0105,
415  PRODUCT_DETAIL_BARNDOOR_SHUTTER = 0x0106,
416  PRODUCT_DETAIL_EFFECTS_DISC = 0x0107,
417  PRODUCT_DETAIL_GOBO_ROTATOR = 0x0108,
418  PRODUCT_DETAIL_VIDEO = 0x0200,
419  PRODUCT_DETAIL_SLIDE = 0x0201,
420  PRODUCT_DETAIL_FILM = 0x0202,
421  PRODUCT_DETAIL_OILWHEEL = 0x0203,
422  PRODUCT_DETAIL_LCDGATE = 0x0204,
423  PRODUCT_DETAIL_FOGGER_GLYCOL = 0x0300,
424  PRODUCT_DETAIL_FOGGER_MINERALOIL = 0x0301,
425  PRODUCT_DETAIL_FOGGER_WATER = 0x0302,
426  PRODUCT_DETAIL_CO2 = 0x0303,
427  PRODUCT_DETAIL_LN2 = 0x0304,
428  PRODUCT_DETAIL_BUBBLE = 0x0305,
429  PRODUCT_DETAIL_FLAME_PROPANE = 0x0306,
430  PRODUCT_DETAIL_FLAME_OTHER = 0x0307,
431  PRODUCT_DETAIL_OLEFACTORY_STIMULATOR = 0x0308,
432  PRODUCT_DETAIL_SNOW = 0x0309,
433  PRODUCT_DETAIL_WATER_JET = 0x030A,
434  PRODUCT_DETAIL_WIND = 0x030B,
435  PRODUCT_DETAIL_CONFETTI = 0x030C,
436  PRODUCT_DETAIL_HAZARD = 0x030D,
437  PRODUCT_DETAIL_PHASE_CONTROL = 0x0400,
438  PRODUCT_DETAIL_REVERSE_PHASE_CONTROL = 0x0401,
439  PRODUCT_DETAIL_SINE = 0x0402,
440  PRODUCT_DETAIL_PWM = 0x0403,
441  PRODUCT_DETAIL_DC = 0x0404,
442  PRODUCT_DETAIL_HFBALLAST = 0x0405,
443  PRODUCT_DETAIL_HFHV_NEONBALLAST = 0x0406,
444  PRODUCT_DETAIL_HFHV_EL = 0x0407,
445  PRODUCT_DETAIL_MHR_BALLAST = 0x0408,
446  PRODUCT_DETAIL_BITANGLE_MODULATION = 0x0409,
447  PRODUCT_DETAIL_FREQUENCY_MODULATION = 0x040A,
448  PRODUCT_DETAIL_HIGHFREQUENCY_12V = 0x040B,
449  PRODUCT_DETAIL_RELAY_MECHANICAL = 0x040C,
450  PRODUCT_DETAIL_RELAY_ELECTRONIC = 0x040D,
451  PRODUCT_DETAIL_SWITCH_ELECTRONIC = 0x040E,
452  PRODUCT_DETAIL_CONTACTOR = 0x040F,
453  PRODUCT_DETAIL_MIRRORBALL_ROTATOR = 0x0500,
454  PRODUCT_DETAIL_OTHER_ROTATOR = 0x0501,
455  PRODUCT_DETAIL_KABUKI_DROP = 0x0502,
456  PRODUCT_DETAIL_CURTAIN = 0x0503,
457  PRODUCT_DETAIL_LINESET = 0x0504,
458  PRODUCT_DETAIL_MOTOR_CONTROL = 0x0505,
459  PRODUCT_DETAIL_DAMPER_CONTROL = 0x0506,
460  PRODUCT_DETAIL_SPLITTER = 0x0600,
461  PRODUCT_DETAIL_ETHERNET_NODE = 0x0601,
462  PRODUCT_DETAIL_MERGE = 0x0602,
463  PRODUCT_DETAIL_DATAPATCH = 0x0603,
464  PRODUCT_DETAIL_WIRELESS_LINK = 0x0604,
465  PRODUCT_DETAIL_PROTOCOL_CONVERTOR = 0x0701,
466  PRODUCT_DETAIL_ANALOG_DEMULTIPLEX = 0x0702,
467  PRODUCT_DETAIL_ANALOG_MULTIPLEX = 0x0703,
468  PRODUCT_DETAIL_SWITCH_PANEL = 0x0704,
469  PRODUCT_DETAIL_ROUTER = 0x0800,
470  PRODUCT_DETAIL_FADER = 0x0801,
471  PRODUCT_DETAIL_MIXER = 0x0802,
472  PRODUCT_DETAIL_CHANGEOVER_MANUAL = 0x0900,
473  PRODUCT_DETAIL_CHANGEOVER_AUTO = 0x0901,
474  PRODUCT_DETAIL_TEST = 0x0902,
475  PRODUCT_DETAIL_GFI_RCD = 0x0A00,
476  PRODUCT_DETAIL_BATTERY = 0x0A01,
477  PRODUCT_DETAIL_CONTROLLABLE_BREAKER = 0x0A02,
478  PRODUCT_DETAIL_OTHER = 0x7FFF,
479 } rdm_product_detail;
480 
481 
485 typedef enum {
486  ST_PRIMARY = 0x00,
487  ST_SEC_FINE = 0x01,
488  ST_SEC_TIMING = 0x02,
489  ST_SEC_SPEED = 0x03,
490  ST_SEC_CONTROL = 0x04,
491  ST_SEC_INDEX = 0x05,
492  ST_SEC_ROTATION = 0x06,
493  ST_SEC_INDEX_ROTATE = 0x07,
494  ST_SEC_UNDEFINED = 0xFF,
495 } rdm_slot_type;
496 
497 
501 typedef enum {
502  SD_INTENSITY = 0x0001,
503  SD_INTENSITY_MASTER = 0x0002,
504  SD_PAN = 0x0101,
505  SD_TILT = 0x0102,
506  SD_COLOR_WHEEL = 0x0201,
507  SD_COLOR_SUB_CYAN = 0x0202,
508  SD_COLOR_SUB_YELLOW = 0x0203,
509  SD_COLOR_SUB_MAGENTA = 0x0204,
510  SD_COLOR_ADD_RED = 0x0205,
511  SD_COLOR_ADD_GREEN = 0x0206,
512  SD_COLOR_ADD_BLUE = 0x0207,
513  SD_COLOR_CORRECTION = 0x0208,
514  SD_COLOR_SCROLL = 0x0209,
515  SD_COLOR_SEMAPHORE = 0x0210,
516  SD_STATIC_GOBO_WHEEL = 0x0301,
517  SD_ROTO_GOBO_WHEEL = 0x0302,
518  SD_PRISM_WHEEL = 0x0303,
519  SD_EFFECTS_WHEEL = 0x0304,
520  SD_BEAM_SIZE_IRIS = 0x0401,
521  SD_EDGE = 0x0402,
522  SD_FROST = 0x0403,
523  SD_STROBE = 0x0404,
524  SD_ZOOM = 0x0405,
525  SD_FRAMING_SHUTTER = 0x0406,
526  SD_SHUTTER_ROTATE = 0x0407,
527  SD_DOUSER = 0x0408,
528  SD_BARN_DOOR = 0x0409,
529  SD_LAMP_CONTROL = 0x0501,
530  SD_FIXTURE_CONTROL = 0x0502,
531  SD_FIXTURE_SPEED = 0x0503,
532  SD_MACRO = 0x0504,
533  SD_UNDEFINED = 0xFFFF,
534 } rdm_slot_definition;
535 
536 
537 typedef enum {
538  STS_CAL_FAIL = 0x0001,
539  STS_SENS_NOT_FOUND = 0x0002,
540  STS_SENS_ALWAYS_ON = 0x0003,
541  STS_LAMP_DOUSED = 0x0011,
542  STS_LAMP_STRIKE = 0x0012,
543  STS_OVERTEMP = 0x0021,
544  STS_UNDERTEMP = 0x0022,
545  STS_SENS_OUT_RANGE = 0x0023,
546  STS_OVERVOLTAGE_PHASE = 0x0031,
547  STS_UNDERVOLTAGE_PHASE = 0x0032,
548  STS_OVERCURRENT = 0x0033,
549  STS_UNDERCURRENT = 0x0034,
550  STS_PHASE = 0x0035,
551  STS_PHASE_ERROR = 0x0036,
552  STS_AMPS = 0x0037,
553  STS_VOLTS = 0x0038,
554  STS_DIMSLOT_OCCUPIED = 0x0041,
555  STS_BREAKER_TRIP = 0x0042,
556  STS_WATTS = 0x0043,
557  STS_DIM_FAILURE = 0x0044,
558  STS_DIM_PANIC = 0x0045,
559  STS_READY = 0x0050,
560  STS_NOT_READY = 0x0051,
561  STS_LOW_FLUID = 0x0052,
562 } rdm_status_message_id;
563 
564 
565 typedef enum {
566  LAMP_OFF = 0x00,
567  LAMP_ON = 0x01,
568  LAMP_STRIKE = 0x02,
569  LAMP_STANDBY = 0x03,
570  LAMP_NOT_PRESENT = 0x04,
571  LAMP_ERROR = 0x7F,
572 } rdm_lamp_state;
573 
574 typedef enum {
575  LAMP_ON_MODE_OFF = 0x00,
576  LAMP_ON_MODE_DMX = 0x01,
577  LAMP_ON_MODE_ON = 0x02,
578  LAMP_ON_MODE_ON_AFTER_CAL = 0x03,
579 } rdm_lamp_mode;
580 
581 typedef enum {
582  POWER_STATE_FULL_OFF = 0x00,
583  POWER_STATE_SHUTDOWN = 0x01,
584  POWER_STATE_STANDBY = 0x02,
585  POWER_STATE_NORMAL = 0xFF,
586 } rdm_power_state;
587 
588 typedef enum {
589  DISPLAY_INVERT_OFF = 0x00,
590  DISPLAY_INVERT_ON = 0x01,
591  DISPLAY_INVERT_AUTO = 0x02,
592 } rdm_display_invert;
593 
594 // The identify modes from E1.37-1
595 typedef enum {
596  IDENTIFY_MODE_QUIET = 0x00,
597  IDENTIFY_MODE_LOUD = 0xFF,
598 } rdm_identify_mode;
599 
600 typedef enum {
601  RESET_WARM = 0x01,
602  RESET_COLD = 0xFF,
603 } rdm_reset_device_mode;
604 
605 // the two special presets
606 static const uint16_t PRESET_PLAYBACK_OFF = 0x0000;
607 static const uint16_t PRESET_PLAYBACK_ALL = 0xFFFF;
608 
609 static const uint8_t ALL_SENSORS = 0xff;
610 
611 // bit masks for sensor values
612 static const uint8_t SENSOR_RECORDED_VALUE = 0x01;
613 static const uint8_t SENSOR_RECORDED_RANGE_VALUES = 0x02;
614 
615 // Consts for sensor values when unsupported
616 static const uint8_t SENSOR_RECORDED_UNSUPPORTED = 0x0000;
617 static const uint8_t SENSOR_RECORDED_RANGE_UNSUPPORTED = 0x0000;
618 
619 // Consts for SENSOR_DEFINITION's range_min
620 static const int16_t SENSOR_DEFINITION_RANGE_MIN_UNDEFINED = -0x8000;
621 
622 // Consts for SENSOR_DEFINITION's range_max
623 static const int16_t SENSOR_DEFINITION_RANGE_MAX_UNDEFINED = 0x7FFF;
624 
625 // Consts for SENSOR_DEFINITION's normal_min
626 static const int16_t SENSOR_DEFINITION_NORMAL_MIN_UNDEFINED = -0x8000;
627 
628 // Consts for SENSOR_DEFINITION's normal_max
629 static const int16_t SENSOR_DEFINITION_NORMAL_MAX_UNDEFINED = 0x7FFF;
630 
631 // The maximum PIN
632 static const uint16_t MAX_LOCK_PIN = 9999;
633 
634 // The Preset programmed modes
635 typedef enum {
636  PRESET_NOT_PROGRAMMED = 0x00,
637  PRESET_PROGRAMMED = 0x01,
638  PRESET_PROGRAMMED_READ_ONLY = 0x02,
639 } rdm_preset_programmed_mode;
640 
641 // The RDM merge modes
642 typedef enum {
643  MERGEMODE_DEFAULT = 0x00,
644  MERGEMODE_HTP = 0x01,
645  MERGEMODE_LTP = 0x02,
646  MERGEMODE_DMX_ONLY = 0x03,
647  MERGEMODE_OTHER = 0xFF,
648 } rdm_preset_mergemode;
649 
650 // Consts for E1.37-2
651 static const uint16_t IPV4_UNCONFIGURED = 0x00000000;
652 static const uint16_t NO_DEFAULT_ROUTE = 0x00000000;
653 
654 typedef enum {
655  DHCP_STATUS_INACTIVE = 0x00,
656  DHCP_STATUS_ACTIVE = 0x01,
657  DHCP_STATUS_UNKNOWN = 0x02,
658  DHCP_STATUS_MAX,
659 } rdm_dhcp_status;
660 
661 static const uint8_t MAX_RDM_HOSTNAME_LENGTH = 63;
662 static const uint8_t MAX_RDM_DOMAIN_NAME_LENGTH = 231;
663 
664 static const int16_t DNS_NAME_SERVER_MAX_INDEX = 2;
665 } // namespace rdm
666 } // namespace ola
667 #endif // INCLUDE_OLA_RDM_RDMENUMS_H_
Generated on Fri Apr 4 2014 11:46:03 for Open Lighting Architecture by   doxygen 1.8.1.2