# This library 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 2.1 of the License, or (at your option) any later version.
#
# This library 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 this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#
# RDMConstants.py
# Copyright (C) 2010 Simon Newton

"""Constants defined in E1.20 (RDM)."""

__author__ = 'nomis52@gmail.com (Simon Newton)'


RDM_ZERO_FOOTPRINT_DMX_ADDRESS = 0xFFFF

RDM_MANUFACTURER_PID_MIN = 0x8000
RDM_MANUFACTURER_PID_MAX = 0xFFDF

RDM_MANUFACTURER_SD_MIN = 0x8000
RDM_MANUFACTURER_SD_MAX = 0xFFDF

RDM_MAX_STRING_LENGTH = 32

RDM_INTERFACE_INDEX_MIN = 1
RDM_INTERFACE_INDEX_MAX = 0xFFFFFF00

RDM_MIN_HOSTNAME_LENGTH = 1
RDM_MAX_HOSTNAME_LENGTH = 63
RDM_MAX_DOMAIN_NAME_LENGTH = 231

RDM_DNS_NAME_SERVER_MAX_INDEX = 2


def _ReverseDict(input):
  output = {}
  for key, value in input.items():
    output[value] = key
  return output


SENSOR_TYPES = {
  'SENSOR_TEMPERATURE': 0x00,
  'SENSOR_VOLTAGE': 0x01,
  'SENSOR_CURRENT': 0x02,
  'SENSOR_FREQUENCY': 0x03,
  'SENSOR_RESISTANCE': 0x04,
  'SENSOR_POWER': 0x05,
  'SENSOR_MASS': 0x06,
  'SENSOR_LENGTH': 0x07,
  'SENSOR_AREA': 0x08,
  'SENSOR_VOLUME': 0x09,
  'SENSOR_DENSITY': 0x0A,
  'SENSOR_VELOCITY': 0x0B,
  'SENSOR_ACCELERATION': 0x0C,
  'SENSOR_FORCE': 0x0D,
  'SENSOR_ENERGY': 0x0E,
  'SENSOR_PRESSURE': 0x0F,
  'SENSOR_TIME': 0x10,
  'SENSOR_ANGLE': 0x11,
  'SENSOR_POSITION_X': 0x12,
  'SENSOR_POSITION_Y': 0x13,
  'SENSOR_POSITION_Z': 0x14,
  'SENSOR_ANGULAR_VELOCITY': 0x15,
  'SENSOR_LUMINOUS_INTENSITY': 0x16,
  'SENSOR_LUMINOUS_FLUX': 0x17,
  'SENSOR_ILLUMINANCE': 0x18,
  'SENSOR_CHROMINANCE_RED': 0x19,
  'SENSOR_CHROMINANCE_GREEN': 0x1A,
  'SENSOR_CHROMINANCE_BLUE': 0x1B,
  'SENSOR_CONTACTS': 0x1C,
  'SENSOR_MEMORY': 0x1D,
  'SENSOR_ITEMS': 0x1E,
  'SENSOR_HUMIDITY': 0x1F,
  'SENSOR_COUNTER_16BIT': 0x20,
  'SENSOR_OTHER': 0x7F,
}

SENSOR_TYPE_TO_NAME = _ReverseDict(SENSOR_TYPES)


UNITS = {
  'UNITS_NONE': 0x00,
  'UNITS_CENTIGRADE': 0x01,
  'UNITS_VOLTS_DC': 0x02,
  'UNITS_VOLTS_AC_PEAK': 0x03,
  'UNITS_VOLTS_AC_RMS': 0x04,
  'UNITS_AMPERE_DC': 0x05,
  'UNITS_AMPERE_AC_PEAK': 0x06,
  'UNITS_AMPERE_AC_RMS': 0x07,
  'UNITS_HERTZ': 0x08,
  'UNITS_OHM': 0x09,
  'UNITS_WATT': 0x0A,
  'UNITS_KILOGRAM': 0x0B,
  'UNITS_METERS': 0x0C,
  'UNITS_METERS_SQUARED': 0x0D,
  'UNITS_METERS_CUBED': 0x0E,
  'UNITS_KILOGRAMMES_PER_METER_CUBED': 0x0F,
  'UNITS_METERS_PER_SECOND': 0x10,
  'UNITS_METERS_PER_SECOND_SQUARED': 0x11,
  'UNITS_NEWTON': 0x12,
  'UNITS_JOULE': 0x13,
  'UNITS_PASCAL': 0x14,
  'UNITS_SECOND': 0x15,
  'UNITS_DEGREE': 0x16,
  'UNITS_STERADIAN': 0x17,
  'UNITS_CANDELA': 0x18,
  'UNITS_LUMEN': 0x19,
  'UNITS_LUX': 0x1A,
  'UNITS_IRE': 0x1B,
  'UNITS_BYTE': 0x1C,
}

