insteon-hub2

Library for monitoring and controlling Insteon devices through an Insteon hub.

Architucture

The INSTEON Hub 2 has a HTTP port that allows for controlling and monitoring the hub and the devices controlled by it. To send a command to the hub, you send a HTTP request. To read responses from the hub is a little trickier. You send a HTTP request to get the buffer which returns a string of hexadecimal characters. This string implements a ring (or circular) buffer. In order to not miss and messages, this buffer must be read at a rate of 20 times per second.

INSTEON Command Types

SD, Standard-length Direct Commands direct SDO v directAck SDK v directNak SDN v

ED, Extended-length Direct Commands direct EDO v directAck EDK directNak EDN

SA, Standard-length ALL-Link Commands allLinkBroadcast SAO v

EA, Extended-length ALL-Link Commands allLinkBroadcast EAO

SC, Standard-length ALL-Link Cleanup Commands allLinkCleanup SCO v allLinkCleanupAck SCK v allLinkCleanupNak SCN v

EC, Extended-length ALL-Link Cleanup Commands allLinkCleanup ECO allLinkCleanupAck ECK allLinkCleanupNak ECN

SB, Standard-length Broadcast Commands broadcast SBO v

EB, Extended-length Broadcast Commands broadcast SBO

INSTEON Message Types

There are 16 logically possible INSTEON Message Types denoted by four bits in the Message Flags byte within an INSTEON Message. A three-letter mnemonic designates the INSTEON Message Type. The first letter is S for Standard-length or E for Extended-length messages. The second letter is D for Direct, B for Broadcast, A for ALL-Link Broadcast, or C for ALL-Link Cleanup messages. The third letter, which is optional, is O for Outgoing, K for ACK, or N for NAK messages. Valid Outgoing INSTEON Message Types are SD, ED, SA, SC, and SB. Valid INSTEON Acknowledgement Message Types are SDK, SDN, SCK, and SCN.

Currently used (as of 2/2009):

• SD, Standard-length Direct Commands

  • direct SDO v (receives acknowledgement)
  • directAck SDK v
  • directNak SDN v

• ED, Extended-length Direct Commands

  • direct EDO v (receives acknowledgement)

• SA, Standard-length ALL-Link Commands

  • allLinkBroadcast SAO v

• SC, Standard-length ALL-Link Cleanup Commands

  • allLinkCleanup SCO v (receives acknowledgement)
  • allLinkCleanupAck SCK v
  • allLinkCleanupNak SCN v

• SB, Standard-length Broadcast Commands

  • broadcast SBO

Undocumented IM commands

• 59-5F (5C received)
• 74-7F (77 and 7F received)

Hardware

Model	Version	Revision	Category	Subcategory	Other
2477D	8.2	3117	01	20	45
2477DH	8.2	3117	01	2D	44
2477S	7.2	2717	01	2A	45
2663-222	7.4	4117	01	39	44
2245-222	2.8	3417	03	33	A3 04-20140904 1013 Build Dec 18 2017 09:43:02

Files

• allLinkDatabase.js
  • createAllLinkDatabase
• allLinkRecord.js
  • createAllLinkRecord
• commandAnnotator.js
  • createCommandAnnotator
• constants.js
  • ALL_LINK_CODES
  • ALL_LINK_CONTROL_CODES
  • ALL_LINK_CONTROL_NAMES
  • ALL_LINK_TYPES
  • BUTTON_EVENTS
  • INSTEON_MESSAGE_TYPES
  • NAK_ERROR_CODES
  • OPERATING_FLAGS
  • OUTLET_CODES
  • OUTLET_NAMES
  • ENGINE_VERSION_CODES
  • ENGINE_VERSION_NAMES
  • X10_COMMANDS
  • X10_HOUSE_CODES
  • X10_UNIT_CODES
• device.js
  • createDevice
• deviceCategories.js
  • '00'
  • '01'
  • '02'
  • '03'
  • '04'
  • '05'
  • '06'
  • '07'
  • '08'
  • '09'
  • '0A'
  • '0B'
  • '0C'
  • '0D'
  • '0E'
  • '0F'
  • '10'
  • '11'
  • '12'
  • '13'
  • '14'
  • '15'
  • '16'
  • '17'
  • FE
  • FF
• deviceManager.js
  • createDeviceManager
• encodeCommand.js
  • encodeCommand
  • commandResponseMatcher
• house.js
  • createHouse
• parseInsteonCommand.js
  • parseInsteonCommand
• parsePlmBuffer.js
  • parsePlmBuffer
• parsers.js
  • parsers
• plm.js
  • createPlm
• plmBase.js
  • createPlmBase
• plmBufferProcessor.js
  • createPlmBufferProcessor
• plmCommandQueue.js
  • createPlmCommandQueue
• plmCommandStream.js
  • createPlmCommandStream
• plmStream.js
  • createPlmStream

References

• openHAB 1 Add-ons resources
• leftover code
• Leftover Code SmartLinc
• The Insteon Hub and SmartLinc 2414N HTTP API for X10 Devices
• Quick Reference Guide for Smarthome Device Manager for INSTEON
• Insteon Custom Commands for HouseLinc
• Insteon Hacking Guides
• Insteon Device Controller for Windows
• INSTEON COMMAND LIST
• Under the Insteon Hub Hood
• Intellihome 2.5 - Now supports ISY and iPhone 5!
• Insteon Direct Commands
• Insteon Hub Commands
• 2242-222dev-062013-en
• INSTEON Device Categories and Product Keys
• INSTEON Devices XML
• Device Categories from Wiki