Differences

This shows you the differences between two versions of the page.

--- indigo_6_documentation:documents [2014/05/28 16:15] – external edit 127.0.0.1
+++ indigo_6_documentation:documents [2025/04/14 20:10] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
+====== Indigo 6 Documentation ======
+Welcome to the Indigo 6 Documentation pages. We've separated the docs into three areas, each focusing on some different part of Indigo 6.
+===== 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 you're 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|use 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.
+==== Other Help Pages ====
+There are other help documents available below and from the purple question mark icon {{:indigo_6_documentation:help_icon.png?nolink|(?)}} 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 Pro ships with many plugins to offer greater functionality. This section contains links to the documentation for each plugin that ships with Indigo 6 (the version number after the plugin name indicates the Indigo version in which the plugin began shipping).
+  * [[plugins:airfoil|Airfoil]] (v5.0.0) - allows users to fully control Airfoil to direct audio output.
+  * [[plugins:directvdvrcontrol|DIRECTV DVR Control]] (v5.0.0) - allows Indigo to control some DIRECTV set-top boxes.
+  * [[plugins:easydaq_1|EasyDAQ Relay Card]] (v5.0.0) - enables Indigo to directly control the EasyDAQ USB relay cards.
+  * [[plugins:growl_1|Growl]] (v5.0.0) - adds the ability to alert you of special events via the Growl library. Growl 2.1, 2.2, and 3.0 are supported.
+  * [[plugins:icalalarmprocessor|iCal Alarm Processor]] (v5.0.0) - a plugin that will monitor an IMAP email account for iCal alarm email messages and do some post-processing for you.
+  * [[plugins:itunes|iTunes]] (v5.0.0) - makes iTunes information available for use in Indigo and allows you to control iTunes.
+  * [[plugins:noaaweather|NOAA Weather]] (v5.0.0) - makes weather data from the National Oceanic and Atmospheric Administration available for use in Indigo.
+  * [[plugins:sql_logger|SQL Logger]] (v5.1.2) - a replacement for the built-in SQL logging functionality of previous versions. More robust and useful.
+  * [[plugins:timersandpesters|Timers and Pesters]] (v6.0.0) - this plugin provides a more direct mechanism to create simple timer objects. It also provides a flexible reminder/notification mechanism called a pester.
+  * [[plugins:vera|Vera Bridge]] (v6.0.3) - adds the ability to control Z-Wave locks and some other devices that are managed by a Vera controller.
+  * [[plugins:weathersnoop|WeatherSnoop]] (v5.0.0) - adds device type that represents a WeatherSnoop weather station (or a WeatherUnderground station). The 2.0 version of the plugin (with Indigo 6) supports WeatherSnoop 3 agents.
+**<color red>Note</color>**: The functionality of the INSTEON Commands plugin (available in Indigo 5) has been directly integrated into Indigo 6 so it doesn't appear as a separate plugin. Check the [[Managing INSTEON Devices|Managing Your INSTEON Network]] document for details. We've also done the same thing with the Action Collection plugin - see the [[indigo_6_documentation:overview#actions|Actions documentation]] for information on those actions.
+===== 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. 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.
+**<color red>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 6 Scripting Tutorial]] - dive into scripting Indigo by examples.
+  * [[plugin_extending_tutorial|Indigo 6 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.
+  * [[plugin_guide|Indigo 6 Plugin Developer's Guide]] - how to create plugin bundles for easy distribution, plugin UI, APIs, callback hooks, and more.
+  * [[object_model_reference|Indigo 6 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.
+  * [[http://static.indigodomo.com/www/html/02300_indigo_as_dict.html|Indigo AppleScript Dictionary]] - this is a text version of the AppleScript dictionary found in Script Editor.
+  * Want the ability to just put some Python scripts or AppleScripts onto a menu somewhere for easy access? [[https://wiki.indigodomo.com/doku.php?id=plugins:user_scripts|There's a simple way to do it.]]
+Starting with Indigo 6 beta releases and API v1.4, we're going to add [[:api_version_chart|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.//