UNIT_TO_NAME = _ReverseDict(UNITS)

PREFIXES = {
  'PREFIX_NONE': 0x00,
  'PREFIX_DECI': 0x01,
  'PREFIX_CENTI': 0x02,
  'PREFIX_MILLI': 0x03,
  'PREFIX_MICRO': 0x04,
  'PREFIX_NANO': 0x05,
  'PREFIX_PICO': 0x06,
  'PREFIX_FEMPTO': 0x07,
  'PREFIX_ATTO': 0x08,
  'PREFIX_ZEPTO': 0x09,
  'PREFIX_YOCTO': 0x0A,
  'PREFIX_DECA': 0x11,
  'PREFIX_HECTO': 0x12,
  'PREFIX_KILO': 0x13,
  'PREFIX_MEGA': 0x14,
  'PREFIX_GIGA': 0x15,
  'PREFIX_TERRA': 0x16,
  'PREFIX_PETA': 0x17,
  'PREFIX_EXA': 0x18,
  'PREFIX_ZETTA': 0x19,
  'PREFIX_YOTTA': 0x1A,
}

PREFIX_TO_NAME = _ReverseDict(PREFIXES)

PRODUCT_CATEGORIES = {
  'PRODUCT_CATEGORY_NOT_DECLARED': 0x0000,
  'PRODUCT_CATEGORY_FIXTURE': 0x0100,
  'PRODUCT_CATEGORY_FIXTURE_FIXED': 0x0101,
  'PRODUCT_CATEGORY_FIXTURE_MOVING_YOKE': 0x0102,
  'PRODUCT_CATEGORY_FIXTURE_MOVING_MIRROR': 0x0103,
  'PRODUCT_CATEGORY_FIXTURE_OTHER': 0x01FF,
  'PRODUCT_CATEGORY_FIXTURE_ACCESSORY': 0x0200,
  'PRODUCT_CATEGORY_FIXTURE_ACCESSORY_COLOR': 0x0201,
  'PRODUCT_CATEGORY_FIXTURE_ACCESSORY_YOKE': 0x0202,
  'PRODUCT_CATEGORY_FIXTURE_ACCESSORY_MIRROR': 0x0203,
  'PRODUCT_CATEGORY_FIXTURE_ACCESSORY_EFFECT': 0x0204,
  'PRODUCT_CATEGORY_FIXTURE_ACCESSORY_BEAM': 0x0205,
  'PRODUCT_CATEGORY_FIXTURE_ACCESSORY_OTHER': 0x02FF,
  'PRODUCT_CATEGORY_PROJECTOR': 0x0300,
  'PRODUCT_CATEGORY_PROJECTOR_FIXED': 0x0301,
  'PRODUCT_CATEGORY_PROJECTOR_MOVING_YOKE': 0x0302,
  'PRODUCT_CATEGORY_PROJECTOR_MOVING_MIRROR': 0x0303,
  'PRODUCT_CATEGORY_PROJECTOR_OTHER': 0x03FF,
  'PRODUCT_CATEGORY_ATMOSPHERIC': 0x0400,
  'PRODUCT_CATEGORY_ATMOSPHERIC_EFFECT': 0x0401,
  'PRODUCT_CATEGORY_ATMOSPHERIC_PYRO': 0x0402,
  'PRODUCT_CATEGORY_ATMOSPHERIC_OTHER': 0x04FF,
  'PRODUCT_CATEGORY_DIMMER': 0x0500,
  'PRODUCT_CATEGORY_DIMMER_AC_INCANDESCENT': 0x0501,
  'PRODUCT_CATEGORY_DIMMER_AC_FLUORESCENT': 0x0502,
  'PRODUCT_CATEGORY_DIMMER_AC_COLDCATHODE': 0x0503,
  'PRODUCT_CATEGORY_DIMMER_AC_NONDIM': 0x0504,
  'PRODUCT_CATEGORY_DIMMER_AC_ELV': 0x0505,
  'PRODUCT_CATEGORY_DIMMER_AC_OTHER': 0x0506,
  'PRODUCT_CATEGORY_DIMMER_DC_LEVEL': 0x0507,
  'PRODUCT_CATEGORY_DIMMER_DC_PWM': 0x0508,
  'PRODUCT_CATEGORY_DIMMER_CS_LED': 0x0509,
  'PRODUCT_CATEGORY_DIMMER_OTHER': 0x05FF,
  'PRODUCT_CATEGORY_POWER': 0x0600,
  'PRODUCT_CATEGORY_POWER_CONTROL': 0x0601,
  'PRODUCT_CATEGORY_POWER_SOURCE': 0x0602,
  'PRODUCT_CATEGORY_POWER_OTHER': 0x06FF,
  'PRODUCT_CATEGORY_SCENIC': 0x0700,
  'PRODUCT_CATEGORY_SCENIC_DRIVE': 0x0701,
  'PRODUCT_CATEGORY_SCENIC_OTHER': 0x07FF,
  'PRODUCT_CATEGORY_DATA': 0x0800,
  'PRODUCT_CATEGORY_DATA_DISTRIBUTION': 0x0801,
  'PRODUCT_CATEGORY_DATA_CONVERSION': 0x0802,
  'PRODUCT_CATEGORY_DATA_OTHER': 0x08FF,
  'PRODUCT_CATEGORY_AV': 0x0900,
  'PRODUCT_CATEGORY_AV_AUDIO': 0x0901,
  'PRODUCT_CATEGORY_AV_VIDEO': 0x0902,
  'PRODUCT_CATEGORY_AV_OTHER': 0x09FF,
  'PRODUCT_CATEGORY_MONITOR': 0x0A00,
  'PRODUCT_CATEGORY_MONITOR_ACLINEPOWER': 0x0A01,
  'PRODUCT_CATEGORY_MONITOR_DCPOWER': 0x0A02,
  'PRODUCT_CATEGORY_MONITOR_ENVIRONMENTAL': 0x0A03,
  'PRODUCT_CATEGORY_MONITOR_OTHER': 0x0AFF,
  'PRODUCT_CATEGORY_CONTROL': 0x7000,
  'PRODUCT_CATEGORY_CONTROL_CONTROLLER': 0x7001,
  'PRODUCT_CATEGORY_CONTROL_BACKUPDEVICE': 0x7002,
  'PRODUCT_CATEGORY_CONTROL_OTHER': 0x70FF,
  'PRODUCT_CATEGORY_TEST': 0x7100,
  'PRODUCT_CATEGORY_TEST_EQUIPMENT': 0x7101,
  'PRODUCT_CATEGORY_TEST_EQUIPMENT_OTHER': 0x71FF,
  'PRODUCT_CATEGORY_OTHER': 0x7FFF,
}

