====== Indigo 2022.1 Documentation ======

Welcome to the Indigo 2022.1 Documentation pages. We've separated the docs into multiple areas, each focusing on some different part of Indigo 2022.1.
===== Indigo User Documents =====

This section contains links to documents that apply to the base Indigo product. 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.

  - [[Getting Started]] <- <color green>**//Start here!//**</color>
  - [[overview|Concept Overview]] - What are Devices, Triggers, Schedules, Action Groups, Control Pages, and Variables?
  - [[ui_tour|Tour the Indigo Mac Client User Interface]]
  - [[clients|Other Indigo Clients]]
  - Indigo supports 3 interfaces, which can be active simultaneously ([[:insteon_zwave|using INSTEON and Z-Wave at the same time]])
    - If you have Z-Wave® devices, read through the [[Managing Z-Wave Devices|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 INSTEON Devices|Managing Your INSTEON Network]] document. For some background on INSTEON links, we have put together a separate page that discusses [[:insteon_links|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.
  - The [[https://wiki.indigodomo.com/doku.php?id=indigo_2022.1_documentation:reflectors|Reflector documentation]] will help you activate and manage your reflector.
  - [[getting_started#managing_plugins|Managing Plugins]] - the [[Getting Started]] guide has a section on [[getting_started#managing_plugins|managing 3rd party plugins]], but we think it's important enough to point out here at the top level of the documentation.
==== Other Help Pages ====

There are other help documents available below and from the purple question mark icon {{:indigo_2022.1_documentation:help_icon.png|(?)}} in the UI for the less frequently used dialogs in Indigo.

  * The [[ui_tour&#event_log_window |Event Log Window]] - this is where you can see a history of what Indigo is doing (among other things)
  * [[Deletion Dependencies]]
  * [[Advanced PowerLinc Options]]
  * [[X10 RF Interface Options]]
===== Indigo Plugin Documents =====

Indigo ships with many plugins to offer greater functionality. This section contains links to the documentation for each plugin that ships with Indigo.

  * [[indigo_2022.1_documentation:plugins:airfoilpro|Airfoil Pro]] - allows users to fully control Airfoil 5 and later to direct audio output.
  * [[indigo_2022.1_documentation:plugins:alexa|Alexa]] - make Indigo devices available for control via Alexa-capable devices.
  * [[indigo_2022.1_documentation:plugins:email+|Email+]] - allows users to integrate with email services.
  * [[indigo_2022.1_documentation:plugins:easydaq_1|EasyDAQ Relay Card]] - enables Indigo to directly control the EasyDAQ USB relay cards.
  * [[indigo_2022.1_documentation:plugins:noaaweather|NOAA Weather]] - makes weather data from the U.S. National Oceanic and Atmospheric Administration available for use in Indigo.
  * [[indigo_2022.1_documentation:plugins:sql_logger|SQL Logger]] - a replacement for the built-in SQL logging functionality of previous versions. More robust and useful.
  * [[indigo_2022.1_documentation:plugins:timersandpesters|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.

The [[indigo_2022.1_documentation:plugins:itunes|iTunes (Music) plugin]] has been removed from this release since it no longer works with the Music app.

===== 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 [[:start|Indigo How-To Wiki]].

===== Technical Documents =====

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. This section provides links to all the documentation needed to develop scripts and plugins for Indigo.

**<color red>About API v3.0</color>**: with API v3.0 and later, we have switched to Python 3. Older versions of the API use Python 2, and -- for this release only -- Python 2 will continue to work with this release (M1 Macs will require Rosetta as it is Intel-only). Plugins specifying API 2.x or earlier will be run with Python 2 (and will stop working in the next release of Indigo) and scripts -- both embedded and external -- __will run in Python 3 only__. See the [[api_release_notes:3.0|API release notes for v3.0]] for details. See [[python_packages|Python Packages]] for a list of the additional Python packages that are installed with the Indigo 2022.1 installer.

**<color blue>A note about version numbers</color>**: 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.

  * [[plugin_scripting_tutorial|Indigo 2022.1 Scripting Tutorial]] - dive into scripting Indigo by examples.
  * [[plugin_extending_tutorial|Indigo 2022.1 Server Plugin Tutorial]] - examples of extending Indigo via plugins.
  * The Indigo Plugin SDK ([[https://github.com/IndigoDomotics/IndigoSDK/releases|available here]]) includes example plugins with full XML and python source. They are a great place to start when developing new plugins (or when upgrading a plugin to Python 3).
  * [[plugin_guide|Indigo 2022.1 Plugin Developer's Guide]] - how to create plugin bundles for easy distribution, plugin UI, APIs, callback hooks, and more.
  * [[object_model_reference|Indigo 2022.1 Object Model Reference]] - the Indigo Object Model (IOM) and how to use it in Python.
  * [[:indigo_s_restful_urls|RESTful API]] - an API that can be easily used from any other device/application to get data to/from Indigo.
  * Want the ability to just put some Python scripts onto a menu somewhere for easy access? [[http://www.indigodomo.com/pluginstore/150/|There's a simple way to do it.]]

Check out the [[:api_version_chart|release notes specifically for API revisions]] so you can more easily locate new features and changes.

Want to add your plugin to the [[https://www.indigodomo.com/pluginstore/|Plugin Store]]? It's simple: review the [[https://wiki.indigodomo.com/doku.php?id=plugin_store_guidelines|Plugin Store Submission Guidelines]] and then add it from [[https://www.indigodomo.com/account/plugins|your Indigo Account]].

-----------------------
//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.//