INSTEON Hub Developer's Manual
  1. Manuals
  2. Brands
  3. INSTEON Manuals
  4. Control Unit
  5. Hub
  6. Developer's manual

INSTEON Hub Developer's Manual

Hide thumbs Also See for Hub:
Table of Contents

Advertisement

Quick Links

Download this manual
INSTEON Hub: Developer's Guide
Version 2.0 © 2005-2013 INSTEON

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Hub and is the answer not in the manual?

Questions and answers

Related Manuals for INSTEON Hub

Summary of Contents for INSTEON Hub

  • Page 1 INSTEON Hub: Developer’s Guide Version 2.0 © 2005-2013 INSTEON...

  • Page 2: Table Of Contents

    Control Commands ..........................6 Query Commands ..........................6 Command Syntax ..........................7 Insteon Commands to send to the Hub for the PLM..............7 Hub Commands ............................7 Commands that will be in the INSTEON Buffer ..................7 Group Commands ..........................8 Individual Device Control Commands (Point to Point) ................
  • Page 3 INSTEON Hub: Developer’s Guide Get ALL-Link Record for Sender ....................38 ALL-Link Record Response ...................... 39 Manage ALL-Link Record ......................40 IM Status Management ........................ 43 Reset the IM ..........................43 User Reset Detected ......................... 44 Get IM Configuration ......................... 45 Set IM Configuration .........................
  • Page 4 10-12-07 Added PowerLinc Modem (PLM) Quick Start Guide section 1-18-08 Updated Set IM command to include that if Bit 3=1, the interface will NAK serial commands if the it is busy processing an INSTEON command. 3-16-12 Added IM commands 7-23-12...
  • Page 5 INSTEON Hub Developer’s Guide may be incorporated. No names, trademarks, service marks or logos of SmartLabs, Inc. or INSTEON may be used to endorse or promote products derived from the INSTEON Hub Developer’s Guide without specific...

  • Page 6: Introduction

    INSTEON Software Development Kit may download from http://code.insteon.com. The INSTEON Hub The INSTEON Hub is an INSTEON-to-Ethernet Bridge module that plugs into a power outlet and also has a ethernet port that you connect to your network. It uses an IN2680A Powerline Modem chip that offers a...

  • Page 7: Other Documents Included By Reference

    The book-length INSTEON Developer’s Guide, 2 Edition is the primary source for the information contained in this (much shorter) INSTEON Hub Developer’s Guide. Some links in this document refer to information found there. Developers who purchase an INSTEON Software Developer’s Kit may download the INSTEON Developer’s Guide from http://code.insteon.com.

  • Page 8: Insteon Modem Reference

    INSTEON Hub: Developer’s Guide INSTEON Modem Reference Software Reference INSTEON Modem (IM) chips and the SmartLabs Hub offer developers a simple, robust interface to an INSTEON network. INSTEON Hubs provide a simpler interface to many of the low-level IBIOS Serial Commands implemented in the SmartLabs Hub described in the INSTEON Developer’s Guide...
  • Page 9 INSTEON Hub: Developer’s Guide IM Serial Communication Protocol and Settings Describes the serial communication protocol IM Power-up and Reset States Explains what happens when you power up the IM or reset it. IM Serial Commands Lists the IM Serial Commands and describes what they do, in a single table and individual charts grouped by functionality.

  • Page 10: Im Serial Communication Protocol And Settings

    INSTEON Hub: Developer’s Guide IM Serial Communication Protocol and Settings In This Section IM Serial Communication Protocol Gives the protocol for communicating serially with an INSTEON Modem. Page 5 © 2013 INSTEON...

  • Page 11: Im Serial Communication Protocol

    INSTEON Hub: Developer’s Guide IM Serial Communication Protocol All INSTEON Modem (IM) Serial Commands start with ASCII 0x02 (STX, Start-of-Text) followed by the Serial Command Number (see IM Serial Commands ). What data follows the Command depends on the Command syntax (see...

  • Page 12: Command Syntax

    For a group: http://bobbieshome.myhouse:8000/0?13182=I=0 where 0x13 is the command and 182 is the group. (URL is an example of internet using getmyip.com to track Dynamic DNS for the hub) (Note the interesting combination of Hex and decimal numbers i.e. 13 182) For a device: http://172.16.1.34/3?02620102030F117F=I=3...

  • Page 13: Group Commands

    2:03.7 ask for the buffer again 2:03.9 get 02620E79860F11FF0602500E798609D6822B11FF In a group command, the buffer will quickly wrap with the clean-ups so searching for the 0258 is a little tricky since that is also a valid Partial Insteon ID. Linking Example: Page 8...
  • Page 14 INSTEON Hub: Developer’s Guide Send go into Linking mode group 137. http://172.16.1.34/0?09137=I=0 The PLM echoes and adds an 06 0264018906 (0264 linking command 01 controller and group 0x89) Press and hold the button on the new device 02640101060253010108B6EA010195 0264010106 Left in the buffer from go into linking mode...

  • Page 15: Id Request Example

    Insteon Message 0E7986 From 09D682 Flags Byte 20 = ACK + B = Hop count Echo CMD1 Echo CMD2 0250 Insteon Message (about 1 sec later) 0E7986 From (01 = Dimmer) (SubCat) (00 = LampLinc) Firmware version Flags Byte 80 = Broadcast + B = hop count...

  • Page 16: Im Power-Up And Reset States

    INSTEON Hub: Developer’s Guide IM Power-up and Reset States This section describes the IM Power-up Behavior and the IM Factory Reset State IM Power-up Behavior The table below shows the state of the IM when it powers up. Holding down the SET Button while powering up will cause a factory reset.

  • Page 17: Im Serial Commands

    INSTEON network. For example, a microcontroller in a thermostat could use an INSTEON Powerline Modem chip to send and receive messages to other INSTEON or X10 devices on the home’s powerline. In this section, the IM Serial Commands are presented twice, once as a summary table, and again as a series of charts grouped by functionality.

  • Page 18: Im Serial Command Summary Table

    INSTEON Hub: Developer’s Guide IM Serial Command Summary Table This table lists all of the Modem Serial Commands supported by INSTEON powerline or RF modem chips. Code Gives the hexadecimal number of the IM Serial Command. Note that IM Commands sent by an IM to the host begin at 0x50 and IM Commands sent by the host to an IM begin at 0x60.
  • Page 19 0x62 Send INSTEON Standard or S: 0x02 0x62 Extended Message <INSTEON Standard message (6 bytes, excludes From Address) | INSTEON Extended message (20 bytes, excludes From Address)> R: 0x02 0x62 <INSTEON Standard message (6 bytes, excludes From Address) | INSTEON Extended message (20 bytes, excludes From Address)>...
  • Page 20 INSTEON Hub: Developer’s Guide R: 0x02 0x66 <Device Category> <Device Subcategory> <0x00 | Firmware Revision> <0x06> 0x67 Reset the IM S: 0x02 0x67 R: 0x02 0x67 <0x06> 0x68 Set INSTEON ACK Message S: 0x02 0x68 Byte <Command 2 Data> R: 0x02 0x68 <Command 2 Data>...
  • Page 21 INSTEON Hub: Developer’s Guide R: 0x02 0x73 <IM Configuration Flags> <Spare 1> <Spare 2> <0x06> Page 16 © 2013 INSTEON...
  • Page 22 INSTEON Hub: Developer’s Guide These commands added after initial release: INSTEON Modem Serial Commands Commands Sent from the Host to an IM Code Command Format 0x74 Cancel Cleanup S: 0x02 0x74 R: 0x02 0x74 <0x06> 0x75 Read 8 bytes from S: 0x02 0x75 <Database Address high byte>...

  • Page 23: Im Serial Command Charts

    INSTEON ALL-Link Commands Commands for sending ALL-Link Commands with automatic handling of ALL-Link Cleanup Commands. ALL-Linking Session Management Commands for creating ALL-Links between an IM and other INSTEON devices. ALL-Link Database Management Commands for managing ALL-Link Records in the IM’s ALL-Link Database.

  • Page 24: Insteon Message Handling

    0x15 (NAK) if an error occurred Notes The From Address is not required because the IM will automatically insert its own INSTEON ID into the message. For more information on INSTEON Commands and the latest Command set, please download the current INSTEON Command Tables Document from http://code.insteon.com.
  • Page 25 Start of IM Command 0x62 IM Command Number <To Address high> The high byte of the INSTEON ID of the message addressee. <To Address middle> The middle byte of the INSTEON ID of the message addressee. <To Address low> The low byte of the INSTEON ID of the message addressee.
  • Page 26 0x15 (NAK) if an error occurred Notes The From Address is not required because the IM will automatically insert its own INSTEON ID into the message. For more information on INSTEON Commands and the latest Command set, please download the...

  • Page 27: Insteon Standard Message Received

    , except that there is no <User Data>. Normally, the IM will only send the host INSTEON messages that are explicitly addressed to the IM or that are from devices that the IM is ALL-Linked to. This behavior can be modified—see the...

  • Page 28: Insteon Extended Message Received

    , except that there are 14 bytes of <User Data>. Normally, the IM will only send the host INSTEON messages that are explicitly addressed to the IM or that are from devices that the IM is ALL-Linked to. This behavior can be modified—see the...

  • Page 29: Set Insteon Ack Message Byte

    Set INSTEON ACK Message Byte (0x68) What it does Allows you to put one byte of data into the Command 2 field of the INSTEON ACK message that the INSTEON Engine automatically sends after it receives an INSTEON Direct message.

  • Page 30: Set Insteon Ack Message Two Bytes

    0x15 (NAK) if an error occurred. Notes You have only about 15 milliseconds after the receipt of an INSTEON Direct message from the IM to send this Command to the IM. The reason is that the INSTEON Engine in the IM automatically sends Acknowledgement messages in assigned timeslots.

  • Page 31: Set Insteon Nak Message Byte

    Allows you to change the INSTEON ACK message that the INSTEON Engine automatically sends after it receives an INSTEON Direct message into a NAK message, and to put one byte of data into the Command 2 field of that message.

  • Page 32: X10 Message Handling

    INSTEON Hub: Developer’s Guide X10 Message Handling Send X10 Send X10 (0x63) What it does Allows you to send a raw X10 Address or X10 Command. What you send 4 bytes. What you’ll get 5 bytes. LED indication None. Related Commands...

  • Page 33: X10 Received

    INSTEON Hub: Developer’s Guide X10 Received X10 Received (0x52) What it does Informs you of an X10 byte detected on the powerline. When you’ll get this Any X10 traffic is detected on the powerline. What you’ll get 4 bytes. LED indication The LED will blink during X10 reception.

  • Page 34: Insteon All-Link Commands

    The IM automatically sends ALL-Link Cleanup messages to each member of an ALL-Link Group following an ALL-Link Broadcast message. If the IM detects other INSTEON traffic during this process, it will abort the ALL-Link Cleanup sequence and send you an...
  • Page 35 The IM first sends an ALL-Link Broadcast message with Max Hops set to 3. When it sends the ensuing ALL-Link Cleanup messages, it sets Max Hops to 1. If the IM’s INSTEON Engine needs to retry a Cleanup message, it will automatically increment Max Hops for each retry, up to a maximum of value of The IM sends the ALL-Link Broadcast message immediately if there is no other INSTEON traffic.

  • Page 36: All-Link Cleanup Failure Report

    The IM automatically sends ALL-Link Cleanup messages to each member of an ALL-Link Group following an ALL-Link Broadcast message. If the IM detects other INSTEON traffic during this process, it will abort the ALL-Link Cleanup sequence. If the Cleanup sequence is aborted, you will not receive this message nor will you receive a Cleanup acknowldgement message for any subsequent devices in the ALL-Link Group.

  • Page 37: All-Link Cleanup Status Report

    After you issue a Send ALL-Link Command and the IM finishes sending Cleanups to all members of the ALL-Link Group, or else when the Cleanup sequence is aborted due to other INSTEON traffic. What you’ll get 3 bytes. LED indication None.

  • Page 38: All-Linking Session Management

    INSTEON Hub: Developer’s Guide ALL-Linking Session Management Start ALL-Linking Start ALL-Linking (0x64) What it does Puts the IM into ALL-Linking mode without using the SET Button. What you send 4 bytes. What you’ll get 5 bytes for this Command response and then an additional 10 bytes in an ALL-Linking Completed message once a successful ALL-Link has been established.

  • Page 39: Cancel All-Linking

    INSTEON Hub: Developer’s Guide Cancel ALL-Linking Cancel ALL-Linking (0x65) What it does Cancels the ALL-Linking process that was started either by holding down the IM’s SET Button or by sending a Start ALL-Linking Command to the IM. What you send 2 bytes.

  • Page 40: All-Linking Completed

    Start ALL-Linking Command. <ID high byte> The high byte of the INSTEON ID of the device that was ALL-Linked. <ID middle byte> The middle byte of the INSTEON ID of the device that was ALL-Linked. <ID low byte>...

  • Page 41: All-Link Database Management

    INSTEON Hub: Developer’s Guide ALL-Link Database Management Get First ALL-Link Record Get First ALL-Link Record (0x69) What it does Returns the first record in the IM’s ALL-Link Database. The data will follow in an ALL-Link Record Response message. What you send 2 bytes.

  • Page 42: Get Next All-Link Record

    INSTEON Hub: Developer’s Guide Get Next ALL-Link Record Get Next ALL-Link Record (0x6A) What it does Returns the next record in the IM’s ALL-Link Database. The data will follow in an ALL-Link Record Response message. What you send 2 bytes.

  • Page 43: Get All-Link Record For Sender

    0x15 (NAK) if the last INSTEON message received had a From Address not in the IM’s ALL-Link Database. Note If you send this after receiving an INSTEON message from an INSTEON device that is not in the IM’s ALL-Link Database, you will receive a NAK in response. Sending a...

  • Page 44: All-Link Record Response

    Reserved (set to 0) <ALL-Link Group> ALL-Link Group Number for this ALL-Link Record <ID high byte> INSTEON ID high byte for device ALL-Linked to <ID middle byte> INSTEON ID middle byte for device ALL-Linked to <ID low byte> INSTEON ID low byte for device ALL-Linked to <Link Data 1>...

  • Page 45: Manage All-Link Record

    INSTEON Hub: Developer’s Guide Manage ALL-Link Record Manage ALL-Link Record (0x6F) What it does Updates the IM’s ALL-Link Database (ALDB) with the ALL-Link Record information you send. Use caution with this Command—the IM does not check the validity of the data.
  • Page 46 Reserved (set to 0) <ALL-Link Group> ALL-Link Group Number for this ALL-Link Record <ID high byte> INSTEON ID high byte for device ALL-Linked to <ID middle byte> INSTEON ID middle byte for device ALL-Linked to <ID low byte> INSTEON ID low byte for device ALL-Linked to <Link Data 1>...
  • Page 47 INSTEON Hub: Developer’s Guide only one of the matching records, then you should: 1. Use Find First and Find Next to find and buffer all of the records matching the <ALL-Link Group> and <ID>, 2. Use Delete First Found enough times to delete all of the matching records, 3.

  • Page 48: Im Status Management

    INSTEON Hub: Developer’s Guide IM Status Management Reset the IM Reset the IM (0x67) What it does Puts the IM into the IM Factory Reset State , which clears the entire ALL-Link Database. What you send 2 bytes. What you’ll get 3 bytes.

  • Page 49: User Reset Detected

    INSTEON Hub: Developer’s Guide User Reset Detected User Reset Detected (0x55) What it does Reports that the user manually put the IM into the IM Factory Reset State When you’ll get this The user held down the IM’s SET Button for at least 10 seconds when power was first applied.

  • Page 50: Get Im Configuration

    INSTEON Hub: Developer’s Guide Get IM Configuration Get IM Configuration (0x73) What it does Returns the IM’s Configuration Flags byte. Also returns two spare bytes of data reserved for future use. What you send 2 bytes. What you’ll get 6 bytes.

  • Page 51: Set Im Configuration

    IM. There are three possibilities: 1. The IM received a Direct message with a To Address matching the IM’s INSTEON ID, 2. The IM received an ALL-Link Broadcast message sent to an ALL-Link Group that the IM belongs to as a Responder (i.e.
  • Page 52 IM is farther away, the message originator may not cause the message to hop enough times for the IM to hear it. To know for sure what an INSTEON device’s status is, you can usually query it directly using an appropriate INSTEON Direct Command. For more...

  • Page 53: Get Im Info

    INSTEON Hub: Developer’s Guide Get IM Info Get IM Info (0x60) What it does Identifies the IM’s 3 byte INSTEON ID, Device Category (DevCat), Device Subcategory (SubCat), and firmware version. What you send 2 bytes. What you’ll get 9 bytes.

  • Page 54: Set Host Device Category

    0x15 (NAK) if an error occurred Notes For INSTEON compliance, you must obtain an approved DevCat and SubCat assignment for your host product from SmartLabs. The IM stores these values in EEPROM so they will not be erased if power is lost.

  • Page 55: Rf Sleep

    INSTEON Hub: Developer’s Guide RF Sleep RF Sleep (0x72) What it does Directs an RF IM to go into power saving sleep mode. To wake up the RF IM, send it one byte of serial data. What you send 2 bytes.

  • Page 56: Im Input/Output

    INSTEON Hub: Developer’s Guide IM Input/Output Button Event Report Button Event Report (0x54) What it does Reports user SET Button events. When you’ll get this The user operates the SET Button, or if they exist, Button 2 or Button 3.

  • Page 57: Led On

    INSTEON Hub: Developer’s Guide LED On LED On (0x6D) What it does Turns on the IM’s LED if IM Configuration Flags bit 5 = 1. What you send 2 bytes. What you’ll get 3 bytes. LED indication The LED will go on.

  • Page 58: Led Off

    INSTEON Hub: Developer’s Guide LED Off LED Off (0x6E) What it does Turns off the IM’s LED if IM Configuration Flags bit 5 = 1. What you send 2 bytes. What you’ll get 3 bytes. LED indication The LED will go off.

  • Page 59: Cancel Cleanup

    INSTEON Hub: Developer’s Guide Cancel Cleanup Cancel Cleanup (0x74) What it does Cancels cleanup from ALL-Link Command What you send 2 bytes. What you’ll get 3 bytes. LED indication None. Related Commands IM 0x61 Send ALL-Link Command Command Sent from Host to IM...

Table of Contents