PRODUCT_CATEGORY_TO_NAME = _ReverseDict(PRODUCT_CATEGORIES)

PRODUCT_DETAIL_IDS = {
  'PRODUCT_DETAIL_NOT_DECLARED': 0x0000,
  'PRODUCT_DETAIL_ARC': 0x0001,
  'PRODUCT_DETAIL_METAL_HALIDE': 0x0002,
  'PRODUCT_DETAIL_INCANDESCENT': 0x0003,
  'PRODUCT_DETAIL_LED': 0x0004,
  'PRODUCT_DETAIL_FLUROESCENT': 0x0005,
  'PRODUCT_DETAIL_COLDCATHODE': 0x0006,
  'PRODUCT_DETAIL_ELECTROLUMINESCENT': 0x0007,
  'PRODUCT_DETAIL_LASER': 0x0008,
  'PRODUCT_DETAIL_FLASHTUBE': 0x0009,
  'PRODUCT_DETAIL_COLORSCROLLER': 0x0100,
  'PRODUCT_DETAIL_COLORWHEEL': 0x0101,
  'PRODUCT_DETAIL_COLORCHANGE': 0x0102,
  'PRODUCT_DETAIL_IRIS_DOUSER': 0x0103,
  'PRODUCT_DETAIL_DIMMING_SHUTTER': 0x0104,
  'PRODUCT_DETAIL_PROFILE_SHUTTER': 0x0105,
  'PRODUCT_DETAIL_BARNDOOR_SHUTTER': 0x0106,
  'PRODUCT_DETAIL_EFFECTS_DISC': 0x0107,
  'PRODUCT_DETAIL_GOBO_ROTATOR': 0x0108,
  'PRODUCT_DETAIL_VIDEO': 0x0200,
  'PRODUCT_DETAIL_SLIDE': 0x0201,
  'PRODUCT_DETAIL_FILM': 0x0202,
  'PRODUCT_DETAIL_OILWHEEL': 0x0203,
  'PRODUCT_DETAIL_LCDGATE': 0x0204,
  'PRODUCT_DETAIL_FOGGER_GLYCOL': 0x0300,
  'PRODUCT_DETAIL_FOGGER_MINERALOIL': 0x0301,
  'PRODUCT_DETAIL_FOGGER_WATER': 0x0302,
  'PRODUCT_DETAIL_CO2': 0x0303,
  'PRODUCT_DETAIL_LN2': 0x0304,
  'PRODUCT_DETAIL_BUBBLE': 0x0305,
  'PRODUCT_DETAIL_FLAME_PROPANE': 0x0306,
  'PRODUCT_DETAIL_FLAME_OTHER': 0x0307,
  'PRODUCT_DETAIL_OLEFACTORY_STIMULATOR': 0x0308,
  'PRODUCT_DETAIL_SNOW': 0x0309,
  'PRODUCT_DETAIL_WATER_JET': 0x030A,
  'PRODUCT_DETAIL_WIND': 0x030B,
  'PRODUCT_DETAIL_CONFETTI': 0x030C,
  'PRODUCT_DETAIL_HAZARD': 0x030D,
  'PRODUCT_DETAIL_PHASE_CONTROL': 0x0400,
  'PRODUCT_DETAIL_REVERSE_PHASE_CONTROL': 0x0401,
  'PRODUCT_DETAIL_SINE': 0x0402,
  'PRODUCT_DETAIL_PWM': 0x0403,
  'PRODUCT_DETAIL_DC': 0x0404,
  'PRODUCT_DETAIL_HFBALLAST': 0x0405,
  'PRODUCT_DETAIL_HFHV_NEONBALLAST': 0x0406,
  'PRODUCT_DETAIL_HFHV_EL': 0x0407,
  'PRODUCT_DETAIL_MHR_BALLAST': 0x0408,
  'PRODUCT_DETAIL_BITANGLE_MODULATION': 0x0409,
  'PRODUCT_DETAIL_FREQUENCY_MODULATION': 0x040A,
  'PRODUCT_DETAIL_HIGHFREQUENCY_12V': 0x040B,
  'PRODUCT_DETAIL_RELAY_MECHANICAL': 0x040C,
  'PRODUCT_DETAIL_RELAY_ELECTRONIC': 0x040D,
  'PRODUCT_DETAIL_SWITCH_ELECTRONIC': 0x040E,
  'PRODUCT_DETAIL_CONTACTOR': 0x040F,
  'PRODUCT_DETAIL_MIRRORBALL_ROTATOR': 0x0500,
  'PRODUCT_DETAIL_OTHER_ROTATOR': 0x0501,
  'PRODUCT_DETAIL_KABUKI_DROP': 0x0502,
  'PRODUCT_DETAIL_CURTAIN': 0x0503,
  'PRODUCT_DETAIL_LINESET': 0x0504,
  'PRODUCT_DETAIL_MOTOR_CONTROL': 0x0505,
  'PRODUCT_DETAIL_DAMPER_CONTROL': 0x0506,
  'PRODUCT_DETAIL_SPLITTER': 0x0600,
  'PRODUCT_DETAIL_ETHERNET_NODE': 0x0601,
  'PRODUCT_DETAIL_MERGE': 0x0602,
  'PRODUCT_DETAIL_DATAPATCH': 0x0603,
  'PRODUCT_DETAIL_WIRELESS_LINK': 0x0604,
  'PRODUCT_DETAIL_PROTOCOL_CONVERTOR': 0x0701,
  'PRODUCT_DETAIL_ANALOG_DEMULTIPLEX': 0x0702,
  'PRODUCT_DETAIL_ANALOG_MULTIPLEX': 0x0703,
  'PRODUCT_DETAIL_SWITCH_PANEL': 0x0704,
  'PRODUCT_DETAIL_ROUTER': 0x0800,
  'PRODUCT_DETAIL_FADER': 0x0801,
  'PRODUCT_DETAIL_MIXER': 0x0802,
  'PRODUCT_DETAIL_CHANGEOVER_MANUAL': 0x0900,
  'PRODUCT_DETAIL_CHANGEOVER_AUTO': 0x0901,
  'PRODUCT_DETAIL_TEST': 0x0902,
  'PRODUCT_DETAIL_GFI_RCD': 0x0A00,
  'PRODUCT_DETAIL_BATTERY': 0x0A01,
  'PRODUCT_DETAIL_CONTROLLABLE_BREAKER': 0x0A02,
  'PRODUCT_DETAIL_OTHER': 0x7FFF,
}

