mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
F and G integrations: apply sentence-style in categories (#29902)
* F and G integrations: apply sentence-style in categories * Apply suggestions from code review Co-authored-by: Joakim Sørensen <joasoe@gmail.com> --------- Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
This commit is contained in:
parent
7bf775c88b
commit
40c0c10b29
@ -14,7 +14,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The FAA Delays integration collects and displays information about delays at US Airports based on the
|
||||
The **FAA Delays** {% term integration %} collects and displays information about delays at US Airports based on the
|
||||
[FAA's National Airspace System Status](https://nasstatus.faa.gov/).
|
||||
|
||||
Data measured includes:
|
||||
@ -26,13 +26,13 @@ Data measured includes:
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Supported Airports
|
||||
## Supported airports
|
||||
|
||||
The airport entered must be a valid IATA
|
||||
airport code for an airport in the US. You can find this by looking up the
|
||||
FAA Identifier at [Airnav](https://airnav.com/airports/).
|
||||
|
||||
## Additional Delay Information
|
||||
## Additional delay information
|
||||
|
||||
Each airport added will expose 5 binary sensors, one for each type of delay. Within each sensor there is additional
|
||||
information listed as attributes, which depends on the type of delay it is. Each delay type has the attributes
|
||||
|
@ -2,14 +2,14 @@
|
||||
title: Facebox
|
||||
description: Detect and recognize faces with Facebox.
|
||||
ha_category:
|
||||
- Image Processing
|
||||
- Image processing
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.7
|
||||
ha_domain: facebox
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `facebox` image processing platform allows you to detect and recognize faces in a camera image using [Facebox](https://machinebox.io/docs/facebox). The state of the entity is the number of faces detected, and recognized faces are listed in the `matched_faces` attribute. An `image_processing.detect_face` event is fired for each recognized face, and the event `data` provides the `confidence` of recognition, the `name` of the person, the `image_id` of the image associated with the match, the `bounding_box` that contains the face in the image, and the `entity_id` that processing was performed on.
|
||||
The **Facebox** image processing {% term integration %} allows you to detect and recognize faces in a camera image using [Facebox](https://machinebox.io/docs/facebox). The state of the entity is the number of faces detected, and recognized faces are listed in the `matched_faces` attribute. An `image_processing.detect_face` event is fired for each recognized face, and the event `data` provides the `confidence` of recognition, the `name` of the person, the `image_id` of the image associated with the match, the `bounding_box` that contains the face in the image, and the `entity_id` that processing was performed on.
|
||||
|
||||
## Setup
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Template Fan"
|
||||
description: "Instructions how to setup the Template fans within Home Assistant."
|
||||
title: "Template fan"
|
||||
description: "Instructions how to setup the template fans within Home Assistant."
|
||||
ha_category:
|
||||
- Fan
|
||||
ha_release: 0.69
|
||||
@ -9,13 +9,13 @@ ha_quality_scale: internal
|
||||
ha_domain: template
|
||||
---
|
||||
|
||||
The `template` platform creates fans that combine integrations and provides the
|
||||
The **Template** {% term integration %} creates fans that combine integrations and provides the
|
||||
ability to run scripts or invoke services for each of the `turn_on`, `turn_off`, `set_percentage`,
|
||||
`set_preset_mode`, `set_oscillating`, and `set_direction` commands of a fan.
|
||||
|
||||
## Configuration
|
||||
|
||||
To enable Template Fans in your installation, add the following to your
|
||||
To enable template fans in your installation, add the following to your
|
||||
`configuration.yaml` file:
|
||||
|
||||
{% raw %}
|
||||
@ -151,7 +151,7 @@ When converting a fan with 3 speeds from the old fan entity model, the following
|
||||
|
||||
## Examples
|
||||
|
||||
### Helper Fan
|
||||
### Helper fan
|
||||
|
||||
This example uses an input_boolean and an input_number to mimic a fan, and
|
||||
the example shows multiple service calls for set_percentage.
|
||||
@ -189,7 +189,7 @@ fan:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Preset Modes Fan
|
||||
### Preset modes fan
|
||||
|
||||
This example uses an existing fan with only a percentage. It extends the
|
||||
percentage value into useable preset modes without a helper entity.
|
||||
|
@ -3,7 +3,7 @@ title: Fast.com
|
||||
description: How to integrate Fast.com within Home Assistant.
|
||||
ha_category:
|
||||
- Sensor
|
||||
- System Monitor
|
||||
- System monitor
|
||||
ha_release: 0.88
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_codeowners:
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: FFmpeg
|
||||
description: Instructions on how to integrate FFmpeg within Home Assistant.
|
||||
ha_category:
|
||||
- Image Processing
|
||||
- Image processing
|
||||
ha_release: 0.29
|
||||
ha_domain: ffmpeg
|
||||
ha_platforms:
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: FFmpeg Motion
|
||||
description: Instructions on how to integrate an FFmpeg-based motion binary sensor
|
||||
ha_category:
|
||||
- Image Processing
|
||||
- Image processing
|
||||
ha_iot_class: Calculated
|
||||
ha_release: 0.27
|
||||
ha_domain: ffmpeg_motion
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: FFmpeg Noise
|
||||
description: Instructions on how to integrate an FFmpeg-based noise binary sensor
|
||||
ha_category:
|
||||
- Image Processing
|
||||
- Image processing
|
||||
ha_iot_class: Calculated
|
||||
ha_release: 0.27
|
||||
ha_domain: ffmpeg_noise
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Fibaro
|
||||
description: Instructions on how to setup Fibaro Home Center and Yubii Home within Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Cover
|
||||
- Event
|
||||
@ -55,7 +55,7 @@ It is recommended to assign a static IP address to your Fibaro controller. This
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Cover
|
||||
- Event
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Amazon Fire TV
|
||||
description: Connect and control your Amazon Fire TV devices using the Android Debug Bridge integration
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_domain: fire_tv
|
||||
ha_integration_type: virtual
|
||||
ha_supporting_domain: androidtv
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: FireServiceRota
|
||||
description: Instructions on how to configure the FireServiceRota integration for Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_iot_class: Cloud Polling
|
||||
@ -34,7 +34,7 @@ A word of caution: Do not solely rely on this integration for your emergency cal
|
||||
This integration provides the following platforms:
|
||||
|
||||
- Sensor: Incoming emergency calls. Metadata contains _among other data_ the location of the incident and a text-to-speech URL. The integration uses a WebSocket client connection with the service to ensure a minimum delay.
|
||||
- Binary Sensor: Your current duty status (as scheduled via the FireServiceRota mobile app and/or website).
|
||||
- Binary sensor: Your current duty status (as scheduled via the FireServiceRota mobile app and/or website).
|
||||
- Switch: Enabled for 30 minutes after an emergency call. ‘on’ represents a confirmed response. Use this to automate your emergency call response and save valuable seconds.
|
||||
|
||||
On how to write automations using these platform read the 'Advanced Configuration' section below.
|
||||
@ -45,7 +45,7 @@ On how to write automations using these platform read the 'Advanced Configuratio
|
||||
|
||||
The following entity types are created:
|
||||
|
||||
### Incidents Sensor
|
||||
### Incidents sensor
|
||||
|
||||
This is the main entity of the integration containing the incident message as its `value`, it has several attributes which are described below.
|
||||
|
||||
@ -65,7 +65,7 @@ This is the main entity of the integration containing the incident message as it
|
||||
| `formatted_address` | Address in string format. |
|
||||
| `task_ids` | ID(s) of appliance(s) or task(s). |
|
||||
|
||||
### Duty Binary Sensor
|
||||
### Duty binary sensor
|
||||
|
||||
This entity reflects the duty you have scheduled, the value can be `on` = on duty, `off` = no duty. When you have no duty the response switch is disabled which means you cannot respond to a call.
|
||||
|
||||
@ -80,7 +80,7 @@ This entity reflects the duty you have scheduled, the value can be `on` = on dut
|
||||
| `type` | Type, e.g. `standby_duty`. |
|
||||
| `assigned function` | Assigned function, e.g. `Chauffeur`. |
|
||||
|
||||
### Incident Response Switch
|
||||
### Incident response switch
|
||||
|
||||
With this switch you can respond to an incident, either by manually controlling the switch via the GUI, or by using an automation action.
|
||||
It gets reset to `unknown` value with every incident received. Switching it to `on` means you send a response acknowledgement, switching it back `off` sends a response rejected.
|
||||
@ -99,7 +99,7 @@ The following attributes are available:
|
||||
| `available_at_incident_creation` | `true` or `false`. |
|
||||
| `active_duty_function_ids` | Active function ID's, e.g., `540`. |
|
||||
|
||||
## Advanced Configuration
|
||||
## Advanced configuration
|
||||
|
||||
With Automation you can configure one or more of the following useful actions:
|
||||
|
||||
@ -110,7 +110,7 @@ With Automation you can configure one or more of the following useful actions:
|
||||
|
||||
These are documented below.
|
||||
|
||||
### Example Automation
|
||||
### Example automation
|
||||
|
||||
{% raw %}
|
||||
|
||||
@ -166,7 +166,7 @@ automation:
|
||||
```
|
||||
|
||||
|
||||
### Example Dashboard
|
||||
### Example dashboard
|
||||
|
||||
```yaml
|
||||
panel: true
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Firmata
|
||||
description: Connect Arduino-compatible boards within Home Assistant
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- DIY
|
||||
- Light
|
||||
- Sensor
|
||||
@ -26,7 +26,7 @@ The Firmata protocol is a standard protocol for microcontrollers. Most of these
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](#binary_sensor)
|
||||
- [Binary sensor](#binary_sensor)
|
||||
- [Light](#lights)
|
||||
- [Sensor](#sensors)
|
||||
- [Switch](#switches)
|
||||
|
@ -3,7 +3,7 @@ title: FiveM
|
||||
description: Instructions on how to integrate a FiveM server into Home Assistant.
|
||||
ha_release: 2022.3
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
ha_iot_class: Local Polling
|
||||
ha_config_flow: true
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Fjäråskupan
|
||||
description: Instructions on how to configure fjäråskupan integration.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Fan
|
||||
- Light
|
||||
ha_release: 2021.9
|
||||
@ -24,7 +24,7 @@ ha_integration_type: integration
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Fan
|
||||
- Light
|
||||
|
||||
|
@ -3,7 +3,7 @@ title: Bouygues Flexom
|
||||
description: Connect and control your Bouygues Flexom devices using the Overkiz integration
|
||||
ha_category:
|
||||
- Alarm
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Button
|
||||
- Climate
|
||||
- Cover
|
||||
@ -16,7 +16,7 @@ ha_category:
|
||||
- Sensor
|
||||
- Siren
|
||||
- Switch
|
||||
- Water Heater
|
||||
- Water heater
|
||||
ha_domain: flexom
|
||||
ha_integration_type: virtual
|
||||
ha_supporting_domain: overkiz
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Flic
|
||||
description: Instructions on how to integrate flic buttons within Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
ha_iot_class: Local Push
|
||||
ha_release: 0.35
|
||||
ha_domain: flic
|
||||
@ -112,6 +112,6 @@ automation:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Ignoring Click Types
|
||||
### Ignoring click types
|
||||
|
||||
For some purposes it might make sense to exclude a specific click type from triggering click events. For example when ignoring double clicks, pressing the button twice fast results in two `single` instead of a `double` click event. This is very useful for applications where you want to click fast.
|
||||
For some purposes it might make sense to exclude a specific click type from triggering click events. For example, when ignoring double clicks, pressing the button twice fast results in two `single` instead of a `double` click event. This is very useful for applications where you want to click fast.
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Flo
|
||||
description: Instructions on how to integrate Flo by Moen into Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_config_flow: true
|
||||
@ -23,7 +23,7 @@ The `flo` integration integrates
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- **Binary Sensor**: reports whether or not there are any alerts.
|
||||
- **Binary sensor**: reports whether or not there are any alerts.
|
||||
- **Sensor**: reports on the device's system mode, water flow rate, temperature, water pressure, and daily water consumption.
|
||||
- **Switch**: allows the user to open and close the valve on the water shutoff device.
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Flume
|
||||
description: Documentation about the flume sensor.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_release: 0.103
|
||||
@ -76,7 +76,7 @@ action:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
## Configuration for Binary Sensor
|
||||
## Configuration for binary sensor
|
||||
|
||||
The following YAML creates a binary sensor. This requires the default sensor to be configured successfully.
|
||||
|
||||
|
@ -136,9 +136,9 @@ After the devices have been added they can be configured with different effects
|
||||
A list of RGB colors can be entered to create an effect. The effect speed can be adjusted using the slider underneath.
|
||||
|
||||
**Custom Effect Type**\
|
||||
This determines the transition between each color.
|
||||
This determines the transition between each color.
|
||||
|
||||
### Supported Models
|
||||
### Supported models
|
||||
|
||||
The following models have been tested.
|
||||
|
||||
@ -178,7 +178,7 @@ The following models have been tested.
|
||||
| 0xE1 | Ceiling Light CCT | no | |
|
||||
| 0xE2 | Ceiling Light Assist | no | Auxiliary Switch not supported |
|
||||
|
||||
### Untested Models
|
||||
### Untested models
|
||||
|
||||
The following models have not been tested but may work.
|
||||
|
||||
@ -222,7 +222,7 @@ The Magic Home light offers a number of effects which are not included in other
|
||||
| `random` | Chooses a random color by selecting random values for R, G, and B. |
|
||||
|
||||
|
||||
### Custom Effects - Service `flux_led.set_custom_effect`
|
||||
### Custom effects - service `flux_led.set_custom_effect`
|
||||
|
||||
The integration offers a custom service to enable you to set the lights to a custom light effect.
|
||||
|
||||
@ -244,7 +244,7 @@ speed_pct: 80
|
||||
transition: "jump"
|
||||
```
|
||||
|
||||
### Set Zones - Service `flux_led.set_zones`
|
||||
### Set zones - service `flux_led.set_zones`
|
||||
|
||||
The Addressable v3 (0xA3) models allow setting a color effect per zone. The length of each zone is the number of pixels per segment divided by the number of colors. If the device is turned off, setting the zones will not turn it on. A separate call to `light.turn_on` is needed to turn on the device.
|
||||
|
||||
@ -256,7 +256,7 @@ The Addressable v3 (0xA3) models allow setting a color effect per zone. The leng
|
||||
| `effect` | The effect you would like. Valid options are `static`, `running_water`, `strobe`, `jump`, or `breathing`. (Default `static`) |
|
||||
|
||||
```yaml
|
||||
#Example Service Call
|
||||
#Example service call
|
||||
service: flux_led.set_zones
|
||||
target:
|
||||
entity_id:
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Folder Watcher
|
||||
description: Integration for monitoring changes within the filesystem.
|
||||
ha_category:
|
||||
- System Monitor
|
||||
- System monitor
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.67
|
||||
ha_quality_scale: internal
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: OwnTone
|
||||
description: Instructions on how to integrate an OwnTone server into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_release: '0.110'
|
||||
ha_iot_class: Local Push
|
||||
ha_domain: forked_daapd
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: FortiOS
|
||||
description: Instructions on how to use Fortinet FortiOS to track devices in Home Assistant.
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.97
|
||||
ha_domain: fortios
|
||||
|
@ -4,7 +4,7 @@ description: Instructions on how to integrate Freebox routers into Home Assistan
|
||||
ha_category:
|
||||
- Camera
|
||||
- Network
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_release: 0.85
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Freedompro
|
||||
description: Instructions for how to integrate Freedompro accessories within Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Cover
|
||||
- Fan
|
||||
|
@ -2,9 +2,9 @@
|
||||
title: AVM FRITZ!Box Tools
|
||||
description: Instructions on how to integrate AVM FRITZ!Box based routers into Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Image
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
- Sensor
|
||||
- Update
|
||||
ha_release: '0.10'
|
||||
@ -56,7 +56,7 @@ Currently supported services are Platform specific:
|
||||
|
||||
- `fritz.cleanup`
|
||||
|
||||
### Platform Services
|
||||
### Platform services
|
||||
|
||||
#### Service `fritz.cleanup`
|
||||
|
||||
@ -95,11 +95,11 @@ Parental control switches can be used to enable and disable internet access of i
|
||||
|
||||
Parental control switches are designed for advanced users, thus they are disabled by default. You need to enable the wanted entities manually.
|
||||
|
||||
### Device Tracker
|
||||
### Device tracker
|
||||
|
||||
**Note**: If you don't want to automatically track newly detected devices, disable the integration system option `Enable new added entities`.
|
||||
|
||||
### Port Forward
|
||||
### Port forward
|
||||
|
||||
Due to security reasons, AVM implemented the ability to enable/disable a port forward rule only from the host involved in the rule.
|
||||
As a result, this integration will create entities only for rules that have your Home Assistant host as a destination.
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: AVM FRITZ!SmartHome
|
||||
description: Instructions on how to integrate AVM Fritz!DECT components into Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Button
|
||||
- Climate
|
||||
- Light
|
||||
@ -33,7 +33,7 @@ The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Cover
|
||||
- Light
|
||||
@ -67,7 +67,7 @@ Additionally, we also support to trigger smarthome templates.
|
||||
The configuration in the UI asks for a username. Starting from FRITZ!OS 7.24 the FRITZ!Box creates a random username for the admin user if you didn't set one yourself. This can be found after logging into the FRITZ!Box and visiting System -> FRITZ!Box Users -> Users. The username starts with "fritz" followed by four random numbers. Under properties on the right it says "created automatically". Prior to FRITZ!OS 7.24 the default username was "admin".
|
||||
</div>
|
||||
|
||||
## Switches & Thermostats
|
||||
## Switches & thermostats
|
||||
|
||||
To get AVM FRITZ!DECT switches (e.g. FRITZ!DECT 400/440) or thermostats (e.g. FRITZ!DECT 301) follow the [configuration instructions](#configuration) above.
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: AVM FRITZ!Box Call Monitor
|
||||
description: Instructions on how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant.
|
||||
ha_category:
|
||||
- System Monitor
|
||||
- System monitor
|
||||
ha_release: 0.27
|
||||
ha_iot_class: Local Polling
|
||||
ha_domain: fritzbox_callmonitor
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Home Assistant Frontend
|
||||
title: Home Assistant frontend
|
||||
description: Offers a frontend to Home Assistant.
|
||||
ha_category:
|
||||
- Other
|
||||
@ -47,7 +47,7 @@ frontend:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Defining Themes
|
||||
## Defining themes
|
||||
|
||||
### Theme format
|
||||
|
||||
@ -153,7 +153,7 @@ For more details about splitting up the configuration into multiple files, see [
|
||||
|
||||
Check our [community forums](https://community.home-assistant.io/c/projects/themes) to find themes to use.
|
||||
|
||||
## Setting Themes
|
||||
## Setting themes
|
||||
|
||||
There are two themes-related services:
|
||||
|
||||
@ -170,7 +170,7 @@ There are two themes-related services:
|
||||
If no dark mode backend theme is set, the light mode theme will also be used in dark mode.
|
||||
The backend theme settings will be saved and restored on a restart of Home Assistant.
|
||||
|
||||
### Manual Theme Selection
|
||||
### Manual theme selection
|
||||
|
||||
When themes are enabled in the `configuration.yaml` file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately.
|
||||
This will overrule the theme settings set by the above service calls, and will only be applied to the current device.
|
||||
@ -200,7 +200,7 @@ For other devices (`es5` mode) you can use `extra_js_url_es5`, this will be load
|
||||
|
||||
The ES5 and module version will never both be loaded, depending on if the device supports `import` the module of ES5 version will be loaded.
|
||||
|
||||
### Manual Language Selection
|
||||
### Manual language selection
|
||||
|
||||
The browser language is automatically detected. To use a different language, go to the user profile page (accessed by clicking your user account initials at the bottom of the sidebar) and select one. It will be applied immediately.
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Frontier Silicon
|
||||
description: Instructions on how to integrate Frontier Silicon Internet Radios into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: '0.40'
|
||||
ha_domain: frontier_silicon
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Fully Kiosk Browser
|
||||
description: Instructions on how to integrate Fully Kiosk Browser with Home Assistant
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_release: 2022.9
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Garages Amsterdam
|
||||
description: Instructions on how to integrate Garages Amsterdam within Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Sensor
|
||||
ha_release: 2021.6
|
||||
ha_codeowners:
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Gardena Bluetooth
|
||||
description: Instructions on how to integrate Gardena Bluetooth devices within Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Number
|
||||
- Sensor
|
||||
- Switch
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Global Caché GC-100
|
||||
description: Instructions on how to integrate gc100 with Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Hub
|
||||
- Switch
|
||||
ha_release: 0.57
|
||||
@ -20,7 +20,7 @@ hardware device which has an array of relays, RS232 serial ports, and flexible p
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Configuration](#configuration)
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Binary sensor](#binary-sensor)
|
||||
- [Switch](#switch)
|
||||
|
||||
Currently, only relays and ports configured to be digital inputs are supported in Home Assistant. For IR support, please use the [iTach remote platform](/integrations/itach), but note that it will likely not function concurrently on the same GC100 due to limitations in the TCP socket server implementation used by Global Caché.
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Generic Thermostat
|
||||
title: Generic thermostat
|
||||
description: Turn Home Assistant into a thermostat
|
||||
ha_category:
|
||||
- Climate
|
||||
|
@ -2,11 +2,11 @@
|
||||
title: Genius Hub
|
||||
description: Instructions on how to integrate a Genius Hub with Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Climate
|
||||
- Sensor
|
||||
- Switch
|
||||
- Water Heater
|
||||
- Water heater
|
||||
ha_release: 0.92
|
||||
ha_iot_class: Local Polling
|
||||
ha_codeowners:
|
||||
@ -30,7 +30,7 @@ It uses the [geniushub](https://pypi.org/project/geniushub-client/) client libra
|
||||
Each zone controlled by your Genius Hub will be exposed as either a:
|
||||
|
||||
- `Climate` entity, for **Radiator** and **Wet Underfloor** zones, and
|
||||
- `Water Heater` entity, for **Hot Water Temperature** zones and
|
||||
- `Water heater` entity, for **Hot Water Temperature** zones and
|
||||
- `Switch` entity, for **On/Off** zones
|
||||
|
||||
**Group** zones are not supported.
|
||||
@ -47,9 +47,9 @@ Home Assistant is obligated to place restrictions upon integrations such as **ge
|
||||
- `set_zone_override`: change the zone's setpoint _for a specified duration_ (up to 24h), and
|
||||
- `set_zone_mode`: change the zone's mode to one of `off`, `timer` or (if supported by the zone) `footprint`
|
||||
|
||||
### Climate and Water Heater Entities
|
||||
### Climate and water heater entities
|
||||
|
||||
Climate and Water Heater entities will report their current temperature, setpoint and mode; other properties (e.g., occupied state) are available via their state attributes (see examples below). The Genius Hub mode will be reported as/set to:
|
||||
Climate and water heater entities will report their current temperature, setpoint and mode; other properties (e.g., occupied state) are available via their state attributes (see examples below). The Genius Hub mode will be reported as/set to:
|
||||
|
||||
| GH mode | HA Operation | HA Preset |
|
||||
| :-----------: | :----------: | :-------: |
|
||||
@ -73,10 +73,10 @@ Individual smart plugs are not yet exposed as switches - you can create one zone
|
||||
|
||||
### Devices
|
||||
|
||||
Each Device controlled by your Genius Hub will be exposed as either a:
|
||||
Each device controlled by your Genius Hub will be exposed as either a:
|
||||
|
||||
- `Sensor` entity with a % battery, for any Device with a battery (e.g., a Genius Valve), or
|
||||
- `Binary Sensor` entity with on/off state for any Device that is a switch (e.g., Smart Plugs, DCRs)
|
||||
- `Binary sensor` entity with on/off state for any Device that is a switch (e.g., Smart Plugs, DCRs)
|
||||
|
||||
Such entities will report back their primary state and `assigned_zone`. If the Hub is directly polled using Option 1 (see below), then some additional state attributes such as `last_comms` (last communications time) are also available.
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Geofency
|
||||
description: Instructions for how to use Geofency to track devices in Home Assistant.
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
ha_release: 0.53
|
||||
ha_iot_class: Cloud Push
|
||||
ha_config_flow: true
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Glances
|
||||
description: Instructions on how to integrate Glances sensors into Home Assistant.
|
||||
ha_category:
|
||||
- System Monitor
|
||||
- System monitor
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: 0.7.3
|
||||
ha_config_flow: true
|
||||
|
@ -83,20 +83,20 @@ to all the Google Calendars available to your linked account.
|
||||
|
||||
If the setup process fails and you see an error message such as *Authentication code expired, please try again* you may want to try the flow again. You may also check the logs for additional error messages that may indicate a misconfiguration such as an invalid client id or secret.
|
||||
|
||||
If you have an error with your credentials, you can delete them in the [Application Credentials](/integrations/application_credentials/) user interface.
|
||||
If you have an error with your credentials, you can delete them in the [application credentials](/integrations/application_credentials/) user interface.
|
||||
|
||||
### Video Tutorial
|
||||
### Video tutorial
|
||||
This video tutorial explains how to set up Google Calendar in Home Assistant and how you can trigger an automation based on a calendar event.
|
||||
|
||||
<lite-youtube videoid="r2WbpxKDOD4" videotitle="How To Use Calendar Events in Home Assistant - Tutorial" posterquality="maxresdefault"></lite-youtube>
|
||||
|
||||
## Calendar Entities
|
||||
## Calendar entities
|
||||
|
||||
Each Google Calendar from *My Calendars* ([more info](https://support.google.com/calendar/answer/37095)) is represented as a [calendar](/integrations/calendar) entity in Home Assistant.
|
||||
|
||||
For example, your calendar named *Personal* is created as entity `calendar.personal`. You may rename an entity, or disable any entities which you don't need.
|
||||
|
||||
## Calendar Event Automations
|
||||
## Calendar event automations
|
||||
|
||||
Individual Calendar *Events* are what powering automations such as:
|
||||
|
||||
@ -104,9 +104,9 @@ Individual Calendar *Events* are what powering automations such as:
|
||||
- Send a notification *5 minutes before the start of any event*
|
||||
- Stop the media player *30 minutes after* the *end* of the event named *Exercise*.
|
||||
|
||||
See [Calendar Automations](/integrations/calendar#automation) for an overview, and read more about [Calendar Trigger Variables](/docs/automation/templating/#calendar) for the available information you can use in a condition or action such as the event `summary`, `description`, `location` and more.
|
||||
See [calendar automations](/integrations/calendar#automation) for an overview, and read more about [calendar trigger variables](/docs/automation/templating/#calendar) for the available information you can use in a condition or action such as the event `summary`, `description`, `location` and more.
|
||||
|
||||
## Calendar Entity Attributes
|
||||
## Calendar entity attributes
|
||||
|
||||
The calendar entity has additional attributes related to a single next upcoming event.
|
||||
|
||||
@ -173,7 +173,7 @@ data:
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
## More Configuration
|
||||
## More configuration
|
||||
|
||||
|
||||
{% details "More Configuration" %}
|
||||
|
@ -302,7 +302,7 @@ Certain devices are considered secure. This includes devices in the `lock` domai
|
||||
|
||||
By default, secure devices cannot be opened by Google Assistant unless a `secure_devices_pin` code is set up. To allow opening, set the `secure_devices_pin` to something. You will then be prompted to speak the pin when opening the device. Closing or locking these devices does not require a pin.
|
||||
|
||||
If a code is set for the Alarm Control Panel, it must be the same as the `secure_devices_pin`. If `code_arm_required` is set to `false`, the system will arm without prompting for the pin.
|
||||
If a code is set for the Alarm control panel, it must be the same as the `secure_devices_pin`. If `code_arm_required` is set to `false`, the system will arm without prompting for the pin.
|
||||
|
||||
### Room/Area support
|
||||
|
||||
|
@ -57,7 +57,7 @@ You can use the service `google_mail.set_vacation` to set vacation options.
|
||||
|
||||
The added `notify` service will be named after the email address you chose on the consent screen. For example, an email address named "example@gmail.com" wil display as `notify.example_gmail_com`.
|
||||
|
||||
### Google Mail Notify Service Data
|
||||
### Google Mail notify service data
|
||||
|
||||
The following attributes can be placed inside the `data` key of the service call for extended functionality:
|
||||
|
||||
@ -87,7 +87,8 @@ data:
|
||||
from: "example@gmail.com"
|
||||
```
|
||||
|
||||
### Video Tutorial
|
||||
### Video tutorial
|
||||
|
||||
This video tutorial explains how to set up Gmail in Home Assistant and how you can create a dashboard and automations to send e-mail and toggle your out-of-office notice.
|
||||
|
||||
<lite-youtube videoid="IHKliqSFZvM" videotitle="How To send e-mail PERFECTLY using Gmail in Home Assistant - Tutorial" posterquality="maxresdefault"></lite-youtube>
|
||||
|
@ -3,7 +3,7 @@ title: Google Maps
|
||||
description: Instructions how to use Google Maps Location Sharing to track devices in Home Assistant.
|
||||
ha_release: 0.67
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_domain: google_maps
|
||||
ha_platforms:
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: Google Wifi
|
||||
description: Instructions on how to integrate Google Wifi/OnHub routers into Home Assistant.
|
||||
ha_category:
|
||||
- System Monitor
|
||||
- System monitor
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: '0.50'
|
||||
ha_domain: google_wifi
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: GPSLogger
|
||||
description: Instructions on how to use GPSLogger to track devices in Home Assistant.
|
||||
ha_category:
|
||||
- Presence Detection
|
||||
- Presence detection
|
||||
ha_release: 0.34
|
||||
ha_iot_class: Cloud Push
|
||||
ha_config_flow: true
|
||||
|
@ -2,14 +2,14 @@
|
||||
title: Group
|
||||
description: Instructions on how to setup groups within Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Cover
|
||||
- Event
|
||||
- Fan
|
||||
- Helper
|
||||
- Light
|
||||
- Lock
|
||||
- Media Player
|
||||
- Media player
|
||||
- Notifications
|
||||
- Organization
|
||||
- Sensor
|
||||
|
@ -1,8 +1,8 @@
|
||||
---
|
||||
title: GStreamer
|
||||
description: Instructions on how to integrate Gstreamer into Home Assistant.
|
||||
description: Instructions on how to integrate GStreamer into Home Assistant.
|
||||
ha_category:
|
||||
- Media Player
|
||||
- Media player
|
||||
ha_release: 0.39
|
||||
ha_iot_class: Local Push
|
||||
ha_domain: gstreamer
|
||||
|
@ -4,7 +4,7 @@ description: Instructions on how to integrate Guardian into Home Assistant.
|
||||
ha_iot_class: Local Polling
|
||||
ha_release: '0.111'
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Binary sensor
|
||||
- Button
|
||||
- Sensor
|
||||
- Switch
|
||||
@ -28,7 +28,7 @@ The `guardian` integration integrates
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- **Binary Sensor**: reports the status of the onboard leak detector and access point
|
||||
- **Binary sensor**: reports the status of the onboard leak detector and access point
|
||||
- **Button**: add various configuration controls
|
||||
- **Sensor**: reports on the device's detected temperature and uptime
|
||||
- **Switch**: allows the user to open and close the valve
|
||||
|
Loading…
x
Reference in New Issue
Block a user