c-f integrations: apply sentence style capitalization (#29860)

This commit is contained in:
c0ffeeca7 2023-11-16 12:23:01 +01:00 committed by GitHub
parent a151fbadff
commit e21e250a65
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
30 changed files with 39 additions and 39 deletions

View File

@ -27,7 +27,7 @@ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev
{% enddetails %}
## Basic Setup
## Basic setup
To integrate a WebDAV calendar in Home Assistant, add the following section to your `configuration.yaml` file:

View File

@ -70,7 +70,7 @@ away from the current time, or your trigger might not fire.
See [Automation Trigger Variables: Calendar](/docs/automation/templating/#calendar)
for additional trigger data available for conditions or actions.
### Automation Recipes
### Automation recipes
Below are a few example ways you can use Calendar triggers.

View File

@ -18,7 +18,7 @@ The camera integration allows you to use IP cameras with Home Assistant.
{% include integrations/building_block_integration.md %}
### Streaming Video
### Streaming video
If your camera supports it, and the [`stream`](/integrations/stream) integration is setup, you will be able to stream your cameras in the frontend and on supported media players.

View File

@ -409,7 +409,7 @@ value_template:
If a property works in *optimistic mode* (when the corresponding state topic is not set), Home Assistant will assume that any state changes published to the command topics did work and change the internal state of the entity immediately after publishing to the command topic. If it does not work in optimistic mode, the internal state of the entity is only updated when the requested update is confirmed by the device through the state topic. You can enforce optimistic mode by setting the `optimistic` option to `true`. When set, the internal state will always be updated, even when a state topic is defined.
## Using Templates
## Using templates
For all `*_state_topic`s, a template can be specified that will be used to render the incoming payloads on these topics. Also, a default template that applies to all state topics can be specified as `value_template`. This can be useful if you received payloads are e.g., in JSON format. Since in JSON, a quoted string (e.g., `"foo"`) is just a string, this can also be used for unquoting.

View File

@ -25,6 +25,6 @@ To configure and use this integration, you need to obtain a free API key from El
{% include integrations/config_flow.md %}
## Sensor Types
## Sensor types
When configured, the platform will create two sensors for each configured location: the carbon intensity expressed in `gCO2eq/kWh` and a percentage of how much the grid relies on fossil fuels for production.

View File

@ -34,7 +34,7 @@ This section enables you to manage your Home Assistant users.
This section enables you to manage the name, location, and unit system of your Home Assistant installation.
### Server Control
### Server control
This section enables you to control Home Assistant from within Home Assistant. Check your configuration, reload the core, groups, scripts, automations, and the Home Assistant process itself with a single mouse click.

View File

@ -15,7 +15,7 @@ Home Assistant can give you an interface to control covers such as rollershutter
{% include integrations/building_block_integration.md %}
## Device Class
## Device class
The way these {% term sensors %} are displayed in the {% term frontend %} can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for covers:

View File

@ -39,7 +39,7 @@ Time unit:
description: SI unit of time of the derivative. If this parameter is set, the unit of measurement will be set to **x/y** where **x** is the unit of the source sensor and **y** is the value of this parameter.
{% endconfiguration_basic %}
## YAML Configuration
## YAML configuration
Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the Derivative sensor in your installation, add the

View File

@ -48,7 +48,7 @@ The integration provides support for the following Z-Wave devices:
- Fibaro Wall Plug
- Fibaro Double Relay Switch
## Binary Sensors
## Binary sensors
The integration provides support for the following Z-Wave devices:

View File

@ -34,11 +34,11 @@ The devolo Home Network integration allows you to monitor your PLC network.
{% include integrations/config_flow.md %}
## Device Types
## Device types
Currently the following device types within Home Assistant are supported.
### Binary Sensors
### Binary sensors
- Device attached to the router
- Updates every 5 minutes
@ -57,7 +57,7 @@ Currently the following device types within Home Assistant are supported.
- Updates every 15 seconds if changes are detected
- Is enabled by default
### Presence Detection
### Presence detection
- Detect presence of devices connected to the main or the guest wifi
- Updates every 15 seconds

View File

@ -41,7 +41,7 @@ If you have a sensor session running, and once you have enabled the Dexcom integ
- Blood glucose value sensor
- Blood glucose trend sensor
## Example Automation
## Example automation
```yaml
- id: '1234567890123'

View File

@ -44,7 +44,7 @@ access_token:
type: string
{% endconfiguration %}
## Binary Sensor
## Binary sensor
The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets.

View File

@ -32,7 +32,7 @@ ha_integration_type: integration
The `ecobee` integration lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats.
## Preliminary Steps
## Preliminary steps
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this integration. To get the key, your thermostat must be registered on ecobee's website (which you likely would have already done while installing your thermostat). Once you have done that, perform the following steps.
@ -61,7 +61,7 @@ Your new application will now appear on the left. Upon clicking on the applicati
3. In the next pop-up box, you will be presented with a unique 8 character code separated by a dash (format: XXXX-XXXX), which you will need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by logging in, selecting **My Apps** from the hamburger menu, clicking **Add Application** on the left, entering the PIN code from Home Assistant, clicking **Validate** and then **Add Application** in the bottom right.
4. After authorizing the app with ecobee, return to Home Assistant and click **Submit**. If the authorization was successful, a configuration entry will be created and your thermostats, ventilators and sensors will be available in Home Assistant.
## Manual Configuration
## Manual configuration
If you prefer to set up the integration in [`configuration.yaml`](/docs/configuration/), add your API key (and optional parameters) as follows (however, you must still complete authorization via the **Integrations** panel):

View File

@ -34,7 +34,7 @@ EcoNet devices may be represented by one or more platforms.
- [Sensor](#sensor)
- [Water Heater](#water-heater)
### Binary Sensor
### Binary sensor
The EcoNet Binary Sensor platform lets you view binary states of sensors associated with your EcoNet thermostat or water heater. For example, if the device is currently running.
@ -46,6 +46,6 @@ The EcoNet Climate platform lets you control your EcoNet thermostat. Multi-zone
The EcoNet Sensor platform lets you view sensors associated with your EcoNet thermostat or water heater. For example, alert count or available hot water.
### Water Heater
### Water heater
The EcoNet Water Heater platform lets you control your EcoNet water heater. Water Heaters do not report the current water temperature.

View File

@ -170,7 +170,7 @@ template:
{% endraw %}
### Handling Errors
### Handling errors
The vacuum entity has an `error` attribute that will contain the _most recent_ error message that came from the vacuum. There is not a comprehensive list of all error messages, so you may need to do some experimentation to determine the error messages that your vacuum can send.

View File

@ -27,7 +27,7 @@ To get an app token:
3. Click on App tokens
4. Click "Add token"
## Integration Entities
## Integration entities
The following sensors will be created:

View File

@ -123,7 +123,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha
Note that for all code groups (*arm*,*disarm*, etc) multiple codes can be entered since each sensor triggers with a different code and each user of the system has its own arm and disarm codes. Also note that your system will do regular system checks which will be reported as well. Since Home Assistant provides no way of handling them properly, you can enter those codes as *ignore* (again, multiple codes can be used here). The egardia integration will ignore these codes and continue returning the old status if it receives any of the codes that are listed as ignore. This is useful for example when you have armed your alarm at night: normally a system check will occur at least once during the night and if that code is not specified anywhere Home Assistant will set the status of the alarm to its default, which is unarmed. This is in fact wrong. Listing the code as ignore changes this behavior and Home Assistant will continue to show the status the alarm is in (disarm, arm, home, triggered) even when system checks occur.
5. Test your setup and enjoy. The integration will update if the alarm status changes, including triggers. You can use this to build your own automations and send notifications as you wish. *Note*: previous versions required a separate egardiaserver to be set up. This is no longer necessary and corresponding system services can be removed (using systemctl).
## Binary Sensor
## Binary sensor
The `egardia` platform allows you to get data from your [Egardia](https://www.egardia.com)/[Woonveilig](https://www.woonveilig.nl) binary sensors from within Home Assistant.
Currently only door contacts are supported. IR sensors are not supported and will probably never be since their status cannot be read outside of the alarm control panel. Smoke sensors and others might be added but currently are not supported.

View File

@ -51,7 +51,7 @@ Support for tech-in messages is not implemented.
Despite the UI-based configuration of the hub, the entities are still configured using YAML see next chapters).
## Binary Sensor
## Binary sensor
This can typically be one of those batteryless wall switches.
Tested with:

View File

@ -24,7 +24,7 @@ The Environment Canada integration provides meteorological data for Canadian loc
{% include integrations/config_flow.md %}
## Location Selection
## Location selection
The integration automatically determines the closest weather station based on the latitude and longitude specified. If integration-specific coordinates are not provided, the coordinates configured for Home Assistant are used.
@ -88,11 +88,11 @@ The integration will create the entities listed below. Some of the entities are
The alert sensors use the number of current alerts as their state, with an attribute containing the title of each alert.
## Solving Problems
## Solving problems
The Environment Canada service is very stable and provides high-quality data. Here are some steps that you can take before opening a problem report or posting on the forum.
### Service Interruptions
### Service interruptions
Although infrequent, there have been some outages and instabilities of the Environment Canada service. If you see error messages in your logs similar to the one below, it is very unlikely to be a problem with this integration and is likely a problem with the Environment Canada service.
@ -106,7 +106,7 @@ The first course of action should be to check if there are known problems with t
Not all weather stations provide a complete set of weather/sensor data. The data that is retrieved by this integration can be found [here](https://dd.weather.gc.ca/citypage_weather/xml/). Browsing the XML data for your station will help you to understand what data is (un)available.
## Template Sensors
## Template sensors
The configuration snippet below adds a useful [template sensors](/integrations/template/) showing the current "feels like" temperature among air temperature, humidex, and wind chill.

View File

@ -13,7 +13,7 @@ ha_integration_type: integration
[EverLights](https://myeverlights.com/) are permanent Christmas lights installed on a home's gutters or flashing. This integration can change all LEDs in a zone to a single color or activate a pattern that was previously saved to the control box.
### Configuration Details
### Configuration details
To enable EverLights, add the following lines to your `configuration.yaml` file:

View File

@ -78,11 +78,11 @@ The DHW controller is represented as a **WaterHeater** entity which will report
Note that there is limited support for schedules: they cannot be changed and there is no facility to backup/restore that data (see [here](https://evohome.readthedocs.io/en/latest/) for such functionality).
### Round Thermostat
### Round thermostat
These systems use an internet gateway rather than an Evohome controller. They usually have only one Round Thermostat, although they can have two. Systems with one such thermostat will still appear as two **Climate** entities, one for location mode (away, economy, etc.), and another for the zone setpoint.
## Temperature Precision
## Temperature precision
Note that TCC devices may well measure temperatures with very high precision, but the vendor API will report temperatures rounded _towards_ the setpoint (i.e., either up or down) with a precision of 0.5 °C; this a proxy for the deadband as used by other climate systems. Where possible, this integration will leverage an older vendor API to obtain current temperatures with a precision of 0.01 °C.
@ -112,7 +112,7 @@ Some locations have a hidden mode, **AutoWithReset**, that will behave as **Auto
In the Home Assistant schema, all this is done via a combination of `HVAC_MODE` and `PRESET_MODE` (but also see the state attributes `system_mode_status` and `setpoint_status`, below).
## Service Calls
## Service calls
This integration provides its own service calls to expose the full functionality of TCC systems beyond the limitations of Home Assistant's standardized schema. Mostly, this relates to specifying the duration of mode changes, after which time the entities revert to **Auto** or **FollowSchedule** (for locations and zones, respectively).

View File

@ -89,7 +89,7 @@ automation:
Any field under the `<entry>` tag in the feed can be used for example `trigger.event.data.content` will get the body of the feed entry.
### Video Tutorial
### Video tutorial
This video tutorial explains how to set up the feedreader and show the latest news feed item on your dashboard in Home Assistant.
<lite-youtube videoid="Va4JOKbesi0" videotitle="How to view RSS feeds on your Dashboard in Home Assistant" posterquality="maxresdefault"></lite-youtube>

View File

@ -158,7 +158,7 @@ To adjust the rate you need to set the window_size. To throttle a sensor down to
This filter is relevant when you have a sensor which produces states at a very high-rate, which you might want to throttle down for storing or visualization purposes.
### Time Throttle
### Time throttle
The Time Throttle filter (`time_throttle`) will only update the state of the sensor for the first state in the window. This means the filter will skip all other values.

View File

@ -49,7 +49,7 @@ The integration setup will next give you instructions to enter the [Application
{% enddetails %}
## Additional Information
## Additional information
Please be aware that Fitbit has very low rate limits, 150 per user per hour. The clock resets at the _top_ of the hour (meaning it is not a rolling 60 minutes). There is no way around the limits. Due to the rate limits, the sensor only updates every 30 minutes. You can manually trigger an update by restarting Home Assistant. Keep in mind that 1 request is used for every sensor.

View File

@ -37,7 +37,7 @@ sensor:
type: string
{% endconfiguration %}
## Available Metrics
## Available metrics
Every ten minutes, it'll fetch the last ten minutes average of the following measurements:

View File

@ -22,7 +22,7 @@ All devices with a MAC address identified by FortiGate would be tracked, this co
The integration is based on the Home Assistant `device_tracker` platform.
### Example Configuration:
### Example configuration:
This example uses the FortiOS integration as a device tracker, with an API token and does not verify the SSL certificate.

View File

@ -96,7 +96,7 @@ Only the routers with Freebox OS are supported:
- Freebox V6 also known as Freebox Revolution
- Freebox mini 4k
## Presence Detection
## Presence detection
This platform offers presence detection by keeping track of the devices connected to a [Freebox](https://www.free.fr/freebox/) router.

View File

@ -34,7 +34,7 @@ Freedompro with its products installed on the electrical system, allows you to c
This integration lets you control all [Freedompro](https://freedompro.eu/) accessories.
## Preliminary Steps
## Preliminary steps
You will need to obtain an API key from [Freedompro Cloud](https://home.freedompro.eu/) to use this integration.

View File

@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant:
Additionally, we also support to trigger smarthome templates.
#### Tested Devices
#### Tested devices
- [FRITZ!Box 5590 Fiber](https://en.avm.de/products/fritzbox/fritzbox-5590-fiber/)
- FRITZ!Box 6490 Cable

View File

@ -17,7 +17,7 @@ ha_config_flow: true
This integration provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the UNDOK app.
## Supported Models
## Supported models
Frontier Silicon is used by many different brands of radio manufacturers.