funlogic-io/zwave-serialapi

View on GitHub
lib/serialapi/consts.js

Summary

Maintainability
A
0 mins
Test Coverage
const Consts = {

  SOF: 0x01,
  ACK: 0x06,
  NAK: 0x15,
  CAN: 0x18,

  REQUEST: 0x00,
  RESPONSE: 0x01,

  GET_INIT_DATA_FLAG_SLAVE_API: 0x01,
  GET_INIT_DATA_FLAG_TIMER_SUPPORT: 0x02,
  GET_INIT_DATA_FLAG_CONTROLLER_STATUS: 0x04,
  GET_INIT_DATA_FLAG_SECONDARY_CTRL: 0x04,
  GET_INIT_DATA_FLAG_IS_SUC: 0x08,

  SERIAL_API_APPL_NODE_ROLE_SET: 0x01,
  SERIAL_API_APPL_NODE_ROLE_GET: 0x02,
  SERIAL_API_APPL_NODE_ROLE_REPORT: 0x03,
  SERIAL_API_APPL_SLAVE_NODE_ROLE_SET: 0x04,
  SERIAL_API_APPL_SLAVE_NODE_ROLE_GET: 0x05,
  SERIAL_API_APPL_SLAVE_NODE_ROLE_REPORT: 0x06,
  SERIAL_API_APPL_NODE_ROLE_UNDEFINED: 0xFF,

  FUNC_ID_SERIAL_API_GET_INIT_DATA: 0x02,
  FUNC_ID_SERIAL_API_APPL_NODE_INFORMATION: 0x03,
  FUNC_ID_APPLICATION_COMMAND_HANDLER: 0x04,
  FUNC_ID_ZW_GET_CONTROLLER_CAPABILITIES: 0x05,
  FUNC_ID_SERIAL_API_SET_TIMEOUTS: 0x06,
  FUNC_ID_SERIAL_API_GET_CAPABILITIES: 0x07,
  FUNC_ID_SERIAL_API_SOFT_RESET: 0x08,
  FUNC_ID_ZW_GET_PROTOCOL_VERSION: 0x09,
  FUNC_ID_SERIAL_API_APPL_NODE_ROLE_TYPE: 0x0A,
  FUNC_ID_ZW_SET_RF_RECEIVE_MODE: 0x10,
  FUNC_ID_ZW_SET_SLEEP_MODE: 0x11,
  FUNC_ID_ZW_SEND_NODE_INFORMATION: 0x12,
  FUNC_ID_ZW_SEND_DATA: 0x13,
  FUNC_ID_ZW_SEND_DATA_MULTI: 0x14,
  FUNC_ID_ZW_GET_VERSION: 0x15,
  FUNC_ID_ZW_SEND_DATA_ABORT: 0x16,
  FUNC_ID_ZW_RF_POWER_LEVEL_SET: 0x17,
  FUNC_ID_ZW_SEND_DATA_META: 0x18,
  FUNC_ID_ZW_RESERVED_SD: 0x19,
  FUNC_ID_ZW_RESERVED_SDM: 0x1A,
  FUNC_ID_ZW_RESERVED_SRI: 0x1B,
  FUNC_ID_ZW_GET_RANDOM: 0x1C,
  FUNC_ID_MEMORY_GET_ID: 0x20,
  FUNC_ID_MEMORY_GET_BYTE: 0x21,
  FUNC_ID_MEMORY_PUT_BYTE: 0x22,
  FUNC_ID_MEMORY_GET_BUFFER: 0x23,
  FUNC_ID_MEMORY_PUT_BUFFER: 0x24,
  FUNC_ID_SERIAL_API_GET_APPL_HOST_MEMORY_OFFSET: 0x25,
  FUNC_ID_DEBUG_OUTPUT: 0x26,
  FUNC_ID_AUTO_PROGRAMMING: 0x27,
  FUNC_ID_NVR_GET_VALUE: 0x28,
  FUNC_ID_CLOCK_SET: 0x30,
  FUNC_ID_CLOCK_GET: 0x31,
  FUNC_ID_CLOCK_CMP: 0x32,
  FUNC_ID_RTC_TIMER_CREATE: 0x33,
  FUNC_ID_RTC_TIMER_READ: 0x34,
  FUNC_ID_RTC_TIMER_DELETE: 0x35,
  FUNC_ID_RTC_TIMER_CALL: 0x36,
  FUNC_ID_ZW_SET_LEARN_NODE_STATE: 0x40,
  FUNC_ID_ZW_GET_NODE_PROTOCOL_INFO: 0x41,
  FUNC_ID_ZW_SET_DEFAULT: 0x42,
  FUNC_ID_ZW_NEW_CONTROLLER: 0x43,
  FUNC_ID_ZW_REPLICATION_COMMAND_COMPLETE: 0x44,
  FUNC_ID_ZW_REPLICATION_SEND_DATA: 0x45,
  FUNC_ID_ZW_ASSIGN_RETURN_ROUTE: 0x46,
  FUNC_ID_ZW_DELETE_RETURN_ROUTE: 0x47,
  FUNC_ID_ZW_REQUEST_NODE_NEIGHBOR_UPDATE: 0x48,
  FUNC_ID_ZW_APPLICATION_UPDATE: 0x49,
  FUNC_ID_ZW_APPLICATION_CONTROLLER_UPDATE: 0x49,
  FUNC_ID_ZW_ADD_NODE_TO_NETWORK: 0x4A,
  FUNC_ID_ZW_REMOVE_NODE_FROM_NETWORK: 0x4B,
  FUNC_ID_ZW_CREATE_NEW_PRIMARY: 0x4C,
  FUNC_ID_ZW_CONTROLLER_CHANGE: 0x4D,
  FUNC_ID_ZW_RESERVED_FN: 0x4E,
  FUNC_ID_ZW_RESERVED_AR: 0x4F,
  FUNC_ID_ZW_REQUEST_NODE_INFO: 0x60,
  FUNC_ID_ZW_REMOVE_FAILED_NODE_ID: 0x61,
  FUNC_ID_ZW_IS_FAILED_NODE_ID: 0x62,
  FUNC_ID_ZW_REPLACE_FAILED_NODE: 0x63,
  FUNC_ID_ZW_GET_ROUTING_MAX: 0x64,
  FUNC_ID_ZW_SET_ROUTING_MAX: 0x65,
  FUNC_ID_ZW_IS_PRIMARY_CTRL: 0x66,
  FUNC_ID_ZW_AES_ECB: 0x67,
  FUNC_ID_ZW_SET_LEARN_MODE: 0x50,
  FUNC_ID_ZW_ASSIGN_SUC_RETURN_ROUTE: 0x51,
  FUNC_ID_ZW_ENABLE_SUC: 0x52,
  FUNC_ID_ZW_REQUEST_NETWORK_UPDATE: 0x53,
  FUNC_ID_ZW_SET_SUC_NODE_ID: 0x54,
  FUNC_ID_ZW_DELETE_SUC_RETURN_ROUTE: 0x55,
  FUNC_ID_ZW_GET_SUC_NODE_ID: 0x56,
  FUNC_ID_ZW_SEND_SUC_ID: 0x57,
  FUNC_ID_ZW_RESERVED_ASR: 0x58,
  FUNC_ID_ZW_REDISCOVERY_NEEDED: 0x59,
  FUNC_ID_ZW_EXPLORE_REQUEST_INCLUSION: 0x5E,
  FUNC_ID_TIMER_START: 0x70,
  FUNC_ID_TIMER_RESTART: 0x71,
  FUNC_ID_TIMER_CANCEL: 0x72,
  FUNC_ID_TIMER_CALL: 0x73,
  FUNC_ID_GET_ROUTING_TABLE_LINE: 0x80,
  FUNC_ID_GET_TX_COUNTER: 0x81,
  FUNC_ID_RESET_TX_COUNTER: 0x82,
  FUNC_ID_STORE_NODEINFO: 0x83,
  FUNC_ID_STORE_HOMEID: 0x84,
  FUNC_ID_LOCK_ROUTE_RESPONSE: 0x90,
  FUNC_ID_ZW_SEND_DATA_ROUTE_DEMO: 0x91,
  FUNC_ID_SERIAL_API_TEST: 0x95,
  FUNC_ID_SERIAL_API_APPL_SLAVE_NODE_INFORMATION: 0xA0,
  FUNC_ID_APPLICATION_SLAVE_COMMAND_HANDLER: 0xA1,
  FUNC_ID_ZW_SEND_SLAVE_NODE_INFORMATION: 0xA2,
  FUNC_ID_ZW_SEND_SLAVE_DATA: 0xA3,
  FUNC_ID_ZW_SET_SLAVE_LEARN_MODE: 0xA4,
  FUNC_ID_ZW_GET_VIRTUAL_NODES: 0xA5,
  FUNC_ID_ZW_IS_VIRTUAL_NODE: 0xA6,
  FUNC_ID_ZW_RESERVED_SSD: 0xA7,
  FUNC_ID_APPLICATION_COMMAND_HANDLER_BRIDGE: 0xA8,
  FUNC_ID_ZW_SEND_DATA_BRIDGE: 0xA9,
  FUNC_ID_ZW_SEND_DATA_META_BRIDGE: 0xAA,
  FUNC_ID_ZW_SEND_DATA_MULTI_BRIDGE: 0xAB,
  FUNC_ID_PWR_SETSTOPMODE: 0xB0,
  FUNC_ID_PWR_CLK_PD: 0xB1,
  FUNC_ID_PWR_CLK_PUP: 0xB2,
  FUNC_ID_PWR_SELECT_CLK: 0xB3,
  FUNC_ID_ZW_SET_WUT_TIMEOUT: 0xB4,
  FUNC_ID_ZW_IS_WUT_KICKED: 0xB5,
  FUNC_ID_ZW_WATCHDOG_ENABLE: 0xB6,
  FUNC_ID_ZW_WATCHDOG_DISABLE: 0xB7,
  FUNC_ID_ZW_WATCHDOG_KICK: 0xB8,
  FUNC_ID_ZW_SET_EXT_INT_LEVEL: 0xB9,
  FUNC_ID_ZW_RF_POWER_LEVEL_GET: 0xBA,
  FUNC_ID_ZW_GET_NEIGHBOR_COUNT: 0xBB,
  FUNC_ID_ZW_ARE_NODES_NEIGHBOURS: 0xBC,
  FUNC_ID_ZW_TYPE_LIBRARY: 0xBD,
  FUNC_ID_ZW_SEND_TEST_FRAME: 0xBE,
  FUNC_ID_ZW_GET_PROTOCOL_STATUS: 0xBF,
  FUNC_ID_ZW_SET_PROMISCUOUS_MODE: 0xD0,
  FUNC_ID_PROMISCUOUS_APPLICATION_COMMAND_HANDLER: 0xD1,
  FUNC_ID_ZW_WATCHDOG_START: 0xD2,
  FUNC_ID_ZW_WATCHDOG_STOP: 0xD3,
  FUNC_ID_SERIAL_API_READY: 0xEF,
  FUNC_ID_PROPRIETARY_0: 0xF0,
  FUNC_ID_PROPRIETARY_1: 0xF1,
  FUNC_ID_PROPRIETARY_2: 0xF2,
  FUNC_ID_PROPRIETARY_3: 0xF3,
  FUNC_ID_PROPRIETARY_4: 0xF4,
  FUNC_ID_PROPRIETARY_5: 0xF5,
  FUNC_ID_PROPRIETARY_6: 0xF6,
  FUNC_ID_PROPRIETARY_7: 0xF7,
  FUNC_ID_PROPRIETARY_8: 0xF8,
  FUNC_ID_PROPRIETARY_9: 0xF9,
  FUNC_ID_PROPRIETARY_A: 0xFA,
  FUNC_ID_PROPRIETARY_B: 0xFB,
  FUNC_ID_PROPRIETARY_C: 0xFC,
  FUNC_ID_PROPRIETARY_D: 0xFD,
  FUNC_ID_PROPRIETARY_E: 0xFE,

  // FUNC_ID_ZW_ECHO_REQUEST : FUNC_ID_PROPRIETARY_0
  // FUNC_ID_ZW_ECHO_REQUEST_LONG : FUNC_ID_PROPRIETARY_1
  FUNC_ID_UNKNOWN: 0xFF,

  // Transport consants
  TRANSMIT_COMPLETE_OK: 0x00,
  TRANSMIT_COMPLETE_NO_ACK: 0x01,
  TRANSMIT_COMPLETE_FAIL: 0x02,
  TRANSMIT_COMPLETE_NOROUTE: 0x04,
  TRANSMIT_ROUTING_NOT_IDLE: 0x03,

  TRANSMIT_OPTION_ACK: 0x01,
  TRANSMIT_OPTION_LOW_POWER: 0x02,
  TRANSMIT_OPTION_AUTO_ROUTE: 0x04,
  TRANSMIT_OPTION_NO_ROUTE: 0x10,
  TRANSMIT_OPTION_EXPLORE: 0x20,

  TRANSMIT_EXPLORE_OPTION_ACK: 0x01, // TRANSMIT_OPTION_ACK,
  TRANSMIT_EXPLORE_OPTION_LOW_POWER: 0x02, // TRANSMIT_OPTION_LOW_POWER,

  RECEIVE_STATUS_TYPE_MASK: 0x0C,
  RECEIVE_STATUS_TYPE_SINGLE: 0x00,
  RECEIVE_STATUS_TYPE_BROAD: 0x04,
  RECEIVE_STATUS_TYPE_MULTI: 0x08,

  RECEIVE_STATUS_ROUTED_BUSY: 0x01,
  RECEIVE_STATUS_FOREIGN_FRAME: 0x40,
  RECEIVE_STATUS_FOREIGN_HOMEID: 0x80,

  ZW_ROUTE_LOST_FAILED: 0x04,
  ZW_ROUTE_LOST_ACCEPT: 0x05,

  ZW_RF_TEST_SIGNAL_CARRIER: 0x00,
  ZW_RF_TEST_SIGNAL_CARRIER_MODULATED: 0x01,
  RECEIVE_STATUS_TYPE_EXPLORE: 0x10,
  ZW_TEST_NOT_A_NODEID: 0x00,
  ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS: 5,
  ZW_MAX_NODES: 232,
  NODE_BROADCAST: 0xFF,
  NODEPARM_MAX: 20,
  RECEIVE_STATUS_LOW_POWER: 0x02,

  SERIAL_LINK_DETACHED: 0x00,
  SERIAL_LINK_CONNECTED: 0x01,

  UPDATE_STATE_NODE_INFO_RECEIVED: 0x84,
  UPDATE_STATE_NODE_INFO_REQ_DONE: 0x82,
  UPDATE_STATE_NODE_INFO_REQ_FAILED: 0x81,
  UPDATE_STATE_ROUTING_PENDING: 0x80,
  UPDATE_STATE_NEW_ID_ASSIGNED: 0x40,
  UPDATE_STATE_DELETE_DONE: 0x20,
  UPDATE_STATE_SUC_ID: 0x10,

  ZW_SET_LEARN_MODE_DISABLE: 0x00,
  ZW_SET_LEARN_MODE_CLASSIC: 0x01,
  ZW_SET_LEARN_MODE_NWI: 0x02,
  ZW_SET_LEARN_MODE_NWE: 0x03,

  /* Callback states from ZW_AddNodeToNetwork */
  ADD_NODE_STATUS_LEARN_READY: 0x01,
  ADD_NODE_STATUS_NODE_FOUND: 0x02,
  ADD_NODE_STATUS_ADDING_SLAVE: 0x03,
  ADD_NODE_STATUS_ADDING_CONTROLLER: 0x04,
  ADD_NODE_STATUS_PROTOCOL_DONE: 0x05,
  ADD_NODE_STATUS_DONE: 0x06,
  ADD_NODE_STATUS_FAILED: 0x07,
  ADD_NODE_STATUS_SECURITY_FAILED: 0x09,
  ADD_NODE_STATUS_NOT_PRIMARY: 0x23,

  /* Callback states from ZW_SetLearnMode */
  LEARN_MODE_STARTED: 0x01,
  LEARN_MODE_DONE: 0x06,
  LEARN_MODE_FAILED: 0x07,

  /** Library types from ZW_Version */
  ZW_LIB_CONTROLLER_STATIC: 0x01,
  ZW_LIB_CONTROLLER: 0x02,
  ZW_LIB_SLAVE_ENHANCED: 0x03,
  ZW_LIB_SLAVE: 0x04,
  ZW_LIB_INSTALLER: 0x05,
  ZW_LIB_SLAVE_ROUTING: 0x06,
  ZW_LIB_CONTROLLER_BRIDGE: 0x07,
  ZW_LIB_DUT: 0x08,
  ZW_LIB_AVREMOTE: 0x0A,
  ZW_LIB_AVDEVICE: 0x0B,

  /** Controller capabilities from ZW_GetControllerCapabilities */
  CONTROLLER_IS_SECONDARY: 0x01,
  CONTROLLER_ON_OTHER_NETWORK: 0x02,
  CONTROLLER_NODEID_SERVER_PRESENT: 0x04,
  CONTROLLER_IS_REAL_PRIMARY: 0x08,
  CONTROLLER_IS_SUC: 0x10,

  /** Suc Capabilities and setup */
  ZW_SUC_FUNC_NODEID_SERVER: 0x01,

  ZW_SUC_UPDATE_DONE: 0x00,
  ZW_SUC_UPDATE_ABORT: 0x01,
  ZW_SUC_UPDATE_WAIT: 0x02,
  ZW_SUC_UPDATE_DISABLED: 0x03,
  ZW_SUC_UPDATE_OVERFLOW: 0x04,

  ZW_SUC_SET_SUCCEEDED: 0x05,
  ZW_SUC_SET_FAILED: 0x06

}

module.exports = Consts