Differences

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

Link to this comparison view

Next revision		 Previous revision
indigo_2024.2_documentation:ui_tour [2025/02/18 20:36] – created - external edit 127.0.0.1indigo_2024.2_documentation:ui_tour [2025/04/14 20:10] (current) – external edit 127.0.0.1
Line 7: Line 7:
 The Home Window in the Mac client looks like this: The Home Window in the Mac client looks like this:
  
-{{main_window.png?nolink|}}+{{main_window.png?nolink|Main Window Image}}
  
 The Home Window has 4 areas: The Home Window has 4 areas:
Line 21: Line 21:
 The outline view shows all high-level objects (except [[overview#variables|Variables]] which have their own window): [[overview#Devices]], [[overview#Triggers]], [[overview#Schedules]], [[overview#Action Groups]], and [[overview#Control Pages]]. Selecting one of these in the outline view will switch the Item List to view all of those types of objects. The same goes for folders that are under the high-level headings except only the objects in those folders will show. The outline view shows all high-level objects (except [[overview#variables|Variables]] which have their own window): [[overview#Devices]], [[overview#Triggers]], [[overview#Schedules]], [[overview#Action Groups]], and [[overview#Control Pages]]. Selecting one of these in the outline view will switch the Item List to view all of those types of objects. The same goes for folders that are under the high-level headings except only the objects in those folders will show.
  
-{{outline_view_controls.png?nolink|}}+{{outline_view_controls.png?nolink|Outline View Controls Image}}
  
 To create a new folder, select the main object type in the list then click the plus (''**+**'') button at the lower-left corner of the outline view. A new folder will appear and you can just start typing its new name. To create a new folder, select the main object type in the list then click the plus (''**+**'') button at the lower-left corner of the outline view. A new folder will appear and you can just start typing its new name.
Line 41: Line 41:
 The image above shows all possible columns in the device view. However, if you right-click on the table header: The image above shows all possible columns in the device view. However, if you right-click on the table header:
  
-{{device_column_selection_menu.png?nolink|}}+{{device_column_selection_menu.png?nolink|Device Column Selection Menu Image}}
  
 you can customize what columns are shown by checking/unchecking them in the list. Several of the columns have a checkbox in them - you can check/uncheck the feature for the object by clicking on the checkbox. In a few rare cases the checkbox will be disabled (grayed out). you can customize what columns are shown by checking/unchecking them in the list. Several of the columns have a checkbox in them - you can check/uncheck the feature for the object by clicking on the checkbox. In a few rare cases the checkbox will be disabled (grayed out).
Line 48: Line 48:
 Every Item List is customizable in this regard. Also, if you right-click on a device: Every Item List is customizable in this regard. Also, if you right-click on a device:
  
-{{device_contextual_menu.png?nolink|}}+{{device_contextual_menu.png?nolink|Device Contextual Menu Image}}
  
 This menu will: This menu will:
Line 152: Line 152:
 Device controls are separated into a variety of control tiles that are laid out in a grid in the Item Detail area. We also refer to this as the control area. If you have no device selected, the control area is blank. If you have a single device selected, you may see a variety of different control tiles. The first tile that will always be showing is the Device Details tile: Device controls are separated into a variety of control tiles that are laid out in a grid in the Item Detail area. We also refer to this as the control area. If you have no device selected, the control area is blank. If you have a single device selected, you may see a variety of different control tiles. The first tile that will always be showing is the Device Details tile:
  
-{{device_details_tile.png?nolink|}} \\ +{{device_details_tile.png?nolink|Device Details Tile Image}} \\ 
-{{device_details_tile2.png?nolink|}}+{{device_details_tile2.png?nolink|Device Details Tile Image}}
  
 The information in the tile will be specific to the device type. For instance, battery powered devices (that report their battery status) will show the battery level. For sensor devices, the sensor reading will show (temp, humidity, etc. for instance). All devices, regardless of type, will show ''**Last Update**'' - the last date/time that the device was changed in any way. The information in the tile will be specific to the device type. For instance, battery powered devices (that report their battery status) will show the battery level. For sensor devices, the sensor reading will show (temp, humidity, etc. for instance). All devices, regardless of type, will show ''**Last Update**'' - the last date/time that the device was changed in any way.
Line 159: Line 159:
 Plugin devices, regardless of whether they implement one of the built-in device types below or if they are completely custom devices, will also have a ''**Custom States**'' tile that will show all the device's custom states. This tile is always below the first row of tiles so you may need to scroll or resize the Item Detail area to see it: Plugin devices, regardless of whether they implement one of the built-in device types below or if they are completely custom devices, will also have a ''**Custom States**'' tile that will show all the device's custom states. This tile is always below the first row of tiles so you may need to scroll or resize the Item Detail area to see it:
  
-{{:indigo_2024.2_documentation:custom_states_tile.png?nolink|}}+{{:indigo_2024.2_documentation:custom_states_tile.png?nolink|Custom States Tile Image}}
  
 If you right-click a custom state, you will see the following contextual menu with several options: If you right-click a custom state, you will see the following contextual menu with several options:
  
-{{:indigo_2024.2_documentation:device_state_context_menu.png?nolink|}}+{{:indigo_2024.2_documentation:device_state_context_menu.png?nolink|Device State Context Menu Image}}
  
   - Copy Python Reference will copy the full reference to that state that you can use in a Python script. It will look something like this: ''<nowiki>indigo.devices[1604256801].states["album"] # State "album" of "MightMini iTunes"</nowiki>''   - Copy Python Reference will copy the full reference to that state that you can use in a Python script. It will look something like this: ''<nowiki>indigo.devices[1604256801].states["album"] # State "album" of "MightMini iTunes"</nowiki>''
Line 176: Line 176:
 For lights (dimmers) and appliance modules (relays or On/Off devices), you see ''**On/Off/Brightness Controls**'' tile: For lights (dimmers) and appliance modules (relays or On/Off devices), you see ''**On/Off/Brightness Controls**'' tile:
  
-{{on_off_dimmer_tile.png?nolink|}}+{{on_off_dimmer_tile.png?nolink|On Off Dimmer Tile Image}}
  
 If the device doesn't support dimming, those controls will be hidden. You'll also notice that in the Device Details tile, ''**On State**'' and ''**Brightness**'' (if it's a dimmer) will show the current values. If the device doesn't support dimming, those controls will be hidden. You'll also notice that in the Device Details tile, ''**On State**'' and ''**Brightness**'' (if it's a dimmer) will show the current values.
Line 182: Line 182:
 For lights that allow users to set the color, you'll see the ''**Color Controls**'' tile: For lights that allow users to set the color, you'll see the ''**Color Controls**'' tile:
  
-{{color_controls_tile?nolink|}}+{{color_controls_tile?nolink|Color Controls Tile Image}}
  
 The top row of controls allow you to turn the light On, Off, and the last text field will allow you to type in the brightness (0-100). The second row of controls allows you to set the color and if the light supports it, the white value (also 0-100). If the light doesn't support setting white separately, the slider and text field will not show. The last row will allow you to se the temperature of the white (again, if the light supports it). If the light doesn't allow setting temperature, the ''**Send Status Request**'' button will show instead. The top row of controls allow you to turn the light On, Off, and the last text field will allow you to type in the brightness (0-100). The second row of controls allows you to set the color and if the light supports it, the white value (also 0-100). If the light doesn't support setting white separately, the slider and text field will not show. The last row will allow you to se the temperature of the white (again, if the light supports it). If the light doesn't allow setting temperature, the ''**Send Status Request**'' button will show instead.
Line 188: Line 188:
 ==  Sensors (Motion Sensors, Energy Meters like the iMeter, etc.) == ==  Sensors (Motion Sensors, Energy Meters like the iMeter, etc.) ==
  
-{{sensor_controls_tile.png?nolink|}}+{{sensor_controls_tile.png?nolink|Sensor Controls Tile Image}}
  
 Sensor devices have their own control tile as well. Some of those devices can be explicitly turned On and Off (thus the buttons) and can respond to status requests. The buttons will be enabled/disabled based on the device's capabilities. Sensor devices have their own control tile as well. Some of those devices can be explicitly turned On and Off (thus the buttons) and can respond to status requests. The buttons will be enabled/disabled based on the device's capabilities.
Line 198: Line 198:
 == Speed Controls == == Speed Controls ==
  
-{{speed_controls.png?nolink|}}+{{speed_controls.png?nolink|Speed Controls Image}}
  
 Speed control devices are devices that can control the speed of some kind of motor. For instance, the INSTEON FanLinc. And, in fact, the controls are currently tailored to the FanLinc's High, Medium, Low, and Off settings. When we run across more of these types of devices we'll customize the controls appropriately. Speed control devices are devices that can control the speed of some kind of motor. For instance, the INSTEON FanLinc. And, in fact, the controls are currently tailored to the FanLinc's High, Medium, Low, and Off settings. When we run across more of these types of devices we'll customize the controls appropriately.
Line 204: Line 204:
 == Sprinklers == == Sprinklers ==
  
-{{sprinkler_controls.png?nolink|}}+{{sprinkler_controls.png?nolink|Sprinkler Controls Image}}
  
 The sprinkler tile allows you to turn on a specific zone, go to the next or previous zone, update the valve status. And, if a schedule is currently running, pause/resume it, begin running the previous schedule, and stop all activity. The sprinkler tile allows you to turn on a specific zone, go to the next or previous zone, update the valve status. And, if a schedule is currently running, pause/resume it, begin running the previous schedule, and stop all activity.
Line 210: Line 210:
 == Thermostats == == Thermostats ==
  
-{{thermostat_controls.png?nolink|}}+{{thermostat_controls.png?nolink|Thermostat Controls Image}}
  
 The thermostat tile shows the current temperature, humidity, mode, cool/heat setpoints, and fan mode. You can also adjust all of those as well as refresh the values and turn everything off. Note that on rev2 thermostat adaptors the circles next to cool and heat setpoints will be lit if their respective HVAC system is actually running (A/C or heater). The thermostat tile shows the current temperature, humidity, mode, cool/heat setpoints, and fan mode. You can also adjust all of those as well as refresh the values and turn everything off. Note that on rev2 thermostat adaptors the circles next to cool and heat setpoints will be lit if their respective HVAC system is actually running (A/C or heater).
Line 216: Line 216:
 == Generic Output Devices == == Generic Output Devices ==
  
-{{io_controls.png?nolink|}}+{{io_controls.png?nolink|I/O Controls Image}}
  
 Output Controls tile shows the state of all the output states available for the device and you can update them immediately using the ''**Send Status Request**'' button. The button grid shows all available outputs and their status. Use the ''**Turn Off All Outputs**'' button to turn off all binary outputs. Output Controls tile shows the state of all the output states available for the device and you can update them immediately using the ''**Send Status Request**'' button. The button grid shows all available outputs and their status. Use the ''**Turn Off All Outputs**'' button to turn off all binary outputs.
Line 223: Line 223:
 === Triggers and Schedules === === Triggers and Schedules ===
  
-{{trigger_schedule_controls.png?nolink|}}+{{trigger_schedule_controls.png?nolink|Trigger Schedule Controls Image}}
  
 The detail area for triggers and schedules is identical - it shows the triggering event (either a state change or some time/date description), whether the condition is always, rules, or a script, and a summary of actions. Depending on your interface, a popup may allow you to specify how the object is processed: The detail area for triggers and schedules is identical - it shows the triggering event (either a state change or some time/date description), whether the condition is always, rules, or a script, and a summary of actions. Depending on your interface, a popup may allow you to specify how the object is processed:
Line 238: Line 238:
 === Action Groups === === Action Groups ===
  
-{{action_group_controls.png?nolink|}}+{{action_group_controls.png?nolink|Action Group Controls Image}}
  
 The action group detail shows a list of all the actions in the group. The ''**Execute Actions Now**'' button will do exactly that - execute all the actions associated with the action group. The action group detail shows a list of all the actions in the group. The ''**Execute Actions Now**'' button will do exactly that - execute all the actions associated with the action group.
Line 255: Line 255:
 ===== Event Log Window ===== ===== Event Log Window =====
  
-{{event_log_window.png?nolink|}}+{{event_log_window.png?nolink|Event Log Window Image}}
  
 The event log window shows you most everything the Indigo Server is doing at any given time. You see incoming and outgoing traffic, trigger and schedule executions, and other useful diagnostic information. The event log window shows you most everything the Indigo Server is doing at any given time. You see incoming and outgoing traffic, trigger and schedule executions, and other useful diagnostic information.
Line 272: Line 272:
 In this section, we'll go through each of the menus in Indigo. In this section, we'll go through each of the menus in Indigo.
  
-==== Indigo 2024.1 Menu ====+==== Indigo 2024.2 Menu ====
  
-{{indigo_menu_2023_1.png?nolink|}}+{{indigo_menu_2023_1.png?nolink|Indigo Menu Image}}
  
   * ''**About Indigo 2024.1**'' - this will show the About window which will show what client and server versions you're running and will show your registration code   * ''**About Indigo 2024.1**'' - this will show the About window which will show what client and server versions you're running and will show your registration code
Line 285: Line 285:
   * ''**License Details...**'' - this opens the Subscription Status window that will show you the status of your License and it's associated Up-to-Date Subscription:   * ''**License Details...**'' - this opens the Subscription Status window that will show you the status of your License and it's associated Up-to-Date Subscription:
  
-{{subscription_status.png?nolink|}}+{{subscription_status.png?nolink|Subscription Status Image}}
  
   * ''**Check for Updates...**'' - this will have the server your connected to contact us to see if there is an update available   * ''**Check for Updates...**'' - this will have the server your connected to contact us to see if there is an update available
 ==== File Menu ==== ==== File Menu ====
  
-{{file_menu.png?nolink|}}+{{file_menu.png?nolink|File Menu Image}}
  
   * ''**New Database...**'' - this will close the current database and create a new one - you'll be prompted for a name and save location   * ''**New Database...**'' - this will close the current database and create a new one - you'll be prompted for a name and save location
Line 319: Line 319:
 ==== Window Menu ==== ==== Window Menu ====
  
-{{window_menu_2023_1.png?nolink|}}+{{window_menu_2023_1.png?nolink|Window Menu Image}}
  
   * ''**Home Window**'' - this will show/bring to front the Home Window   * ''**Home Window**'' - this will show/bring to front the Home Window
Line 328: Line 328:
 ==== Help Menu ==== ==== Help Menu ====
  
-{{help_menu_2023_1.png?nolink|}}+{{help_menu_2023_1.png?nolink|Help Menu Image}}
  
   * ''**Help for XXXX**'' - this will change slightly based on what window is selected and what's selected in that window - but it will open the default browser to the page in the help documentation for that particular item   * ''**Help for XXXX**'' - this will change slightly based on what window is selected and what's selected in that window - but it will open the default browser to the page in the help documentation for that particular item
  • /www/perceptive/wiki/data/attic/indigo_2024.2_documentation/ui_tour.1739910987.txt.gz
  • Last modified: 2025/02/18 20:36
  • by 127.0.0.1