Differences

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

--- indigo_2023.2_documentation:getting_started [2024/08/05 20:26] – [Starting Indigo Server] davel17
+++ indigo_2023.2_documentation:getting_started [2025/10/23 23:54] (current) – [Indigo Software and Mac Requirements] davel17
@@ Line 11: / Line 11: @@
 To install the Indigo software, you'll need a Mac that meets these OS and hardware requirements:
-  * [[https://en.wikipedia.org/wiki/MacOS_Sierra |Mac OS X 10.12]] or higher
+  * [[https://en.wikipedia.org/wiki/MacOS_Sierra |Mac OS X 10.13]] or higher
-  * [[https://en.wikipedia.org/wiki/MacOS_Sierra#System_requirements|Any Mac capable of running Mac OS X 10.12]]
+  * [[https://en.wikipedia.org/wiki/MacOS_Sierra#System_requirements|Any Mac capable of running Mac OS X 10.13]]
 Indigo requires you to leave your Mac running all the time (though the display can go to sleep) in order to control your home automation; you should take this into consideration when choosing a location for your Mac.
@@ Line 199: / Line 199: @@
 To uninstall the Indigo Server and all of its data and configuration files, first deactivate Indigo on your Mac by selecting the ''**Indigo 2023.2->License Details...**'' menu item and clicking the ''**Deactivate License**'' button. You'll get the following warning dialog:
-{{:indigo_2023.2_documentation:deactivate_sheet.png?nolink|}}
+{{:indigo_2023.2_documentation:deactivate_sheet.png?nolink|Deactivate Sheet Image}}
 Then make sure that you have the server and client completely shut down (select **''Stop Server''** from the **''Indigo 2023.2''** menu if the server is still running before you quit the Indigo Mac Client).
@@ Line 279: / Line 279: @@
   - If you want to reconfigure the Indigo Server on a Mac already running Indigo, then select the ''**Indigo 2023.2->Start Local Server...**'' menu item.
-{{:indigo_2023.2_documentation:start_server_dialog.png|}}
+{{:indigo_2023.2_documentation:start_server_dialog.png?nolink|Start Server Dialog Image}}
 ==== Standard startup mode ====
@@ Line 316: / Line 315: @@
 If this is the first time you've started the server, you'll be prompted first to click through our Enduser License Agreement (EULA), then you'll see the Indigo Account Log In dialog:
-{{:indigo_2023.2_documentation:login_dialog.png?nolink|}}
+{{:indigo_2023.2_documentation:login_dialog.png?nolink|Login Dialog Image}}
 and enter your Indigo Account username (or email) and password. The server will then continue to start up.
@@ Line 336: / Line 335: @@
 If you are using the macOS built-in Firewall, and depending on how you have your firewall configured, you may be prompted by the firewall with the following dialogs the first time you start Indigo:
-{{:indigo_2023.2_documentation:firewall_prompt.png|}}\\
+{{:indigo_2023.2_documentation:firewall_prompt.png?nolink|Firewall Prompt Image}}\\
-{{:indigo_2023.2_documentation:iph_firewall_prompt.png|}}
+{{:indigo_2023.2_documentation:iph_firewall_prompt.png?nolink|IPH Firewall Prompt Image}}
 You **must** click the Allow button in those dialogs (if they pop up) or Indigo will not function correctly.
@@ Line 346: / Line 345: @@
 For other browsers to remotely access the Web server, we need to know the network IP address for the Mac running Indigo Server. This address will be used on the remote Mac or Web browser when connecting to the Indigo Server. By selecting the active network in the Network System Preference, you can see the IP address for your Indigo Server Mac. For WiFi, it might look something like this:
-{{:indigo_2023.2_documentation:network_wifi.png?nolink|}}
+{{:indigo_2023.2_documentation:network_wifi.png?nolink|Network WiFi Image}}
 and a wired ethernet connection might look something like this:
-{{:indigo_2023.2_documentation:network_wired.png?nolink|}}
+{{:indigo_2023.2_documentation:network_wired.png?nolink|Network Wired Image}}
 Note the IP address under the **Status** section.
@@ Line 366: / Line 365: @@
   - Press the ''**Connect**'' button.
-{{:indigo_2023.2_documentation:client_connect_dialog.png?nolink|}}
+{{:indigo_2023.2_documentation:client_connect_dialog.png?nolink|Client Connect Dialog Image}}
 **<color red>NOTE</color>**: the Indigo Mac Client doesn't use the [[reflectors|Indigo Reflector]] service. Connecting an Indigo Mac Client to a server over the internet is a complex topic that is well beyond this document – we suggest you search our online forums for others that have configured this type of access.
 ==== Remote Access Using Indigo Touch ====
-[[http://www.indigodomo.com/touch|Indigo Touch]], the iPhone and iPod Touch application from Indigo Domotics, allows the user to view and control Devices, activate Action Groups, view Variables, and access custom Control Pages. One of the best features of [[http://www.indigodomo.com/touch|Indigo Touch]] is it's ability to automatically detect and configure network connections. If your iPhone (or iPod Touch) is connected to your local wireless LAN, then it should automatically discover your server. In [[http://www.indigodomo.com/touch|Indigo Touch]], tap the ''**Settings**'' button. You should see the name of your Database in the list. Tap on it, and it will connect (it will ask for your username/password if you have one set, but it will remember it going forward so you won't have to type it in again).
+[[http://www.indigodomo.com/touch|Indigo Touch]], the iPhone and iPod Touch application from Indigo Domotics, allows the user to view and control Devices, activate Action Groups, view Variables, and access custom Control Pages. One of the best features of [[http://www.indigodomo.com/touch|Indigo Touch]] is its ability to automatically detect and configure network connections. If your iPhone (or iPod Touch) is connected to your local wireless LAN, then it should automatically discover your server. In [[http://www.indigodomo.com/touch|Indigo Touch]], tap the ''**Settings**'' button. You should see the name of your Database in the list. Tap on it, and it will connect (it will ask for your username/password if you have one set, but it will remember it going forward so you won't have to type it in again).
-At this point, [[http://www.indigodomo.com/touch|Indigo Touch]] will also query the server to see if you have an [[reflectors|Indigo Reflector]] set up for the server. This makes connecting to your home server via [[http://www.indigodomo.com/touch|Indigo Touch]] completely seemless. If you have a reflector set up and running, then [[http://www.indigodomo.com/touch|Indigo Touch]] will automatically attempt to connect no matter where you are or how you're connected. If you're local, it will use the local WiFi network, if you're on a remote WiFi network, it will attempt to use the reflector account. If you're iPhone is on LTE/4G/3G/Edge, it will also attempt to connect via your reflector account. This makes [[http://www.indigodomo.com/touch|Indigo Touch]] truly location agnostic!
+At this point, [[http://www.indigodomo.com/touch|Indigo Touch]] will also query the server to see if you have an [[reflectors|Indigo Reflector]] set up for the server. This makes connecting to your home server via [[http://www.indigodomo.com/touch|Indigo Touch]] completely seamless. If you have a reflector set up and running, then [[http://www.indigodomo.com/touch|Indigo Touch]] will automatically attempt to connect no matter where you are or how you're connected. If you're local, it will use the local WiFi network, if you're on a remote WiFi network, it will attempt to use the reflector account. If you're iPhone is on LTE/4G/3G/Edge, it will also attempt to connect via your reflector account. This makes [[http://www.indigodomo.com/touch|Indigo Touch]] truly location agnostic!
 You can, however, configure a connection manually. Simply tap ''**Manually Add Server**'' on the ''**Settings**'' screen in [[http://www.indigodomo.com/touch|Indigo Touch]] and you can enter your host/ip address and port number.
@@ Line 392: / Line 391: @@
 You manage them from the Interfaces menu:
-{{interfaces_menu.png?nolink|}}
+{{interfaces_menu.png?nolink|Interfaces Menu Image}}
 The first thing you'll notice is the dot beside the names in that menu. A green dot means that the interface is enabled. If the dot is gray, it means that it's disabled. This allows you to see what's enabled by just looking at the menu. Each interface (and it's submenu) is described below. If you select the ''**Manage Interfaces...**'' menu item, it will open the Preferences dialog with the Interfaces tab selected:
-{{:indigo_2023.2_documentation:interfaces_tab.png?nolink|}}
+{{:indigo_2023.2_documentation:interfaces_tab.png?nolink|Interfaces Tab Image}}
 You can enable/disable an interface just by clicking the checkbox (rather than selecting the Enable/Disable menu item on each interface's submenu). Likewise, if an interface has any configuration options, you can open those dialogs by selecting the interface and clicking on the ''**Configure...**'' button (rather than selecting the ''**Configure...**'' menu item on each interface's submenu).
@@ Line 417: / Line 416: @@
 Installing new plugins is pretty simple (updating plugins is the same process, it will just replace the existing one if there is an older version installed). We're going to describe a couple of ways of installing them primarily based on where you get the plugin. While you may get a plugin from anywhere, we recommending getting them from our [[https://www.indigodomo.com/pluginstore/|Plugin Store]]. To download and install a plugin from the store, this is the process (we're using Safari in these steps, so you may need to adjust accordingly if using another browser):
-  - In Safari on your Indigo Server Mac, go to the [[https://www.indigodomo.com/pluginstore/|Plugin Store]] and navigate to the Plugin you want to install. {{pluginstore_detail.png?nolink|}}
+  - In Safari on your Indigo Server Mac, go to the [[https://www.indigodomo.com/pluginstore/|Plugin Store]] and navigate to the Plugin you want to install. {{pluginstore_detail.png?nolink|Plugin Store Detail Image}}
   - Make sure that the plugin is supported by this Indigo release (look for the **<color green>Requires</color>** field). This is an important step because there may be older plugins which aren't compatible with the current version of Indigo.
   - Click the ''**Download Latest Release**'' button, which will download the plugin. If the release isn't compatible with your version of Indigo, you can click on the **<color purple>Releases</color>** tab, and look through the list for a version that works with your version of Indigo (click on it and then click the ''**Download this release**'' link).
-  - When the download is complete, click on the down arrow in the title bar which will show the plugin download.{{:indigo_2023.2_documentation:pluginstore_safari_download.png|}}
+  - When the download is complete, click on the down arrow in the title bar which will show the plugin download.{{:indigo_2023.2_documentation:pluginstore_safari_download.png?nolink|Plugin Store Safari Download Image}}
   - Most plugins will show the plugin directly as the above image. If it does, double click it and proceed to step 8 below.
   - If you see a folder icon (usually with an odd name) in the download dropdown rather than the plugin icon, double-click on the folder and it'll switch to the Finder with the download folder open.
   - In the Finder window that's now showing, you should see the plugin which will end in ''**.indigoPlugin**''. Double-click that file.
-  - You will be switched to the Indigo Client app, and you'll a dialog window which asks you if you want to install and enable the plugin {{plugin_install_permission.png?nolink|}}. You will see a different dialog if the version number is lower than an already-installed version; for safety, Indigo will ask you to confirm that you want to downgrade the plugin.
+  - You will be switched to the Indigo Client app, and you'll a dialog window which asks you if you want to install and enable the plugin {{plugin_install_permission.png?nolink|Plugin Install Permission Image}}. You will see a different dialog if the version number is lower than an already-installed version; for safety, Indigo will ask you to confirm that you want to downgrade the plugin.
-  - **NOTE**: due to a bug in some macOS releases, this step may try to launch a previous version of Indigo. If it does, quit it, then right-click the plugin file, select the ''**Open With**'' menu item, then select Indigo 2023.2.{{:indigo_2023.2_documentation:openwithmenuitem.png?nolink|}}
+  - **NOTE**: due to a bug in some macOS releases, this step may try to launch a previous version of Indigo. If it does, quit it, then right-click the plugin file, select the ''**Open With**'' menu item, then select Indigo 2023.2.{{:indigo_2023.2_documentation:openwithmenuitem.png?nolink|Open With Menu Item Image}}
   - Click the ''**Install and Enable**'' button.
   - Done!
@@ Line 431: / Line 430: @@
 Many plugins require some kind of configuration for the plugin itself. If that's the case, then when you click the ''**Install and Enable**'' button, the plugin's configuration dialog may automatically popup:
-{{plugin_config_dialog.png?nolink|}}
+{{plugin_config_dialog.png?nolink|Plugin Configuration Dialog}}
 Complete the dialog as necessary (sometimes, as with the example above, you don't have to do anything) and click the ''**Save**'' button. **<color red>Note</color>**: if you click the ''**Cancel**'' button, the plugin may not be fully operational until you completely fill out the dialog and save it.
@@ Line 446: / Line 445: @@
 This is the meta-menu for many things related to plugins.
-{{plugins_menu.png?nolink|}}
+{{plugins_menu.png?nolink|Plugins Menu Image}}
 The ''**Reload Libraries and Attachments**'' menu item will allow scripters to add Python libraries to specific locations and use them in Indigo (see [[plugin_scripting_tutorial#shared_classes_and_methods_in_python_files_python_modules|Shared Classes and Methods in Python Files]] for details).
@@ Line 452: / Line 451: @@
 The next section of the menu is dedicated to each plugin that's installed on your system. As you can see, you can tell at a glance the status of the plugin itself:
-  * {{[email protected]?nolink&14|}} a gray dot means the plugin is disabled
+  * {{[email protected]?nolink&14|Gray Dot Image}} a gray dot means the plugin is disabled
-  * {{[email protected]?nolink&14|}} a green dot with no arrows means the plugin is enabled and up to date.
+  * {{[email protected]?nolink&14|Green Dot No Arrow Image}} a green dot with no arrows means the plugin is enabled and up to date.
-  * {{[email protected]?nolink&14|}} a green dot with a black arrow means the plugin is enabled and there is an update available that will work with your Indigo version
+  * {{[email protected]?nolink&14|Green Dot Black Arrow Image}} a green dot with a black arrow means the plugin is enabled and there is an update available that will work with your Indigo version
-  * {{[email protected]?nolink&14|}} a green dot with a red arrow means the plugin is enabled and there is an update available but it won't work with your version of Indigo
+  * {{[email protected]?nolink&14|Green Dot Red Arrow Image}} a green dot with a red arrow means the plugin is enabled and there is an update available but it won't work with your version of Indigo
 There are yellow versions of the dots - the meaning is the same as the green version except it's indicating that the plugin is using an API version that was deprecated with Indigo 2023. You should check the [[https://pluginstore.indigodomo.com|Plugin Store]] for an updated version or contact the plugin developer.
-  * {{[email protected]?nolink&14|}} a yellow dot with no arrows means the plugin is enabled but needs updating before the next Indigo release
+  * {{[email protected]?nolink&14|Yellow Dot With No Arrows Image}} a yellow dot with no arrows means the plugin is enabled but needs updating before the next Indigo release
-  * {{[email protected]?nolink&14|}} a yellow dot with a black arrow means the plugin is enabled and there is an update available that will work with your Indigo version - you should install the update before upgrading to the next version of Indigo
+  * {{[email protected]?nolink&14|Green Dot with Black Arrow Image}} a yellow dot with a black arrow means the plugin is enabled and there is an update available that will work with your Indigo version - you should install the update before upgrading to the next version of Indigo
-  * {{[email protected]?nolink&14|}} a yellow dot with a red arrow means the plugin is enabled and there is an update available but it won't work with your version of Indigo
+  * {{[email protected]?nolink&14|Green Dot with Red Arrow Image}} a yellow dot with a red arrow means the plugin is enabled and there is an update available but it won't work with your version of Indigo
 There is also a red version of the dot, which can mean several things.
-  * {{[email protected]?nolink&14|}} the plugin is not compatible with your version of Indigo and we are not aware of a version that will work with your version of Indigo.
+  * {{[email protected]?nolink&14|Red Dot Image}} the plugin is not compatible with your version of Indigo and we are not aware of a version that will work with your version of Indigo.
-  * {{[email protected]?nolink&14|}} the plugin has failed due to a catastrophic error that has caused the plugin to crash or has caused Indigo to stop the plugin. An error will be output to the log to explain the problem.
+  * {{[email protected]?nolink&14|Red Dot Image}} the plugin has failed due to a catastrophic error that has caused the plugin to crash or has caused Indigo to stop the plugin. An error will be output to the log to explain the problem.
-  * {{[email protected]?nolink&14|}} the plugin's //''self.stopPlugin()''// method has been called for any reason.
+  * {{[email protected]?nolink&14|Red Dot Image}} the plugin's //''self.stopPlugin()''// method has been called for any reason.
 We'll discuss how to change/deal with those states later, but this menu provides a very simple visual dashboard for plugin status.
@@ Line 479: / Line 478: @@
 Each plugin installed will have it's own submenu on the ''**Plugins**'' menu. For instance, here's the 3rd party [[https://www.indigodomo.com/pluginstore/32/|Harmony Hub plugin]] submenu when it's enabled:
-{{plugin_enabled_submenu.png?nolink|}}
+{{plugin_enabled_submenu.png?nolink|Plugin Enabled Submenu Image}}
 The top section will be available for every plugin
@@ Line 498: / Line 497: @@
 There are several other places where plugins may insert menu items in the Indigo Mac UI. The first place is in the [[overview#devices|Device Create/Edit window]]:
-{{plugin_new_device.png?nolink|}}
+{{plugin_new_device.png?nolink|Plugin New Device Image}}
 The top half of that menu allows you to create devices from the built-in interfaces. Anything in the bottom half represents plugins that supply new device types that you can create and use in the same way you work with built-in devices (switches, thermostats, etc.). The next place is in the [[overview#triggers |Trigger Create/Edit dialog]]:
-{{plugin_events.png?nolink|}}
+{{plugin_events.png?nolink|Plugin Events Image}}
 The last section of that menu will show plugins that supply custom events that you can trigger from. The final place that plugins can add menu items is in the [[overview#actions |Action Create/Edit window]]:
-{{plugin_actions.png?nolink|}}
+{{plugin_actions.png?nolink|Plugin Actions Image}}
 There are actually 3 places where plugins can add menu items to the actions windows: The first is at the bottom of the [[overview#device_actions|Device Actions submenu]]: menus here are for plugin actions that act on devices. The second place is on the [[overview#notification_actions|Notification Action submenu]]: plugins that supply some kind of notification action will put their actions on this submenu. Finally, at the bottom of the [[overview#actions|Action Type menu]] itself: this is where plugins will add actions that don't fit into the other two categories.
@@ Line 513: / Line 512: @@
 ==== The Plugins tab of the Indigo Preferences ====
-{{plugins_tab.png?nolink}}
+{{plugins_tab.png?nolink|Plugins Tab Image}}
 You can also enable/disable a plugin and download a new plugin version from the Plugins tab in the Indigo Preferences. You open the config window choosing the ''**Indigo 2023.2->Preferences...**'' menu item and clicking the ''**Plugins**'' tab or by selecting the ''**Plugins->Manage Plugins...**'' menu item discussed above.
@@ Line 555: / Line 554: @@
 By default, Indigo will use Location Services to determine the location of your Mac. You will be asked the first time you start your server to grant permission for **IndigoServer** to access you Mac's location. If Indigo doesn't seem to be running schedules at the right time, make sure that Indigo is authorized to access Location Services. Open the System Preferences, select the Security & Privacy preference, click on the Privacy tab and you should see IndigoServer in the list - make sure the check box beside it is enabled:
-{{:indigo_2023.2_documentation:location_services.png?nolink|}}
+{{:indigo_2023.2_documentation:location_services.png?nolink|Location Services Image}}
 You can, however, manually specify the latitude and longitude:
-{{longlat_tab.png?nolink|}}
+{{longlat_tab.png?nolink|Longitude Latitude Tab Image}}
   * Choose the ''**Indigo 2023.2->Preferences...**'' menu item, then make sure the **''Sunset & Sunrise''** tab is selected.
@@ Line 567: / Line 566: @@
 ===== General Configuration Settings =====
-{{general_prefs_tab.png?nolink|}}
+{{general_prefs_tab.png?nolink|General Preferences Tab Image}}
 You can configure other Indigo settings by opening the preferences dialog (selecting the ''**Indigo 2023.2->Preferences...**'' menu item) and clicking on the ''**General**'' tab.