Fix markdownlint / spelling issues #2 (#19903)

This commit is contained in:
Stefan 2021-10-22 12:50:06 +02:00 committed by GitHub
parent 87b84afd47
commit a417e7d82b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 43 additions and 41 deletions

View File

@ -14,6 +14,8 @@ ha_platforms:
The [Apprise service](https://github.com/caronc/apprise/) is an all-in-one solution to open up Home Assistant to _just about_ every Notification platform (such as Amazon SNS, Discord, Telegram, Slack, MSTeams, Twilio, etc.)
## Configuration
To use Apprise supported notifications, add the following to your `configuration.yaml` file:
```yaml
@ -59,7 +61,7 @@ config:
type: string
{% endconfiguration %}
#### Example service call
## Example service call
```yaml
- service: notify.apprise
@ -80,11 +82,11 @@ If you're using configuration files to store your Apprise URLs in, then you have
The tag `all` is reserved to notify absolutely everything, whether you have a tag associated with a URL or not.
### Notes
## Notes
There are over 50 supported Notification services supported by Apprise. Each has their own tweaks and customizations you can leverage.
- For instructions on how to construct the URLs, visit [here](https://github.com/caronc/apprise/wiki#notification-services).
- For instructions on how you can customize your own Apprise configuration files (referenced through the `config` directive), check out the following:
- [Text Formatted URLs](https://github.com/caronc/apprise/wiki/config_text)
- [YAML Formatted URLs](https://github.com/caronc/apprise/wiki/config_yaml)
- [Text Formatted URLs](https://github.com/caronc/apprise/wiki/config_text)
- [YAML Formatted URLs](https://github.com/caronc/apprise/wiki/config_yaml)

View File

@ -14,6 +14,8 @@ The `aquostv` platform allows you to control a [Sharp Aquos TV](http://www.sharp
When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication.
## Configuration
To add a TV to your installation, add the following to your `configuration.yaml` file:
```yaml
@ -62,7 +64,7 @@ Also, with **power_on_enabled** as True, the Aquos logo on your TV will stay on
</div>
Currently known supported models:
## Currently known supported models
- LC-40LE830U
- LC-46LE830U
@ -78,4 +80,4 @@ Currently known supported models:
- LC-70LE650U
- LC-70LE747E (no volume control)
If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.io/blob/current/source/_integrations/aquostv.markdown).
If your model is not on the list, give it a test. If everything works correctly, then add it to the list on [GitHub](https://github.com/home-assistant/home-assistant.io/blob/current/source/_integrations/aquostv.markdown).

View File

@ -26,19 +26,16 @@ Supported devices:
## Power state
Arcam FMJ receivers turn off their network port when in standby, the component will try to
reconnect to the receiver every 5 seconds. This mean powering on the first zone is not
possible over the builtin network connection. Two options for complete power control
exists: IR or Serial gateway.
Arcam FMJ receivers turn off their network port when in standby, the component will try to reconnect to the receiver every 5 seconds. This means powering on the first zone is not possible over the built-in network connection. Two options for complete power control exists: IR or Serial gateway.
### IR command
Use an IR blaster to send a command to turn the device on using these discrete codes:
- Zone 1: Protocol: RC5 Device: 16 Function: 123
- Zone 2: Protocol: RC5 Device: 23 Function: 123
- Zone 1: Protocol: RC5 Device: 16 Function: 123
- Zone 2: Protocol: RC5 Device: 23 Function: 123
Turn on sometime requires two IR codes to be sent. You can generate the raw, broadlink or other IR format string using [irgen](https://github.com/elupus/irgen) tool like:
Turn on sometime requires two IR codes to be sent. You can generate the raw, broadlink or other IR format string using [irgen](https://github.com/elupus/irgen) tool like:
```shell
irgen -i rc5 -d 16 0 123 -o broadlink_base64 -r 2

View File

@ -16,6 +16,7 @@ ha_platforms:
This platform allows you to detect presence by looking at connected devices to an Arris TG2492LG router.
This is one of the routers provided by:
* [Ziggo](https://www.ziggo.nl/), a cable operator in the Netherlands, to their customers as the Ziggo Connectbox.
* [Virgin Media](https://www.virginmedia.com/), a cable operator in the United Kingdom, to their customers as the Hub 3.

View File

@ -17,7 +17,8 @@ The `aten_pe` integration lets you control [ATEN Rack PDUs](https://www.aten.com
In order to use it, SNMP must be enabled on your PDU. It is recommended to use SNMPv3 to protect your credentials from eavesdropping.
Tested devices:
* [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/)
* [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/)
To set it up, add the following information to your `configuration.yaml` file:

View File

@ -25,7 +25,7 @@ The `august` integration allows you to integrate your [August](https://august.co
{% include integrations/config_flow.md %}
### Known Working Devices
## Known Working Devices
- August Wi-Fi Smart Lock (Gen 4)
- August Smart Lock Pro (Gen 3)
@ -46,12 +46,13 @@ There is currently support for the following device types within Home Assistant:
August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant.
</div>
### Known Unsupported Devices
## Known Unsupported Devices
- The Yale Doorman L3
Other devices not listed above have not been tested and may not function as expected.
### Binary Sensor
## Binary Sensor
If you have an August Doorbell, once you have enabled the August component, you should see following sensors:
@ -63,11 +64,11 @@ If you have an August Smart Lock with DoorSense, once you have enabled the Augus
- Door sensor
### Camera
## Camera
The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](https://august.com/) device in Home Assistant.
### Sensor
## Sensor
If you have an August Doorbell with a battery, once you have enabled the August component, you should see the following sensors:
@ -82,7 +83,7 @@ If you have an August Keypad, once you have enabled the August component, you sh
- Keypad Battery
### Presence Detection with Lock Operation
## Presence Detection with Lock Operation
Using the lock operation sensors, you can detect when a user operates a lock and is physically present (not remote). The below automation example (added to `automations.yaml`) will trigger when the user named “John Doe” in August locks or unlocks the door from the keypad (if present), via Bluetooth from their phone, or by auto-unlock. The state of the sensor will be the name of the party operating the lock as returned by August.

View File

@ -14,7 +14,7 @@ ha_platforms:
[Elgato Avea](https://www.evehome.com/en/news/elgato-avea-transform-your-home) is a Bluetooth light bulb that is no longer supported by the manufacturer. The `avea` integration allows you to control all your Avea bulbs with Home Assistant.
### Configuration
## Configuration
To enable Avea, add the following lines to your `configuration.yaml` file:

View File

@ -24,14 +24,14 @@ You will need to request access to the Awair API and obtain an access token from
The integration will fetch data from each device linked to your Awair developer account. The following sensors are supported:
* Temperature
* Humidity
* Carbon dioxide
* Total volatile organic compounds
* PM2.5 density
* PM10 density
* Sound level
* Luminescence
* Temperature
* Humidity
* Carbon dioxide
* Total volatile organic compounds
* PM2.5 density
* PM10 density
* Sound level
* Luminescence
Not all devices support all sensors; consult Awair's documentation to find out what sensors are present on your device. For first-generation Awair devices with a "dust" sensor, the integration will create identical PM2.5 and PM10 sensors (which reflects the capabilities of the sensor - it can detect dust between PM2.5 and PM10 but cannot differentiate between them).

View File

@ -138,7 +138,7 @@ If one exists, the SNS Subject will be set to the title. All attributes from the
### Setting up SNS within AWS
- Log into your AWS console and under "Security and Identity", select "Identity & Access Management".
- On the left-hand side, select "Users" then click "Create New Users". Enter a name here and then click "Create".
- On the left-hand side, select "Users" then click "Create New Users". Enter a name here and then click "Create".
- You can either download the credentials or click the arrow to display them one time.
<div class='note warning'>

View File

@ -10,7 +10,7 @@ ha_codeowners:
ha_domain: azure_event_hub
---
The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to an [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to an [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
## First time setup

View File

@ -20,7 +20,7 @@ There is no setup needed for the integration itself.
The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
## Configuration
### Configuration
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
@ -73,7 +73,7 @@ For more details about the GPIO layout, visit the [article](https://elinux.org/B
The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
## Configuration
### Configuration
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:

View File

@ -50,4 +50,3 @@ device_class:
required: true
type: string
{% endconfiguration %}

View File

@ -49,9 +49,9 @@ The preferred way to enable the `bmw_connected_drive` integration is via **Confi
| Setting | Description |
|---------|-------------|
| Read-only | No execution of services to the vehicle. Still possible to send messages and POIs via `notify` and to request a status update via `bmw_connected_drive.update_state`.
| Use Home Assistant location for car location polls | Older cars (non i3/i8 build before 7/2014) require the phone to be close to the car to get location updates. Enable this option to use the location of your Home Assistant instance for these queries, so updates are available when your car is in the surrounding of your home. |
| Use Home Assistant location for car location polls | Older cars (non i3/i8 build before 7/2014) require the phone to be close to the car to get location updates. Enable this option to use the location of your Home Assistant instance for these queries, so updates are available when your car is in the surrounding of your home. |
The following settings in your `configuration.yaml` file are considered legacy. They will be imported into **Configuration** > **Integrations** and you can set the options from above. Changes to `configuration.yaml` after the first import will be ignored.
The following settings in your `configuration.yaml` file are considered legacy. They will be imported into **Configuration** > **Integrations** and you can set the options from above. Changes to `configuration.yaml` after the first import will be ignored.
### Legacy configuration
@ -133,7 +133,7 @@ action:
## Services
The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN as attribute of all enties, e.g. (binary) sensors or the device tracker. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`.
The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN as attribute of all entities, e.g. (binary) sensors or the device tracker. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`.
Using these services will impact the state of your vehicle. So use these services with care!

View File

@ -114,7 +114,7 @@ Calling this service will change the tracked power state of any bond light but n
### Service `bond.set_light_brightness_tracked_state`
Sets the tracked brightness state of a bond light
Sets the tracked brightness state of a bond light
Calling this service will change the tracked brightness state of any bond light but not transmit any signal to make the device change its state.
| Service data attribute | Optional | Description |

View File

@ -33,11 +33,11 @@ To ensure a clean re-configuration, please perform the following steps:
- Perform the [TV does not generate new pin](#tv-does-not-generate-new-pin) steps.
- Retry [configuration](#configuration).
### TV does not generate new pin:
### TV does not generate new pin
If you have previously set up your TV with any Home Assistant instances, you must remove Home Assistant from your TV in order for your TV to generate a new pin. To do this, you must do **one** of the following:
- 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 guidiance.
- 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.
## Remote
@ -182,7 +182,6 @@ Users of TVs older than 2013 have another option for controlling their TV via Ho
If you have a Raspberry Pi connected to your TV:
{% raw %}
```yaml