Insteon Link to Interface
Adding an Insteon device to MisterHouse is two step process. First, MisterHouse needs to be informed about the existence of the device. Second, we need to link the device to the interface, so that MisterHouse is informed of any changes to the device and so that MisterHouse can program the device.
Marc's insteon.mht file has long served as the primary example for new users, see Marc's insteon.mht file. See a list of other user contributed insteon.mht files.
You may also find a list of Insteon device definitions in Insteon Supported Devices and Insteon Devices - Quirks and Hints.
Defining a device is relatively simple, but getting this right is fundamental to correctly linking devices using MH. You want to define your devices in the same MHT file you created for the PLM. You also want to make sure that the PLM definition is above any other Insteon device definitions.
The format for specifying an Insteon devices is:
<<DEVICE_TYPE>>, <<Address>>, <<Name>>, <<Groups>> #CommentsEach item is separated by a comma. People generally use tabs to try and keep the file easy to read. You can find a list of Device_Types on the Insteon Supported Devices page. The address is the 6 digit hexadecimal number you wrote down while installing the physical device with the addition of periods between each group of two numbers. The name is anything you want it to be, likely something descriptive of the device's location and load that it controls. A group is a logical collection of devices, such as Living_Room.
You cannot include dashes in either the name or group use underscores instead. More than one group may be specified by separating them with a pipe | character.
Anything on a line after a hash # character will be ignored. Most people add comments after the end of their device line. Marc Merlin recommends, and many of us agree, that you write the various revision numbers and manufacturing dates in the comments section that you collected while Installing the Physical Devices. It is also recommended that you write down the circuit number, so your entry should look something like:
INSTEON_SWITCHLINC, 01.08.27, living_accent_light, All_Lights|Downstairs # 2477D Rev 6.5 1406 Cir 7
A multigroup device, is a device that has more than one controller or responder object. Some examples include, KeyPadLincs (6 or 8 buttons), FanLincs (Light and Fan), RemoteLincs (4 or 8 button), and Thermostats (Heat, Cool, Humidity).
Group numbers are used to distinguish between the various objects on a device. The group number is a two digit hexadecimal number and is zero padded so groups 01-F4 are available. Group numbers are appended to the device_id follow a colon. Group 01 is always the root object of a device and all devices have a group 01 object. Therefore, when defining a device using the definition above, a group 01 object is implicit, you do not need to include it but you can. The above definition could be also written as:
INSTEON_SWITCHLINC, 01.08.27:01, living_accent_light, All_Lights|Downstairs # 2477D Rev 6.5 1406 Cir 7For devices with multiple buttons like the KeypadLinc, each of the non-root buttons needs to include its group number if you are going to define it in MisterHouse. For example:
INSTEON_KEYPADLINC, 01.08.27:03, hall_kpl_a, All_Lights|Downstairs INSTEON_KEYPADLINC, 01.08.27:04, hall_kpl_b, All_Lights|DownstairsNote the use of ":03" to indicate that this is the A button of a 6 button KeypadLinc. Or ":04" to indicate the B button of a 6 button KeypadLinc. Also note, that each sub-group device needs to have a unique name.
Once all of your devices have been defined, fire up MisterHouse and see if you have any errors. It is important to note, that any time you make changes to an MHT file, you need to restart MisterHouse in order for the changes to take effect.
Once restarted, you should check to make sure all of the devices you defined appear in MisterHouse. You can do this by going to the web interface "MrHouse Home -> Browse Categories -> Insteon" and look for the devices you defined. If you don't see a device, go and check if it is properly defined in the MHT file.
As soon as you add a device to MisterHouse, you need to link it to the interface, so that MisterHouse can track the state of the device.
You need to perform the link to interface step on each device that you add to MisterHouse. Due to the nature of i2cs the link to interface procedure needs to be done before anything else. Until this step is peformed, MH will not be able to communicate with the device at all. Only root objects need to or can be linked. A root object, is the base object the 01 group of a mutltigroup device. The KeyPadLinc for example, only the 01 object needs to be linked.
To perform the link to interface step, go to MrHouse Home -> Setup MrHouse -> Browse Categories -> Insteon. Then do the following:
- In the PLM menu, select "Scan all Changed Link Tables". This is required for mh to learn about all your devices and be able to link to them via the web (next step). This step is time consuming, look at the print.log tail and wait for it to complete (you will receive a clear message when this completes). If you installed multiple devices at once, you only need to run this once for all devices before proceeding to the next step. Don't worry if some devices are reported as having problems, these are likely just i2cs devices.
- Find each of your newly added devices and select 'link to interface' for each device. Check your print.log for errors. You will receive a confirmation for each device when this is complete.