Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
| indigo_2024.2_documentation:getting_started [2025/03/30 16:47] – [Moving an Indigo Installation to another Architecture] jay | indigo_2024.2_documentation:getting_started [2025/10/23 23:58] (current) – [Uninstalling the Mac Client] davel17 | ||
|---|---|---|---|
| Line 11: | Line 11: | ||
| To install the Indigo software, you'll need a Mac that meets these OS and hardware requirements: | To install the Indigo software, you'll need a Mac that meets these OS and hardware requirements: | ||
| - | * [[https:// | + | * [[https:// |
| - | * [[https:// | + | * [[https:// |
| 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. | 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 169: | Line 169: | ||
| If you're moving Indigo to a Mac with a different architecture, | If you're moving Indigo to a Mac with a different architecture, | ||
| - | === Moving an Indigo Installation to another Architecture === | + | ==== Moving an Indigo Installation to another Architecture |
| When you move your Indigo installation from one macOS architecture to another (for example from an Intel-based Mac to an M-series Mac) -- especially if you use Migration Assistant or Time Machine -- you will likely need to take additional steps because many Python libraries are compiled to the specific hardware they' | When you move your Indigo installation from one macOS architecture to another (for example from an Intel-based Mac to an M-series Mac) -- especially if you use Migration Assistant or Time Machine -- you will likely need to take additional steps because many Python libraries are compiled to the specific hardware they' | ||
| Line 195: | Line 195: | ||
| To uninstall the Indigo Server and all of its data and configuration files, first deactivate Indigo on your Mac by selecting the '' | To uninstall the Indigo Server and all of its data and configuration files, first deactivate Indigo on your Mac by selecting the '' | ||
| - | {{: | + | {{: |
| Then make sure that you have the server and client completely shut down (select **'' | Then make sure that you have the server and client completely shut down (select **'' | ||
| Line 209: | Line 209: | ||
| To also uninstall the Indigo Mac Client delete the following files: | To also uninstall the Indigo Mac Client delete the following files: | ||
| - | * ''/ | + | * ''/ |
| - | * '' | + | * '' |
| - | * '' | + | * '' |
| - | * '' | + | * '' |
| Note your Mac has two different Library folders. One is in your the home directory of the account Indigo runs under and the other is at the root level of the drive. In Mac OS X Lion and higher the user's home Library folder is hidden in the Finder so you'll have to use the '' | Note your Mac has two different Library folders. One is in your the home directory of the account Indigo runs under and the other is at the root level of the drive. In Mac OS X Lion and higher the user's home Library folder is hidden in the Finder so you'll have to use the '' | ||
| Line 279: | Line 279: | ||
| - If you want to reconfigure the Indigo Server on a Mac already running Indigo, then select the '' | - If you want to reconfigure the Indigo Server on a Mac already running Indigo, then select the '' | ||
| - | {{: | + | {{: |
| <color red> | <color red> | ||
| Line 316: | Line 316: | ||
| 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: | 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: | ||
| - | {{: | + | {{: |
| and enter your Indigo Account username (or email) and password. The server will then continue to start up. | and enter your Indigo Account username (or email) and password. The server will then continue to start up. | ||
| Line 336: | Line 336: | ||
| 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: | 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: | ||
| - | {{: | + | {{: |
| - | {{: | + | {{: |
| You **must** click the Allow button in those dialogs (if they pop up) or Indigo will not function correctly. | You **must** click the Allow button in those dialogs (if they pop up) or Indigo will not function correctly. | ||
| Line 346: | Line 346: | ||
| 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: | 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: | ||
| - | {{: | + | {{: |
| and a wired ethernet connection might look something like this: | and a wired ethernet connection might look something like this: | ||
| - | {{: | + | {{: |
| Note the IP address under the **Status** section. | Note the IP address under the **Status** section. | ||
| Line 366: | Line 366: | ||
| - Press the '' | - Press the '' | ||
| - | {{: | + | {{: |
| **<color red> | **<color red> | ||
| Line 392: | Line 392: | ||
| You manage them from the Interfaces menu: | You manage them from the Interfaces menu: | ||
| - | {{interfaces_menu.png? | + | {{interfaces_menu.png? |
| 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 its submenu) is described below. If you select the '' | 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 its submenu) is described below. If you select the '' | ||
| - | {{: | + | {{: |
| You can enable/ | You can enable/ | ||
| Line 417: | Line 417: | ||
| 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:// | 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:// | ||
| - | - In Safari on your Indigo Server Mac, go to the [[https:// | + | - In Safari on your Indigo Server Mac, go to the [[https:// |
| - Make sure that the plugin is supported by this Indigo release (look for the **<color green> | - Make sure that the plugin is supported by this Indigo release (look for the **<color green> | ||
| - Click the '' | - Click the '' | ||
| - | - When the download is complete, click on the down arrow in the title bar which will show the plugin download.{{: | + | - When the download is complete, click on the down arrow in the title bar which will show the plugin download.{{: |
| - Most plugins will show the plugin directly as the above image. If it does, double click it and proceed to step 8 below. | - 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. | - 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 '' | - In the Finder window that's now showing, you should see the plugin which will end in '' | ||
| - | - 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? | + | - 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? |
| - | - **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 '' | + | - **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 '' |
| - Click the '' | - Click the '' | ||
| - Done! | - Done! | ||
| Line 431: | Line 431: | ||
| Many plugins require some kind of configuration for the plugin itself. If that's the case, then when you click the '' | Many plugins require some kind of configuration for the plugin itself. If that's the case, then when you click the '' | ||
| - | {{plugin_config_dialog.png? | + | {{plugin_config_dialog.png? |
| Complete the dialog as necessary (sometimes, as with the example above, you don't have to do anything) and click the '' | Complete the dialog as necessary (sometimes, as with the example above, you don't have to do anything) and click the '' | ||
| Line 446: | Line 446: | ||
| This is the meta-menu for many things related to plugins. | This is the meta-menu for many things related to plugins. | ||
| - | {{plugins_menu.png? | + | {{plugins_menu.png? |
| The '' | The '' | ||
| Line 452: | Line 452: | ||
| 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: | 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]? | + | * {{[email protected]? |
| - | * {{[email protected]? | + | * {{[email protected]? |
| - | * {{[email protected]? | + | * {{[email protected]? |
| - | * {{[email protected]? | + | * {{[email protected]? |
| 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:// | 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:// | ||
| - | * {{[email protected]? | + | * {{[email protected]? |
| - | * {{[email protected]? | + | * {{[email protected]? |
| - | * {{[email protected]? | + | * {{[email protected]? |
| There is also a red version of the dot, which can mean several things. | There is also a red version of the dot, which can mean several things. | ||
| - | * {{[email protected]? | + | * {{[email protected]? |
| - | * {{[email protected]? | + | * {{[email protected]? |
| - | * {{[email protected]? | + | * {{[email protected]? |
| We'll discuss how to change/deal with those states later, but this menu provides a very simple visual dashboard for plugin status. | 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 479: | ||
| Each plugin installed will have it's own submenu on the '' | Each plugin installed will have it's own submenu on the '' | ||
| - | {{plugin_enabled_submenu.png? | + | {{plugin_enabled_submenu.png? |
| The top section will be available for every plugin | The top section will be available for every plugin | ||
| Line 498: | Line 498: | ||
| There are several other places where plugins may insert menu items in the Indigo Mac UI. The first place is in the [[overview# | There are several other places where plugins may insert menu items in the Indigo Mac UI. The first place is in the [[overview# | ||
| - | {{plugin_new_device.png? | + | {{plugin_new_device.png? |
| 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, | 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, | ||
| - | {{plugin_events.png? | + | {{plugin_events.png? |
| 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# | 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# | ||
| - | {{plugin_actions.png? | + | {{plugin_actions.png? |
| There are actually 3 places where plugins can add menu items to the actions windows: The first is at the bottom of the [[overview# | There are actually 3 places where plugins can add menu items to the actions windows: The first is at the bottom of the [[overview# | ||
| Line 513: | Line 513: | ||
| ==== The Plugins tab of the Indigo Preferences ==== | ==== The Plugins tab of the Indigo Preferences ==== | ||
| - | {{plugins_tab.png? | + | {{plugins_tab.png? |
| You can also enable/ | You can also enable/ | ||
| Line 541: | Line 541: | ||
| ===== Specifying your Latitude and Longitude ===== | ===== Specifying your Latitude and Longitude ===== | ||
| - | Indigo uses your current Latitude and Longitude coordinates to calculate precisely when sunset and sunrise will occur every day. Indigo automatically extracts your location from the System Preferences. To do this, it must have access to Location Services on your Mac and WiFi must be turned on. When Indigo first launches, you'll be prompted to allow access to Location data. If for some reason it's not working, check the Location Services section on the Privacy tab of the Security & Privacy section of your System Preferences and make sure that IndigoServer is enabled (has a checkbox beside it). | + | Indigo uses your current Latitude and Longitude coordinates to calculate precisely when sunset and sunrise will occur every day. Indigo automatically extracts your location from the System Preferences. To do this, it must have access to Location Services on your Mac (and WiFi must be turned on for Location Services to work). When Indigo first launches, you'll be prompted to allow access to Location data. If for some reason it's not working, check the Location Services section on the Privacy tab of the Security & Privacy section of your System Preferences and make sure that IndigoServer is enabled (has a checkbox beside it). |
| ==== Configuring your System Location ==== | ==== Configuring your System Location ==== | ||
| Line 555: | Line 555: | ||
| 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' | 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' | ||
| - | {{: | + | {{: |
| You can, however, manually specify the latitude and longitude: | You can, however, manually specify the latitude and longitude: | ||
| - | {{longlat_tab.png? | + | {{longlat_tab.png? |
| * Choose the '' | * Choose the '' | ||
| Line 567: | Line 567: | ||
| ===== General Configuration Settings ===== | ===== General Configuration Settings ===== | ||
| - | {{general_prefs_tab.png? | + | {{general_prefs_tab.png? |
| You can configure other Indigo settings by opening the preferences dialog (selecting the '' | You can configure other Indigo settings by opening the preferences dialog (selecting the '' | ||