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:device_class [2013/03/07 23:03]
mattb [Class Properties]
indigo_5_documentation:device_class [2019/01/25 22:53] (current)
Line 1: Line 1:
 +====== Devices ======
  
 +In the IOM, all devices are derived from a common //''​Device''//​ base class. This base class provides for all the common properties of a device (including devices defined by Server plugins) and each subclass also inherits all the commands in the device command namespace (//''​indigo.device.*''//​) - there are a few exceptions that will be noted below. Check out the examples for each section to see how you use each device type.
 +
 +Like other high-level objects in Indigo, there are rules for modifying devices. For Scripters and Plugin Developers:
 +
 +  * To create, duplicate, delete, and send commands to a device, use the appropriate command namespace as defined below
 +  * To modify an device'​s definition get a copy of the device, make the necessary changes, then call //''​myDevice.replaceOnServer()''//​
 +
 +For Plugin Developers:
 +
 +  * To update a plugin'​s props on a device on the server, call //''​myDevice.replacePluginPropsOnServer(newPropsDict)''//​ rather than try to update them on the local device
 +  * To change a device'​s state on the server, use //''​myDevice.updateStateOnServer(key="​keyName",​ value="​Value"​)''//​
 +===== Device Base Class =====
 +
 +The //''​Device''//​ class is generally used as a base class - your script will use objects that are instances of one of it’s subclasses - we'll discuss each of the subclasses later in this section. First, a quick refresher on a fundamental aspect of devices: some devices can only be controlled (i.e. old-style ApplianceLincs,​ most X10 devices, etc.), called responders in Indigo terminology,​ other devices are only controllers (i.e. RemoteLincs,​ PalmPads, etc.), and some devices are both responders and controllers (i.e. KeypadLincs).
 +
 +This terminology was really invented for INSTEON devices, but we think it applies to other technologies as well but perhaps in a slightly different way. In any event, controller devices can support a number of buttons and/or a number of groups from which commands are sent, all of which Indigo can use to trigger actions. From a technical and practical standpoint, they are in fact the same thing so a single number, indexed based on how the device supports them, is how this property should be used.
 +
 +The base class supports getting the number of buttons or groups as a single property (buttonGroupCount) for the device. Use that count as a guide to what you can pass in the various trigger classes. For any device that doesn’t support local physical buttons or sending group commands and/or status commands, the number returned should be 0.
 +
 +If you’re writing a plugin that defines devices, they will automatically inherit all of the following properties.
 +==== Device Base Class Properties ====
 +
 +^Property ^  Type  ^  Writable ​ ^Description ^
 +|//''​address''//​| ​ string ​ |  No  |the address for the device |
 +|//''​buttonGroupCount''//​| ​ integer ​ |  No  |the number of groups (or buttons in the case of the RemoteLinc and ControLinc) that the controller supports - currently used only for INSTEON devices - 0 for other devices|
 +|//''​description''//​| ​ string ​ |  Yes  |a description of the device as specified by the user|
 +|//''​deviceTypeId''//​| ​ string ​ |  No  |the typeId specified in the Devices.xml (or it’s documentation) - only used for plugin defined devices|
 +|//''​enabled''//​| ​ boolean ​ |  No  |is the device enabled - set using the //''​indigo.device.enable()''//​ method|
 +|//''​folderId''//​| ​ integer ​ |  No  |the unique ID of the folder this device is in (0 if it's not in a folder) - use //''​moveToFolder()''//​ method to change|
 +|//''​globalProps''//​| ​ dictionary ​ |  No  |an //''​indigo.Dict()''//​ representing all name/value pairs associated with this device - each plugin will have it's own dictionary (//''​globalProps[pluginId]''//​) - see [[#​about_plugin_properties|About Plugin Properties]] below for details|
 +|//''​id''//​| ​ integer ​ |  No  |id or instance of the device, assigned on creation by IndigoServer|
 +|//''​lastChanged''//​| ​ datetime ​ |  No  |the last date/time that the device was changed - populated by IndigoServer|
 +|//''​model''//​| ​ string ​ |  No  |the model name of the device - defined either by Indigo based on type or by the plugin'​s device definition|
 +|//''​name''//​| ​ string ​ |  Yes  |the unique name of the device - no two devices can have the same name|
 +|//''​pluginId''//​| ​ string ​ |  No  |if protocol is //''​Plugin''//,​ the string ID for the plugin|
 +|//''​pluginProps''//​| ​ dictionary ​ |  No  |an //''​indigo.Dict()''//​ representing the name/value pairs defined by your plugin for the device - plugin developers should publish this information if you want other plugins/​scripts to create devices of this type - see [[#​about_plugin_properties|About Plugin Properties]] below for details - use //''​replacePluginPropsOnServer()''//​ method to change|
 +|//''​protocol''//​| ​ ''//​[[#​protocol_enumeration|kProtocol]]//'' ​ |  No  |an enumeration specifying the protocol of the device - see protocol enumeration below for possible values|
 +|//''​remoteDisplay''//​| ​ boolean ​ |  Yes  |should this device be displayed in remote clients (IWS, Indigo Touch, etc) - may also be set with //''​indigo.device.displayInRemoteUI()''//​|
 +|//''​states''//​| ​ dictionary ​ |  No  |returns an indigo.Dict() of device states - the key is the state id and the value is the value. Note that enumerated states will have not only the state, but also each option for the state. So, for instance, if I had a state called //status// and it had 3 options (//​online//,​ //​offline//,​ //error//), then you'd not only have //status// as a key, but also //​status.online//,​ //​status.offline//,​ and //​status.error//​ as keys in the dictionary. This is so that you can test each state enumeration independently in trigger actions (e.g. //​status.online//​ is true).|
 +|//''​supportsAllLightsOnOff''//​| ​ boolean ​ |  No  |indicates that this device should react to  all lights On and all lights Off commands - always False for plugin defined devices|
 +|//''​supportsAllOff''//​| ​ boolean ​ |  No  |indicates that this device should react to  all Off commands - always False for plugin defined devices|
 +|//''​supportsStatusRequest''//​| ​ boolean ​ |  No  |indicates if the device supports querying the status - always False for plugin defined devices|
 +
 +== Protocol Enumeration ==
 +
 +^  indigo.kProtocol ​ ^^
 +^//''​Value''// ​ ^Description ​ ^
 +|//''​Insteon''// ​ |identifies the device as an INSTEON device|
 +|''//​X10//'' ​ |identifies the device as an X10 device|
 +|//''​ZWave''// ​ |identifies the device as an Z-Wave device|
 +|//''​Plugin''// ​ |identifies the device as a being defined by a plugin|
 +
 +==== About Plugin Properties ====
 +
 +Devices have properties - some are class properties, defined by the class itself. One of the biggest requests we've gotten in the past is some way to add arbitrary properties to a device - so that you could store your own data with the device in the database. And with plugin defined devices, we needed a place to store the properties that you need to operate the device. That's what the //''​pluginProps''//​ and //''​globalProps''//​ represent - the additional properties that are not defined by the class. //''​globalProps''//​ is a dictionary of every additional property defined for the device - each plugin has it's own dictionary of props in here which are readable by anyone. //''​pluginProps''//​ is a shortcut to get to your plugin'​s props and are only writable by your plugin once the plugin has been created - a script can create a device supplied by your plugin along with the necessary properties, which are passed in on the //''​create()''//​ method. You should publish the properties necessary to make your device work so that scripters can create your devices.
 +
 +We mentioned before that devices were read-only, and that's true, and that you'd need to use commands in a different command name space. That's //​**mostly**//​ true. Here's one exception to that rule: to change a device'​s pluginProps (it must be "​owned"​ by your plugin - that is, the pluginId must be set to your id), you use a method that's in the device'​s class: replacePluginPropsOnServer(). Here's an example:
 +
 +<​code>​dev=indigo.devices[123]
 +localPropsCopy = dev.pluginProps
 +localPropsCopy["​pollInterval"​] = 10
 +dev.replacePluginPropsOnServer(localPropsCopy)</​code>​
 +
 +You would use this technique if you wanted to just change some of the properties that are already defined. Because this method replaces ALL of the properties for your plugin in the device, you can just set them all in one call:
 +
 +<​code>​dev=indigo.devices[123]
 +dev.replacePluginPropsOnServer({"​pollInterval":​10,"​checkForUpdates":​True})</​code>​
 +
 +Note, though, that if you have a //''<​ConfigUI>''//​ defined for the device, those properties are also stored here - so in order to make sure your device works correctly you must include those properties as well. If you need to update several properties in your props dict, you can use the //''​update()''//​ method:
 +
 +<​code>​dev=indigo.devices[123]
 +localPropsCopy = dev.pluginProps
 +localPropsCopy.update({"​pollInterval":​10,"​checkForUpdates":​True})
 +dev.replacePluginPropsOnServer(localPropsCopy)</​code>​
 +
 +The //''​update()''//​ method will change the properties specified, and add the property if it doesn'​t exist. Now, you might be wondering - why do the extra //''​localPropsCopy = dev.pluginProps''//​ rather than just modify the props in place:
 +
 +<​code>​dev=indigo.devices[123]
 +dev.pluginProps.update({"​pollInterval":​10,"​checkForUpdates":​True})
 +dev.replacePluginPropsOnServer(dev.pluginProps)</​code>​
 +
 +Because the dev object is read-only - when you reference //''​dev.pluginProps''//,​ it returns a copy rather than returning a reference to the read-only object. So, in effect, you'd be modifying a copy. But, because you aren't saving a reference to that copy, it goes away since the next time you reference //''​dev.pluginProps''//​ another copy is made.
 +
 +If you need to just dump all the properties for a device, you can just:
 +
 +<​code>​dev=indigo.devices[123]
 +dev.replacePluginPropsOnServer(None)</​code>​
 +
 +That will completely remove your properties from the device.
 +
 +==== About Custom Device States ====
 +
 +If you are a Developer and your plugin defines custom devices, then those devices will also need to define a collection of states. For instance, let's look at the states defined in a custom device'​s Devices.xml:​
 +
 +<​code><​States>​
 +    <State id="​playStatus">​
 +        <​ValueType>​
 +            <​List>​
 +                <Option value="​playing">​Playing</​Option>​
 +                <Option value="​paused">​Paused</​Option>​
 +                <Option value="​stopped">​Stopped</​Option>​
 +                <Option value="​unavailable">​Unavailable</​Option>​
 +            </​List>​
 +        </​ValueType>​
 +        <​TriggerLabel>​Player Status Changed</​TriggerLabel>​
 +        <​TriggerLabelPrefix>​Player Status is</​TriggerLabelPrefix>​
 +        <​ControlPageLabel>​Current Player Status</​ControlPageLabel>​
 +        <​ControlPageLabelPrefix>​Player Status is</​ControlPageLabelPrefix>​
 +    </​State>​
 +    <State id="​sep1">​
 +        <​ValueType>​Separator</​ValueType>​
 +    </​State>​
 +    <State id="​playlist">​
 +        <​ValueType>​String</​ValueType>​
 +        <​TriggerLabel>​Current Playlist Name</​TriggerLabel>​
 +        <​ControlPageLabel>​Current Playlist Name</​ControlPageLabel>​
 +    </​State>​
 +    <State id="​album">​
 +        <​ValueType>​String</​ValueType>​
 +        <​TriggerLabel>​Current Album</​TriggerLabel>​
 +        <​ControlPageLabel>​Current Album</​ControlPageLabel>​
 +    </​State>​
 +    <State id="​artist">​
 +        <​ValueType>​String</​ValueType>​
 +        <​TriggerLabel>​Current Artist</​TriggerLabel>​
 +        <​ControlPageLabel>​Current Artist</​ControlPageLabel>​
 +    </​State>​
 +    <State id="​track">​
 +        <​ValueType>​String</​ValueType>​
 +        <​TriggerLabel>​Current Track</​TriggerLabel>​
 +        <​ControlPageLabel>​Current Track</​ControlPageLabel>​
 +    </​State>​
 +    <State id="​volume">​
 +        <​ValueType>​Integer</​ValueType>​
 +        <​TriggerLabel>​Current Volume</​TriggerLabel>​
 +        <​ControlPageLabel>​Current Volume</​ControlPageLabel>​
 +    </​State>​
 +    <State id="​shuffle">​
 +        <​ValueType boolType="​YesNo">​Boolean</​ValueType>​
 +        <​TriggerLabel>​Shuffling</​TriggerLabel>​
 +        <​ControlPageLabel>​Shuffling</​ControlPageLabel>​
 +    </​State>​
 +</​States>​
 +<​UiDisplayStateId>​playStatus</​UiDisplayStateId>​
 +</​code>​
 +
 +You'll recall from the [[plugin_guide#​custom_device_type|Custom Device Type]] section of the developers guide, these define the states that are used in various places in the UI and by other objects (triggers, control pages, etc). So, the question is now that the server understands the structure of your devices'​ states, how do you change them?
 +
 +It's actually pretty simple. When your plugin detects a change in one of the states, you just call the //''​updateStateOnServer("​id",​value="​value"​)''//​ method. Here are some examples for setting the state based on the above state definitions:​
 +
 +<​code>#​ assume that someMusicServer represents a device with the above states
 +# to update the volume state
 +someMusicServer.updateStateOnServer("​volume",​ value=50)
 +
 +# to update the track name
 +someMusicServer.updateStateOnServer("​track",​ value="​Cluster One")
 +
 +# to update the album name
 +someMusicServer.updateStateOnServer("​album",​ value="​The Division Bell")
 +
 +# to update the artist name
 +someMusicServer.updateStateOnServer("​artist",​ value="​Pink Floyd"​)
 +
 +# to update the playStatus
 +someMusicServer.updateStateOnServer("​playStatus",​ value="​playing"​)
 +
 +# to update the playStatus
 +someMusicServer.updateStateOnServer("​shuffle",​ value=True)</​code>​
 +
 +<color red>​Note</​color>​ - for states that have a //''<​ValueType>''//​ of //''​Number''//,​ you pass an integer or float; for states that are //''​Boolean''//,​ you pass Python //''​True''//​ or //''​False''//;​ all others pass a string.
 +
 +It's just that simple. This will cause any triggers on the server that are set on your device'​s states to be fired. It will update any visible control pages. It will show the state that's defined in the //''<​UiDisplayStateId>''//​ element in the Mac device table'​s **''​State''​** column.
 +
 +The //''​updateStateOnServer''//​ method has 2 optional parameters: //''​decimalPlaces''//​ (integer) and //''​triggerEvents''//​ (boolean). When updating floating point state values use the //''​decimalPlaces''//​ parameter to specify the number of fractional digits to store and display. For example:
 +
 +<​code>​someThermmostateDevice.updateStateOnServer("​mainTemp"​ value=76.1234,​ decimalPlaces=2)</​code>​
 +
 +instructs the Indigo Server to store and display the value as 76.12.
 +
 +The //''​triggerEvents''//​ parameter can be set to False (defaults to True) to have the Indigo Server update the state but ignore any Device State Changed triggers that should be processed as a result of the state change.
 +
 +==== Commands (indigo.device.*) ====
 +
 +=== All Off ===
 +
 +Turns off all devices for all protocols unless a direct parameter is specified. The direct parameter, if specified, will determine which devices will be turned off. In the context of this command, devices are defined as all dimmable (light) and relay (appliance) devices and does not include other device types that may have an on/off state. This command doesn’t work for plugin defined devices regardless of type.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.allOff()</​code> ​ |
 +|<​code>​indigo.device.allOff(indigo.kAllDeviceSel.HouseCodeA)</​code> ​ |
 +|<​code>​indigo.device.allOff(indigo.kAllDeviceSel.Insteon)</​code> ​ |
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  //''​[[#​all_device_selector_enumeration|kAllDeviceSel]]''// ​ |enumerated value to indicate which devices to turn off, all if no parameter is passed - see the //''​kAllDeviceSel''//​ enumeration for a full description|
 +
 +== All Device Selector Enumeration ==
 +
 +^  //''​indigo.kAllDeviceSel''// ​ ^^
 +^  Enumerated Type  ^  Description ​ ^
 +|//''​Insteon''//​|specify all INSTEON devices that support ON/OFF|
 +|//''​X10''//​|specify all X10 devices that support ON/OFF|
 +|//''​ZWave''//​|specify all Z-Wave devices that support ON/OFF|
 +|//''​HouseCodeA''//​|specify all X10 devices in house code A|
 +|//''​HouseCodeB''//​|specify all X10 devices in house code B|
 +|//''​HouseCodeC''//​|specify all X10 devices in house code C|
 +|//''​HouseCodeD''//​|specify all X10 devices in house code D|
 +|//''​HouseCodeE''//​|specify all X10 devices in house code E|
 +|//''​HouseCodeF''//​|specify all X10 devices in house code F|
 +|//''​HouseCodeG''//​|specify all X10 devices in house code G|
 +|//''​HouseCodeH''//​|specify all X10 devices in house code H|
 +|//''​HouseCodeI''//​|specify all X10 devices in house code I|
 +|//''​HouseCodeJ''//​|specify all X10 devices in house code J|
 +|//''​HouseCodeK''//​|specify all X10 devices in house code K|
 +|//''​HouseCodeL''//​|specify all X10 devices in house code L|
 +|//''​HouseCodeM''//​|specify all X10 devices in house code M|
 +|//''​HouseCodeN''//​|specify all X10 devices in house code N|
 +|//''​HouseCodeO''//​|specify all X10 devices in house code O|
 +|//''​HouseCodeP''//​|specify all X10 devices in house code P|
 +
 +=== Create ===
 +
 +Create a device. You can create devices that are defined by your plugin, in other plugins, and X10 devices (FIXME you can't currently add INSTEON devices because they need to perform some action to actually make the device function). You use this method to create ALL device types - it will return a device of the correct class to you based on the arguments. It can be considered the "​device"​ factory method.
 +
 +This method returns a **copy** of the newly created device.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.create(protocol=indigo.kProtocol.Plugin,​
 +    address="​F8",​
 +    name="​Device Name Here", ​
 +    description="​Description Here", ​
 +    pluginId="​com.mycompany.pluginId",​
 +    deviceTypeId="​myDeviceTypeId",​
 +    props={"​propA":"​value","​propB":"​value"​},​
 +    folder=1234)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|''//​address//''​| ​ No  |  string ​ |the address of the X10 device - plugins must set an //''​address''//​ property in their property dictionary|
 +|''//​description//''​| ​ No  |  string ​ |the description of the device|
 +|''//​deviceTypeId//''​| ​ Yes  |  string ​ |the id of the device type – defined by the plugin or one of the defined X10 devices FIXME link here|
 +|//''​name''//​| ​ Yes  |  string ​ |the name of the device|
 +|''//​pluginId//''​| ​ No  |  string ​ |the plugin ID - defaults to your plugin'​s id if in a [[#​indigo_server_plugins|Server Plugin]]|
 +|''//​props//''​| ​ No  |  dictionary ​ |this is the properties for the device - they will be inserted in to the pluginId'​s property space as supplied above. If you are creating a device of a type defined in a different plugin, it's that plugin'​s id and properties.|
 +|''//​protocol//''​| ​ Yes  |  ''//​[[#​protocol_enumeration|kProtocol]]//'' ​ |the protocol for the device (//''​indigo.kProtocol.Plugin''//​ or //''​indigo.kProtocol.X10''//​)|
 +|''//​folder//''​| ​ No  |  integer ​ |id or instance of the folder in which to put the newly created device|
 +
 +=== Delete ===
 +
 +Delete the specified device regardless of it’s type.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.delete(123)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device to delete|
 +
 +=== Duplicate ===
 +
 +Duplicate the specified device regardless of the type. This method returns a copy of the new device.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.duplicate(123,​ duplicateName="​New Name"​)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device to duplicate|
 +|//''​duplicateName''//​| ​ No  |  string ​ |name for the newly duplicated device|
 +
 +=== Enable/​Disable ===
 +
 +Enable/​Disable the specified device regardless of the type.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.enable(123,​ value=True) #enable
 +indigo.device.enable(123,​ value=False) #​disable</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device to enable/​disable|
 +|//''​value''//​| ​ No  |  boolean ​ |//''​True''//​ to enable, //''​False''//​ to disable|
 +
 +=== Move To Folder ===
 +
 +Use this command to move the device to a different folder.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.moveToFolder(123,​ value=987)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|//''​value''//​| ​ Yes  |  integer ​ |id or instance of the folder to move the device to|
 +
 +=== Remove Delayed Actions ===
 +
 +This command will remove delayed actions for the specified device. ​
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.removeDelayedActions(123)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ No  |  integer ​ |id or instance of the device|
 +
 +=== Set Remote Display ===
 +
 +Use this command to set the remote display flag for the folder.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.displayInRemoteUI(123,​ value=True)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|//''​value''//​| ​ Yes  |  boolean ​ |True to display the device on remote user interfaces or False to hide it|
 +
 +=== Status Request ===
 +
 +This tells IndigoServer to send a status request command to the specified device and refresh it’s status.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.statusRequest(123)</​code>​|
 +|<​code>​indigo.device.statusRequest(123,​ suppressLogging=True)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |the id of the device|
 +|//''​suppressLogging''//​| ​ No  |  boolean ​ |//''​True''//​ to keep the request from being logged into the event log window (default is //''​False''//​)|
 +
 +=== Toggle ===
 +
 +This tells IndigoServer to toggle a device from on to off or vice versa depending on it’s current state. This command only works for device types that can be turned on and off.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.toggle(123)</​code>​|
 +|<​code>​indigo.device.toggle(123,​ delay=10, duration=300)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|//''​delay''//​| ​ No  |  integer ​ |number of seconds to delay before toggling the device|
 +|//''​duration''//​| ​ No  |  integer ​ |number of seconds delay before the device toggles back to it’s original state|
 +
 +=== Turn Off ===
 +
 +This tells IndigoServer to turn off a device. This command only works for device types that can be turned on and off.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.turnOff(123)</​code>​|
 +|<​code>​indigo.device.turnOff(123,​ delay=10, duration=300)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|//''​delay''//​| ​ No  |  integer ​ |number of seconds to delay before turning off the device|
 +|//''​duration''//​| ​ No  |  integer ​ |number of seconds delay before the device turns back on|
 +
 +=== Turn On ===
 +
 +This tells IndigoServer to turn on a device. This command only works for device types that can be turned on and off.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.device.turnOn(123)</​code>​|
 +|<​code>​indigo.device.turnOn(123,​ delay=10, duration=300)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|//''​delay''//​| ​ No  |  integer ​ |number of seconds to delay before turning on the device|
 +|//''​duration''//​| ​ No  |  integer ​ |number of seconds delay before the device turns back off|
 +
 +==== Examples ====
 +
 +Here’s a side by site comparison of using various device properties in Python and AppleScript:​
 +
 +^  Python ​ ^  AppleScript ​ ^
 +|<​code>#​ Creating a device
 +myDevice = indigo.device.create(protocol=indigo.kProtocol.X10,​
 +    name="​Office Lamp",
 +    description="​X10 Lamp module",​
 +    address="​F7",​
 +    deviceTypeId:"​LampLinc Plus Plug-In Dimmer"​)</​code>​|<​code>​-- Creating a device
 +set myDevice to make new device with properties {type:​x10,​¬
 +    name:"​Office Lamp",​¬
 +    description:"​X10 Lamp module",​¬
 +    address:"​F7",​¬
 +    model:"​LampLinc Plus Plug-In Dimmer"​}</​code>​|
 +|<​code>#​ Getting a device
 +myDevice = indigo.devices[123]</​code>​|<​code>​-- Getting a device
 +set myDevice to device "​Office Lamp"</​code>​|
 +|<​code>#​ Logging a message if it’s an X10 device
 +if (myDevice.protocol == indigo.kProtocol.X10):​
 +    indigo.server.log("​device is an X10 device"​)
 +    ​
 +</​code>​|<​code>​-- Logging a message if it’s an X10 device
 +if type of mydevice is "​x10"​ then
 +    log "​device is an X10 device"​
 +end if</​code>​|
 +|<​code>#​ Logging a message if it’s showing in Indigo Touch
 +if (myDevice.remoteDisplay):​
 +    indigo.server.log("​device is showing in Indigo Touch"​)
 +
 +
 +</​code>​|<​code>​-- Logging a message if it’s showing in Indigo Touch
 +if display in remote ui of myDevice then
 +    log "​device is showing in Indigo Touch"
 +end if</​code>​|
 +|<​code>#​ Setting the folder ID that the device is in
 +indigo.device.setFolder(myDevice,​ 987)</​code>​|<​code>​-- Folder ID is not available in AppleScript
 +
 +
 +</​code>​|
 +|<​code>#​ Turning off all devices (dimmer and relay)
 +indigo.device.allOff()
 +
 +# Turning off all devices in X10 house code A
 +indigo.device.allOff(indigo.kAllDeviceSel.HouseCodeA)
 +
 +# Turning off all INSTEON devices
 +indigo.device.allOff(indigo.kAllDeviceSel.Insteon)</​code>​|<​code>​-- Turning off all devices (dimmer and relay)
 +all off
 +
 +-- Turning off all devices in X10 house code A
 +all lights off "​A"​
 +
 +-- Turning off all INSTEON devices is not available in
 +-- AppleScript</​code>​|
 +
 +
 +===== DimmerDevice =====
 +
 +Dimmer devices are dimmable light modules. They can be turned on and off and their brightness may be set. Your script may manipulate any dimmer device. You may specify that devices defined by your plugin are of this type. The standard dimmer UI in the various clients will be presented to users attempting to control your device.
 +
 +==== Class Properties ====
 +
 +^  Property ​ ^  Type  ^  Writable ​ ^  Description ​ ^
 +|//''​brightness''//​| ​ integer ​ |  No  |an integer from 0-100 indicating the brightness of the device - plugin developers may decide if their device may be on but have a brightness of 0 (non-standard) - set using commands below|
 +|//''​ledStates''//​| ​ list  |  No  |this is a list of booleans that represent the state of LEDs on the device. So, to check to see if LED 3 is on you'd check dev.ledStates[2] (Python arrays are 0-based so the first element is element 0). Currently, only KPL devices use this array - however, future devices may use it as well so you should probably check the length first to make sure that the LED you're looking for is actually there. Use the len(dev.ledStates) method to see how many entries there are before you access a specific index.|
 +|//''​onState''//​| ​ boolean ​ |  No  |indicates whether the device is on - set using commands below|
 +
 +==== Commands (indigo.dimmer.*) ====
 +
 +=== All Lights Off ===
 +
 +Turns off all lights for all protocols unless a direct parameter is specified. The direct parameter, if specified, will determine which lights will be turned off. Lights are defined as all dimmable devices. This command doesn’t work for plugin defined devices regardless of type.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.dimmer.allLightsOff()</​code>​|
 +|<​code>​indigo.dimmer.allLightsOff(indigo.kAllDeviceSel.HouseCodeA)</​code>​|
 +|<​code>​indigo.dimmer.allLightsOff(indigo.kAllDeviceSel.Insteon)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ No  |''//​[[#​all_device_selector_enumeration|kAllDeviceSel]]//''​|enumerated value to indicate which devices to turn off, all if no parameter is passed - see the [[#​all_device_selector_enumeration|kAllDeviceSel]] enumeration for a full description|
 +
 +=== All Lights On ===
 +
 +Turns on all lights for all protocols unless a direct parameter is specified. The direct parameter, if specified, will determine which lights will be turned on. Lights are defined as all dimmable devices. This command doesn’t work for plugin defined devices regardless of type.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.dimmer.allLightsOn()</​code>​|
 +|<​code>​indigo.dimmer.allLightsOn(indigo.kAllDeviceSel.HouseCodeA)</​code>​|
 +|<​code>​indigo.dimmer.allLightsOn(indigo.kAllDeviceSel.Insteon)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ No  |  ''//​[[#​all_device_selector_enumeration|kAllDeviceSel]]//'' ​ |enumerated value to indicate which lights to turn on, all if no parameter is passed - see the [[#​all_device_selector_enumeration|kAllDeviceSel]] enumeration for a full description|
 +
 +=== Brighten ===
 +
 +Changes the brightness of the specified light relative to the current brightness. ​
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.dimmer.brighten("​Office Lamp"​)</​code>​|
 +|<​code>​indigo.dimmer.brighten(123)</​code>​|
 +|<​code>​indigo.dimmer.brighten("​Office Lamp", by=50, delay=4)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​by//''​| ​ No  |  integer ​ |relative amount to brighten by where brightness is 0-100|
 +|''//​delay//''​| ​ No  |  integer ​ |number of seconds to delay before executing the brighten command|
 +
 +=== Dim ===
 +
 +Dim the brightness of the specified light by some amount relative to the current brightness.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.dimmer.dim("​Office Lamp"​)</​code>​|
 +|<​code>​indigo.dimmer.dim(123)</​code>​|
 +|<​code>​indigo.dimmer.dim("​Office Lamp", by=50, delay=4)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​by//''​| ​ No  |  integer ​ |relative amount to dim by where dimness is 0-100 |
 +|''//​delay//''​| ​ No  |  integer ​ |number of seconds to delay before executing the dim command|
 +
 +=== Set Brightness ===
 +
 +Changes the brightness of the specified light to a specific value.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.dimmer.setBrightness(123,​ value=75)</​code>​|
 +|<​code>​indigo.dimmer.setBrightness(123,​ value=75, delay=360)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​value//''​| ​ Yes  |  integer ​ |absolute value to set the brightness to on a scale of 0-100|
 +|''//​delay//''​| ​ No  |  integer ​ |number of seconds to delay before executing the dim command|
 +
 +=== Set LED State ===
 +
 +Turns on/off the specified LED. Useful for KeypadLinc (and similar) devices. <color red>​Note</​color>:​ you can't use this method to control the LED of the button(s) that control the direct load - use Turn ON/Turn OFF for those.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.dimmer.setLedState(123,​ index=0, value=True)</​code>​|
 +|<​code>​indigo.dimmer.setLedState(123,​ index=0, value=True, suppressLogging=True)</​code>​|
 +|<​code>​indigo.dimmer.setLedState(123,​ index=0, value=True, updateStatesOnly=True)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​index//''​| ​ Yes  |  integer ​ |the index of the button. Recall that Python-based arrays are 0-based, so the index is also 0-based. That is, the first object in an array is object 0.|
 +|''//​value//''​| ​ Yes  |  boolean ​ |True to turn on the LED, False to turn it off|
 +|''//​suppressLogging//''​| ​ No  |  boolean ​ |True to suppress logging (defaults to False)|
 +|''//​updateStatesOnly//''​| ​ No  |  boolean ​ |True to only update Indigo'​s internal state - no command will be sent to the KPL (defaults to False)|
 +
 +=== Set On State ===
 +
 +Use the Turn On, Turn Off, and Toggle methods to turn on/off a dimmer device.
 +
 +==== Examples ====
 +
 +Here’s a side by site comparison of dimmer properties in Python and AppleScript:​
 +
 +^  Python ​ ^  AppleScript^
 +|<​code>#​ Getting a device
 +myDevice = indigo.devices[123]</​code>​|<​code>​-- Getting a device
 +set myDevice to device "​Office Lamp"</​code>​|
 +|<​code>#​ Set a device’s brightness to 75 if it’s currently
 +# less than that, but only if it’s turned on
 +myDevice = indigo.devices[123]
 +if ((myDevice.brightness < 75) and 
 +    (myDevice.onState)):​
 + indigo.dimmer.setBrightness(myDevice,​ 75)</​code>​|<​code>​-- Set a device’s brightness to 75 if it’s currently
 +-- less than that, but only if it’s turned on
 +if ((brightness of device "​Office Lamp" < 75) and ¬
 +    (on state of device "​Office Lamp"​)) then
 + set brightness of device "​Office Lamp" to 75
 +end if</​code>​|
 +|<​code>#​ Brighten a light by 25% after 10 minutes
 +indigo.dimmer.brighten(123,​ by=25, delay=600)
 +</​code>​|<​code>​-- Brighten a light by 25% after 10 minutes
 +brighten "​Office Lamp" by 25 in 600</​code>​|
 +|<​code>#​ Logging a message if it’s showing in Indigo Touch
 +myDevice = indigo.devices[123] ​
 +if (myDevice.remoteDisplay):​
 + indigo.server.log("​device is showing in Indigo Touch"​)</​code>​|<​code>​-- Logging a message if it’s showing in Indigo Touch
 +if display in remote ui of device "​Office Lamp" then
 + log "​device is showing in Indigo Touch"
 +end if</​code>​|
 +|<​code>#​ Getting the folder ID that the device is in
 +myDevice = indigo.devices[123]
 +myDevice.folderId
 +# OR
 +indigo.devices[123].folderId # see comments below</​code>​|<​code>​-- Folder ID is not available in AppleScript</​code>​|
 +
 +You might look at the second Python example above, and wonder why we didn’t do something like this:
 +
 +<​code>#​ Set a device’s brightness to 75 if it’s currently
 +# less than that, but only if it’s turned on
 +myDevice = indigo.devices[123] ​
 +if ((indigo.devices[123].brightness < 75) and 
 +    (indigo.devices[123].onState)):​
 + indigo.dimmer.setBrightness(indigo.devices[123],​ 75)</​code>​
 +
 +That code works correctly, but is very inefficient. The Python to C++ bridge will cause a copy of the object to be made every time //''​indigo.devices[123]''//​ is used since the devices list is a C++ object, but the object returned from it using the id subscript is bridged to a Python object, and all bridged objects are copies. So, the code directly above will create 3 copies of the device object - very inefficient. The code in the example above gets a single copy of the object and uses that in all the rest of the code. A good rule of thumb is to get an explicit copy of an object if you need to use it more than once.
 +
 +===== InputOutputDevice =====
 +
 +I/O devices have a wide variety of capabilities that we’ve tried to boil down to some specifics. The I/O devices that Indigo supports generally have some combination of three types of inputs: analog, binary, and sensor. They may also support some number of binary outputs.
 +
 +==== Class Properties ====
 +
 +All outputs are modified using commands below.
 +
 +^  Property ​ ^  Type  ^  Writable ​ ^  Description ​ ^
 +|//''​analogInputs''//​| ​ list of integer ​ |  No  |a list of the current analog input values, one per input|
 +|//''​analogInputCount''//​| ​ integer ​ |  No  |number of analog inputs this device supports|
 +|//''​binaryInputs''//​| ​ list of boolean ​ |  No  |a list of the current binary input values, one per input|
 +|//''​binaryInputCount''//​| ​ integer ​ |  No  |number of binary inputs this device supports|
 +|//''​binaryOutputs''//​| ​ list of boolean ​ |  No  |a list of the current binary output values, on per output (max 12 total outputs)|
 +|//''​binaryOutputCount''//​| ​ integer ​ |  No  |number of binary outputs this device supports|
 +|//''​sensorInputCount''//​| ​ integer ​ |  No  |number of sensor inputs this device supports|
 +|//''​sensorInputs''//​| ​ list of integer ​ |  No  |a list of the current sensor input values, one per input|
 +
 +==== Commands (indigo.iodevice.*) ====
 +
 +=== Set Binary Output ===
 +
 +Set the state of the specified binary output.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.iodevice.setBinaryOutput(123,​ index=2, value=True)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​index//''​| ​ Yes  |  integer ​ |0-based index of the output to change - should be less than the ''//​binaryOutputCount//''​ property of the device|
 +|''//​value//''​| ​ Yes  |  boolean ​ |True to turn the output on, False to turn it off|
 +
 +==== Examples ====
 +
 +^  Python ​ ^  AppleScript ​ ^
 +|<​code>#​ If binary input 3 is true, set binary output 1
 +# to false (python arrays are 0-based)
 +myIODevice = indigo.devices[123]
 +if (!myIODevice.binaryInputs[2]):​
 + indigo.iodevice.setBinaryOutput(myIODevice, ​
 + index=1,
 + value=False)</​code>​|<​code=applescript>​-- If binary input 3 is false, set binary output 1
 +-- to false
 +set theBinaryInputs to binary inputs ¬
 + of device "​EZIO8SA"​
 +if not item 3 of theBinaryInputs then
 + set theBinaryOutputs to binary outputs ¬
 + of device "​EZIO8SA"​
 + set item 1 of theBinaryOutputs to false
 + set binary outputs of device ¬
 + "​EZIO8SA"​ to theBinaryOutputs
 +end if</​code>​|
 + 
 +===== SensorDevice =====
 +
 +Some sensor devices, like motion sensors, are treated differently in Indigo. They aren't generally directly controllable and are considered input devices.
 +
 +They typically send a command of some type when they detect some condition and send another command when they stop detecting it. However, dealing with them in Indigo as if they maintain state is much more useful in many cases. So, Indigo will attempt to maintain a virtual state for each motion sensor if configured that way. Currently, the following devices fall under this category:
 +
 +  * X10 Motion Sensors
 +  * the Wireless INSTEON Motion / Occupancy Sensor (2420M) from SmartLabs
 +  * the TriggerLinc from SmartLabs
 +  * the SynchroLinc from SmartLabs
 +
 +Other sensor types, such as an energy meter (iMeter solo), do maintain some state information (like current load in Watts). Indigo maintains additional virtual states for these types of devices as well though, for example to track the kWh of energy used from a base time stamp.
 +==== Class Properties ====
 +
 +^  Property ​ ^  Type  ^  Writable ​ ^  Description ​ ^
 +|//''​onState''//​| ​ boolean ​ |  No  |indicates that the device is currently detecting motion|
 +|//''​energyInputCount''//​| ​ integer ​ |  No  |number of energy (current) monitoring inputs this device supports|
 +|//''​energyInputs''//​| ​ list of integer ​ |  No  |a list of the energy input values in Watts, one per input|
 +|//''​accumEnergyTotals''//​| ​ list of float  |  No  |a list of the energy used in kWh since the last base time specified in //''​accumEnergyBaseTimes''//,​ one per input|
 +|//''​accumEnergyTimeDeltas''//​| ​ list of integer ​ |  No  |a list of the time delta in seconds since the last base time, one per input|
 +|//''​accumEnergyBaseTimes''//​| ​ list of datetime ​ |  No  |a list of the base times from which to calculate energy totals (//''​accumEnergyTotals''//​),​ one per input|
 +
 +==== Commands (indigo.sensor.*) ====
 +
 +=== Set On State ===
 +
 +Set the sensor onState property. Normally this is unnecessary since Indigo will maintain it for you so this method is provided mainly for testing and error recovery.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.sensor.setOnState(123,​ value=True)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|value| ​ Yes  |  boolean ​ |True to set Indigo’s state to on, False to set it to off|
 +
 +=== Reset Accumulated Energy Totals ===
 +
 +Resets the //''​accumEnergyTotals''//,​ //''​accumEnergyTimeDeltas''//​ values for all inputs properties and changes the //''​accumEnergyBaseTimes''//​ to the server'​s current datetime.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.sensor.resetAccumEnergyTotals(123)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +
 +==== Examples ====
 +
 +Because this can't be done in AppleScript,​ we've just provided an example in Python:
 +
 +<​code>#​ Log to the Event Log the current kWh total for an energy meter (ID 123):
 +dev = indigo.devices[123]
 +indigo.server.log("​current kWh total: " + str(dev.accumEnergyTotals[0]))
 +
 +# Then reset the accumulative totals and log again (should be 0):
 +indigo.sensor.resetAccumEnergyTotals(dev)
 +dev.refreshFromServer(waitUntilServerIdle=True)
 +indigo.server.log("​reset kWh total: " + str(dev.accumEnergyTotals[0]))
 +</​code>​
 +
 +===== RelayDevice =====
 +
 +Relay devices are very simple devices, often times called appliance modules. They can be turned on and off only. Your script may manipulate any relay device. Your plugin may specify devices that are of this type and the standard relay UI in the various clients will be presented to users when controlling it.
 +
 +==== Class Properties ====
 +
 +^  Property ​ ^  Type  ^  Description ​ ^
 +|//''​ledStates''//​| ​ list  |  No  |this is a list of booleans that represent the state of LEDs on the device. So, to check to see if LED 3 is on you'd check dev.ledStates[2] (Python arrays are 0-based so the first element is element 0). Currently, only KPL devices use this array - however, future devices may use it as well so you should probably check the length first to make sure that the LED you're looking for is actually there. Use the len(dev.ledStates) method to see how many entries there are before you access a specific index.|
 +|''//​onState//''​| ​ boolean ​ |indicates whether the device is on|
 +
 +==== Commands (indigo.relay.*) ====
 +
 +Use the [[#​turn_on|Turn On]], [[#​turn_off|Turn Off]], and [[#​toggle|Toggle]] methods in the indigo.device.* namespace to turn on/off a relay device.
 +
 +
 +=== Set LED State ===
 +
 +Turns on/off the specified LED. Useful for KeypadLinc (and similar) devices. <color red>​Note</​color>:​ you can't use this method to control the LED of the button(s) that control the direct load - use Turn ON/Turn OFF for those.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.relay.setLedState(123,​ index=0, value=True)</​code>​|
 +|<​code>​indigo.relay.setLedState(123,​ index=0, value=True, suppressLogging=True)</​code>​|
 +|<​code>​indigo.relay.setLedState(123,​ index=0, value=True, updateStatesOnly=True)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​index//''​| ​ Yes  |  integer ​ |the index of the button. Recall that Python-based arrays are 0-based, so the index is also 0-based. That is, the first object in an array is object 0.|
 +|''//​value//''​| ​ Yes  |  boolean ​ |True to turn on the LED, False to turn it off|
 +|''//​suppressLogging//''​| ​ No  |  boolean ​ |True to suppress logging (defaults to False)|
 +|''//​updateStatesOnly//''​| ​ No  |  boolean ​ |True to only update Indigo'​s internal state - no command will be sent to the KPL (defaults to False)|
 +
 +==== Examples ====
 +
 +^  Python ​ ^  AppleScript ​ ^
 +|<​code>#​ Toggle the device
 +indigo.device.toggle(123)</​code>​|<​code>​-- Toggle the device
 +toggle device “Office Lamp”</​code>​|
 +
 +===== SprinklerDevice =====
 +
 +Sprinkler devices generally have some number of sprinkler zones.
 +
 +==== Class Properties ====
 +
 +^  Property ​ ^  Type  ^  Writable ​ ^  Description ​ ^
 +|//''​activeZone''//​| ​ integer ​ |  No  |the number of the active zone, -1 if off (0=zone 1, 1=zone 2, etc)|
 +|//''​zoneCount''//​| ​ integer ​ |  No  |the number of zones available for this sprinkler|
 +|//''​zoneNames''//​| ​ list of string ​ |  No  |list of zone names, starting at zone 1 through zone [''//​zoneCount//''​] - you must include ''//​zoneCount//''​ strings in the list|
 +|//''​zoneMaxDurations''//​| ​ list of integer ​ |  No  |list of zone durations in minutes, starting at zone 1 through zone [''//​zoneCount//''​] - you must include ''//​zoneCount//''​ integers in the list|
 +|//''​zoneScheduledDurations''//​| ​ list of integer ​ |  No  |list of currently active zone durations in minutes if a schedule is running (empty list if no schedule is running), starts at zone 1 through zone [''//​zoneCount//''​] - you must include ''//​zoneCount//''​ integers in the list|
 +
 +==== Commands (indigo.sprinkler.*) ====
 +
 +=== Next Zone ===
 +
 +Set the sprinkler to the next zone, and turn off if it’s the last defined zone.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.sprinkler.nextZone(123)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +
 +=== Pause Schedule ===
 +
 +Pause the current sprinkler schedule but keep it active so it can be resumed.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.sprinkler.pause(123)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +
 +=== Previous Zone ===
 +
 +Set the sprinkler to the previous zone, and turn off if it’s the first defined zone.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.sprinkler.previousZone(123)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +
 +=== Resume Schedule ===
 +
 +Resume the current sprinkler schedule.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.sprinkler.resume(123)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +
 +=== Run Schedule ===
 +
 +Run a sprinkler schedule.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.sprinkler.run(123,​ schedule=[10,​15,​8,​ 0, 0, 0, 0, 0])</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|//''​schedule''//​| ​ Yes  |  list of integer ​ |list of integers representing the number of minutes to run for each zone - the list must have [//''​zoneCount''//​] elements, with 0 for any zone that shouldn’t run|
 +
 +=== Stop Schedule ===
 +
 +Stop the current sprinkler schedule and clear it.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.sprinkler.stop(123)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +
 +=== Turn On Zone ===
 +
 +Turn on a specific zone.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.sprinkler.turnOnZone(123,​ index=2)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​index//''​| ​ Yes  |  integer ​ |0-based index of the zone to turn on|
 +
 +==== Examples ====
 +
 +^  Python ​ ^  AppleScript ​ ^
 +|<​code>​
 +
 +
 +
 +
 +# run schedule
 +indigo.sprinkler.run(123, ​
 +    schedule=[10,​15,​8,​ 0, 0, 0, 0, 0])
 +    ​
 +    ​
 +    ​
 +    ​
 +    ​
 +    ​
 +    ​
 +    ​
 +    ​
 +</​code>​|<​code>​-- AppleScript doesn'​t support directly running a schedule, so
 +-- we have to create an action group with the right schedule
 +-- then execute that.
 +-- run schedule
 +set actionGroupName to "My Sprinkler Schedule"​
 +if not (exists action group actionGroupName) then
 +    make new action group with properties {name:​actionGroupName}
 +    make new action step of action group actionGroupName ¬
 +        with properties ¬
 +          {action type:​controlSprinkler,​ device name:"​Sprinklers"​}
 +end if
 +set zone durations of  ¬
 +    (action step 1 of action group actionGroupName) ¬
 +    to [10, 15, 8, 0, 0, 0, 0, 0]
 +execute group actionGroupName</​code>​|
 +
 +===== ThermostatDevice =====
 +
 +Thermostats have a wide variety of capabilities that we’ve tried to boil down to some specifics. They can have multiple temperature and humidity sensors, they generally have a fan mode, an HVAC mode (heating, cooling, etc) and associated setpoints. **Note:​**some thermostats don’t support getting the following values: //''​coolIsOn''//,​ //''​fanIsOn''//,​ and //''​heatIsOn''//​ - for those thermostats those properties will always be False.
 +
 +==== Class Properties ====
 +
 +^  Property ​ ^  Type  ^  Writable ​ ^  Description ​ ^
 +|//''​coolIsOn''//​| ​ boolean ​ |  No  |is the cooling system (compressor) currently running|
 +|//''​coolSetpoint''//​| ​ float  |  No  |current cool setpoint value|
 +|//''​fanMode''//​| ​ ''//​[[#​fan_mode_enumeration|kFanMode]]//'' ​ |  No  |the operating mode for the fan attached to the thermostat|
 +|//''​fanIsOn''//​| ​ boolean ​ |  No  |is the fan currently running|
 +|//''​heatIsOn''//​| ​ boolean ​ |  No  |is the heater currently running|
 +|//''​heatSetpoint''//​| ​ float  |  No  |current heat setpoint value|
 +|//''​humidities''//​| ​ list of float  |  No  |a list of floating point values representing the current values of all humidity sensors connected to the thermostat|
 +|//''​humiditySensorCount''//​| ​ integer ​ |  No  |number of humidity sensors this thermostat supports|
 +|//''​hvacMode''//​| ​ ''//​[[#​hvac_mode_enumeration|kHvacMode]]//'' ​ |  No  |the operating mode for the HVAC system attached to the thermostat|
 +|//''​temperatureSensorCount''//​| ​ integer ​ |  No  |number of temperature sensors this thermostat supports|
 +|//''​temperatures''//​| ​ list of float  |  No  |a list of floating point values representing the current values of all temperature sensors connected to the thermostat|
 +
 +== Fan Mode Enumeration ==
 +
 +^  ''//​indigo.kFanMode//'' ​ ^^
 +^  Value  ^  Description ​ ^
 +|//''​AlwaysOn''//​|signal the fan that it should be running continuously|
 +|//''​Auto''//​|signal the fan that it should only run when the HVAC system needs it to be running|
 +
 +== HVAC Mode Enumeration ==
 +
 +^  ''//​indigo.kHvacMode//'' ​ ^^
 +^  Value  ^  Description ​ ^
 +|//''​Cool''//​|the hvac system is only reacting to cool setpoints|
 +|//''​HeatCool''//​|the hvac system is reacting to both cool and heat setpoints|
 +|//''​Heat''//​|the hvac system is only reacting to and heat setpoints|
 +|//''​Off''//​|the hvac system is turned off|
 +|//''​ProgramHeatCool''//​|the hvac system is executing it’s built-in automatic program, which usually responds to both heat and cool setpoints|
 +|//''​ProgramCool''//​|the hvac system is executing it’s built-in cooling program|
 +|//''​ProgramHeat''//​|the hvac system is executing it’s built-in heating program|
 +
 +==== Commands (indigo.thermostat.*) ====
 +
 +=== Decrease Cool Setpoint ===
 +
 +Decrease the cool setpoint by a delta value.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.thermostat.decreaseCoolSetpoint(123,​ delta=5)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|value| ​ Yes  |  integer ​ |number of degrees to decrease the cool setpoint|
 +
 +=== Decrease Heat Setpoint ===
 +
 +Decrease the heat setpoint by a delta value.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.thermostat.decreaseHeatSetpoint(123,​ delta=5)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​value//''​| ​ Yes  |  integer ​ |number of degrees to decrease the heat setpoint|
 +
 +=== Increase Cool Setpoint ===
 +
 +Increase the cool setpoint by a delta value.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.thermostat.increaseCoolSetpoint(123,​ delta=5)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​value//''​| ​ Yes  |  integer ​ |number of degrees to increase the cool setpoint|
 +
 +=== Increase Heat Setpoint ===
 +
 +Increase the heat setpoint by a delta value.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.thermostat.increaseHeatSetpoint(123,​ delta=5)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​value//''​| ​ Yes  |  integer ​ |number of degrees to increase the heat setpoint|
 +
 +=== Set Cool Setpoint ===
 +
 +Set the cool setpoint to an absolute temperature.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.thermostat.setCoolSetpoint(123,​ value=78)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​value//''​| ​ Yes  |  integer ​ |the absolute temperature of the setpoint|
 +
 +=== Set Fan Mode ===
 +
 +Adjust the fan mode.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.thermostat.setFanMode(123,​ value=indigo.kFanMode.AlwaysOn)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​value//''​| ​ Yes  |  ''//​[[#​fan_mode_enumeration|kFanMode]]//'' ​ |the absolute temperature of the setpoint|
 +
 +=== Set Heat Setpoint ===
 +
 +Set the heat setpoint to an absolute temperature.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.thermostat.setHeatSetpoint(123,​ value=78)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​value//''​| ​ Yes  |  integer ​ |the absolute temperature of the setpoint|
 +
 +=== Set HVAC Mode ===
 +
 +Adjust the HVAC mode.
 +
 +^  Command Syntax Examples ​ ^
 +|<​code>​indigo.thermostat.setHvacMode(123,​ value=indigo.kHvacMode.HeatCoolOn)</​code>​|
 +
 +^  Parameters ​ ^^^^
 +^  Parameter ​ ^  Required ​ ^  Type  ^  Description ​ ^
 +|direct parameter| ​ Yes  |  integer ​ |id or instance of the device|
 +|''//​value//''​| ​ Yes  |  ''//​[[#​hvac_mode_enumeration|kHvacMode]]//'' ​ |HVAC mode identifier|
 +
 +==== Examples ====
 +
 +^  Python ​ ^  AppleScript ​ ^
 +|<​code>#​ increase the cool setpoint by 5 degrees
 +indigo.thermostat.decreaseCoolSetpoint(123,​ delta=5)
 +
 +
 +# set the thermostat mode to auto
 +indigo.thermostat.setHvacMode(123, ​
 +    value=indigo.kHvacMode.HeatCoolOn)
 +
 +# set the heat setpoint to 78
 +indigo.thermostat.setHeatSetpoint(123,​ value=78)</​code>​|<​code>​-- increase the cool setpoint by 5 degrees
 +set cool setpoint of device "​Thermostat"​ to ¬
 + (cool setpoint of device "​Thermostat"​) + 5
 +
 +-- set the thermostat mode to auto
 +set hvac mode of device "​Thermostat"​ to heatCoolOn
 +
 +
 +-- set the heat setpoint to 78
 +set heat setpoint of device "​Thermostat"​ to 78</​code>​|
indigo_5_documentation/device_class.txt · Last modified: 2019/01/25 22:53 (external edit)
 

© Perceptive Automation, LLC. · Privacy