Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
indigo_5_documentation:insteon_link_management [2011/09/20 14:48] – [The Manage INSTEON Device Links dialog] jayindigo_5_documentation:insteon_link_management [2025/04/14 20:10] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +====== Indigo INSTEON Link Management ======
 +
 +The INSTEON protocol has linking built-in as part of it's core functionality. The idea is that one device, a controller in INSTEON speak, can be linked to another device, a responder, then from that point forward the controller device sends its command directly to the responder device. So, for instance, you can link a KeypadLinc button to a SwitchLinc so that when you press the button on the KPL the SwitchLinc responds. That's normally done by pressing various buttons on each device in specific ways until the link is established.
 +
 +The manual linking method is useful if you don't have a software-controlled environment. However, since you've decided to have Indigo automate your home, you do have software to help you manage your automation needs. We've worked very hard to allow Indigo to perform the majority of link management tasks remotely so you don't have to walk around pressing buttons.
 +
 +===== Managing INSTEON Device Links =====
 +
 +The primary place that you'll manage links between devices is in the Manage INSTEON Device Links dialog. Select **''Manage INSTEON Device Links''** from **''Interfaces->INSTEON/X10 Power Line''**, and the dialog will popup:
 +
 +{{:indigo_5_documentation:device_links_dialog.png?nolink|Device Links Dialog Image}}
 +
 +The dialog may look slightly different depending on the roles that the device selected in the popup at the top can play. As we mentioned earlier, devices that can control other devices are called "controllers" and devices that can be controlled are called "responders". Many devices are both controllers and responders (the example above is a SwitchLinc, which is both). These links are also called groups and/or scenes, depending on usage, so keep that in mind.
 +
 +For example, you can use Indigo to remotely program button #1 on a RemoteLinc to: set the thermostat to 68°, brighten the bedroom sconces to 75%, dim the bedroom overhead fixture down to 35%, turn off the hallway and bathroom lights.
 +
 +{{:indigo_5_documentation:device_links_example.png?nolink|Device Links Example Image}}
 +
 +Indigo automatically creates the links to define the scene in most remote modules. This means you do not have to press-and-hold the set button or up paddle on most remote modules. Indigo will do it all remotely for you with a single press of the Sync Now button. See the Supports Remote Link Management column of the INSTEON module and Indigo 4 compatibility table for information on which modules Indigo can remotely manage.
 +
 +You can also define Indigo initiated scenes to control multiple remote modules in unison. See the defining Indigo INSTEON scenes section for more information on this capability.
 +
 +==== Responder Modules vs. Controller Modules ====
 +
 +Every INSTEON module is either a //responder module//, a //controller module// or both:
 +
 +  * //Responder modules// respond to incoming INSTEON commands by controlling a load (light or appliance), a thermostat setting, sprinkler valves, low-voltage relays, etc. Examples of responder modules include: LampLinc, ApplianceLinc, and the EZRain sprinkler controller.
 +  * //Controller modules// send outgoing INSTEON commands onto the power line or via RF to modules that are responders. Examples of controller modules include: RemoteLinc, ControLinc, and the PowerLinc computer interface.
 +  * Some modules are both //responders// and //controllers//. For example, a KeypadLinc can respond to a RemoteLinc but it can also control other modules, such as a LampLinc.
 +
 +==== Defining the Scene between Modules ====
 +
 +First, select the module you want to edit. You can choose to edit either the controller module in the scene (ex: RemoteLinc) or the responder module in the scene (ex: LampLinc).
 +
 +  - Choose **''Manage INSTEON Device Links...''** from the **''Interface''** menu.
 +  - Select the module's device name to edit in the **''Show links used by device''** popup control.
 +
 +If the module you selected is a controller (RemoteLinc, KeypadLinc, SwitchLinc, etc.), then you can add or edit responders:
 +
 +  - If you want to add a new responder module to the scene, then press the **''New Link to Responder''** button. If you want to change the settings (brightness, ramp rate duration, etc.) of an existing responder module in the scene, then select that module's link in the table with the **''Link to Responder Device''** column title.
 +  - Choose the button or group number that identifies the scene you are defining in the controller (ex: RemoteLinc button #1) from the **''broadcast of button/group number''** popup control.
 +  - Choose the responder module's device name from the responder popup control (ex: LampLinc).
 +  - When responding to a scene command, most modules will control the main load (light or appliance) connected to that module. For these modules (SwitchLinc, ToggleLinc, LampLinc, etc.) you can specify the exact brightness you want for that module as well as a duration for how quickly the module should go to that brightness: Some modules will have different options. For example, when a KeypadLinc is responding to a scene command, it can turn one of the secondary button LEDs on instead of controlling the main load, or the thermostat module can respond to a scene command by changing both the thermostat operation mode and the current **''cool''** and **''heat''** setpoint temperatures.
 +  - Optionally turn on the **''Persistent''** checkbox to force this link to automatically be restored whenever either the responder module or controller module is synced. If the modules are ever reset, replaced, or have this link modified, then Indigo will automatically rewrite the original link on the next sync operation.
 +  - Repeat steps 1 through 5 for every new responder module that you want to add to the selected controller.
 +
 +If the module you selected is a responder (LampLinc, Thermostat Adapter, KeypadLinc, SwitchLinc, etc.), then you can add or edit controllers:
 +
 +  - If you want to add a controller of the selected responder module, then press the **''New Link to Controller''** button. If you want to change the settings (brightness, ramp rate duration, etc.) used by the selected module in a controller's scene, then select the controller module's link in the table with the **''Link to Controller Device''** column title.
 +  - Choose the controller module's device name from the On controller popup control (ex: RemoteLinc).
 +  - Choose the button or group number that identifies the controller scene for which you want the responder to listen (ex: RemoteLinc button #3) from the **''broadcast of button/group number''** popup control.
 +  - When responding to a scene command, most modules will control the main load (light or appliance) connected to that module. For these modules (SwitchLinc, ToggleLinc, LampLinc, etc.) you can specify the exact brightness you want for that module as well as a duration for how quickly the module should go to that brightness using the % text box and the rate popup. Some modules will have different options. For example, when a KeypadLinc is responding to a scene command, it can turn one of the secondary button LEDs on instead of controlling the main load, or the thermostat module can respond to a scene command by changing both the thermostat operation mode via the mode popup and the current **''cool''** and **''heat''** setpoint temperatures via those text boxes.
 +  - Optionally turn on the **''Persistent''** checkbox to force this link to automatically be restored whenever either the responder module or controller module is synced. If the modules are ever reset, replaced, or have this link modified, then Indigo will automatically rewrite the original link on the next sync operation.
 +  - Repeat steps 1 through 5 for every new controller module you want to add for the selected responder.
 +
 +Lastly, to have Indigo write all of your link changes to the remote modules, press the **''Sync Now''** button to have Indigo immediately write all changed links to the remote modules. Or, press the **''Close (Sync Later)''** button to close the link editor window and write the changes to the modules at a later time. When you are ready to write the changes to the remote modules, select **''Start Sync INSTEON Device Links...''** from the **''Interfaces->INSTEON/X10 Power Line''** menu, and then press the press the **''Sync Changes Only''** button.
 +
 +==== Manually Creating Links between Modules ====
 +
 +In addition to using Indigo's remote link and scene management, you can also manually create the links physically at the devices themselves. Follow the instructions that came with the hardware for the exact steps, which usually involves creating the links by press-and-holding the set button or up paddles for 10 seconds on each module.
 +
 +If you manually create or delete a link, then you must tell Indigo to [[#INSTEON_link_syncing|re-sync those modules]]. This enables Indigo to read in the link changes, and is required for Indigo to accurately show the state of the modules as they change.
 +
 +
 +
 +===== Managing INSTEON PowerLinc Scenes =====
 +
 +INSTEON scenes (also called groups) can be used to control multiple INSTEON modules, such as light switch modules, lamp or appliance plug-in modules, and thermostat modules, all in unison. For example, you could create a //home theatre lighting// scene that turns off all lighting in your media room, except for a few sconce side lights which are set to 20% brightness. You can create lighting scenes for any activity you desire: //dining//, //entertaining//, //sleeping//, //reading in bed//, //emergency//, etc.
 +
 +{{:indigo_5_documentation:manage_powerlinc_scenes.png?nolink|Manage Powerlinc Scenes Image}}
 +
 +Indigo can remotely create scenes in the computer interface (PowerLinc) that control multiple remote modules. Indigo automatically creates the links to define the scene in both the PowerLinc and most remote modules. This means you do not have to press-and-hold the button on either the PowerLinc or most remote modules. Indigo will do it all remotely for you with a single press of the Sync Now button.
 +
 +Once Indigo writes the links defining the scene to the PowerLinc and remote modules, you can execute the scene from any [[indigo_5_documentation:overview#triggers|Trigger]], [[indigo_5_documentation:overview#schedules|Schedule]], or [[indigo_5_documentation:overview#actions_and_action_groups|Action Group]] using the **''Execute INSTEON Scene''** [[indigo_5_documentation:overview#Execute_INSTEON_Scene|action]].
 +
 +Indigo can also remotely create and edit scenes between remote modules (ex: from a KeypadLinc to a LampLinc). See [[#Managing INSTEON Device Links]] for more information on this capability.
 +
 +==== Defining the Scene ====
 +
 +First, specify which PowerLinc Group/Scene number you want to use:
 +
 +  - Choose **''Manage INSTEON PowerLinc Links...''** from the **''Interfaces->INSTEON/X10 Power Line''** menu.
 +  - Select a **''PowerLinc Group/Scene''** number to use for the scene. Use 1 if this is your first scene.
 +  - Optionally enter a **''PowerLinc Group/Scene''** name in the edit field (ex: "reading in bed").
 +
 +Next, create a new link for every responder module in the scene:
 +
 +  - If you want to add a new responder module to the scene, then press the **''New Link to Responder''** button. If you want to change the settings (brightness, ramp rate duration, etc.) of an existing responder module in the scene, then select that module's link in the table in the top-half of the window.
 +  - Choose the responder module's device name from the **''responder''** popup control.
 +  - When responding to a scene command most modules will control the main load (light or appliance) connected to that module. For these modules (SwitchLinc, ToggleLinc, LampLinc, etc.) you can specify the exact brightness you want for that module as well as a duration for how quickly the module should go to that brightness by using the % text box and the duration popup. Some modules will have different options. For example, when a KeypadLinc is responding to a scene command it can turn one of the secondary button LEDs on instead of controlling the main load, or the thermostat module can respond to a scene command by changing both the thermostat operation mode via the mode popup and the current **''cool''** and **''heat''** setpoint temperatures using the text boxes.
 +  - Optionally turn on the **''Persistent''** checkbox to force this link to automatically be restored whenever the responder module is synced. If the responder module is ever reset, replaced, or has this link modified, then Indigo will automatically rewrite the original link into the device when it is next synced.
 +  - Repeat steps 1 through 4 for every new module you want to add to the scene.
 +
 +Lastly, have Indigo write all of your link changes to both the PowerLinc and the remote modules by pressing the **''Sync Now''** button to have Indigo immediately write all changed links to the PowerLinc and remote modules. Or, press the **''Close (Sync Later)''** button to close the link editor window and write the changes to the modules at a later time. When you are ready to write the changes to the PowerLinc and remote modules select **''Start Sync INSTEON Device Links...''** from the **''Interfaces->INSTEON/X10 Power Line''** menu, and then press the press the **''Sync Changes Only''** button.
 +
 +You can test the scene after the links are written by using the Send On and Send Off buttons.
 +
 +==== Executing the Scene ====
 +
 +The Indigo scene can now be executed from any Trigger, Schedule, or Action Group:
 +
 +  - Follow the instructions to create a [[indigo_5_documentation:overview#triggers|Trigger]], [[indigo_5_documentation:overview#schedules|Schedule]], or [[indigo_5_documentation:overview#actions_and_action_groups|Action Group]].
 +  - Select the **''Actions''** tab inside the edit window.
 +  - Select [[indigo_5_documentation:overview#Execute_INSTEON_Scene|Execute INSTEON Scene]] from the action **''Type''** popup item.
 +  - Use the **''Send''** popup item to select which scene command to send:
 +    * **''Group On''** will command all the responder modules to their scene-specific brightness using their scene-specific ramp rate duration, if any.
 +    * **''Group On to 100% (instant / ignore rate)''** will set the brightness of dimmable modules to 100% immediately, ignoring any ramp rate duration.
 +    * **''Group Off''** will turn off all the responder modules using their scene-specific ramp rate duration, if any.
 +    * **''Group Off (instant / ignore rate)''** will turn off all the modules immediately, ignoring any ramp rate duration.
 +  - Select the scene number defined previously (see above) from the **''Scene''** popup item.
 +
 +<color red>Note</color>: you can press the **''Modify this Scene button...''** to add a new responder module to the currently selected scene, or you can double-click a device in the scene list to edit its settings (brightness, ramp rate duration, etc.).
 +
 +
 +
 +
 +
 +===== INSTEON Link Syncing =====
 +
 +Indigo's smart INSTEON Link Syncing makes it easy to setup and keep all of your devices working with your PowerLinc. This link syncing process allows Indigo to control devices, and to update its internal device state (on / off / brightness) as the device is controlled locally (at the switch) or remotely by other devices. Indigo shows the state of all INSTEON devices as they change, even if the change is because of a command from another device. For example, a LampLinc that is turned ON from a ControLinc will immediately show as ON within Indigo. Indigo automatically does link syncing when you first create the device.
 +
 +If, after the device is initially created, a remote device has any additional controller links added (ex: LampLinc is controlled by a KeypadLinc), then that device (LampLinc in this case) should have its links re-synced. This option is available from the Device dialog and will ensure Indigo has an accurate representation of the device's internal links, allowing it to correctly show state (on / off / brightness) changes as they occur.
 +
 +==== Re-Syncing a Single INSTEON Device ====
 +
 +Make sure the device is properly wired or plugged in.
 +Select Device List from the View menu.
 +Double-click the device you need to re-sync.
 +Press the Re-Sync Links... button.
 +Press the Start Synch button.
 +Wait for the Smart Link Syncing steps to complete and press the Close button.
 +The sync process can take a few minutes to complete. Lamp and appliance devices normally take less than a minute, but KeypadLincs and ControLincs can take a few minutes because of the additional link information needed for all the buttons.
 +
 +==== Re-Syncing All INSTEON Devices ====
 +
 +In addition to syncing individual devices, you can also batch sync all of your INSTEON devices. Depending on the number of INSTEON devices you have, this process can take a significant amount of time to complete. Because control of your devices will be limited during the synchronization process, it is recommended that you start the synchronization process at night or before you leave the house.
 +
 +Make sure all devices are properly wired or plugged in.
 +Select Start Sync INSTEON Device Links... from the Interface menu.
 +Press the Sync All Devices button.
 +Watch the Event Log window to see when the synchronization process is complete.
 +The batch synchronization process can be canceled at any time.
 +
 +Select Stop Sync INSTEON Device Links from the Interface menu.
 +Watch the Event Log window to see when the synchronization process is canceled.
 +
 +==== PowerLinc Replacement ====
 +
 +If your PowerLinc is ever replaced, then you must re-sync all of your devices. This will ensure that all devices have their internal links updated to reflect the new PowerLinc's INSTEON address.
 +
 +<color red>Note</color>: that any links that you create, either using the UIs described above, or by manual linking must be marked as **''Persistent''** in the link dialogs in order for them to be recreated correctly. For links that you create manually between devices, when you have the manual links created successfully, you must come back to Indigo and sync the device(s) links. The manual links will show up in the dialogs - you must then mark them as **''Persistent''** in order for them to be retained when doing a resync/replacement.