Indigo 7 Documentation
Welcome to the Indigo 7 Documentation pages. We've separated the docs into three areas, each focusing on some different part of Indigo 7.
Indigo User Documents
This section contains links to documents that apply to the base Indigo product (both Indigo Lite and Indigo Pro). It's the starting point if your new to Indigo. We highly recommend starting with the Getting Started guide then progressing on to the other documents.
- What are Devices, Triggers, Schedules, Action Groups, Control Pages, and Variables?
If you have Z-Wave® devices, read through the Managing Your Z-Wave Network
document. Also, our Z-Wave
wiki article discusses, in general terms, what Z-Wave is and how it works.
If you have INSTEON devices, read through the Managing Your INSTEON Network
document. For some background on INSTEON links, we have put together a separate page that discusses INSTEON Scenes
. We highly recommend that you read through that page as it will give you a better understanding of what links are and how they work.
The Virtual Devices Interface
provides several different devices that help you integrate Z-Wave, INSTEON, and 3rd party devices together and even create your own devices.
Other Help Pages
There are other help documents available below and from the purple question mark icon in the UI for the less frequently used dialogs in Indigo.
Indigo Plugin Documents
Indigo Pro ships with many plugins to offer greater functionality. This section contains links to the documentation for each plugin that ships with Indigo 7.
- allows users to fully control Airfoil 5 and later to direct audio output.
- adds the ability to alert you of special events via the Growl library. Growl 2.1, 2.2, and 3.0 are supported.
iCal Alarm Processor
- a plugin that will monitor an IMAP
email account for iCal alarm email messages and do some post-processing for you.
- makes iTunes information available for use in Indigo and allows you to control iTunes.
- makes weather data from the National Oceanic and Atmospheric Administration available for use in Indigo.
- a replacement for the built-in SQL logging functionality of previous versions. More robust and useful.
Timers and Pesters
- this plugin provides a more direct mechanism to create simple timer objects. It also provides a flexible reminder/notification mechanism called a pester.
- adds device type that represents a WeatherSnoop weather station (or a WeatherUnderground station).
With Indigo 7, we no longer ship the following plugins.
- this plugin was replaced by the Airfoil Pro plugin listed above, so you'll need to create Airfoil devices and update your old Airfoil actions to use the new plugin. If you need to use the old plugin, you can get it on our Github repo
DIRECTV DVR Control
- this plugin, which allows Indigo to control some DIRECTV set-top boxes, is now in our Github repo
to allow community improvements.
- this plugin, which integrates with the Vera controller, is no longer needed since Indigo now supports Z-Wave locks directly. It is still available in our Github repo
Indigo How-To Wiki
Need step-by-step instructions on setting up specific home automation tasks? Or have a question about using a particular device/module with Indigo? Take a look at our Indigo How-To Wiki.
We provide several powerful yet easy to use ways to extend Indigo. We support a Python-based API that allows 3rd parties to integrate devices, events, and actions natively into Indigo without sacrificing speed and stability of the core server. We also support a legacy AppleScript API that allows you to integrate with other Mac applications. This section provides links to all the documentation needed to develop scripts and plugins for Indigo.
A note about version numbers: As we've revised the API and added features, we've incremented the API version number. The API version number takes the form of X.Y - where X is the major version and Y is the minor. We will increment the minor version any time we implement new functionality (but old functionality remains the same). We will only increment the major version if we implement a change in the API that will break backwards compatibility. See the API version chart to see which API versions were released in which Indigo version.
If any of the API tables or functionality in the documentation don't have a version number you can assume that the feature is available in API version 1.0 and later.
Starting with Indigo 7 beta releases and API v1.4, we're going to add release notes specifically for API revisions so you can more easily locate new features and changes.
Z-Wave® is a registered trademark of Sigma Designs, Inc. Indigo's support of Z-Wave hardware is neither endorsed nor certified by Sigma Designs.