← API Version Chart

Server API 2.6 Release Notes

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>](../indigo_2021.2_documentation/plugin_guide.md#custom-html-menu-item-dialogs) and [<PluginConfig>](../indigo_2021.2_documentation/plugin_guide.md#custom-html-config-dialogs) 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](../indigo_2021.2_documentation/object_model_reference.md#converting-to-native-python-collections) and [indigo.List](../indigo_2021.2_documentation/object_model_reference.md#converting-to-native-python-collections) instances to the Python equivalents (recursively).
  • Added the ability to convert an [indigo.Device](../indigo_2021.2_documentation/device_class.md#generating-a-dictionary-for-a-device) to a Python [dict](../indigo_2021.2_documentation/device_class.md#generating-a-dictionary-for-a-device)with 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](../indigo_2021.2_documentation/plugin_guide.md#properties))
  • Added an API to get the support URL for a plugin ([self.pluginSupportURL](../indigo_2021.2_documentation/plugin_guide.md#properties))
  • Added an API to get the best URL to the web server ([indigo.server.getWebServerURL](../indigo_2021.2_documentation/server_commands.md#get-web-server-url))
  • Added new [indigo.utils](../indigo_2021.2_documentation/object_model_reference.md#utility-classes-and-functions) 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](../indigo_2021.2_documentation/object_model_reference.md#return-static-file))
    • Added helper function to validate the construction of an email address ([indigo.utils.validate_email_address](../indigo_2021.2_documentation/object_model_reference.md#validate-email-address))