API v2.6 Release Notes

This version of the API shipped with Indigo 2021.2.0 - check the API Version Chart to see what version of the API is available in which Indigo versions.

• Added a <URL> element to <MenuItem> and <PluginConfig> elements so that those menus will open a browser URL rather than run a plugin config dialog.
• Added the full path to a file specified in a /messages/ call to the action props dict.
• Added ability for a plugin to pass back a file reference for IWS to stream back to caller.
• Added the ability to convert indigo.Dict and indigo.List instances to the Python equivalents (recursively).
• Added the ability to convert an indigo.Device to a Python dictwith all properties and states.
• Added the ability for a plugin to provide static content through IWS HTTP calls.
• Added ability for plugins to return custom error text on IWS generated error pages (ex 404, etc.)
• Added the capability to specify relative URLs in plugin dialogs so that the plugin can host its own help files.
• Added the Example HTTP Responder plugin to the SDK to illustrate most of the above features.
• Added an API to get the full path to the plugin's directory (self.pluginFolderPath)
• Added an API to get the support URL for a plugin (self.pluginSupportURL)
• Added an API to get the best URL to the web server (indigo.server.getWebServerURL)
• Added new indigo.utils module
  • Added a JSONEncoder subclass to encode python dates as strings (indigo.utils.JSONDateEncoder)
  • Added FileNotFoundError exception (indigo.utils.FileNotFoundError)
  • Added helper function to validate and return the appropriate indigo.Dict to IWS to direct it to stream the contents of a static file back to the requester (indigo.utils.return_static_file)
  • Added helper function to validate the construction of an email address (indigo.utils.validate_email_address)