Differences

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

--- indigo_5_documentation:documents [2012/07/18 23:01] – [Indigo Plugin Documents] jay
+++ indigo_5_documentation:documents [2025/04/14 20:10] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
+====== Indigo 5 Documentation ======
+Welcome to the Indigo 5 Documentation pages. We've separated the docs into three areas, each focusing on some different part of Indigo 5.
+===== 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]]
+  - If you have INSTEON devices, learn about [[https://wiki.indigodomo.com/doku.php?id=insteon_links|INSTEON Scenes]] and [[insteon_link_management|how Indigo can help you manage them]]. If you want to do any INSTEON linking, you really should read through both of those linked page to help ensure that your linking experience is smooth.
+==== Other Help Pages ====
+There are other help documents available below and from the purple question mark icon {{:indigo_5_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)
+  * [[insteon_link_management|INSTEON Link Management in Indigo]] - If you have INSTEON devices, this dialog will help you to manage links between them. (Learn about [[https://wiki.indigodomo.com/doku.php?id=insteon_links|INSTEON Scenes]])
+  * [[Advanced PowerLinc Options]]
+  * [[X10 RF Interface Options]]
+  * [[Deletion Dependencies]]
+===== Indigo Plugin Documents =====
+Indigo Pro ships with many extensions to offer greater functionality. In Indigo 5, these are referred to as plugins. This section contains links to the documentation for each plugin that ships with Indigo 5 (the version number after the plugin name indicates which version the plugin began shipping).
+  * [[plugins:action_collection|Action Collection]] (v5.0.0) - a collection of random actions to do various things.
+  * [[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.
+  * [[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: insteon_commands |INSTEON Commands]] (v5.1.1) - a collection of INSTEON commands for functions that aren't built-in to the Client UIs.
+  * [[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:weathersnoop|WeatherSnoop]] (v5.0.0) - adds device type that represents a WeatherSnoop weather station (or a WeatherUnderground station).
+===== Technical Documents =====
+With the release of Indigo 5, extending Indigo has become easier than ever. Along with AppleScript, we've introduced a Python-based API that allows even greater ability for 3rd parties to integrate devices, events, and actions more natively into Indigo. 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. Up until Indigo 5 v5.1.1, the API remained 1.0 and the documents were just updated with new features (which could lead to incompatible features if using an older release of Indigo). As of Indigo 5 v 5.1.2, we've begun incrementing the API minor version number (1.X) whenever we add new features. The major number (X.0) will only be incremented when we do something 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 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 5 Scripting Tutorial]] - dive into scripting Indigo by examples.
+  * [[plugin_extending_tutorial|Indigo 5 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 5 Plugin Developer's Guide]] - how to create plugin bundles for easy distribution, plugin UI, APIs, callback hooks, and more.
+  * [[object_model_reference|Indigo 5 Object Model Reference]] - the Indigo Object Model (IOM) and how to use it in Python.
+  * [[iws_plugin_guide|Indigo Web Server Plugins Guide]] - this document explains how to build an IWS plugin.
+  * [[http://static.indigodomo.com/www/html/02300_indigo_as_dict.html|Indigo 5 AppleScript Dictionary]] - this is a text version of the AppleScript dictionary found in Script Editor.