INSTEON Hub Developer's Guide

INSTEON Hub: Developer’s Guide
Page 29 © 2013 INSTEON
INSTEON ALL-Link Commands
Send ALL-Link Command
Send ALL-Link Command (0x61)
What it does Sends an ALL-Link Command to an ALL-Link Group of one or more Responders that the IM is ALL-
Linked to.
What you send
5 bytes.
What you’ll get 6 bytes for the echo of the Command and then an additional 11 bytes in an INSTEON Standard
Message Received
22
message for each device in the group that acknowledges ALL-Link Cleanup, or
7 bytes in an ALL-Link Cleanup Failure Report
31
message for each device in the group that does not
acknowledge ALL-Link Cleanup.
LED indication
None.
Related Commands
IM 0x50 INSTEON Standard Message Received
22
IM 0x56 ALL-Link Cleanup Failure Report
31
IM 0x58 ALL-Link Cleanup Status Report
32
Command Sent from Host to IM
Byte Value Meaning
1 0x02 Start of IM Command
2
0x61
IM Command Number
3 <ALL-Link Group> ALL-Link Group Number that the ALL-Link Command is sent to
4 <ALL-Link Command> ALL-Link Command
5 <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
Byte Value Meaning
1 0x02 Echoed Start of IM Command
2
0x61
Echoed IM Command Number
3 <ALL-Link Group> Echoed <ALL-Link Group>
4 <ALL-Link Command> Echoed <ALL-Link Command>
5 <Broadcast Command 2> Echoed <Broadcast Command 2>
6 <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
32
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 an ALL-Link Cleanup Status Report
32
with a Status Byte of 0x06 (ACK).
For each ALL-Link Cleanup message that the IM sends, you will either receive an INSTEON Standard
Message Received
22
when the Responder answers with a Cleanup acknowledgement message, or
else you will receive an ALL-Link Cleanup Failure Report
31
if the Responder fails to answer with a
Cleanup acknowledgement message. The IM will send you an ALL-Link Cleanup Status Report
32
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 Send ALL-Link
Command
29
or Send INSTEON Standard or Extended Message
19
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 ALL-Link Cleanup Status Report
32
in those cases.

INSTEON Hub Specifications

General

Product Name	INSTEON Hub
Model Number	2245-222
Connectivity	Ethernet
Communication Protocol	INSTEON
Operating Temperature	0°C to 40°C (32°F to 104°F)
Operating Humidity	85% non-condensing