Server Properties and Commands (indigo.server.*)

These are properties and commands that aren't associated with any specific object type and are inside the indigo.server.* command namespace.

This command will broadcast message to other plugins that have subscribed to the specified name message.

indigo.server.broadcastToSubscribers(messageName)

This command will return a datetime object that represents the sunrise for the specified day (or the next sunrise if no date is passed in).

indigo.server.calculateSunrise()

indigo.server.calculateSunrise(myDateObject)

This command will return a datetime object that represents the sunset for the specified day (or the next sunset if no date is passed in).

indigo.server.calculateSunset()

indigo.server.calculateSunset(myDateObject)

This command will return a string that contains the latest log entries. Each line is terminated with a line feed character.

indigo.server.getEventLogList()

indigo.server.getEventLogList(lineCount=5)

indigo.server.getEventLogList(showTimeStamp=False)

indigo.server.getEventLogList(lineCount=5, showTimeStamp=False)

indigo.server.getEventLogList(returnAsList=True, lineCount=5)

Returns the name of the current database name (without the file extension). It takes no parameters.

name=indigo.server.getDbName()

Returns the POSIX path to the current database file (includes the file name with extension). It takes no parameters.

name=indigo.server.getDbFilePath()

Returns the server's list of elements that have attributes orproperties that are now deprecated.

name=indigo.server. getDeprecatedElems(includeWarnings=[True/False]

Returns the POSIX path to the current Indigo installation path. Useful if you want to manipulate files (like graphics and scripts) that are in the Indigo installation path. It takes no parameters.

name=indigo.server.getInstallFolderPath()

Returns a list of floating point numbers where the first float is the latitude and the second (and last) is the longitude. It takes no parameters.

latLong=indigo.server.getLatitudeAndLongitude()
lat = latLong[0]
long = latLong[1]

Returns a plugin object given the plugin id.

myPlugin=indigo.server.getPlugin("com.company.pluginId")

See scripting plugins for details and examples of using this method.

API v2.4: Returns a list of all enabled plugin object instances.

enabled_plugin_list=indigo.server.getPluginList()

API v2.5: Returns a string with the URL to the active reflector. Returns None if there is no reflector or if remote access is disabled.

indigo.server.getReflectorURL()

>>> indigo.server.getReflectorURL()
"https://myreflector.indigodomo.net/"

Returns a dictionary representing all serial ports on the server machine. The key is the full path specification for the port (for use by PySerial) and the value is just the name of the port (for display purposes).

indigo.server.getSerialPorts()

indigo.server.getSerialPorts(filter="indigo.ignoreBluetooth")

ports = indigo.server.getSerialPorts(filter="indigo.ignoreBluetooth")
# iterate through the full paths
for posixPath in ports:
	print(posixPath)
# iterate through just the port name itself
for uiName in ports.itervalues():
	print(uiName)
# iterate through both
for posixPath, uiName in ports.iteritems():
	print(posixPath)
	print(uiName)

Returns a datetime object representing the server's current time.

indigo.server.getTime()

No Parameters

serverTime = indigo.server.getTime()

Returns a URL string that best represents the URL to the active Indigo Web Server. This is the order of which URL will be returned:

1. Reflector (https://reflector.indigodomo.net) if a reflector is configured.
2. Bonjour name (http://MacName.local:PORT) if it can be determined.
3. Localhost (http://localhost:PORT) if all else fails.

Note, there is no trailing slash.

 indigo.server.getWebServerURL()

No Parameters

This tells IndigoServer to write a log entry with the specified text. The type in the log will be the name of the plugin. The examples below that refer to the logging package assume that you've done this somewhere before: import logging

indigo.server.log("Info Text to log")

indigo.server.log("Info Text to log", type="myType")

indigo.server.log("Warning Text to log", level=logging.WARNING)

indigo.server.log("Error Text to log1", level=logging.ERROR)

indigo.server.log("Error Text to log2", isError=True)

This command will remove all delayed actions currently scheduled. It doesn’t take any parameters.

indigo.server.removeAllDelayedActions()

This command will tell the server to restart our plugin process. The message is printed to the event log, and if isError is true then it's logged as an error. This command can only be called from a plugin and it refers to the plugin itself (not other plugins).

indigo.server.restartPlugin("Restarting now for some reason", isError=True)

The Indigo server will save changes to plugin preferences automatically, and this command will cause the server to save plugin preferences immediately. It doesn’t take any parameters.

indigo.server.savePluginPrefs()

This tells IndigoServer to send an email using the SMTP settings configured in the preferences “Email” tab.

indigo.server.sendEmailTo("my.address@example.com")

indigo.server.sendEmailTo("my.address@example.com", subject="Subject of email", body="Body of email")

Speak a text string using the built-in speech synthesizer.

indigo.server.speak("text to speak", waitUntilDone=True)

Tell the server to shutdown our plugin process. Plugin will remain enabled but be in a stopped state. This command can only be called from a plugin and it refers to the plugin itself (not all plugins).

indigo.server.stopPlugin("Stopping now for some reason", isError=True))

Subscribes to all server event log broadcasts. This command does not take any parameters.

indigo.server.subscribeToLogBroadcasts()

Wait (block) until server has completed event processing and command sending. This command does not take any parameters.

indigo.server.waitUntilIdle()