Differences

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

Link to this comparison view

indigo_5_documentation:insteon_specific_commands [2019/01/25 22:53] (current)
Line 1: Line 1:
 +====== INSTEON Commands (indigo.insteon.*) ======
 +
 +Commands that are specific to INSTEON devices.
 +
 +==== Send Scene ON ====
 +
 +This command will send an INSTEON Scene ON command to the specified PowerLinc scene.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.insteon.sendSceneOn(11)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOn(11,​ sendCleanUps=False)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOn(11,​ suppressLogging=True)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOn(11,​ updateStatesOnly=True)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOn("​working in office scene"​)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOn("​working in office scene",​ sendCleanUps=False)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer or string ​ |either the scene number or the scene name - we encourage numbers since they won't change and the scene names can.|
 +|//''​sendCleanUps''//​| ​ No  |  boolean ​ |a boolean indicating if cleanup messages should be sent to each device in the scene after the scene command - this will have the PowerLinc send each device a message to make sure it received the command. You might want to stop cleanup messages from being sent because it involves adding a lot of INSTEON traffic and might effect performance (particularly if a group has a lot of responders). But, of course, disabling it may reduce reliability of some modules receiving the scene command so it's usually best to ignore this setting. (default is True)|
 +|//''​suppressLogging''//​| ​ No  |  boolean ​ |a boolean indicating if entries in the event log should be suppressed (default is False)|
 +|//''​updateStatesOnly''//​| ​ No  |  boolean ​ |use if you only want Indigo'​s internal device state representation to be updated - no actual INSTEON command will be sent on RF or the power line (default is False)|
 +
 +==== Send Scene OFF ====
 +
 +This command will send an INSTEON Scene OFF command to the specified PowerLinc scene.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.insteon.sendSceneOff(11)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOff(11,​ sendCleanUps=False)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOff(11,​ suppressLogging=True)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOff(11,​ updateStatesOnly=True)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOff("​working in office scene"​)</​code>​|
 +|<​code>​indigo.insteon.sendSceneOff("​working in office scene",​ sendCleanUps=False)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer or string ​ |either the scene number or the scene name - we encourage numbers since they won't change and the scene names can.|
 +|//''​sendCleanUps''//​| ​ No  |  boolean ​ |a boolean indicating if cleanup messages should be sent to each device in the scene after the scene command - this will have the PowerLinc send each device a message to make sure it received the command. You might want to stop cleanup messages from being sent because it involves adding a lot of INSTEON traffic and might effect performance (particularly if a group has a lot of responders). But, of course, disabling it may reduce reliability of some modules receiving the scene command so it's usually best to ignore this setting. (default is True)|
 +|//''​suppressLogging''//​| ​ No  |  boolean ​ |a boolean indicating if entries in the event log should be suppressed (default is False)|
 +|//''​updateStatesOnly''//​| ​ No  |  boolean ​ |use if you only want Indigo'​s internal device state representation to be updated - no actual INSTEON command will be sent on RF or the power line (default is False)|
 +
 +==== Send Scene Fast ON ====
 +
 +This command will send an INSTEON Scene Fast ON command to the specified PowerLinc scene.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.insteon.sendSceneFastOn(11)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOn(11,​ sendCleanUps=False)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOn(11,​ suppressLogging=True)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOn(11,​ updateStatesOnly=True)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOn("​working in office scene"​)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOn("​working in office scene",​ sendCleanUps=False)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer or string ​ |either the scene number or the scene name - we encourage numbers since they won't change and the scene names can.|
 +|//''​sendCleanUps''//​| ​ No  |  boolean ​ |a boolean indicating if cleanup messages should be sent to each device in the scene after the scene command - this will have the PowerLinc send each device a message to make sure it received the command. You might want to stop cleanup messages from being sent because it involves adding a lot of INSTEON traffic and might effect performance (particularly if a group has a lot of responders). But, of course, disabling it may reduce reliability of some modules receiving the scene command so it's usually best to ignore this setting. (default is True)|
 +|//''​suppressLogging''//​| ​ No  |  boolean ​ |a boolean indicating if entries in the event log should be suppressed (default is False)|
 +|//''​updateStatesOnly''//​| ​ No  |  boolean ​ |use if you only want Indigo'​s internal device state representation to be updated - no actual INSTEON command will be sent on RF or the power line (default is False)|
 +
 +==== Send Scene Fast OFF ====
 +
 +This command will send an INSTEON Scene Fast OFF command to the specified PowerLinc scene.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.insteon.sendSceneFastOff(11)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOff(11,​ sendCleanUps=False)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOff(11,​ suppressLogging=True)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOff(11,​ updateStatesOnly=True)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOff("​working in office scene"​)</​code>​|
 +|<​code>​indigo.insteon.sendSceneFastOff("​working in office scene",​ sendCleanUps=False)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer or string ​ |either the scene number or the scene name - we encourage numbers since they won't change and the scene names can.|
 +|//''​sendCleanUps''//​| ​ No  |  boolean ​ |a boolean indicating if cleanup messages should be sent to each device in the scene after the scene command - this will have the PowerLinc send each device a message to make sure it received the command. You might want to stop cleanup messages from being sent because it involves adding a lot of INSTEON traffic and might effect performance (particularly if a group has a lot of responders). But, of course, disabling it may reduce reliability of some modules receiving the scene command so it's usually best to ignore this setting. (default is True)|
 +|//''​suppressLogging''//​| ​ No  |  boolean ​ |a boolean indicating if entries in the event log should be suppressed (default is False)|
 +|//''​updateStatesOnly''//​| ​ No  |  boolean ​ |use if you only want Indigo'​s internal device state representation to be updated - no actual INSTEON command will be sent on RF or the power line (default is False)|
  
indigo_5_documentation/insteon_specific_commands.txt ยท Last modified: 2019/01/25 22:53 (external edit)
 

© Perceptive Automation, LLC. · Privacy