PRODUCT_DETAIL_IDS_TO_NAME = _ReverseDict(PRODUCT_DETAIL_IDS)

SLOT_TYPES = {
  'ST_PRIMARY': 0x00,
  'ST_SEC_FINE': 0x01,
  'ST_SEC_TIMING': 0x02,
  'ST_SEC_SPEED': 0x03,
  'ST_SEC_CONTROL': 0x04,
  'ST_SEC_INDEX': 0x05,
  'ST_SEC_ROTATION': 0x06,
  'ST_SEC_INDEX_ROTATE': 0x07,
  'ST_SEC_UNDEFINED': 0xFF,
}

SLOT_TYPE_TO_NAME = _ReverseDict(SLOT_TYPES)

SLOT_DEFINITIONS = {
  'SD_INTENSITY': 0x0001,
  'SD_INTENSITY_MASTER': 0x0002,
  'SD_PAN': 0x0101,
  'SD_TILT': 0x0102,
  'SD_COLOR_WHEEL': 0x0201,
  'SD_COLOR_SUB_CYAN': 0x0202,
  'SD_COLOR_SUB_YELLOW': 0x0203,
  'SD_COLOR_SUB_MAGENTA': 0x0204,
  'SD_COLOR_ADD_RED': 0x0205,
  'SD_COLOR_ADD_GREEN': 0x0206,
  'SD_COLOR_ADD_BLUE': 0x0207,
  'SD_COLOR_CORRECTION': 0x0208,
  'SD_COLOR_SCROLL': 0x0209,
  'SD_COLOR_SEMAPHORE': 0x0210,
  'SD_COLOR_ADD_AMBER': 0x0211,
  'SD_COLOR_ADD_WHITE': 0x0212,
  'SD_COLOR_ADD_WARM_WHITE': 0x0213,
  'SD_COLOR_ADD_COOL_WHITE': 0x0214,
  'SD_COLOR_SUB_UV': 0x0215,
  'SD_COLOR_HUE': 0x0216,
  'SD_COLOR_SATURATION': 0x0217,
  'SD_STATIC_GOBO_WHEEL': 0x0301,
  'SD_ROTO_GOBO_WHEEL': 0x0302,
  'SD_PRISM_WHEEL': 0x0303,
  'SD_EFFECTS_WHEEL': 0x0304,
  'SD_BEAM_SIZE_IRIS': 0x0401,
  'SD_EDGE': 0x0402,
  'SD_FROST': 0x0403,
  'SD_STROBE': 0x0404,
  'SD_ZOOM': 0x0405,
  'SD_FRAMING_SHUTTER': 0x0406,
  'SD_SHUTTER_ROTATE': 0x0407,
  'SD_DOUSER': 0x0408,
  'SD_BARN_DOOR': 0x0409,
  'SD_LAMP_CONTROL': 0x0501,
  'SD_FIXTURE_CONTROL': 0x0502,
  'SD_FIXTURE_SPEED': 0x0503,
  'SD_MACRO': 0x0504,
  'SD_POWER_CONTROL': 0x0505,
  'SD_FAN_CONTROL': 0x0506,
  'SD_HEATER_CONTROL': 0x0507,
  'SD_FOUNTAIN_CONTROL': 0x0508,
  'SD_UNDEFINED': 0xFFFF,
}

SLOT_DEFINITION_TO_NAME = _ReverseDict(SLOT_DEFINITIONS)

PRESET_PROGRAMMED = {
  'PRESET_NOT_PROGRAMMED': 0x00,
  'PRESET_PROGRAMMED': 0x01,
  'PRESET_PROGRAMMED_READ_ONLY': 0x02,
}

PRESET_PROGRAMMER_TO_NAME = _ReverseDict(PRESET_PROGRAMMED)

MERGE_MODE = {
  'MERGEMODE_DEFAULT': 0x00,
  'MERGEMODE_HTP': 0x01,
  'MERGEMODE_LTP': 0x02,
  'MERGEMODE_DMX_ONLY': 0x03,
  'MERGEMODE_OTHER': 0xFF,
}

MERGE_MODE_TO_NAME = _ReverseDict(MERGE_MODE)

INTERFACE_HARDWARE_TYPE_ETHERNET = 0x0001
