a-b integrations: apply sentence-style capitalization (#29859)

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

View File

@ -74,7 +74,7 @@ Service parameters:
- **adstype**: Specify the type of the variable. Use one of the following: `int`, `byte`, `uint`, `bool`
- **value**: The value that will be written in the variable.
## Binary Sensor
## Binary sensor
The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device.

View File

@ -59,7 +59,7 @@ The integration will create sensor entities for a variety of aspects:
- Each zone that is temperature-controlled will have a sensor to show the temperature (disabled by default), and how open the damper is.
- Each zone with a wireless temperature or motion sensor will have a sensor that reports its wireless RSSI.
### Binary Sensor
### Binary sensor
The integration will create a binary sensor for each zone that has a motion sensor.

View File

@ -33,7 +33,7 @@ There are two ways of retrieving the 10-digit serial number of a Wave device:
This integration uses the last 6 digits of the serial number.
## Supported Devices
## Supported devices
- Wave gen. 1
- Wave Radon

View File

@ -73,7 +73,7 @@ AQI | Status | Description
- **Sample Sensor Name:** `sensor.us_air_pollution_level`
- **Example Sensor Value:** `Moderate`
### Main Pollutant
### Main pollutant
- **Description:** This sensor displays the pollutant whose value is currently highest.
- **Sample Sensor Name:** `sensor.us_main_pollutant`

View File

@ -23,7 +23,7 @@ You will need the device's Samba password, which [can be found on the unit](http
{% include integrations/config_flow.md %}
## Sensor Types
## Sensor types
AirVisual Pro devices create a variety of sensors:

View File

@ -41,7 +41,7 @@ ID:
description: "Airzone System ID (only needed if System ID 0 is not supported on your device)"
{% endconfiguration_basic %}
## Binary Sensors
## Binary sensors
For each Airzone system (HVAC machine), the following *binary sensors* are created:
@ -97,6 +97,6 @@ For each Airzone zone (Thermostat), the following *sensors* are created:
| humidity | Current zone relative humidity. |
| temperature | Current zone temperature. |
## Water Heater
## Water heater
For each Airzone device a *water heater entity* is created if supported.

View File

@ -45,7 +45,7 @@ Password:
description: "Cloud API password"
{% endconfiguration_basic %}
## Binary Sensors
## Binary sensors
For each Airzone system (HVAC machine), the following *binary sensors* are created:

View File

@ -43,7 +43,7 @@ You will be prompted to select a protocol (i.e. `socket` or `serial`). Depending
Once AlarmDecoder has been set up according to the instructions above, the arming settings and zones can be configured by selecting _Options_ on the _AlarmDecoder_ card on the **{% my integrations title="Settings -> Devices & Services" %}** page.
### Arming Settings
### Arming settings
There are currently 3 arming settings for AlarmDecoder (shown below).
@ -71,7 +71,7 @@ When prompted, enter the number of the zone you'd like to edit. Press _Submit_ t
When prompted, enter the number of the zone you'd like to remove. Press _Submit_ to move to the next screen where the existing zone settings will be pre-filled. Clear the _Zone Name_ field and press _Submit_.
#### Zone Settings
#### Zone settings
The settings for zones are described below:

View File

@ -29,7 +29,7 @@ State | Description
`on` | The condition for the alert is true.
`off` | The condition for the alert is true but it was acknowledged.
### Basic Example
### Basic example
The `alert` integration makes use of any of the `notification` integrations. To
setup the `alert` integration, first, you must setup a `notification` integration.
@ -215,7 +215,7 @@ following notification.
For example, if the garage door opens at 2:00, a notification will be
sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes.
### Message Templates
### Message templates
It may be desirable to have the alert notifications include information
about the state of the entity. [Templates][template]

View File

@ -80,7 +80,7 @@ Next you need to create a Lambda function.
- Go back to your Alexa skill and go to the Custom->Endpoint menu option on the left.
- Paste the ARN value in the "Default Region". Note: you will not be able to do this until you have completed the step above adding the Alexa Skills Kit trigger (done in the previous step) to the AWS Lambda Function.
### Account Linking
### Account linking
Alexa can link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa requests are actioned. In order to link the account, you have to make sure your Home Assistant instance can be accessed from the Internet.
@ -232,7 +232,7 @@ Here we are using [templates] to take the name we gave to Alexa e.g., `downstair
Now say `Alexa ask Home Assistant to activate <some scene>` and Alexa will activate that scene for you.
### Adding Scripts
### Adding scripts
We can easily extend the above idea to work with scripts as well. As before, add an intent for scripts:

View File

@ -221,7 +221,7 @@ Now remove the long-lived access token (if you want), copy the ARN of your Lambd
- Click `SMART HOME` in the left navigation bar of build page.
- Fill in `Default endpoint` under `2. Smart Home service endpoint` using the `ARN` you copied from your Lambda function configuration.
## Account Linking
## Account linking
Alexa needs to link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa requests are able to access your home's devices. In order to link the account, you have to make sure your Home Assistant can be accessed from Internet at port 443.
@ -383,7 +383,7 @@ alexa:
type: string
{% endconfiguration %}
### Alexa Locale <!-- omit in toc -->
### Alexa locale <!-- omit in toc -->
The `locale` should match the location and language used for your Amazon echo devices.
@ -407,7 +407,7 @@ The supported locales are:
See [List of Capability Interfaces and Supported Locales][alexa-supported-locales].
### Proactive Events <!-- omit in toc -->
### Proactive events <!-- omit in toc -->
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode (i.e., "Send Alexa Events" enabled). Please note the following if you want to enable proactive mode:
@ -415,7 +415,7 @@ The `endpoint`, `client_id` and `client_secret` are optional, and are only requi
- The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the [Alexa Developer Console][alexa-dev-console]: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available. Also, you need to restart your Home Assistant after each disabling/enabling the skill in Alexa."
### Configure Filter <!-- omit in toc -->
### Configure filter <!-- omit in toc -->
By default, no entity will be excluded. To limit which entities are being exposed to Alexa, you can use the `filter` parameter. Keep in mind that only [supported platforms](#supported-platforms) can be added.
@ -452,7 +452,7 @@ Devices such as cameras, garage doors, and alarm control panels require specific
See [Alexa Display Categories][alexa-display-categories] for a complete list
## Supported Platforms
## Supported platforms
Home Assistant supports the following integrations through Alexa using a Smart Home Skill. For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/).
@ -553,7 +553,7 @@ Turn on and off Alert, Automation, and Group entities as switches.
- _"Alexa, turn off energy saving automations."_
- _"Alexa, Downstairs to on."_
### Binary Sensor
### Binary sensor
Requires [Proactive Events](#proactive-events) enabled.
@ -600,7 +600,7 @@ In order to enable this, buttons will appear to have "presence detection" capabi
<img height='460' src='/images/integrations/alexa/alexa_app_button_trigger.png' alt='Screenshot: Alexa App Button Routine Trigger'/></a>
</p>
#### Doorbell Announcement with binary_sensor
#### Doorbell announcement with binary_sensor
Requires [Proactive Events](#proactive-events) enabled.
@ -755,7 +755,7 @@ Covers that support tilt position can be controlled using percentages.
Currently, Alexa only supports friendly name synonyms for the `en-US` locale.
#### Garage Doors
#### Garage doors
Covers with a `device_class` of `garage` support the Open by Voice PIN feature in the Alexa app. Configure a 4 digit PIN code to open the garage door in the Alexa app.
@ -768,7 +768,7 @@ Covers with a `device_class` of `garage` support the Open by Voice PIN feature i
Requires [Proactive Events](#proactive-events) enabled.
#### Doorbell Events
#### Doorbell events
Home Assistant `event` entities can trigger a doorbell announcement in Alexa if the `device_class` of the `event` entity is set to `doorbell`.
Alexa will announce on all echo devices _"Someone is at the [entity name]"_ when an `event` entity has received an updated.
@ -786,7 +786,7 @@ Each Amazon Echo device will need the communication and announcements setting en
Control fan speed, direction, and oscillation.
#### Fan Speed
#### Fan speed
The fan device must support percentage based speeds with the `percentage` attribute.

View File

@ -73,7 +73,7 @@ foreign_exchange:
type: string
{% endconfiguration %}
## API Information
## API information
Alpha Vantage offers two tiers of the API key, one free and one paid for. If you are using the free version you will be limited to five queries per minute. This means that you'll likely only be able to have one or two ticker entries. The paid version starts at thirty queries per minute increasing ticker quantity quite a bit.

View File

@ -396,7 +396,7 @@ elements:
movement: zoom_out
```
## Advanced Configuration
## Advanced configuration
You can also use this more advanced configuration example:

View File

@ -18,7 +18,7 @@ The `ampio` air quality platform will query the open data API of [ampio.pl](http
To get the ID of a station you need to contact Ampio directly.
## Manual Configuration
## Manual configuration
To enable this platform, add the following lines to your `configuration.yaml` file:

View File

@ -17,7 +17,7 @@ ha_integration_type: system
Home Assistant allows users to share their usage data via the analytics integration. The aggregated data is available at <https://analytics.home-assistant.io>. It is used to influence Home Assistant development priorities and to convince manufacturers to add local control and privacy-focused features.
## Data Collection
## Data collection
The information sent depends on what options you opt-in to. You can opt-in during onboarding and by going to **{% my analytics title="Settings > System > Analytics" %}** .

View File

@ -60,7 +60,7 @@ Configure State Detection Rules:
description: Here you can configure a list of rules where the rule key is the app IDs and whose values are lists of state detection rules. As example a valid value for a detection rule is `["standby", {"playing":{"media_session_state":4}}, {"paused":{"media_session_state":3, "wake_lock_size":4}}]`. Note that rule values must be always inside square bracket (`[...]`). See the section [Custom State Detection](#custom-state-detection) for more info.
{% endconfiguration_basic %}
## ADB Setup
## ADB setup
This integration works by sending ADB commands to your Android / Fire TV device. There are two ways to accomplish this.
@ -94,7 +94,7 @@ To configure ADB server on integration setup, you need to enable [advanced mode]
Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value.
## ADB Troubleshooting
## ADB troubleshooting
If the setup for your Android or Fire TV device fails, then there is probably an issue with your ADB connection. Here are some possible causes.

View File

@ -16,7 +16,7 @@ ha_integration_type: integration
Both [Anthem]'s current and last generation of A/V Receivers and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network.
## Supported Models
## Supported models
### A/V Receiver
@ -28,7 +28,7 @@ Both [Anthem]'s current and last generation of A/V Receivers and Processors supp
- [AVM 60](https://www.anthemav.com/products-current/model=avm-60/page=overview)
### Distribution Solution
### Distribution solution
- [MDX 8](https://www.anthemav.com/products-current/type=distribution/model=mdx-8/page=overview), [MDX 16](https://www.anthemav.com/products-current/type=distribution/model=mdx-16/page=overview)
- Martin Logan [MDA 8](https://www.martinlogan.com/en/product/mda8), [MDA 16](https://www.martinlogan.com/en/product/mda16)

View File

@ -84,7 +84,7 @@ filter:
type: list
{% endconfiguration %}
## Configure Filter
## Configure filter
By default, no entity will be excluded. To limit which entities are being exposed to `Apache Kafka`, you can use the `filter` parameter.

View File

@ -27,7 +27,7 @@ There is currently support for the following entities within the Apple TV device
{% include integrations/config_flow.md %}
## Media Player
## Media player
The Apple TV media player platform will create a Media Player entity for each
Apple TV discovered on your network.

View File

@ -12,7 +12,7 @@ ha_integration_type: system
The Application Credentials integration is used by integrations that use OAuth2 to link your account to Home Assistant. The most common and preferred approach is using account linking with Home Assistant Cloud, however not all cloud providers support that and integrations can use Application Credentials instead. Additionally, users may use Application Credentials if preferred instead of Home Assistant Cloud Account Linking.
## Automatic Setup
## Automatic setup
Some integrations like [Google Calendar](/integrations/google/) will automatically create application credentials as part of adding an integration. To view any entries:
1. Go to **{% my integrations title="Settings -> Devices & Services" %}**
@ -22,7 +22,7 @@ Some integrations like [Google Calendar](/integrations/google/) will automatical
![Application credential list](/images/integrations/application_credentials/application-credentials.png)
## Manual Setup
## Manual setup
Note that integrations that do not support cloud linking will prompt to setup Application Credentials
when setting up for the first time. You may also manually enter credentials with the following steps:

View File

@ -73,7 +73,7 @@ To trigger this IR command add an automation on the event `arcam.turn_on` filter
the `entity_id` of the `media_player` zone entity. This can be added using device automations
or manually using normal automations.
### Serial Port to network gateway
### Serial port to network gateway
Use a network to a serial port gateway to connect to the serial port of the
receiver. The serial port is always available and can power on the device.

View File

@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Switch](#switch)
## Binary Sensor
## Binary sensor
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/Wi-Fi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework.

View File

@ -34,7 +34,7 @@ You need to enable telnet on your router if you choose to use `protocol: telnet`
</div>
### Sensors Configuration
### Sensors configuration
These sensors are automatically created and associated to the router device:

View File

@ -62,7 +62,7 @@ This integration supports the following services (see [Climate](/integrations/cl
Currently selection of custom timeframes in Extend, Away and boost modes is not supported. The default settings can be changed on the device.
</div>
## Water Heater
## Water heater
The Water Heater reports current and target temperature for Domestic Hot Water demand, as well as boiler status (heating or idle). This can be used to detect hot water demand, such as a running shower or tap water.
Setting target values is currently not supported.

View File

@ -76,7 +76,7 @@ While most entities can be updated via the push API, August/Yale does not offer
- Lock Battery sensor
- Lock Operation sensor
## Binary Sensor
## Binary sensor
If you have an August Doorbell, once you have enabled the August integration, you should see following sensors:

View File

@ -38,7 +38,7 @@ The integration will create sensor entities for a variety of metrics that relate
- Billing Cycle Length
- Billing Cycle Remaining
#### Mobile Phone
#### Mobile phone
- Data Usage
- National Calls
- Mobile Calls

View File

@ -33,7 +33,7 @@ This integration refreshes once every 5 minutes, based on the [default per-devic
{% include integrations/config_flow.md %}
## Available Sensors
## Available sensors
The integration will fetch data from each device. The following sensors are supported:

View File

@ -58,7 +58,7 @@ If your device is not discovered. On your camera, go to **System Options** -> **
When creating an issue detailing a problem related to the integration make sure to share the device model and firmware as well as prepare logs. Logs might contain sensitive information so make sure to look through it before sharing.
## Binary Sensor
## Binary sensor
The following sensor types are supported:

View File

@ -40,7 +40,7 @@ Not filtering domains or entities will send every event to Azure Event Hub, thus
Event Hubs have a retention time of at most 7 days, if you do not capture or use the events they are deleted automatically from the Event Hub, the default retention is 1 day.
</div>
### Filter Configuration
### Filter configuration
By default, no entity will be excluded. To limit which entities are being exposed to `Azure Event Hub`, you can use the `filter` parameter.

View File

@ -38,7 +38,7 @@ Integrates [Big Ass Fans](https://www.bigassfans.com/) devices into Home Assista
## Platforms
### Binary Sensor
### Binary sensor
For devices that support Auto Comfort and are running firmware 3.1 or later, an occupancy sensor entity is available. The sensor has a hold time of about 5 minutes and pushes state updates.

View File

@ -25,7 +25,7 @@ There is currently support for the following device types within Home Assistant:
Due to third party limitation, the sensors will only be available if Home Assistant and the Bbox are on the same local area network. You can check this by going to 192.168.1.254 with your web browser.
</div>
## Presence Detection
## Presence detection
The `bbox` platform offers presence detection by looking at connected devices to a [Bbox](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France.

View File

@ -30,7 +30,7 @@ or using an [input boolean helper](/integrations/input_boolean).
{% include integrations/building_block_integration.md %}
### Device Class
### Device class
Knowing a sensor is binary impacts how the sensor's current state may be
represented in Home Assistant's UI (see [Dashboards](/dashboards/)). Opposing states

View File

@ -46,7 +46,7 @@ api_key:
type: string
{% endconfiguration %}
## Binary Sensor
## Binary sensor
The `bloomsky` binary sensor platform allows you to get data from your BloomSky device.

View File

@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant:
{% include integrations/config_flow.md %}
### Binary Sensor
### Binary sensor
The binary sensor platform allows you to monitor the states of your shutter contact and battery sensors. Binary sensor devices are added for each of the following devices:

View File

@ -35,7 +35,7 @@ The Bravia TV integration supports two types of authentication:
For more information, see [IP Control Authentication](https://pro-bravia.sony.net/develop/integrate/ip-control/index.html#ip-control-authentication).
## Common Issues
## Common issues
### TV does not generate new pin
@ -44,11 +44,11 @@ If you have previously set up your TV with any Home Assistant instances via PIN
- On your TV, go to: **Settings** -> **Network** -> **Remote device settings** -> **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidance.
- Reset your TV to factory condition.
## Media Browser
## Media browser
Using the Media Browser, you can view a list of all installed applications and TV channels and launch them.
## Play Media service
## Play media service
The `play_media` service can be used in a automation or script to switch to a specified application or TV channel. It selects the best matching application or channel according to the `media_content_id`:

View File

@ -37,7 +37,7 @@ For some Brother devices, `SNMPv3 read-write access and v1/v2c read-only access`
![SNMP settings on Brother Printer web interface](/images/integrations/brother/brother-printer-webui.png)
## Sensor Example
## Sensor example
You can configure Home Assistant to alert you when the printer jams or runs out of paper as follows. First, add the following to `configuration.yaml` under the `template:` section (Note: replace `sensor.hl_l2340d_status` with the actual name of your sensor):

View File

@ -53,7 +53,7 @@ This service can be called to trigger a button press for that entity.
entity_id: button.my_button
```
## Device Class
## Device class
The way these buttons are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/).
The following device classes are supported for buttons: