Variables

The variable class represents an Indigo variable.

The Variable class has a special method, getValue(TYPE, default=VALUE), that you can call which will retrieve the variable value as the specified Python class. There are a couple of advantages to using this method: first, it won't throw an exception but will always return a value; second, the Indigo server will do the conversion in the exact same way that it does type conversions when using variables in triggers and conditions. You can also optionally specify a default value if the value can't be successfully converted into the specified type. Here's a list of the valid types you can specify and what the default is if not specified:

Remember that accessing the value property of a variable object (var.value) will return a unicode string object so you don't need a conversion for that.

# Get a variable
var = indigo.variables[123456]

# Getting the unicode string value (no conversion call necessary, just access the property)
unicodeValue = var.value

# Getting the boolean value
intValue = var.getValue(bool)   # False if it can't be converted
intValue = var.getValue(int, default=True) # True if it can't be converted

# Getting the integer value
intValue = var.getValue(int)   # 0 if it can't be converted
intValue = var.getValue(int, default=10) # 10 if it can't be converted

# Getting the float value
intValue = var.getValue(float)   # 0 if it can't be converted
intValue = var.getValue(float, default=98.6) # 98.6 if it can't be converted

Create a variable. This method returns a copy of the newly created variable.

indigo.variable.create("VariableName", value="Var Value", folder=843920)

Delete the specified folder.

indigo.variable.delete(123)

Duplicate the specified variable. This method returns a copy of the new variable.

indigo.variable.duplicate(123, duplicateName="NewName")

Return an indigo.Dict with all the dependencies on this variable.

depDict = indigo.variable.getDependencies(123)

The dictionary will look something like this:

>>> print indigo.variable.getDependencies(91776575)
Data : (dict)
     actionGroups : (list)
     controlPages : (list)
     devices : (list)
     schedules : (list)
          Data : (dict)
               ID : 552463741 (integer)
               Name : Between condition test (string)
          Data : (dict)
               ID : 296710860 (integer)
               Name : Greater than condition test (string)
     triggers : (list)
     variables : (list)

So, the dictionary will have 5 top-level keys: “actionGroups”, “controlPages”, “devices”, “schedules”, “triggers”, and “variables”. Each one of those keys will return a list object. Inside that list object will be multiple dicts, one for each dependency (or an empty list if there are none). Each dependency dictionary has two keys: “ID” which is the unique id and “Name” which is the name of the object.

Use this command to move the variable to a different folder.

indigo.variable.moveToFolder(123, value=987)

Use this command to set the remote display flag for the folder.

indigo.variable.displayInRemoteUI(123, value=True)

Use this command to set the value of a variable without having to get a local copy first.

indigo.variable.updateValue(123, value="New Value")

# Create a new variable
newVar = indigo.variable.create("fooName", "fooMonster")

# Updating value via command space function:
indigo.variable.updateValue(newVar, "asleep789")
newVar.refreshFromServer()  # refresh needed to update local's .value

# changing name property
newVar.name = "goodName"
newVar.replaceOnServer()

newVar.name = "bad name"  # should throw because of space character

# changing name and values properties:
newVar.name = "goodName2"
newVar.value = "searchingForWaldo"
newVar.replaceOnServer()

indigo.variable.delete(newVar)

# Getting a variable using it's ID
someVar = indigo.variables[123]

# Getting a variable using it's name
someVar = indigo.variables["MyVarName"]