This shows you the differences between two versions of the page.
indigo_5_documentation:x10_specific_commands [2019/01/25 22:53] |
indigo_5_documentation:x10_specific_commands [2019/01/26 00:10] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== X10 Commands (indigo.x10.*) ====== | ||
+ | |||
+ | Commands that are specific to X10 devices. | ||
+ | |||
+ | ==== Send Address ==== | ||
+ | |||
+ | This command will send an x10 address to the interface with NO function code. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code> indigo.x10.sendAddress("A1")</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address| | ||
+ | |//''suppressLogging''//| No | boolean |//''True''// to keep the request from being logged into the event log window (default is //''False''//) | ||
+ | |||
+ | ==== Send Brighten ==== | ||
+ | |||
+ | This will send the Brighten command to an x10 address. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code> indigo.x10.sendBrighten("A1", delta=15)</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address| | ||
+ | |//''delta''//| Yes | integer |the amount to brighten by relative to the current brightness - valid values from 1 to 100 | | ||
+ | |//''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 X10 commands will be sent (default is False)| | ||
+ | |||
+ | ==== Send Dim ==== | ||
+ | |||
+ | This will send the Dim command to an x10 address. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code> indigo.x10.sendDim("A1", delta=15)</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address| | ||
+ | |//''delta''//| Yes | integer |the amount to dim by relative to the current brightness - valid values from 1 to 100 | | ||
+ | |//''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 X10 commands will be sent (default is False)| | ||
+ | |||
+ | ==== Send Extended ==== | ||
+ | |||
+ | This will send an Extended command to an x10 address. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code> indigo.x10.sendExtended("A1", data=10, command=128)</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address | | ||
+ | |//''command''//| Yes | integer |the comand to send | | ||
+ | |//''data''//| Yes | integer |the data to send | | ||
+ | |//''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 X10 commands will be sent (default is False)| | ||
+ | |||
+ | ==== Send Hail Request ==== | ||
+ | |||
+ | This will send a Hail Request command to the interface. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code> indigo.x10.sendHailRequest("A1")</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address | | ||
+ | |//''suppressLogging''//| No | boolean |a boolean indicating if entries in the event log should be suppressed (default is False)| | ||
+ | |||
+ | ==== Send Hail Reply ==== | ||
+ | |||
+ | This will send a Hail Reply command to the interface. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code> indigo.x10.sendHailReply("A1")</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address | | ||
+ | |//''suppressLogging''//| No | boolean |a boolean indicating if entries in the event log should be suppressed (default is False)| | ||
+ | |||
+ | ==== Send On ==== | ||
+ | |||
+ | This will send an ON command to an x10 address. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code>indigo.x10.sendOn("A1")</code>| | ||
+ | |<code>indigo.x10.sendOn("A1", suppressLogging=True)</code>| | ||
+ | |<code>indigo.x10.sendOn("A1", updateStatesOnly=True)</code>| | ||
+ | |<code>indigo.x10.sendOn("A1", suppressLogging=True, updateStatesOnly=True)</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address | | ||
+ | |//''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 X10 commands will be sent (default is False)| | ||
+ | |||
+ | ==== Send Off ==== | ||
+ | |||
+ | This will send an OFF command to an x10 address. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code>indigo.x10.sendOff("A1")</code>| | ||
+ | |<code>indigo.x10.sendOff("A1", suppressLogging=True)</code>| | ||
+ | |<code>indigo.x10.sendOff("A1", updateStatesOnly=True)</code>| | ||
+ | |<code>indigo.x10.sendOff("A1", suppressLogging=True, updateStatesOnly=True)</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address | | ||
+ | |//''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 X10 commands will be sent (default is False)| | ||
+ | |||
+ | ==== Send Status Response On ==== | ||
+ | |||
+ | This will send a Status Response On command to the interface. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code> indigo.x10.sendStatusResponseOn("A1")</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address | | ||
+ | |//''suppressLogging''//| No | boolean |a boolean indicating if entries in the event log should be suppressed (default is False)| | ||
+ | |||
+ | ==== Send Status Response Off ==== | ||
+ | |||
+ | This will send a Status Response Off command to the interface. | ||
+ | |||
+ | ^ Command Syntax Examples ^ | ||
+ | |<code> indigo.x10.sendStatusResponseOff("A1")</code>| | ||
+ | |||
+ | ^ Parameters ^^^^ | ||
+ | ^ Parameter ^ Required ^ Type ^ Description ^ | ||
+ | |direct parameter| Yes | string |X10 address | | ||
+ | |//''suppressLogging''//| No | boolean |a boolean indicating if entries in the event log should be suppressed (default is False)| | ||