- No category
advertisement
M o d e m D e v e l o p e r ’ s G u i d e
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page i
Table of Contents
INSTEON Modem Chips.............................................................................. 1
The SmartLabs Powerline Modem (PLM) ................................................... 2
Comparing the Powerline Modem (PLM) to the PowerLinc Controller (PLC)
Other Documents Included by Reference .................................................. 4
INSTEON Developer’s Guide ....................................................................... 4
INSTEON Conformance Specification ........................................................... 4
INSTEON Command Tables Document ...................................................... 4
INSTEON Device Categories and Product Keys Document............................. 4
INSTEON Modem Spec Sheets .................................................................... 5
IN2680A INSTEON Direct Powerline Modem Interface.................................. 5
IN2682A INSTEON Direct RF Modem Interface ........................................... 5
INSTEON MODEM REFERENCE ...................................................................... 6
IM Serial Communication Protocol and Settings............................................. 7
IM Serial Communication Protocol ............................................................ 8
IM RS232 Port Settings........................................................................... 8
How to Quickly Start Communicating with an IM ........................................ 9
IM Power-up and Reset States...................................................................10
IM Power-up Behavior ...........................................................................10
IM Factory Reset State ..........................................................................10
IM Serial Command Summary Table ........................................................12
IM Serial Command Charts.....................................................................16
INSTEON Message Handling.................................................................17
Send INSTEON Standard or Extended Message ....................................17
INSTEON Standard Message Received ................................................20
INSTEON Extended Message Received ................................................21
Set INSTEON ACK Message Byte........................................................23
Set INSTEON ACK Message Two Bytes................................................24
Set INSTEON NAK Message Byte .......................................................25
X10 Message Handling ........................................................................26
Send X10 .......................................................................................26
X10 Received..................................................................................27
INSTEON ALL-Link Commands .............................................................28
Send ALL-Link Command..................................................................28
ALL-Link Cleanup Failure Report ........................................................30
ALL-Link Cleanup Status Report.........................................................31
ALL-Linking Session Management .........................................................32
Start ALL-Linking.............................................................................32
Cancel ALL-Linking ..........................................................................33
ALL-Linking Completed.....................................................................34
ALL-Link Database Management...........................................................35
Get First ALL-Link Record .................................................................35
Get Next ALL-Link Record .................................................................36
Get ALL-Link Record for Sender.........................................................37
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page ii
ALL-Link Record Response ................................................................38
Manage ALL-Link Record ..................................................................39
IM Status Management .......................................................................41
Reset the IM...................................................................................41
User Reset Detected ........................................................................42
Get IM Configuration........................................................................43
Set IM Configuration ........................................................................44
Get IM Info.....................................................................................46
Set Host Device Category .................................................................47
RF Sleep ........................................................................................48
IM Input/Output ................................................................................49
Button Event Report ........................................................................49
LED On ..........................................................................................50
LED Off ..........................................................................................51
INSTEON Powerline Modem (PLM) Main Board .............................................53
INSTEON PLM Main Board Schematic .......................................................54
INSTEON PLM Main Board Bill of Materials ................................................55
INSTEON PLM Serial (RS232) Daughter Board .............................................57
INSTEON PLM Serial Daughter Board Schematic ........................................58
INSTEON PLM Serial Daughter Board Bill of Materials .................................59
INSTEON PLM Ethernet (IP) Daughter Board................................................60
INSTEON PLM Ethernet (IP) Daughter Board Schematic..............................61
INSTEON PLM Ethernet (IP) Daughter Board Bill of Materials .......................62
Revision History
Release
Date
Author Description
01-30-07 PVD Abstracted from INSTEON Developers Guide.
02-12-07 PVD
02-14-07 PVD
03-01-07 PVD
03-27-07 PVD
Added daughter card sections.
Released for proofreading.
More information on the PLM, comparison to PLC.
Fixed bytecount in IM Command 0x62 Send INSTEON Standard or Extended
Message.
03-28-07 PVD
03-29-07 PVD
04-02-07 PVD
04-06-07 PVD
04-17-07 PVD
Added IM Command 0x58 ALL-Link Cleanup Status Report.
Updated explanation of IM Command 0x6F Manage ALL-Link Record.
Updated explanation of IM Commands 0x61 Send ALL-Link Command, 0x56
ALL-Link Cleanup Failure Report, and 0x58 ALL-Link Cleanup Status Report.
Command interrupts its own Cleanup sequence.
Corrected <X10 Flag> value in IM Commands 0x63 Send X10 and 0x52 X10
Received.
04-19-07 PVD
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page iii
Legal Information
Terms of Use
This INSTEON Modem Developer’s Guide is supplied to you by SmartLabs, Inc.
(SmartLabs) in consideration of your agreement to the following terms. Your use or installation of this INSTEON Modem Developer’s Guide constitutes acceptance of these terms. If you do not agree with these terms, please do not use or install this
INSTEON Modem Developer’s Guide.
In consideration of your agreement to abide by the following terms, and subject to these terms, SmartLabs grants you a personal, non-exclusive license, under
SmartLabs’ intellectual property rights in this INSTEON Modem Developer’s Guide, to use this INSTEON Modem Developer’s Guide; provided that no license is granted herein under any patents that may be infringed by your works, modifications of works, derivative works or by other works in which the information in this INSTEON
Modem 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 Modem Developer’s Guide without specific prior written permission from SmartLabs, Inc. Except as expressly stated herein, no other rights or licenses, express or implied, are granted by SmartLabs and nothing herein grants any license under any patents except claims of SmartLabs patents that cover this INSTEON Modem Developer’s Guide as originally provided by SmartLabs, and only to the extent necessary to use this INSTEON Modem Developer’s Guide as originally provided by SmartLabs. SmartLabs provides this INSTEON Modem
Developer’s Guide on an "AS IS" basis.
SMARTLABS MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT
LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS
INSTEON MODEM DEVELOPER’S GUIDE OR ITS USE, ALONE OR IN COMBINATION
WITH ANY PRODUCT.
IN NO EVENT SHALL SMARTLABS BE LIABLE FOR ANY SPECIAL, INDIRECT,
INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE,
REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THIS INSTEON MODEM
DEVELOPER’S GUIDE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF
CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE,
EVEN IF SMARTLABS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Trademarks and Patents
SmartLabs, Smarthome, INSTEON, Dual Mesh, BiPHY, ALL-Link, Powerline Modem,
PowerLinc, ControLinc, LampLinc, SwitchLinc, RemoteLinc, Electronic Home
Improvement, SmartLabs Device Manager, Home Network Language, and Plug-n-Tap are trademarks of SmartLabs, Inc.
INSTEON networking technology is covered by pending U.S. and foreign patents.
Copyright
© Copyright 2005, 2007 SmartLabs, Inc. 16542 Millikan Ave., Irvine, CA 92606-
5027; 800-SMARTHOME (800-762-7846), 949-221-9200, www.smartlabsinc.com
.
All rights reserved.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 1
INTRODUCTION
INSTEON Modem Chips
INSTEON Modems (IMs) are single chips available from SmartLabs that use simple
ASCII commands over a serial port to interface to an INSTEON network. The
IN2680A INSTEON Direct Powerline Modem Interface
network via the house wiring and the
IN2682A INSTEON Direct RF Modem Interface
connects via radio. A BiPHY™ Modem that interfaces to both the powerline and radio is under development.
Developers can create INSTEON applications that run on whatever host device they choose, as long as the host can communicate serially with the IM using the RS232 serial protocol at TTL levels. A microcontroller chip is the most common choice for a host device in standalone INSTEON modules, although virtually any hardware capable of executing applications and communicating serially can use an IM to interface with an INSTEON network.
Perhaps the greatest advantage of using an IM is that you can create applications in
a development environment that you are already comfortable with. The ASCII
are relatively few in number and easy to learn, so development
cycles can be short.
As an added bonus, the easiest way to achieve INSTEON conformance for your product is to build it around an INSTEON modem, because an IM automatically handles most of the details of the INSTEON protocol for you. See the
document for the full conformance requirements.
April 19, 2007 © 2007 SmartLabs Technology
This INSTEON Modem Developer’s Guide is for users of INSTEON Modem chips, such as the IN2680A Powerline Modem Interface or the IN2682A RF Modem Interface, and also for purchasers of the SmartLabs PowerLine Modem™ (PLM) module.
The information in this document is excepted from the
which purchasers of an INSTEON Software Development Kit may download from www.insteon.net
.
Modem Developer’s Guide
Page 2
The main functions of an INSTEON Modem are:
• Interfacing to a host via an RS232 serial port at TTL levels.
• Interfacing to the powerline or an FSK 915 MHz radio.
• Sending and receiving INSTEON messages.
• Sending and receiving X10 messages.
• ALL-Linking to other INSTEON devices and managing an ALL-Link Database.
• Sending ALL-Link Commands and transparently handling ALL-Link Cleanups.
• Managing a SET Button and LED.
The SmartLabs Powerline Modem (PLM)
The SmartLabs Powerline Modem (PLM) is an INSTEON-to-Serial Bridge module that plugs into a power outlet and also has a serial port that you connect to your PC (an
Ethernet interface is under development). It uses an IN2680A Powerline Modem chip that offers a simple set of ASCII devices.
The PLM uses a daughter board to implement serial communications with the host.
Daughter boards interface to the PLM’s main board via an 8-pin connector using TTLlevel serial communications. PLMs with RS232 daughter boards are currently available, with USB and Ethernet versions under development.
You may communicate to an RS232 PLM via USB by using a USB-to-Serial adapter.
SmartLabs has found that Keyspan brand adapters, models USA-49WLC and USA-
19HS, provide excellent protocol translation and PLM compatibility.
If you wish, you may create a custom daughter board that fits within a PLM module.
You can find hardware reference designs for such custom devices in the
section below. To support custom daughter boards, SmartLabs offers a
special version of the PLM with the following features:
• Uses the same case as the current PLM/PLC modules.
• Has no labeling on the front cover or rear UL label.
• Does not have UL approval.
• Does not include a daughter board.
• Includes the plastic insert for a RJ-45 jack or a blank cover.
• Uses PLM firmware with auto EEPROM detection. When no external EEPROM is detected, the PLM is limited to 31 ALL-Links.
Comparing the Powerline Modem (PLM) to the PowerLinc Controller (PLC)
The SmartLabs PowerLinc controller (PLC) module runs a downloadable SALad application that implements an interface between a host device and an INSTEON network on the powerline. SALad is a language developed specially for the PLC and other SALad-enabled INSTEON devices. If desired, the SALad application can be designed to run in standalone mode without any connection to a host.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 3
Unlike the PLC, a PLM cannot operate in standalone mode because it cannot run application programs by itself. External applications designed to work with a PLC, such as SmartLabs Device Manager (SDM), will not work with a PLM.
In summary, these are the main differences between the PLC and the PLM:
• The PLM has a simplified command set compared to the PLC.
• The PLM does not support SmartLabs Device Manager (SDM) running on a host computer.
• The PLC runs a downloadable SALad application, such as the SALad coreApp program, but the PLM cannot run applications of any kind. An embedded host on a daughter card or else an always-on external host must be available full time to run applications and manage the PLM.
• The PLM does not have an internal realtime clock.
• If fewer than 32 ALL-Links need to be supported, the PLM can run without external EEPROM. The PLC must have external EEPROM to store a downloadable
SALad program.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 4
Other Documents Included by
Reference
This INSTEON Modem Developer’s Guide contains information abstracted from the comprehensive INSTEON Developer’s Guide, 2
nd
Edition.
Although the full INSTEON Developer’s Guide is largely self-contained, there are aspects of INSTEON technology, such as listings of INSTEON Commands, INSTEON
Device Categories, and INSTEON Product Keys, that require continuous updating as developers create new INSTEON products. Accordingly, SmartLabs maintains separate documents for that kind of information.
All of the documents listed in this section are available for downloading at www.insteon.net
.
INSTEON Developer’s Guide
The book-length INSTEON Developer’s Guide, 2
nd
Edition is the primary source for the information contained in this (much shorter) INSTEON Modem 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 www.insteon.net
.
INSTEON Conformance Specification
The INSTEON Conformance Specification identifies those aspects of INSTEON that assure interoperability with other INSTEON products. The Conformance Spec assumes that readers have already gained familiarity with INSTEON technology by reading the INSTEON Developer’s Guide.
INSTEON Command Tables Document
The current tables of INSTEON Commands are contained in a separate document titled INSTEON Command Tables, which is integral to both the INSTEON
Conformance Specification and the INSTEON Developer’s Guide.
The filename for that document is INSTEON Command Tables yyyymmddx.doc, where yyyy is the year, mm is the month, dd is the day, and x is a daily version letter beginning with a. Be sure to refer to the document with the latest date.
INSTEON Device Categories and Product
Keys Document
The current table of INSTEON Device Categories (DevCats), Subcategories
(SubCats), and INSTEON Product Keys (IPKs) is contained in a separate document titled INSTEON Device Categories and Product Keys, which is also integral to both the INSTEON Conformance Specification and the INSTEON Developer’s Guide.
The filename for that document is INSTEON DevCats and Product Keys
yyyymmddx.doc, where yyyy is the year, mm is the month, dd is the day, and x is a daily version letter beginning with a. Be sure to refer to the document with the latest date.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
INSTEON Modem Spec Sheets
Developers will find the latest specifications for INSTEON modem ICs at www.insteon.net
.
Page 5
IN2680A INSTEON Direct Powerline Modem
Interface
The IN2680A is a one-chip solution that uses the simple ASCII serial interface
) to connect a host device or system to an INSTEON network via the powerline.
IN2682A INSTEON Direct RF Modem
Interface
The IN2682A is similar to the IN2680A Powerline Modem except that it connects to an INSTEON network via radio.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 6
INSTEON MODEM REFERENCE
Software Reference
INSTEON Modem (IM) chips and the SmartLabs PowerLine Modem™ (PLM) module offer developers a simple, robust interface to an INSTEON network. There are
currently two kinds of IM chip, the
IN2680A INSTEON Direct Powerline Modem
IN2682A INSTEON Direct RF Modem Interface
that interfaces to both the powerline and radio is under development.
INSTEON Modems provide a simpler interface to many of the low-level IBIOS Serial
Commands implemented in the SmartLabs PowerLinc Controller™ (PLC) described in the
, but they also handle ALL-Linking, ALL-Link
Database management, ALL-Link Cleanup messages, X10 powerline interfacing, and message acknowledgement. The RS232 serial interface to the host is similar to that of the PLC.
In This Section
IM Serial Communication Protocol and Settings
and a recommended terminal program.
Describes the serial communication protocol, the port settings for an RS232 link,
Explains what happens when you power up the IM or reset it.
Lists the IM Serial Commands and describes what they do, in a single table and individual charts grouped by functionality.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 7
IM Serial Communication Protocol and
Settings
In This Section
IM Serial Communication Protocol
Gives the protocol for communicating serially with an INSTEON Modem.
Shows how to set up your PC’s COM (RS232) port to talk to an INSTEON Modem.
How to Quickly Start Communicating with an IM
Gives a recommendation for a terminal program for communicating with an
INSTEON Modem.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 8
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
data follows the Command depends on the Command syntax (see
and
When you send a message to the IM, it will respond with an echo of the 0x02 and the
IM Command Number followed by any data that the Command returns (often just an echo of what you sent to it). The last byte it sends back will be ASCII 0x06 (ACK,
Acknowledge).
(S: and R: denote serial data you Send to or Receive from the IM, respectively.)
S:
0x02 <Command Number> <parameters>
R:
0x02 <Command Number> <any returned data> 0x06 (ACK)
If the IM is not ready, it will respond with an echo of the 0x02 and the IM Command
Number followed by ASCII 0x15 (NAK, Negative Acknowledge).
S:
0x02 <Command Number> <parameters>
R:
0x15 (NAK)
If you receive 0x15 (NAK), resend your Serial Command.
IM RS232 Port Settings
To communicate to an RS232 IM, set your PC’s COM port as follows:
Setting
Baud Rate
Value
19,200
Data Bits 8
Parity N
Stop Bits
Hardware Flow Control
1
None
Software Flow Control IM echoes bytes received from host
The IM buffers IM Commands as it receives them, so you can send a complete IM
Command without pause. To maintain compatibility with earlier IM versions, the IM will echo each byte that it receives (earlier versions of the IM used byte echoing for flow control). You can now ignore the byte echos, but in order to avoid overrunning the IM’s receive buffer, you must wait for the IM to send its response to your current
IM Command before sending a new one.
Note that there is a maximum time between IM Command bytes that you send to the
IM. If you do not send the next expected byte of an IM Command within 240 milliseconds after sending the previous one, the IM will reset its message parser and you will have to resend the message from the beginning. You can disable this
Deadman feature by setting a configuration bit (see
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 9
There is no flow control when the IM sends data to the host—the IM will transfer data to the host as fast as it can send it.
How to Quickly Start Communicating with an IM
No matter how your application intends to use the IM, it is important to gain a basic understanding of how it operates. SmartLabs suggests that developers use a terminal communications program and a serial connection to an IM to get started.
While there are many terminal programs for computers, SmartLabs has found good results with Docklight Scripting. An evaluation copy may be downloaded from http://www.docklight.de/ .
Docklight Scripting allows you to set up test macros and label received
for easy identification, as suggested in the following screenshot:
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 10
IM Power-up and Reset States
This section describes the
.
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.
LED Indication
LED on steadily
LED blinks six times
LED off
Meaning
The IM detected an external EEPROM (up to 32 KB) for storage of database links.
The IM did not detect an external EEPROM, so it will use the internal EEPROM in the processor chip. A maximum of 31 ALL-Links are permitted. An attempt to add a 32 nd
ALL-Link will result in the 31 st
being erased.
The user pressed and held the IM’s SET button for 10 seconds while powering
up, causing the IM to perform a factory reset and go into the
indications above. You will also receive a
the IM.
. At the conclusion of the reset, the IM’s LED will give one of the two
message from
IM Factory Reset State
Resetting the IM to its factory default condition by holding down the SET Button for ten seconds while powering it up or by sending it a
into the following state:
IM Resource
ALL-Link Database
Host Device Category,
Device Subcategory,
Firmware Version
Factory Reset State
Erased (set to all zeros).
Set to the original DevCat (0x03), SubCat (0x05), and firmware version hardcoded into the IM’s firmware at the factory.
IM Configuration Flags Cleared (set to all zeros).
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 11
IM Serial Commands
The IM Serial Command set is a simple but complete interface between a host application and an INSTEON network. For example, a microcontroller in a thermostat could use an INSTEON Powerline Modem 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.
In This Section
IM Serial Command Summary Table
Number.
Describes all of the IM Serial Commands in table form ordered by Command
Describes all of the IM Serial Commands using individual charts for each
Command, grouped by functionality.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 12
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.
Command
Gives the name of the IM Serial Command as a link to the complete explanation of the Command in the
.
Format
Gives the syntax of the IM Serial Command, including any parameters.
S: and R: denote serial data you Send to or Receive from the IM, respectively.
IM Serial Communication Protocol
for more information.
All IM Serial Commands start with ASCII 0x02 (STX, Start-of-Text) followed by the
Serial Command Number.
All fields in this table contain only one byte, except as noted.
INSTEON Modem Serial Commands
Code Command
0x50
0x51
0x52
0x53
0x54
Commands Sent from an IM to the Host
Format
R: 0x02 0x50
<INSTEON Standard message (9 bytes)>
R: 0x02 0x51
<INSTEON Extended message (23 bytes)>
R: 0x02 0x52
<Raw X10> <X10 Flag>
R: 0x02 0x53
<0x00 (IM is Responder) | 0x01 (IM is Controller | 0xFF Link Deleted)>
<ALL-Link Group>
<ID high byte> <ID middle byte> <ID low byte>
<Device Category> <Device Subcategory> <0xFF | Firmware Revision>
R: 0x02 0x54 <0x02>
IM’s SET Button tapped
R: 0x02 0x54 <0x03>
IM’s SET Button held
R: 0x02 0x54 <0x04>
IM’s SET Button released after hold
R: 0x02 0x54 <0x12>
IM’s Button 2 tapped
R: 0x02 0x54 <0x13>
IM’s Button 2 held
R: 0x02 0x54 <0x14>
IM’s Button 2 released after hold
R: 0x02 0x54 <0x22>
IM’s Button 3 tapped
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 13
INSTEON Modem Serial Commands
Commands Sent from an IM to the Host
Code Command
0x61
0x62
0x63
0x64
Send INSTEON Standard or Extended Message
Format
0x55
0x57
0x56
0x58
R: 0x02 0x54 <0x23>
IM’s Button 3 held
R: 0x02 0x54 <0x24>
IM’s Button 3 released after hold
R: 0x02 0x55
User pushed and held IM’s SET Button on power up
R: 0x02 0x56 <0x01>
<ALL-Link Group>
<ID high byte> <ID middle byte> <ID low byte>
R: 0x02 0x57
<ALL-Link Record Flags>
<ALL-Link Group>
<ID high byte> <ID middle byte> <ID low byte>
<Link Data 1> <Link Data 2> <Link Data 3>
R: 0x02 0x58 <0x06>
ALL-Link Cleanup sequence completed
R: 0x02 0x58 <0x15>
ALL-Link Cleanup sequence aborted due to INSTEON traffic
Commands Sent from the Host to an IM
0x60
S: 0x02 0x60
R: 0x02 0x60
<ID high byte> <ID middle byte> <ID low byte>
<Device Category> <Device Subcategory> < Firmware Revision>
<0x06>
S: 0x02 0x61
<ALL-Link Group>
<ALL-Link Command>
<0xFF | 0x00>
R: 0x02 0x61
<ALL-Link Group>
<ALL-Link Command>
<0xFF | 0x00>
<0x06>
S: 0x02 0x62
<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)>
<0x06>
S: 0x02 0x63
<Raw X10> <X10 Flag>
R: 0x02 0x63
<Raw X10> <X10 Flag>
<0x06>
S: 0x02 0x64
<0x00 (IM is Responder) | 0x01 (IM is Controller) |
0x03 (IM is either) | 0xFF (Link Deleted)>
<ALL-Link Group>
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 14
INSTEON Modem Serial Commands
Commands Sent from an IM to the Host
Code Command Format
0x65
0x66
0x67
0x68
0x69
R: 0x02 0x64
<0x00 (IM is Responder) | 0x01 (IM is Controller) |
0x03 (IM is either) | 0xFF (Link Deleted)>
<ALL-Link Group>
<0x06>
S: 0x02 0x65
R: 0x02 0x65
<0x06>
S: 0x02 0x66
<Device Category> <Device Subcategory> <0xFF | Firmware Revision>
R: 0x02 0x66
<Device Category> <Device Subcategory> <0xFF | Firmware Revision>
<0x06>
S: 0x02 0x67
R: 0x02 0x67
<0x06>
S: 0x02 0x68
<Command 2 Data>
R: 0x02 0x68
<Command 2 Data>
<0x06>
S: 0x02 0x69
R: 0x02 0x69
<0x06>
0x6A
0x6B
0x6C
0x6D
S: 0x02 0x6A
R: 0x02 0x6A
<0x06>
S: 0x02 0x6B
<IM Configuration Flags>
R: 0x02 0x6B
<IM Configuration Flags>
<0x06>
S: 0x02 0x6C
R: 0x02 0x6C
<0x06>
S: 0x02 0x6D
0x6E
R: 0x02 0x6D
<0x06>
S: 0x02 0x6E
R: 0x02 0x6E
<0x06>
0x6F
S: 0x02 0x6F
<Control Flags>
<ALL-Link Record Flags>
<ALL-Link Group>
<ID high byte> <ID middle byte> <ID low byte>
<Link Data 1> <Link Data 2> <Link Data 3>
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 15
INSTEON Modem Serial Commands
Code
0x70
0x71
0x72
0x73
Command
Commands Sent from an IM to the Host
Format
R: 0x02 0x6F
<Control Flags>
<ALL-Link Record Flags>
<ALL-Link Group>
<ID high byte> <ID middle byte> <ID low byte>
<Link Data 1> <Link Data 2> <Link Data 3>
<0x06>
S: 0x02 0x70
<Command 2 Data>
R: 0x02 0x70
<Command 2 Data>
<0x06>
S: 0x02 0x71
<Command 1 Data>
<Command 2 Data>
R: 0x02 0x71
<Command 1 Data>
<Command 2 Data>
<0x06>
S: 0x02 0x72
R: 0x02 0x72
<0x06>
S: 0x02 0x73
R: 0x02 0x73
<IM Configuration Flags>
<Spare 1>
<Spare 2>
<0x06>
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 16
IM Serial Command Charts
The following charts describe the IM Commands individually in a chart format, grouped by functionality. These are the same IM Commands as in the
, which is ordered by Command Number.
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. When the host sends an IM Command to an IM, the IM will respond with a message according to the
In This Section
Commands for sending and receiving INSTEON messages.
Commands for sending and receiving X10 messages.
Cleanup Commands.
Commands for sending ALL-Link Commands with automatic handling of ALL-Link
ALL-Linking Session Management
Commands for creating ALL-Links between an IM and other INSTEON devices.
Commands for managing ALL-Link Records in the IM’s ALL-Link Database.
Commands for resetting and configuring the IM.
Commands for managing the IM’s SET Button and LED.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 17
INSTEON Message Handling
Send INSTEON Standard or Extended Message
This Command lets you send either a Standard-length or an Extended-length
INSTEON message, depending only on what kind of INSTEON message you include in the body of the Command.
Send INSTEON Standard-length Message
Send INSTEON Standard-length Message (0x62)
7
8
9
What it does
What you send
What you’ll get
LED indication
Related Commands
<Command 1>
<Command 2>
<ACK/NAK>
Allows you to send a raw Standard-length INSTEON message.
8 bytes.
9 bytes.
None.
IM 0x50 INSTEON Standard Message Received
IM 0x51 INSTEON Extended Message Received
Command Sent from Host to IM
Byte Value
1 0x02
2
3
4
5
6
0x62
<To Address high>
<To Address middle>
<To Address low>
<Message Flags>
7
8
<Command 1>
<Command 2>
Meaning
Start of IM Command
IM Command Number
The high byte of the INSTEON ID of the message addressee.
The middle byte of the INSTEON ID of the message addressee.
The low byte of the INSTEON ID of the message addressee.
The INSTEON message flags indicating message type and hops.
Extended Message Flag (bit 4) is 0
INSTEON Command 1 for the addressee to execute
INSTEON Command 2 for the addressee to execute
Message Returned by IM to Host
3
4
5
Byte Value
1 0x02
2
0x62
6
<To Address high>
<To Address middle>
<To Address low>
<Message Flags>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <To Address high>
Echoed <To Address middle>
Echoed <To Address low>
Echoed <Message Flags>
Extended Message Flag (bit 4) is 0
Echoed <Command 1>
Echoed <Command 2>
0x06 (ACK) if the IM executed the Command correctly
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
www.insteon.net
.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 18
Send INSTEON Extended-length Message
Send INSTEON Extended-length Message (0x62)
What it does
What you send
What you’ll get
LED indication
Related Commands
Allows you to send a raw Extended-length INSTEON message.
22 bytes.
23 bytes.
None.
IM 0x50 INSTEON Standard Message Received
IM 0x51 INSTEON Extended Message Received
Command Sent from Host to IM
11
12
13
14
7
8
9
10
11
12
13
14
15
16
7
8
9
10
17
18
19
20
21
22
3
4
5
Byte Value
1 0x02
2
0x62
6
<To Address high>
<To Address middle>
<To Address low>
<Message Flags>
<Command 1>
<Command 2>
<User Data 1>
<User Data 2>
<User Data 3>
<User Data 4>
<User Data 5>
<User Data 6>
<User Data 7>
<User Data 8>
<User Data 9>
<User Data 10>
<User Data 11>
<User Data 12>
<User Data 13>
<User Data 14>
Meaning
Start of IM Command
IM Command Number
The high byte of the INSTEON ID of the message addressee.
The middle byte of the INSTEON ID of the message addressee.
The low byte of the INSTEON ID of the message addressee.
The INSTEON message flags indicating message type and hops.
Extended Message Flag (bit 4) is 1
INSTEON Command 1 for the addressee to execute
INSTEON Command 2 for the addressee to execute
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Message Returned by IM to Host
Byte Value
1 0x02
2
3
4
5
6
0x62
<To Address high>
<To Address middle>
<To Address low>
<Message Flags>
<Command 1>
<Command 2>
<User Data 1>
<User Data 2>
<User Data 3>
<User Data 4>
<User Data 5>
<User Data 6>
April 19, 2007
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <To Address high>
Echoed <To Address middle>
Echoed <To Address low>
Echoed <Message Flags>
Extended Message Flag (bit 4) is 1
Echoed <Command 1>
Echoed <Command 2>
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
© 2007 SmartLabs Technology
Modem Developer’s Guide
Page 19
20
21
22
23
15
16
17
18
19
Send INSTEON Extended-length Message (0x62)
<User Data 7>
<User Data 8>
<User Data 9>
<User Data 10>
<User Data 11>
<User Data 12>
<User Data 13>
<User Data 14>
<ACK/NAK>
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
Echoed Extended message data
0x06 (ACK) if the IM executed the Command correctly
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
www.insteon.net
.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 20
INSTEON Standard Message Received
INSTEON Standard Message Received (0x50)
What it does
Informs you of an incoming Standard-length INSTEON message.
When you’ll get this
A Standard-length INSTEON message is received from either a Controller or
Responder that you are ALL-Linked to.
What you’ll get
11 bytes.
LED indication
Related Commands
The LED will blink during INSTEON reception.
IM 0x51 INSTEON Extended Message Received
Message Sent from IM to Host
3
4
5
Byte Value
1 0x02
2
0x50
6
<From Address high>
<From Address middle>
<From Address low>
<To Address high>
7
8
9
<To Address middle>
<To Address low>
<Message Flags>
Meaning
Start of IM Command
IM Command Number
The high byte of the INSTEON ID of the message originator.
The middle byte of the INSTEON ID of the message originator.
The low byte of the INSTEON ID of the message originator.
The high byte of the INSTEON ID of the message addressee.
If the message is an ALL-Link Broadcast (bits 7 and 6 of the
<Message Flags> byte are set) then this will be 0.
The middle byte of the INSTEON ID of the message addressee.
If the message is an ALL-Link Broadcast (bits 7 and 6 of the
<Message Flags> byte are set) then this will be 0.
The low byte of the INSTEON ID of the message addressee.
If the message is an ALL-Link Broadcast (bits 7 and 6 of the
<Message Flags> byte are set) then this will indicate the ALL-Link
Group Number.
The INSTEON message flags indicating message type and hops.
This byte contains the ALL-Link Group Number of the ALL-Link
Broadcast when either bit 6 of the <Message Flags> byte is set (ALL-
Link Cleanup) or bits 6 and 5 of the <Message Flags> byte are set
(ALL-Link Cleanup ACK).
Notes
INSTEON Extended 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
For more information on INSTEON Commands and the latest Command set, please download the current
INSTEON Command Tables Document
www.insteon.net
.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 21
INSTEON Extended Message Received
INSTEON Extended Message Received (0x51)
What it does
Informs you of an incoming Extended-length INSTEON message.
When you’ll get this
An Extended-length INSTEON message is received from either a Controller or
Responder that you are ALL-Linked to.
What you’ll get
25 bytes.
LED indication
Related Commands
The LED will blink during INSTEON reception.
IM 0x50 INSTEON Standard Message Received
Message Sent from IM to Host
3
4
5
Byte Value
1 0x02
2
0x51
6
<From Address high>
<From Address middle>
<From Address low>
<To Address high>
7
8
9
<To Address middle>
<To Address low>
<Message Flags>
Meaning
Start of IM Command
IM Command Number
The high byte of the INSTEON ID of the message originator.
The middle byte of the INSTEON ID of the message originator.
The low byte of the INSTEON ID of the message originator.
The high byte of the INSTEON ID of the message addressee.
If the message is an ALL-Link Broadcast (bits 7 and 6 of the
<Message Flags> byte are set) then this will be 0.
The middle byte of the INSTEON ID of the message addressee.
If the message is an ALL-Link Broadcast (bits 7 and 6 of the
<Message Flags> byte are set) then this will be 0.
The low byte of the INSTEON ID of the message addressee.
If the message is an ALL-Link Broadcast (bits 7 and 6 of the
<Message Flags> byte are set) then this will indicate the ALL-Link
Group Number.
The INSTEON message flags indicating message type and hops.
17
18
19
20
21
22
12
13
14
15
16
23
24
25
<User Data 1>
<User Data 2>
<User Data 3>
<User Data 4>
<User Data 5>
<User Data 6>
<User Data 7>
<User Data 8>
<User Data 9>
<User Data 10>
<User Data 11>
<User Data 12>
<User Data 13>
<User Data 14>
This byte contains the ALL-Link Group Number of the ALL-Link
Broadcast when either bit 6 of the <Message Flags> byte is set (ALL-
Link Cleanup) or bits 6 and 5 of the <Message Flags> byte are set
(ALL-Link Cleanup ACK).
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
Extended message data
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 22
INSTEON Extended Message Received (0x51)
Notes
This is the same as IM 0x50 INSTEON Standard Message Received
<User Data>.
, except that there are 14 bytes of
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
For more information on INSTEON Commands and the latest Command set, please download the current
INSTEON Command Tables Document
www.insteon.net
.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 23
Set INSTEON ACK Message Byte
Set INSTEON ACK Message Byte (0x68)
What it does
What you send
What you’ll get
LED indication
Related Commands
Byte Value
1
2
3
0x02
0x68
<Command 2 Data>
Meaning
Start of IM Command
IM Command Number
Data byte to place into the Command 2 field of the ACK response.
Message Returned by IM to Host
Byte Value
1
2
3
4
0x02
0x68
<Command 2 Data>
<ACK/NAK>
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.
3 bytes.
4 bytes.
None.
IM 0x50 INSTEON Standard Message Received
IM 0x51 INSTEON Extended Message Received
IM 0x71 Set INSTEON ACK Message Two Bytes
IM 0x70 Set INSTEON NAK Message Byte
Command Sent from Host to IM
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <Command 2 Data>
0x06 (ACK) if the IM executed the Command correctly.
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.
Set INSTEON ACK Message Two Bytes
message.
when you need to return two bytes of data in an ACK
when you need to return one byte of data in a NAK message.
Certain INSTEON Direct Commands require returned data in the Acknowledgement message. For more
information on INSTEON Commands and the latest Command set, please download the current
www.insteon.net
.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 24
Set INSTEON ACK Message Two Bytes
Set INSTEON ACK Message Two Bytes (0x71)
What it does
What you send
What you’ll get
LED indication
Related Commands
Allows you to put two bytes of data into the combined Command 1 and
Command 2 fields of the INSTEON ACK message that the INSTEON Engine automatically sends after it receives an INSTEON Direct message.
4 bytes.
5 bytes.
None.
IM 0x50 INSTEON Standard Message Received
IM 0x51 INSTEON Extended Message Received
IM 0x68 Set INSTEON ACK Message Byte
IM 0x70 Set INSTEON NAK Message Byte
Command Sent from Host to IM
Byte Value
1
2
3
4
0x02
0x71
<Command 1 Data>
<Command 2 Data>
Meaning
Start of IM Command
IM Command Number
Data byte to place into the Command 1 field 2 of the ACK response.
Data byte to place into the Command 2 field 2 of the ACK response.
Message Returned by IM to Host
3
4
5
Byte Value
1 0x02
2
0x71
<Command 1 Data>
<Command 2 Data>
<ACK/NAK>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <Command 1 Data>
Echoed <Command 2 Data>
0x06 (ACK) if the IM executed the Command correctly.
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.
when you only need to return one byte of data in an ACK message.
when you need to return one byte of data in a NAK message.
Certain INSTEON Direct Commands require returned data in the Acknowledgement message. For more
information on INSTEON Commands and the latest Command set, please download the current
www.insteon.net
.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 25
Set INSTEON NAK Message Byte
Set INSTEON NAK Message Byte (0x70)
What it does
What you send
What you’ll get
LED indication
Related Commands
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.
3 bytes.
4 bytes.
None.
IM 0x50 INSTEON Standard Message Received
IM 0x51 INSTEON Extended Message Received
IM 0x68 Set INSTEON ACK Message Byte
IM 0x70 Set INSTEON ACK Message Two Bytes
Command Sent from Host to IM
Byte Value
1 0x02
2
3
0x70
<Command 2 Data>
Meaning
Start of IM Command
IM Command Number
Data byte to place into the Command 2 field of the ACK response.
Message Returned by IM to Host
Byte Value
1 0x02
2
3
4
0x70
<Command 2 Data>
<ACK/NAK>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <Command 2 Data>
0x06 (ACK) if the IM executed the Command correctly.
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.
or
Set INSTEON ACK Message Two Bytes
one or two bytes of data in an ACK message.
NAK messages report certain error conditions in a receiving device. See NAK Error Codes in the
for more information.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 26
X10 Message Handling
Send X10
What it does
What you send
What you’ll get
LED indication
Related Commands
Send X10 (0x63)
Allows you to send a raw X10 Address or X10 Command.
4 bytes.
5 bytes.
None.
Command Sent from Host to IM
Byte Value
1 0x02
2
0x63
3 <Raw X10>
4 <X10 Flag>
Byte Value
1 0x02
2
3
4
5
0x63
<Raw X10>
<X10 Flag>
<ACK/NAK>
4-bit
Code
0x6
4 MSBs of <Raw X10>
X10 House Code
A
0xE B
0x2 C
0xA D
0x1 E
0x9 F
0x5 G
0xD H
0x7 I
0xF J
0x3 K
0xB L
0x0 M
0x8 N
0x4 O
0xC P
Meaning
Start of IM Command
IM Command Number
The four most significant bits contain the X10 House Code.
The four least significant bits contain the X10 Key Code.
0x00 indicates that the X10 Key Code is an X10 Unit Code.
0x80 indicates that the X10 Key Code is an X10 Command.
Message Returned by IM to Host
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <Raw X10>
Echoed <X10 Flag>
0x06 (ACK) if the IM executed the Command correctly
0x15 (NAK) if an error occurred
X10 Translation Table
X10 Unit Code
<X10 Flag> = 0x00
1
4 LSBs of <Raw X10>
X10 Command
<X10 Flag> = 0x80
All Lights Off
2
3
4
Status = Off
On
All Lights On 5
6
7
8
9
10
Bright
Status = On
11
12
13
14
15
16
Off
Dim
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 27
X10 Received
4-bit
Code
0x6
4 MSBs of <Raw X10>
X10 House Code
A
0xE B
0x2 C
0xA D
0x1 E
0x9 F
0x5 G
0xD H
0x7 I
0xF J
0x3 K
0xB L
0x0 M
0x8 N
0x4 O
0xC P
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
LED indication
Related Commands
4 bytes.
The LED will blink during X10 reception.
IM 0x50 INSTEON Standard Message Received
IM 0x51 INSTEON Extended Message Received
Message Sent from IM to Host
Byte Value
1
2
3
0x02
0x52
<Raw X10>
4 <X10 Flag>
Meaning
Start of IM Command
IM Command Number
The four most significant bits contain the X10 House Code.
The four least significant bits contain the X10 Key Code.
0x00 indicates that the X10 Key Code is an X10 Unit Code.
0x80 indicates that the X10 Key Code is an X10 Command.
X10 Translation Table
X10 Unit Code
<X10 Flag> = 0x00
1
4 LSBs of <Raw X10>
X10 Command
<X10 Flag> = 0x80
All Lights Off
2
3
4
Status = Off
On
All Lights On 5
6
7
8
9
10
Bright
Status = On
11
12
13
14
15
16
Off
Dim
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 28
INSTEON ALL-Link Commands
Send ALL-Link Command
Send ALL-Link Command (0x61)
What it does
What you send
What you’ll get
LED indication
Related Commands
Sends an ALL-Link Command to an ALL-Link Group of one or more Responders that the IM is ALL-Linked to.
5 bytes.
6 bytes for the echo of the Command and then an additional 11 bytes in an
INSTEON Standard Message Received
message for each device in the group
that acknowledges ALL-Link Cleanup, or 7 bytes in an
message for each device in the group that does not acknowledge ALL-
Link Cleanup.
None.
IM 0x50 INSTEON Standard Message Received
IM 0x56 ALL-Link Cleanup Failure Report
IM 0x58 ALL-Link Cleanup Status Report
Command Sent from Host to IM
3
4
5
Byte Value
1 0x02
2
0x61
<ALL-Link Group>
<ALL-Link Command>
Meaning
Start of IM Command
IM Command Number
ALL-Link Group Number that the ALL-Link Command is sent to
ALL-Link Command
<Broadcast Command 2> Sent in the Command 2 field of the ALL-Link Broadcast message only. Command 2 will always contain the ALL-Link Group Number for the ALL-Link Cleanup messages that follow.
Message Returned by IM to Host
4
5
6
Byte Value
1
2
3
0x02
0x61
<ALL-Link Group>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <ALL-Link Group>
<ALL-Link Command> Echoed <ALL-Link Command>
<Broadcast Command 2> Echoed <Broadcast Command 2>
<ACK/NAK> 0x06 (ACK) if the IM executed the Command correctly
0x15 (NAK) if an error occurred or the group does not exist
Notes
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
ALL-Link Cleanup Status Report
were added to the ALL-Link Database. If the IM finishes sending all of the Cleanup messages, it will send
ALL-Link Cleanup Status Report
with a Status Byte of 0x06 (ACK).
0x15 (NAK). The Cleanup sequence proceeds in the order in which the devices in the ALL-Link Group
For each ALL-Link Cleanup message that the IM sends, you will either receive an
when the Responder answers with a Cleanup acknowledgement message, or else you
ALL-Link Cleanup Failure Report
if the Responder fails to answer with a Cleanup acknowledgement message. The IM will send you an
ALL-Link Cleanup Status Report
every ALL-Link Group member acknowledges the Cleanup Command that the IM sends to it.
You can cause the IM to cancel its own Cleanup sequence by sending it a new
or
Send INSTEON Standard or Extended Message
in those cases.
during the time that it is sending a Cleanup sequence
(i.e. after it has finished sending an ALL-Link Broadcast message). The IM will send you an
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 3.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 29
Send ALL-Link Command (0x61)
The IM sends the ALL-Link Broadcast message immediately if there is no other INSTEON traffic. If there is other INSTEON traffic, the IM will wait for one silent powerline zero crossing following a completed
INSTEON message. The IM will send the first ALL-Link Cleanup message after a delay of 7 zero crossings.
Subsequent Cleanups will go out with a delay of 2 zero crossings.
Do not use this command to control light levels with the Light Start Manual Change INSTEON Command
SA 0x17. Use
Send INSTEON Standard-length Message
to send INSTEON Command SD 0x17 instead.
For more information on INSTEON Commands and the latest Command set, please download the current
INSTEON Command Tables Document
www.insteon.net
.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 30
ALL-Link Cleanup Failure Report
ALL-Link Cleanup Failure Report (0x56)
What it does
Reports that an ALL-Link Group member did not acknowledge an ALL-Link
Cleanup Command.
When you’ll get this
An ALL-Link Group member that you are trying to control did not acknowledge the ALL-Link Cleanup Command sent by the IM.
What you’ll get
LED indication
Related Commands
7 bytes.
None.
IM 0x58 ALL-Link Cleanup Status Report
Message Sent from IM to Host
Byte Value
1
2
3
0x02
0x56
0x01
4
5
6
7
<ALL-Link Group>
<ID high byte>
<ID middle byte>
<ID low byte>
Meaning
Start of IM Command
IM Command Number
Indicates that this ALL-Link Group member did not acknowledge an
ALL-Link Cleanup Command.
Indicates the ALL-Link Group Number that was sent in the ALL-Link
Cleanup Command.
The high byte of the INSTEON ID of the device that did not respond.
The middle byte of the INSTEON ID of the device that did not respond.
The low byte of the INSTEON ID of the device that did not respond.
Notes
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.
The Cleanup sequence proceeds in the order in which the devices in the ALL-Link Group were added to the
ALL-Link Database.
For each ALL-Link Cleanup message the IM sends, you will either receive an
when the Responder sends you an ACK, or you will receive this message. However, it can take awhile before you receive this message. Worst case, if the IM has to wait for a clear line and then retries the Cleanup message for the maximum of five times, the wait will be 2.150 seconds after sending the
ALL-Link Broadcast message, or 1.550 seconds after receiving the first Cleanup acknowledgement or this message. If the Cleanup sequence was aborted due to other INSTEON traffic, you will not get this
message even then. However, you will receive
ALL-Link Cleanup Status Report
0x15 (NAK) indicating that the Cleanup sequence was aborted.
with a Status Byte of
It is possible that this ALL-Link Group member did in fact properly receive the ALL-Link Broadcast message that preceded the ALL-Link Cleanup message.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 31
ALL-Link Cleanup Status Report
ALL-Link Cleanup Status Report (0x58)
What it does
LED indication
Related Commands
completed with all Cleanup messages
sent, or else if Cleanups were interrupted due to other INSTEON traffic.
When you’ll get this
After you issue a
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.
None.
IM 0x56 ALL-Link Cleanup Failure Report
Message Sent from IM to Host
Byte Value
1 0x02
2
0x58
Meaning
Start of IM Command
IM Command Number
<0x06> (ASCII ACK) The ALL-Link Command sequence initiated previously using
completed. The IM first sent an ALL-Link Broadcast message, followed by ALL-Link Cleanup messages sent to all members of the specified ALL-Link Group. If any member of the ALL-Link Group does not return a Cleanup acknowledgement, you will receive an
from that member.
<0x15> (ASCII NAK) The ALL-Link Command sequence initiated previously using
terminated before the IM sent ALL-Link Cleanup messages to all members of the specified ALL-
Link Group. This is normal behavior when the IM detects INSTEON traffic from other devices.
Notes
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 this message with a Status Byte of 0x15 (NAK). The
Cleanup sequence proceeds in the order in which the devices in the ALL-Link Group were added to the
ALL-Link Database. If the IM finishes sending all of the Cleanup messages, it will send you this message with a Status Byte of 0x06 (ACK).
For each ALL-Link Cleanup message that the IM sends, you will either receive an
when the Responder answers with a Cleanup acknowledgement message, or else you
ALL-Link Cleanup Failure Report
if the Responder fails to answer with a Cleanup acknowledgement message. The IM will send you this message whether or not every ALL-Link Group member acknowledges the Cleanup Command that the IM sends to it.
You can cause the IM to cancel its own Cleanup sequence by sending it a new
or
Send INSTEON Standard or Extended Message
(i.e. after it has finished sending an ALL-Link Broadcast message). The IM will send you this message in those cases.
during the time that it is sending a Cleanup sequence
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 32
ALL-Linking Session Management
Start ALL-Linking
What it does
What you send
What you’ll get
LED indication
Related Commands
Start ALL-Linking (0x64)
Puts the IM into ALL-Linking mode without using the SET Button.
4 bytes.
5 bytes for this Command response and then an additional 10 bytes in an
message once a successful ALL-Link has been established.
The LED will blink continuously at a rate of ½ second on and ½ second off until the ALL-Link is completed or canceled.
Command Sent from Host to IM
Byte Value
1 0x02
2
0x64
4 <ALL-Link Group>
Byte Value
1 0x02
2
0x64
3 <Code>
4 <ALL-Link Group>
5 <ACK/NAK>
Meaning
Start of IM Command
IM Command Number
The type of ALL-Link to establish.
0x00 ALL-Links the IM as a Responder (slave).
0x01 ALL-Links the IM as a Controller (master).
0x03 ALL-Links the IM as a Controller when the IM initiates ALL-
Linking, or as a Responder when another device initiates
ALL-Linking.
0xFF Deletes the ALL-Link.
The ALL-Link Group Number to be linked to or deleted.
Message Returned by IM to Host
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <ALL-Link Group>
0x06 (ACK) if the IM executed the Command correctly
0x15 (NAK) if an error occurred
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 33
Cancel ALL-Linking
What it does
What you send
What you’ll get
LED indication
Related Commands
Cancel ALL-Linking (0x65)
Cancels the ALL-Linking process that was started either by holding down the
IM’s SET Button or by sending a
2 bytes.
3 bytes.
The LED will stop blinking.
Command Sent from Host to IM
Byte Value
1 0x02
2
0x65
Byte Value
1
2
3
0x02
0x65
<ACK/NAK>
Meaning
Start of IM Command
IM Command Number
Message Returned by IM to Host
Meaning
Echoed Start of IM Command
Echoed IM Command Number
0x06 (ACK) if the IM executed the Command correctly
0x15 (NAK) if an error occurred
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 34
ALL-Linking Completed
ALL-Linking Completed (0x53)
What it does
Informs you of a successful ALL-Linking procedure.
When you’ll get this
An ALL-Linking procedure has been completed between the IM and either a
Controller or Responder.
What you’ll get
10 bytes.
LED indication
Related Commands
None.
Message Sent from IM to Host
Byte Value
1 0x02
2
0x53
3 <Link Code>
4
5
6
7
8
9
<ALL-Link Group>
<ID high byte>
<ID middle byte>
<ID low byte>
<Device Category>
<Device Subcategory>
|
Version>
Meaning
Start of IM Command
IM Command Number
Indicates the type of link made.
0x00 means the IM is a Responder (slave) to this device
0x01 means the IM is a Controller (master) of this device
0xFF means the ALL-Link to the device was deleted
If done manually (by pushing the SET Button) the Controller /
Responder relationship between the IM and the device is determined automatically. You can assign the Controller / Responder
relationship unconditionally by using the
Command.
Indicates the ALL-Link Group Number that was assigned to this link.
If done manually (by pushing the SET Button) the ALL-Link Group
Number is automatically assigned by the IM. You can assign ALL-
Link Group Numbers unconditionally by using the
Command.
The high byte of the INSTEON ID of the device that was ALL-Linked.
The middle byte of the INSTEON ID of the device that was ALL-
Linked.
The low byte of the INSTEON ID of the device that was ALL-Linked.
The Device Category (DevCat) of the Responder device that was
ALL-Linked.
(Only valid when the IM is a Controller)
The Device Subcategory (SubCat) of the Responder device that was
ALL-Linked.
(Only valid when the IM is a Controller)
0xFF for newer devices.
For legacy devices this is the firmware version of the Responder device that was ALL-Linked.
(Only valid when the IM is a Controller)
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 35
ALL-Link Database Management
Get First ALL-Link Record
Get First ALL-Link Record (0x69)
What it does
What you send
What you’ll get
LED indication
Related Commands
Byte Value
1
2
0x02
0x69
Returns the first record in the IM’s ALL-Link Database. The data will follow in an
message.
2 bytes.
3 bytes.
None.
IM 0x57 ALL-Link Record Response
IM 0x6A
IM 0x6C
Get ALL-Link Record for Sender
Command Sent from Host to IM
Meaning
Start of IM Command
IM Command Number
Message Returned by IM to Host
Byte Value
1 0x02
2
3
0x69
<ACK/NAK>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
0x06 (ACK) if an
follows
0x15 (NAK) if the database is empty.
Note
Use this to begin scanning the IM’s ALL-Link Database. Follow up with
Commands until you receive a NAK.
In the
the ALL-Link Database will be cleared, so you will receive a NAK.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 36
Get Next ALL-Link Record
Get Next ALL-Link Record (0x6A)
What it does
What you send
What you’ll get
LED indication
Related Commands
Returns the next record in the IM’s ALL-Link Database. The data will follow in an
message.
2 bytes.
3 bytes.
None.
IM 0x57 ALL-Link Record Response
IM 0x69 Get First ALL-Link Record
IM 0x6C
Get ALL-Link Record for Sender
Command Sent from Host to IM
Byte Value
1 0x02
2
0x6A
Byte Value
1
2
3
0x02
0x6A
<ACK/NAK>
Meaning
Start of IM Command
IM Command Number
Message Returned by IM to Host
Meaning
Echoed Start of IM Command
Echoed IM Command Number
0x06 (ACK) if an
follows
0x15 (NAK) if there are no more records.
Note
Use this to continue scanning the IM’s ALL-Link Database until you receive a NAK. Begin the scan up with
Command.
In the
the ALL-Link Database will be cleared, so you will receive a NAK.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 37
Get ALL-Link Record for Sender
Get ALL-Link Record for Sender (0x6C)
What it does
What you send
What you’ll get
LED indication
Related Commands
Byte Value
1
2
0x02
0x6C
This gets the record from the IM’s ALL-Link Database for the last INSTEON message received from an INSTEON device that is in the IM’s ALL-Link
Database. The data will follow in an
message.
2 bytes.
3 bytes.
None.
IM 0x57 ALL-Link Record Response
IM 0x69 Get First ALL-Link Record
IM 0x6A
Command Sent from Host to IM
Meaning
Start of IM Command
IM Command Number
Message Returned by IM to Host
Byte Value
1 0x02
2
3
0x6C
<ACK/NAK>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
0x06 (ACK) if an
follows
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.
Command after this will return the ALL-Link Record that follows this
one, but your actual position within the ALL-Link Database will be unknown (unless you are at the end).
In the
the ALL-Link Database will be cleared, so you will receive a NAK.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 38
ALL-Link Record Response
ALL-Link Record Response (0x57)
What it does
Provides a record from the IM’s ALL-Link Database.
When you’ll get this
You get this when you have requested it, in response to a
Command.
Get ALL-Link Record for Sender
What you’ll get
LED indication
Related Commands
10 bytes.
None.
IM 0x69 Get First ALL-Link Record
IM 0x6A
IM 0x6C
Get ALL-Link Record for Sender
Message Sent from IM to Host
7
8
9
4
5
6
10
Byte Value
1
2
3
0x02
0x57
Meaning
Start of IM Command
IM Command Number
<ALL-Link Record Flags> ALL-Link Database control flags for this ALL-Link Record
<ALL-Link Group>
<ID high byte>
<ID middle byte>
<ID low byte>
<Link Data 1>
<Link Data 2>
<Link Data 3>
ALL-Link Group Number for this ALL-Link Record
INSTEON ID high byte for device ALL-Linked to
INSTEON ID middle byte for device ALL-Linked to
INSTEON ID low byte for device ALL-Linked to
Link Information (varies by device ALL-Linked to)
Link Information (varies by device ALL-Linked to)
Link Information (varies by device ALL-Linked to)
Note
See the section INSTEON All-Link Database in the
contents of an ALL-Link Record.
for details about the
April 19, 2007 © 2007 SmartLabs Technology
Manage ALL-Link Record
Modem Developer’s Guide
Page 39
Manage ALL-Link Record (0x6F)
What it does
What you send
What you’ll get
LED indication
Related Commands
Updates the IM’s ALL-Link Database with the ALL-Link Record information you send. Use caution with this Command—the IM does not check the validity of the data.
11 bytes.
12 bytes.
None.
IM 0x57 ALL-Link Record Response
Command Sent from Host to IM
7
8
9
4
5
6
10
11
Byte
1
2
Value
0x02
0x6F
Meaning
Start of IM Command
IM Command Number
What to do with the ALL-Link Record
0x00 Does an ALL-Link Record exist for this ID + ALL-Link Group?
You will receive an ACK at the end of the returned message if the ALL-Link Record exists, or else a NAK if it doesn’t. If the record exists, the IM will return it in an
message.
0x01 Search for the next ALL-Link Record following the one found using Control Code 0x00 above. This allows you to find both
Controller and Responder records for a given ID + ALL-Link
Group. Be sure to use the same ID + ALL-Link Group (bytes
5 – 8) as you used for Control Code 0x00.
You will receive an ACK at the end of the returned message if the ALL-Link Record exists, or else a NAK if it doesn’t. If the record exists, the IM will return it in an
message.
0x20 Update existing or else add new ALL-Link Record
0x40 Update existing or else add new Controller (master) ALL-
Link Record
0x41 Update existing or else add new Responder (slave) ALL-Link
Record
0x80 Delete ALL-Link Record
<ALL-Link Record Flags> ALL-Link Database control flags for this ALL-Link Record
<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>
<ID low byte>
<Link Data 1>
<Link Data 2>
<Link Data 3>
INSTEON ID middle byte for device ALL-Linked to
INSTEON ID low byte for device ALL-Linked to
Link Information: varies by device ALL-Linked to
Link Information: varies by device ALL-Linked to
Link Information: varies by device ALL-Linked to
Message Returned by IM to Host
5
6
7
8
Byte Value
1 0x02
2
3
4
0x6F
<Control Code>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <Control Code>
<ALL-Link Record Flags> Echoed <ALL-Link Record Flags>
<ALL-Link Group>
<ID high byte>
<ID middle byte>
<ID low byte>
Echoed <ALL-Link group>
Echoed <ID high byte>
Echoed <ID middle byte>
Echoed <ID low byte>
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 40
9
10
11
12
<Link Data 1>
<Link Data 2>
<Link Data 3>
<ACK/NAK>
Manage ALL-Link Record (0x6F)
Echoed <Link Data 1>
Echoed <Link Data 2>
Echoed <Link Data 3>
0x06 (ACK) if the IM executed the Command correctly.
0x15 (NAK) if an error occurred or the ALL-Link Record doesn’t exist.
Notes
See the section INSTEON All-Link Database in the
contents of an ALL-Link Record.
for details about the
Please be aware that you can damage the IM’s ALL-Link Database if you misuse this Command. For instance, if you zero the <ALL-Link Record Flags> byte in the first ALL-Link Record, the ALL-Link Database will then appear empty.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 41
IM Status Management
Reset the IM
What it does
What you send
What you’ll get
LED indication
Related Commands
Reset the IM (0x67)
Database.
, which clears the entire ALL-Link
2 bytes.
3 bytes.
While the reset procedure is being processed, the Status LED will turn off. At the conclusion of the reset procedure, the Status LED will illuminate steadily.
Command Sent from Host to IM
Byte Value
1 0x02
2
0x67
Byte Value
1
2
3
0x02
0x67
<ACK/NAK>
Meaning
Start of IM Command
IM Command Number
Message Returned by IM to Host
Meaning
Echoed Start of IM Command
Echoed IM Command Number
0x06 (ACK) if the IM executed the Command correctly
0x15 (NAK) if an error occurred
Notes
The IM will send the <ACK/NAK> byte after it erases the EEPROM.
~20 seconds for models with external EEPROM
~2 seconds for models with no external EEPROM
Command.
section for complete information on the state of the IM after sending this
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 42
User Reset Detected
User Reset Detected (0x55)
What it does
Reports that the user manually put the IM into the
.
When you’ll get this
The user held down the IM’s SET Button for at least 10 seconds when power was first applied.
What you’ll get
2 bytes (not until about 20 seconds after applying power to the IM with the SET
Button held down).
LED indication
Related Commands
The LED will turn off for about 20 seconds. Once the LED turns back on the reset is complete.
Message Sent from IM to Host
Byte Value
1 0x02
2
0x55
Meaning
Start of IM Command
IM Command Number
Notes
The IM will send this message after it erases the EEPROM.
~20 seconds for models with external EEPROM
~2 seconds for models with no external EEPROM
this message.
section for complete information on the state of the IM after receiving
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 43
Get IM Configuration
What it does
What you send
What you’ll get
LED indication
Related Commands
Get IM Configuration (0x73)
Returns the IM’s Configuration Flags byte. Also returns two spare bytes of data reserved for future use.
2 bytes.
6 bytes.
None.
IM 0x6B
Command Sent from Host to IM
Byte Value
1 0x02
2
0x73
Meaning
Start of IM Command
IM Command Number
Message Returned by IM to Host
4
5
6
Byte Value
1
2
3
0x02
0x73
Meaning
<IM Configuration Flags>
<Spare 1>
<Spare 2>
Echoed Start of IM Command
Echoed IM Command Number definitions.
0x00, reserved for future use
0x00, reserved for future use
<ACK/NAK> 0x06 (ACK) if the IM executed the Command correctly
0x15 (NAK) if an error occurred
Note
Because
sets all of the <IM Configuration Flags> at once, to change an individual bit, first use this Command to determine the current state of all of the <IM Configuration Flags>.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 44
Set IM Configuration
Set IM Configuration (0x6B)
What it does
What you send
What you’ll get
LED indication
Related Commands
Allows you change operating parameters of the IM.
3 bytes.
4 bytes.
None.
IM 0x50 INSTEON Standard Message Received
IM 0x51 INSTEON Extended Message Received
IM 0x6D
Command Sent from Host to IM
Byte Value
1
2
3
0x02
0x6B
<IM Configuration Flags>
Meaning
Start of IM Command
IM Command Number
Flag byte containing Configuration Flags that affect IM operation.
These all default to 0.
Bit 7 = 1 Disables automatic linking when the user pushes and holds the SET Button (see
).
Bit 6 = 1 Puts the IM into Monitor Mode (see
Bit 5 = 1 Disables automatic LED operation by the IM. The host must now control the IM’s LED using
and
Bit 4 = 1 Disable host communications Deadman feature (i.e. allow host to delay more than 240 milliseconds between
Bits 3 - 0 Reserved for internal use. Set these bits to 0.
Message Returned by IM to Host
Byte Value
1 0x02
2
3
4
0x6B
<IM Configuration Flags>
<ACK/NAK>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <IM Configuration Flags>
0x06 (ACK) if the IM executed the Command correctly.
0x15 (NAK) if an error occurred.
Notes
, the <IM Configuration Flags> will all be set to zero.
to determine the current state of all of the <IM Configuration Flags>.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 45
Set IM Configuration (0x6B)
About Monitor Mode
Normally, the IM will only send the host an
INSTEON Standard Message Received
There are three possibilities:
notification when it receives an INSTEON messages directed specifically to the IM.
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. the message’s From Address and ALL-Link Group Number match a
Responder entry in the IM’s ALL-Link Database), or
3. The IM received an ALL-Link Cleanup message with a To Address matching the IM’s INSTEON ID and the message’s From Address and ALL-Link Group Number match a Responder entry in the
IM’s ALL-Link Database.
In Monitor Mode, the IM will also notify the host of received INSTEON messages that contain a From
Address matching any INSTEON ID in the IM’s ALL-Link Database, even if the To Address does not match the IM’s INSTEON ID or the IM does not belong to an ALL-Link Group associated with the message. In other words, if the message originator is in the IM’s ALL-Link Database as either a Controller or
Responder, the IM will pass the message to the host even if it is not specifically directed to the IM. In this way you can monitor messages between other INSTEON devices as long as the sender is in the IM’s ALL-
Link Database.
Please be aware that the IM may not always detect this traffic. If the message originator and addressee are close to one another and the 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 information on
INSTEON Commands and the latest Command set, please download the current
from www.insteon.net
.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 46
Get IM Info
What it does
What you send
What you’ll get
LED indication
Related Commands
Get IM Info (0x60)
Identifies the IM’s 3 byte INSTEON ID, Device Category (DevCat), Device
Subcategory (SubCat), and firmware version.
2 bytes.
9 bytes.
None.
IM 0x66 Set Host Device Category
IM 0x6B
Command Sent from Host to IM
Byte Value
1 0x02
2
0x60
7
8
9
4
5
6
Byte Value
1
2
3
0x02
0x60
<ID high byte>
<ID middle byte>
<ID low byte>
<Device Category>
<Device Subcategory>
<Firmware Version>
<ACK/NAK>
Meaning
Start of IM Command
IM Command Number
Message Returned by IM to Host
Meaning
Echoed Start of IM Command
Echoed IM Command Number
IM’s INSTEON ID high byte
IM’s INSTEON ID middle byte
IM’s INSTEON ID low byte
IM’s Device Category
IM’s Device Subcategory
IM’s Firmware Version
0x06 (ACK) if the IM executed the Command correctly
0x15 (NAK) if an error occurred
Note
Command to change the host’s DevCat and SubCat will only affect the data transmitted by the IM to other INSTEON devices during ALL-Linking.
When the host sends this Command to the IM, the IM will return the original DevCat, SubCat and firmware version hard-coded into the IM’s firmware at the factory.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 47
Set Host Device Category
Set Host Device Category (0x66)
What it does
What you send
What you’ll get
LED indication
Related Commands
Lets you set the Device Category (DevCat) and Device Subcategory (SubCat) of the host device connected to the IM.
5 bytes.
6 bytes.
None.
Command Sent from Host to IM
Byte Value
1 0x02
2
0x66
3 <Device Category>
4 <Device Subcategory>
|
Version>
Meaning
Start of IM Command
IM Command Number
INSTEON Device Category (DevCat) of the host device connected to the IM.
INSTEON Device Subcategory (SubCat) of the host device connected to the IM.
0xFF
In legacy devices this byte represented a BCD-encoded firmware version. The high nibble (4 bits) gave the major revision number and the low nibble gave the minor revision.
In current devices use the INSTEON Product Data Request and
Product Data Response Commands to retrieve the firmware version as user-defined data.
Message Returned by IM to Host
Byte Value
1 0x02
2
0x66
3
4
<Device Category>
<Device Subcategory>
|
Version>
6 <ACK/NAK>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <Device Category>
Echoed <Device Subcategory>
Echoed <0xFF> or <Firmware Version>
0x06 (ACK) if the IM executed the Command correctly
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.
firmware at the factory.
, these values will be set to those hard-coded into the IM’s
Using this Command to change the host’s DevCat and SubCat will only affect the data transmitted by the
IM to other INSTEON devices during ALL-Linking.
Command to the IM, the IM will return the original DevCat, SubCat
and firmware version hard-coded into the IM’s firmware at the factory.
For the latest list of assigned INSTEON DevCats, please download the
from www.insteon.net
.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 48
RF Sleep
What it does
What you send
What you’ll get
LED indication
Related Commands
RF Sleep (0x72)
Directs an RF IM to go into power saving sleep mode. To wake up the RF IM, send it one byte of serial data.
2 bytes.
3 bytes.
None.
None.
Command Sent from Host to IM
Byte Value
1 0x02
2
0x71
3
4
<Command 1 Data>
<Command 2 Data>
Meaning
Start of IM Command
IM Command Number
Data byte to place into the Command 1 field 2 of the ACK response.
Data byte to place into the Command 2 field 2 of the ACK response.
Message Returned by IM to Host
3
4
5
Byte Value
1 0x02
2
0x71
<Command 1 Data>
<Command 2 Data>
<ACK/NAK>
Meaning
Echoed Start of IM Command
Echoed IM Command Number
Echoed <Command 1 Data>
Echoed <Command 2 Data>
0x06 (ACK) if the IM executed the Command correctly.
0x15 (NAK) if an error occurred.
Notes
It does not matter what byte you send serially to wake up the RF IM.
When the RF IM wakes up, it will reinitialize, but memory will not be altered as it would be in the
Commands.
. Wait a minimum of 40 milliseconds before sending any further IM Serial
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 49
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.
What you’ll get
3 bytes.
LED indication
Related Commands
If the event is SET Button Press and Hold the IM will automatically go into ALL-
Linking mode which will cause the LED to blink continuously at a rate of ½ second on and ½ second off. Automatic linking may be turned off by setting IM
Configuration Flags bit 7 (see
).
Message Sent from IM to Host
Byte Value
1 0x02
2
0x54
Meaning
Start of IM Command
IM Command Number
Indicates the type of SET Button event that occurred.
0x02 The SET Button was Tapped
0x03 There was a SET Button Press and Hold for more than three seconds.
This automatically puts the IM into ALL-Linking mode unless
IM Configuration Flags bit 7 is set.
0x04 The SET Button was released after a SET Button Press and
Hold event was recorded.
0x12 Button 2 was Tapped
0x13 There was a Button 2 Press and Hold for more than three seconds.
0x14 Button 2 was released after a Button 2 Press and Hold event was recorded.
0x22 Button 3 was Tapped
0x23 There was a Button 3 Press and Hold for more than three seconds.
0x24 Button 3 was released after a Button 3 Press and Hold event was recorded.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 50
LED On
What it does
What you send
What you’ll get
LED indication
Related Commands
Byte Value
1 0x02
2
0x6D
Byte Value
1 0x02
2
0x6D
3 <ACK/NAK>
LED On (0x6D)
Turns on the IM’s LED if IM Configuration Flags bit 5 = 1.
2 bytes.
3 bytes.
The LED will go on.
IM 0x6B
Command Sent from Host to IM
Meaning
Start of IM Command
IM Command Number
Message Returned by IM to Host
Meaning
Echoed Start of IM Command
Echoed IM Command Number
0x06 (ACK) if the IM executed the Command correctly.
0x15 (NAK) if an error occurred or IM Configuration Flags bit 5 = 0.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 51
LED Off
What it does
What you send
What you’ll get
LED indication
Related Commands
Byte Value
1 0x02
2
0x6E
Byte Value
1 0x02
2
0x6E
3 <ACK/NAK>
LED Off (0x6E)
Turns off the IM’s LED if IM Configuration Flags bit 5 = 1.
2 bytes.
3 bytes.
The LED will go off.
IM 0x6B
IM 0x6D
Command Sent from Host to IM
Meaning
Start of IM Command
IM Command Number
Message Returned by IM to Host
Meaning
Echoed Start of IM Command
Echoed IM Command Number
0x06 (ACK) if the IM executed the Command correctly.
0x15 (NAK) if an error occurred or IM Configuration Flags bit 5 = 0.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 52
Hardware Reference
This section gives a reference design for using the IN2680A Powerline Modem chip in a module connected both to the powerline and to a host device. The design uses a main board for the modem chip, power supply, INSTEON powerline interface, and
TTL-level serial communications, and a daughter board for interfacing to a host.
Two different daughter board designs are included. One is for an RS232 interface, and the other is for an IP (Ethernet) interface. A USB interface is under development. Developers may create their own daughter cards to implement custom interfaces.
The reference design presented here is the same one that SmartLabs uses for its
Powerline Modem (PLM) module.
In This Section
INSTEON Powerline Modem (PLM) Main Board
Gives the schematic and bill of materials for the PLM Main Board.
INSTEON PLM Serial (RS232) Daughter Board
Gives the schematic and bill of materials for the Serial (RS232) Daughter Board.
INSTEON PLM Ethernet (IP) Daughter Board
Gives the schematic and bill of materials for the Ethernet (IP) Daughter Board.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 53
INSTEON Powerline Modem (PLM) Main
Board
The Powerline Moded (PLM) main board includes the IN2680A Powerline Modem chip, a transformer-isolated power supply with a 30-volt charge pump booster, a transformer-coupled powerline signal transponder, an optically-isolated zero crossing detector, and an 8-pin daughter board connector for TTL-level host communications.
In This Section
INSTEON PLM Main Board Schematic
Gives the schematic and bill of materials for the PLM main board.
INSTEON PLM Main Board Bill of Materials
Specifies the parts used in the main board.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 54
INSTEON PLM Main Board Schematic
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 55
INSTEON PLM Main Board Bill of Materials
Description
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Crystal
Part Type
Electrolytic, 1000uF, 25V
Metal Polyester, 0.22uF,
250VDC
Ceramic, 0.0015uF, 100V
Metal Polyester, 0.68uF,
250VDC
Electrolytic, 100uF, 6.3V
Ceramic, 0.001uF, 25V
Ceramic, 0.001uF, 25V
Electrolytic, 470uF, 50V
Ceramic, 0.1uF,25V
Ceramic, 220pF, 25V
Ceramic, 27pF, 25V
Ceramic, 27pF, 25V
22.1184MHz, 18pF Load
Designator
C1
C3
C5
C6
C7
C8
C9
C10
C11
C12
Y1
Footprint
Through-hole, 0.2"
SMT, 0805
Through-hole, 0.1"
SMT, 0603
SMT, 0603
Through-hole, 0.2"
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
Through-hole
Remark
Recommended:
Citizen model
CMR309T22.1184MABJTR
Diode DL4004
Diode DL4004
Diode DL4004
Diode DL4004
Diode Zener, 5.1V, 1W
Diode DL4004
Diode Zener, 5.1V, 1W
D5
D7
SMT, MELF
SMT, MELF
Diode 1N4148
Diode 1N4148
Diode
Diode
Zener, 68V, 1/2W
Zener, 39V, 1W
Diode 1N4148
Header
Inductor
LED
2X4 male
J3 Through-hole, For in-circuit programming
J4 Through-hole, 0.1" ctr Used to connect to daughter boards
2.7mH, 8-9 ohms DCR,
100mA DCI
Any single color is acceptable LED1 Through-hole, T1
MCU INSTEON IN2680A
Zetex
ZXMN6A07F
Optocoupler Fairchild 4N25SM or 4N25S
D10
D11
U3
U2
SMT, Mini-MELF
SMT, MELF
SMT, SSOP20
SMT
Regulator
Resistor
Resistor
Resistor
78L05 Positive 5V regulator
15KW, 1/16W, 5%
27W, 1/2W, 5%
330W, 1/10W, 5%
U1 Through-hole, TO-92
100% Transfer ration @
8mA If and 5mA Ic
Recommended:
Panasonic ERJ-P14J27OU
Anti-Surge
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 56
Description Part Type
Resistor
Resistor
Resistor
Resistor
Resistor
Resistor
Resistor
Resistor
Resistor
Resistor
Resistor
Resistor
Resistor
100KW, 1/16W, 5%
33KW, 1/16W, 5%
10KW, 1/16W, 5%
2.2KW, 1/16W, 5%
15W, 1/2W, 5%
1KW, 1/16W, 5%
1K, 1/16W, 5%
10KW, 1/16W, 5%
2.2KW, 1/16W, 5%
10KW, 1/16W, 5%
100KW, 1/16W, 5%
1KW, 1/16W, 5%
100KW, 1/4W, 5%
Designator
R10
R12
Footprint
SMT, 0603
SMT, 0603
Transformer Power Transformer, model
710-2000512
Transformer Power line transformer coil
Transistor
Transistor
Transistor
2N4403 PNP
2N2222A NPN
BST-52 Darlington NPN
Varistor
Wire
Wire
T1 Through-hole
T2
Q1
Q2
Q3
Through-hole
SMT, SOT-23
SMT, SOT-23
SMT, SOT-89
150VAC Metal Oxide Varistor MOV1 Through-hole,
Hot wire, black, 16AWG,
300V, 105°C, VW-1
Neutral wire, white, 16AWG,
300V, 105°C, VW-1
J1
J2
Through-hole
Through-hole
Remark
May be changed to control
LED brightness made, from SmartLabs
Abracon AIRV-111 PLC
Recommended brand:
Zetex
In from power prong
In from power prong
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 57
INSTEON PLM Serial (RS232) Daughter
Board
The Serial Daughter Board attaches to the Powerline Modem (PLM) Main Board using an 8-pin connector, and to a host device using an RJ-45 jack. Host communications uses the RS232 protocol at TTL signal levels.
In This Section
INSTEON PLM Serial Daughter Board Schematic
Gives the schematic and bill of materials for the serial (RS232) Daughter Board.
INSTEON PLM Serial Daughter Board Bill of Materials
Specifies the parts used in the Serial Daughter Board.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 58
INSTEON PLM Serial Daughter Board
Schematic
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 59
INSTEON PLM Serial Daughter Board Bill of
Materials
Description Part Type
Capacitor
Capacitor
Ceramic, 0.1uF, 25V
Electrolytic, 100uF, 6.3V
C3
C4
C5
C6
Designator
C1
C2
Footprint
SMT, 0603
Through-hole
Through-hole
Through-hole
Through-hole
Through-hole
Remark
Diode 1N4148
Diode 1N4148
Driver /
Receiver
MAX232 Multichannel RS-
232 ST232BDR
EEPROM 24LC32A
Header Female 2x4, 2x4PIN,
2.54mm, 2185-20
F1 Through-hole
J1 Through-hole, 0.1” ctr
Resistor 1.5KΩ, 1/16W, 5%
Resistor 1KΩ, 1/16W, 5%
Voltage
Regulator
5V Zetex ZSR500G
J2 SMT
R1 SMT, 0603
R2
U1
SMT, 0603
SMT, SOT223
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 60
INSTEON PLM Ethernet (IP) Daughter
Board
The IP (Ethernet) Daughter Board attaches to the Powerline Modem (PLM) Main
Board using an 8-pin connector, and to an Ethernet LAN using an RJ-45 jack.
In This Section
INSTEON PLM Ethernet (IP) Daughter Board Schematic
Gives the schematic and bill of materials for the IP (Ethernet) Daughter Board.
INSTEON PLM Ethernet (IP) Daughter Board Bill of Materials
Specifies the parts used in the IP Daughter Board.
April 19, 2007 © 2007 SmartLabs Technology
Modem Developer’s Guide
Page 61
INSTEON PLM Ethernet (IP) Daughter Board
Schematic
April 19, 2007 © 2007 SmartLabs Technology
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Capacitor
Controller
Modem Developer’s Guide
Page 62
INSTEON PLM Ethernet (IP) Daughter Board
Bill of Materials
Description Part Type
Crystal
Crystal
Ceramic, 0.1uF, 25V
Electrolytic, 100uF, 6.3V
Ceramic, 0.1uF, 25V
Ceramic, 15pF, 25V
Ceramic, 15pF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 22pF, 25V
Ceramic, 22pF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 0.1uF, 25V
Ceramic, 0.1uF, 25V
Ethernet controller, Realtek
RTL8019AS
19.6608MHz Crystal, 18pF
Load
20MHz Crystal, 18pF Load
C9
C10
C11
C12
C13
C14
C15
C16
C17
C18
C5
C6
C7
C8
Designator
C1
C2
C3
C4
Footprint
SMT, 0603
Through-hole, 0.1"
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
SMT, 0603
U4 SMT,
Remark
Y1 Through-hole
Y2 SMT
J2 Through-hole, For in-circuit programming
J4 SMT Jack RJ45 Female jack
MCU PIC18F452-I/PT
Memory 24LC256-I/SN
Regulator
Resistor
Resistor
Resistor
Resistor
Resistor
Transformer
78L05 5V Voltage regulator
4.7KW, 1/16W, 5%
1KW, 1/16W, 5%
4.7KW, 1/16W, 5%
10KW, 1/16W, 5%
200W, 1/16W, 5%
Ethernet transformer,
Abracon ALAN-107
U1 SMT, SOT-223
T1 SMT
April 19, 2007 © 2007 SmartLabs Technology
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Related manuals
advertisement
Table of contents
- 5 INTRODUCTION
- 5 INSTEON Modem Chips
- 6 The SmartLabs Powerline Modem (PLM)
- 8 Other Documents Included by Reference
- 8 INSTEON Developer’s Guide
- 8 INSTEON Conformance Specification
- 8 INSTEON Command Tables Document
- 8 INSTEON Device Categories and Product Keys Document
- 9 INSTEON Modem Spec Sheets
- 9 IN2680A INSTEON Direct Powerline Modem Interface
- 9 IN2682A INSTEON Direct RF Modem Interface
- 10 INSTEON MODEM REFERENCE
- 10 Software Reference
- 11 IM Serial Communication Protocol and Settings
- 12 IM Serial Communication Protocol
- 12 IM RS232 Port Settings
- 13 How to Quickly Start Communicating with an IM
- 14 IM Power-up and Reset States
- 14 IM Power-up Behavior
- 14 IM Factory Reset State
- 15 IM Serial Commands
- 16 IM Serial Command Summary Table
- 20 IM Serial Command Charts
- 21 INSTEON Message Handling
- 21 Send INSTEON Standard or Extended Message
- 24 INSTEON Standard Message Received
- 25 INSTEON Extended Message Received
- 27 Set INSTEON ACK Message Byte
- 28 Set INSTEON ACK Message Two Bytes
- 29 Set INSTEON NAK Message Byte
- 30 X10 Message Handling
- 30 Send X
- 31 X10 Received
- 32 INSTEON ALL-Link Commands
- 32 Send ALL-Link Command
- 34 ALL-Link Cleanup Failure Report
- 35 ALL-Link Cleanup Status Report
- 36 ALL-Linking Session Management
- 36 Start ALL-Linking
- 37 Cancel ALL-Linking
- 38 ALL-Linking Completed
- 39 ALL-Link Database Management
- 39 Get First ALL-Link Record
- 40 Get Next ALL-Link Record
- 41 Get ALL-Link Record for Sender
- 41 ALL-Link Record Response
- 42 Manage ALL-Link Record
- 44 IM Status Management
- 44 Reset the IM
- 45 User Reset Detected
- 46 Get IM Configuration
- 47 Set IM Configuration
- 49 Get IM Info
- 50 Set Host Device Category
- 51 RF Sleep
- 52 IM Input/Output
- 52 Button Event Report
- 53 LED On
- 54 LED Off
- 55 Hardware Reference
- 56 INSTEON Powerline Modem (PLM) Main Board
- 57 INSTEON PLM Main Board Schematic
- 58 INSTEON PLM Main Board Bill of Materials
- 60 INSTEON PLM Serial (RS232) Daughter Board
- 61 INSTEON PLM Serial Daughter Board Schematic
- 62 INSTEON PLM Serial Daughter Board Bill of Materials
- 63 INSTEON PLM Ethernet (IP) Daughter Board
- 64 INSTEON PLM Ethernet (IP) Daughter Board Schematic
- 65 INSTEON PLM Ethernet (IP) Daughter Board Bill of Materials