mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
g-i integrations: apply sentence-style capitalization (#29861)
This commit is contained in:
parent
eb027142ab
commit
a151fbadff
@ -35,6 +35,6 @@ When you add a parking garage, 4 sensors are created in your configuration by de
|
||||
|
||||
</div>
|
||||
|
||||
### Binary Sensor
|
||||
### Binary sensor
|
||||
|
||||
Each parking garage also has a binary sensor, which indicates whether there are problems in the data provision from the API. When it indicates `ok` everything is fine. If the state changes to `problem`, the upstream data might not be up to date or reliable and will remain in this state until new data is coming in.
|
||||
|
@ -47,7 +47,7 @@ port:
|
||||
type: integer
|
||||
{% endconfiguration %}
|
||||
|
||||
## Binary Sensor
|
||||
## Binary sensor
|
||||
|
||||
To enable this sensor, you first have to set up [gc100](#configuration), and add the following lines to your `configuration.yaml` file:
|
||||
|
||||
|
@ -38,7 +38,7 @@ Please refer to the [creator's disclaimer and terms of use notice](https://www.g
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## State Attributes
|
||||
## State attributes
|
||||
|
||||
The following state attributes are available for each entity in addition to the standard ones:
|
||||
|
||||
@ -84,7 +84,7 @@ from the feed.
|
||||
| updated | Number of entities that were updated during last update (optional). |
|
||||
| removed | Number of entities that were removed during last update (optional). |
|
||||
|
||||
## Full Configuration
|
||||
## Full configuration
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -39,7 +39,7 @@ Currently, there is no support for altering zone schedules, although entities ca
|
||||
|
||||
There are limitations due to the differences between the Genius Hub and Home Assistant schemas (e.g., HA has no **Footprint** mode) - use the service handlers, below, for this functionality.
|
||||
|
||||
### Service Handlers
|
||||
### Service handlers
|
||||
|
||||
Home Assistant is obligated to place restrictions upon integrations such as **geniushub** to maintain compatibility with other ecosystems (e.g., Google Home) and so not all of the **geniushub** functionality is available via the web UI. Some of this missing functionality is exposed via integration-specific service handlers:
|
||||
|
||||
@ -60,7 +60,7 @@ Climate and Water Heater entities will report their current temperature, setpoin
|
||||
|
||||
**Footprint** mode is only available to **Radiator** zones that have room sensors.
|
||||
|
||||
### Switch Entities
|
||||
### Switch entities
|
||||
|
||||
Switch entities will report back their state; other properties are available via their state attributes. Currently, HA switches do not have modes/presets, so the Home Assistant `state` will be *reported* as:
|
||||
|
||||
@ -125,7 +125,7 @@ This alert may be useful to see if the CH is being turned on whilst you're on a
|
||||
|
||||
{% endraw %}
|
||||
|
||||
## State Attributes
|
||||
## State attributes
|
||||
|
||||
Many zone/device properties are available via the corresponding entity's state attributes. For example, in the case of **Radiator**-derived `Climate` entities (note 'status'):
|
||||
|
||||
|
@ -23,7 +23,7 @@ The data is updated every 5 minutes.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## State Attributes
|
||||
## State attributes
|
||||
|
||||
The following state attributes are available for each entity in addition to the standard ones:
|
||||
|
||||
|
@ -47,7 +47,7 @@ We acknowledge the New Zealand GeoNet project and its sponsors EQC, GNS Science
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## State Attributes
|
||||
## State attributes
|
||||
|
||||
The following state attributes are available for each entity in addition to
|
||||
the standard ones:
|
||||
@ -91,7 +91,7 @@ from the feed.
|
||||
| updated | Number of entities that were updated during last update (optional). |
|
||||
| removed | Number of entities that were removed during last update (optional). |
|
||||
|
||||
## Full Configuration
|
||||
## Full configuration
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -47,7 +47,7 @@ We acknowledge the New Zealand GeoNet project and its sponsors EQC, GNS Science
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## State Attributes
|
||||
## State attributes
|
||||
|
||||
The following state attributes are available for each entity in addition to
|
||||
the standard ones:
|
||||
@ -63,7 +63,7 @@ the standard ones:
|
||||
| last update | Timestamp of the last update from the feed. |
|
||||
| last update successful | Timestamp of the last successful update from the feed. |
|
||||
|
||||
## Full Configuration
|
||||
## Full configuration
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
@ -41,7 +41,7 @@ For details about auto-starting `glances`, please refer to [Start Glances throug
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Integration Entities
|
||||
## Integration entities
|
||||
|
||||
Glances integration will add the following sensors if available in the platform:
|
||||
|
||||
|
@ -22,7 +22,7 @@ This Goal Zero Yeti integration pulls data from a Wifi-enabled [Goal Zero Yeti](
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Integration Entities
|
||||
## Integration entities
|
||||
|
||||
Each added configuration entry will create the following binary sensors:
|
||||
|
||||
|
@ -21,7 +21,7 @@ The `gogogate2` cover platform lets you control Gogogate2 and iSmartGate enabled
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
### Supported Devices
|
||||
### Supported devices
|
||||
|
||||
- Gogogate 2
|
||||
- ismartgate PRO
|
||||
|
@ -84,7 +84,7 @@ filter:
|
||||
Not filtering domains or entities will send every event to Google PubSub, thus hitting the free tier limit very fast. Be sure to fill in this configuration parameter or have a paid subscription for Google Cloud.
|
||||
</div>
|
||||
|
||||
### Configure Filter
|
||||
### Configure filter
|
||||
|
||||
By default, no entity will be excluded. To limit which entities are being exposed to `Google Pub/Sub`, you can use the `filter` parameter.
|
||||
|
||||
|
@ -126,7 +126,7 @@ To add or remove entities from an existing group, click on `Group options`, all
|
||||
|
||||

|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
Alternatively, this integration can be configured and set up manually via YAML
|
||||
instead. Here are example of how to configure groups when using the `configuration.yaml` file.
|
||||
@ -284,7 +284,7 @@ state_class:
|
||||
required: false
|
||||
{% endconfiguration %}
|
||||
|
||||
## Notify Groups
|
||||
## Notify groups
|
||||
|
||||
This group is a special case of groups currently only available via YAML configuration.
|
||||
|
||||
|
@ -68,7 +68,7 @@ On a Raspberry Pi, you may need to add the Home Assistant user to the `audio` gr
|
||||
sudo usermod -a -G audio <ha_user>
|
||||
```
|
||||
|
||||
## Example Usage
|
||||
## Example usage
|
||||
|
||||
### Using with TTS
|
||||
|
||||
|
@ -65,7 +65,7 @@ For Home Assistant Host, the following sensors are available:
|
||||
| Disk Total | no | Total space (in GB) on the device
|
||||
| Disk Used | no | Used space (in GB) on the device
|
||||
|
||||
## Binary Sensor entities
|
||||
## Binary sensor entities
|
||||
|
||||
For each installed add-on Supervisor provides following binary sensors:
|
||||
|
||||
|
@ -52,7 +52,7 @@ Use the sign-out service to sign the connected controller out of a HEOS account.
|
||||
|
||||
### Service `media_player.play_media`
|
||||
|
||||
#### Play Favorite
|
||||
#### Play favorite
|
||||
|
||||
You can play a HEOS favorite by number or name with the `media_player.play_media` service. Example service data payload:
|
||||
|
||||
@ -68,7 +68,7 @@ media_content_id: "1"
|
||||
| `media_content_type` | no | Set to the value `favorite`
|
||||
| `media_content_id` | no | (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite
|
||||
|
||||
#### Play Playlist
|
||||
#### Play playlist
|
||||
|
||||
You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload:
|
||||
|
||||
|
@ -30,7 +30,7 @@ Notes:
|
||||
|
||||
{% include integrations/option_flow.md %}
|
||||
|
||||
## Dynamic Configuration
|
||||
## Dynamic configuration
|
||||
|
||||
Tracking can be set up to track entities of type `device_tracker`, `zone`, `sensor`, `input_select`, `input_text` and `person`. If an entity is placed in the origin or destination then each time the platform updates, it will use the latest location of that entity. This means it will directly use its location if possible or try to resolve entity values until it finds a valid set of coordinates. You can put several destinations as options of an `input_select` and define that as the destination.
|
||||
|
||||
|
@ -133,7 +133,7 @@ duration:
|
||||
|
||||
</div>
|
||||
|
||||
### Video Tutorial
|
||||
### Video tutorial
|
||||
This video tutorial explains how you can use history stats. It also shows how you can create a daily bar chart graph to visualize things such as occupancy, or how long the lights are on in a particular room.
|
||||
|
||||
<lite-youtube videoid="BMlU4SynQBY" videotitle="How To Master Graphs to Monitor Occupancy and Device Usage in Home Assistant" posterquality="maxresdefault"></lite-youtube>
|
||||
|
@ -82,7 +82,7 @@ Restart Home Assistant after changing the YAML configuration. At this point, you
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## API Nomenclature
|
||||
## API nomenclature
|
||||
|
||||
Within the context of the Home+ Control API you may come across the following terms:
|
||||
|
||||
@ -93,7 +93,7 @@ Within the context of the Home+ Control API you may come across the following te
|
||||
|
||||
Other devices that are mentioned in the API, but that are not currently supported by this integration are: *remotes* (wireless switches), *heaters* and *automations*.
|
||||
|
||||
## API Limitations
|
||||
## API limitations
|
||||
|
||||
As described in the [authentication](#authentication) section, this integration requires you to set up a subscription in the *Works with Legrand* platform.
|
||||
|
||||
|
@ -222,7 +222,7 @@ Executable by administrators or within the context of an automation:
|
||||
- `homematicip_cloud.dump_hap_config`: Dump the configuration of the Homematic IP Access Point(s).
|
||||
- `homematicip_cloud.reset_energy_counter`: Reset energy counter of measuring actuators.
|
||||
|
||||
### Service Examples
|
||||
### Service examples
|
||||
|
||||
`accesspoint_id` (SGTIN) is optional for all services and only relevant if you have multiple Homematic IP Accesspoints connected to HA. If empty, service will be called for all configured Homematic IP Access Points.
|
||||
The `accesspoint_id` (SGTIN) can be found on top of the integration page, or on the back of your Homematic IP Accesspoint.
|
||||
|
@ -69,7 +69,7 @@ Sensors for Water meter:
|
||||
- **Active usage (L/min)**: Flow of water that is measured at that time.
|
||||
- **Total usage (m³)**: Total water usage since the installation of the HomeWizard Water meter.
|
||||
|
||||
## Energy Socket
|
||||
## Energy socket
|
||||
|
||||
The Energy Socket outlet state and status light can be controlled. There are two switches:
|
||||
|
||||
|
@ -39,7 +39,7 @@ To set up the Hydrawise integration, you must first obtain an API Key.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Binary Sensor
|
||||
## Binary sensor
|
||||
|
||||
Binary sensor entities are created for the controller:
|
||||
|
||||
@ -67,7 +67,7 @@ Switches are added for each zone, controlling:
|
||||
- Smart watering features
|
||||
- Manual watering
|
||||
|
||||
### Switch Operation
|
||||
### Switch operation
|
||||
|
||||
When `auto_watering` is `on` the irrigation zone will follow the Smart Watering schedule set through the Hydrawise [mobile or web app](https://www.hydrawise.com). When the `auto_watering` switch is `off` the zone's Smart Watering schedule is suspended for 1 year.
|
||||
|
||||
|
@ -41,13 +41,13 @@ Options supported:
|
||||
- **Effects to hide**: An optional selection of effects to hide from the light effects
|
||||
list. New effects added to the Hyperion server will be shown by default.
|
||||
|
||||
## Hyperion Instances
|
||||
## Hyperion instances
|
||||
|
||||
This integration supports multiple Hyperion instances running on a single Hyperion
|
||||
server. As instances are added/removed on the Hyperion UI, they will automatically be
|
||||
added/removed from Home Assistant.
|
||||
|
||||
## Light Entity
|
||||
## Light entity
|
||||
|
||||
The default light entity will send data to Hyperion on the priority you have configured
|
||||
during integration setup. When turned off, it will clear the configured priority again.
|
||||
@ -61,7 +61,7 @@ a global switch (see Advanced Entities).
|
||||
The effect list is dynamically pulled from the Hyperion server. Additionally, there
|
||||
will be a 'Solid' effect to switch (back) to showing a solid color only.
|
||||
|
||||
## Hyperion Camera
|
||||
## Hyperion camera
|
||||
|
||||
A Hyperion camera entity is created that shows a stream of the input to Hyperion (e.g., a
|
||||
USB Capture device). This could be used to show a small "preview window" next to TV
|
||||
@ -71,7 +71,7 @@ Please note that only the currently live Hyperion priority can be streamed, and
|
||||
streamable sources will actually stream content (e.g., USB Capture Devices will work, but
|
||||
static colors will not).
|
||||
|
||||
## Advanced Entities
|
||||
## Advanced entities
|
||||
|
||||
The Hyperion integration comes with a series of disabled-by-default entities for
|
||||
advanced usecases. These entities expose 'raw' underlying Hyperion API components for
|
||||
|
@ -83,7 +83,7 @@ If you want an easier way to get the IHC resource ids, you can download the [Alt
|
||||
|
||||
See the manual of each device type for configuration options.
|
||||
|
||||
## Binary Sensor
|
||||
## Binary sensor
|
||||
|
||||
Before you can use the IHC Binary Sensor platform, you must setup the IHC integration.
|
||||
|
||||
|
@ -211,7 +211,7 @@ component_config_glob:
|
||||
required: false
|
||||
{% endconfiguration %}
|
||||
|
||||
## Configure Filter
|
||||
## Configure filter
|
||||
|
||||
By default, no entity will be excluded. To limit which entities are being exposed to `InfluxDB`, you can use the `include` and `exclude` parameters.
|
||||
|
||||
|
@ -74,13 +74,13 @@ Home Assistant itself.
|
||||
| `toggle` | `entity_id(s)`<br>`area_id(s)` | Toggle the value of specific `input_boolean` entities
|
||||
| `reload` | | Reload `input_boolean` configuration |
|
||||
|
||||
### Restore State
|
||||
### Restore state
|
||||
|
||||
If you set a valid value for `initial` this integration will start with the state
|
||||
set to that value. Otherwise, it will restore the state it had prior to
|
||||
Home Assistant stopping.
|
||||
|
||||
## Automation Examples
|
||||
## Automation examples
|
||||
|
||||
Here's an example of an automation using the above `input_boolean`. This action
|
||||
will only occur if the `input_boolean` is on.
|
||||
|
@ -54,7 +54,7 @@ input_button:
|
||||
type: icon
|
||||
{% endconfiguration %}
|
||||
|
||||
## Automation Examples
|
||||
## Automation examples
|
||||
|
||||
The `input_button` entity is stateless, as in, it cannot have a state like the
|
||||
`on` or `off` state that, for example, a normal switch entity has.
|
||||
|
@ -85,7 +85,7 @@ automations and templates.
|
||||
| `year`<br>`month`<br>`day` | The year, month and day of the date.<br>(only available if `has_date: true`)
|
||||
| `timestamp` | A timestamp representing the time held in the input.<br>(only available if `has_time: true`)
|
||||
|
||||
### Restore State
|
||||
### Restore state
|
||||
|
||||
If you set a valid value for `initial`, this integration will start with the state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping.
|
||||
|
||||
|
@ -94,7 +94,7 @@ configuration without restarting Home Assistant itself.
|
||||
| `reload` | | Reload `input_number` configuration |
|
||||
| `set_value` | `value`<br>`entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_number` entities
|
||||
|
||||
### Restore State
|
||||
### Restore state
|
||||
|
||||
If you set a valid value for `initial` this integration will start with the state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping. Please note that `initial` is only available in a YAML configuration and not via the Home Assistant user interface.
|
||||
|
||||
@ -110,7 +110,7 @@ scene:
|
||||
input_number.example_number: 13
|
||||
```
|
||||
|
||||
## Automation Examples
|
||||
## Automation examples
|
||||
|
||||
Here's an example of `input_number` being used as a trigger in an automation.
|
||||
|
||||
|
@ -69,7 +69,7 @@ Because YAML defines [booleans](https://yaml.org/type/bool.html) as equivalent,
|
||||
|
||||
</div>
|
||||
|
||||
### Restore State
|
||||
### Restore state
|
||||
|
||||
If you set a valid value for `initial` this integration will start with the state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping.
|
||||
|
||||
@ -129,7 +129,7 @@ scene:
|
||||
```
|
||||
|
||||
|
||||
## Automation Examples
|
||||
## Automation examples
|
||||
|
||||
The following example shows the usage of the `input_select.select_option` service in an automation:
|
||||
|
||||
|
@ -88,7 +88,7 @@ This integration provides a service to modify the state of the `input_text` and
|
||||
| `set_value` | `value`<br>`entity_id(s)` | Set the value for specific `input_text` entities.
|
||||
| `reload` | | Reload `input_text` configuration |
|
||||
|
||||
### Restore State
|
||||
### Restore state
|
||||
|
||||
If you set a valid value for `initial` this integration will start with state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping.
|
||||
|
||||
@ -104,7 +104,7 @@ scene:
|
||||
input_text.example: Hello!
|
||||
```
|
||||
|
||||
## Automation Examples
|
||||
## Automation examples
|
||||
|
||||
Here's an example using `input_text` in an action in an automation.
|
||||
|
||||
|
@ -44,7 +44,7 @@ Integration time:
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
Alternatively, this integration can be configured and set up manually via YAML
|
||||
as well. To enable the Integration sensor in your installation, add the
|
||||
|
Loading…
x
Reference in New Issue
Block a user