From dfbb264f5de4e1af65698d4579e9ea382d7484e3 Mon Sep 17 00:00:00 2001 From: Stefan Roelofs Date: Thu, 28 Oct 2021 16:05:40 +0200 Subject: [PATCH] Fix markdownlint / spelling issues --- source/_integrations/counter.markdown | 2 -- source/_integrations/cover.command_line.markdown | 1 - source/_integrations/cover.markdown | 4 ++-- source/_integrations/cover.mqtt.markdown | 2 +- source/_integrations/cover.rflink.markdown | 12 ++++++------ source/_integrations/cover.xiaomi_aqara.markdown | 1 - source/_integrations/daikin.markdown | 14 ++++++++------ source/_integrations/demo.markdown | 1 - source/_integrations/denonavr.markdown | 1 - source/_integrations/deutsche_bahn.markdown | 1 + .../device_sun_light_trigger.markdown | 6 +++--- .../_integrations/device_tracker.xiaomi.markdown | 1 - source/_integrations/device_trigger.mqtt.markdown | 13 ++++++++++--- source/_integrations/dexcom.markdown | 8 ++++---- source/_integrations/discord.markdown | 15 ++++++++------- 15 files changed, 43 insertions(+), 39 deletions(-) diff --git a/source/_integrations/counter.markdown b/source/_integrations/counter.markdown index a1cb08a588e9..7fdaabea7233 100644 --- a/source/_integrations/counter.markdown +++ b/source/_integrations/counter.markdown @@ -112,8 +112,6 @@ With this service the properties of the counter can be changed while running. | `initial` | yes | Set new value for initial. | | `value` | yes | Set the counters state to the given value. | - - ### Use the service Select the **Services** tab from within **Developer Tools**. Choose **counter** from the list of **Domains**, select the **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**. diff --git a/source/_integrations/cover.command_line.markdown b/source/_integrations/cover.command_line.markdown index ed6a67497316..c6e2f5c9229a 100644 --- a/source/_integrations/cover.command_line.markdown +++ b/source/_integrations/cover.command_line.markdown @@ -75,7 +75,6 @@ In this section you find some real-life examples of how to use this sensor. ### Full configuration - {% raw %} ```yaml diff --git a/source/_integrations/cover.markdown b/source/_integrations/cover.markdown index a099c0979e22..3816ca93de1b 100644 --- a/source/_integrations/cover.markdown +++ b/source/_integrations/cover.markdown @@ -47,7 +47,7 @@ Set cover position of one or multiple covers. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all. | `position` | no | Integer between 0 and 100. -#### Automation example +#### Automation example ```yaml automation: @@ -71,7 +71,7 @@ Set cover tilt position of one or multiple covers. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all. | `tilt_position` | no | Integer between 0 and 100. -#### Automation example +#### Automation example ```yaml automation: diff --git a/source/_integrations/cover.mqtt.markdown b/source/_integrations/cover.mqtt.markdown index 10e6fe21a1a9..02cc25721a8f 100644 --- a/source/_integrations/cover.mqtt.markdown +++ b/source/_integrations/cover.mqtt.markdown @@ -466,7 +466,7 @@ For auto discovery message the payload needs to be set to `null`, example for co ### Full configuration using `entity_id`- variable in the template -The example below shows an example of how to correct the state of the blind depending if it moved up, or down. +The example below shows an example of how to correct the state of the blind depending if it moved up, or down. {% raw %} diff --git a/source/_integrations/cover.rflink.markdown b/source/_integrations/cover.rflink.markdown index 34db7bfdebe7..5ffe26cf8a55 100644 --- a/source/_integrations/cover.rflink.markdown +++ b/source/_integrations/cover.rflink.markdown @@ -15,7 +15,7 @@ First, you have to set up your [RFLink hub](/integrations/rflink/). After configuring the RFLink hub, covers will be automatically discovered and added. Except the Somfy RTS devices. -### Setting up a Somfy RTS device +## Setting up a Somfy RTS device You have to add the Somfy RTS manually with the supplied RFlinkLoader (Windows only). @@ -53,7 +53,7 @@ RTS Record: 15 Address: FFFFFF RC: FFFF After configuring the RFLink Somfy RTS you have to add the cover to the `configuration.yaml` file like any other RFlink device. -RFLink cover ID's are composed of: protocol, id, and gateway. For example: `RTS_0100F2_0`. +RFLink cover ID's are composed of: protocol, id, and gateway. For example: `RTS_0100F2_0`. Once the ID of a cover is known, it can be used to configure the cover in Home Assistant, for example, to add it to a different group or set a nice name. @@ -131,7 +131,7 @@ devices: type: string {% endconfiguration %} -### Setting up a KAKU ASUN-650 device +## Setting up a KAKU ASUN-650 device In RFLink, the ON and DOWN command are used to close the cover and the OFF and UP command are used to open the cover. The KAKU (COCO) ASUN-650 works the other way around, it uses the ON command to open the cover and the OFF command to close the cover. @@ -166,13 +166,13 @@ cover: name: non_kaku_not_inverted_by_default ``` -The configuration above shows that the `type` property may be omitted. When the ID starts with `newkaku`, the component will make sure that the on and off commands are inverted. When the ID does not start with `newkaku`, the on and off commands are not inverted. +The configuration above shows that the `type` property may be omitted. When the ID starts with `newkaku`, the component will make sure that the on and off commands are inverted. When the ID does not start with `newkaku`, the on and off commands are not inverted. -### Device support +## Device support See [device support](/integrations/rflink/#device-support). -### Additional configuration examples +## Additional configuration examples Multiple covers with custom names and aliases diff --git a/source/_integrations/cover.xiaomi_aqara.markdown b/source/_integrations/cover.xiaomi_aqara.markdown index d0d4b65528f3..296f856f0d43 100644 --- a/source/_integrations/cover.xiaomi_aqara.markdown +++ b/source/_integrations/cover.xiaomi_aqara.markdown @@ -12,4 +12,3 @@ ha_domain: xiaomi_aqara The `xiaomi aqara` cover platform allows you to get data from your [Xiaomi](https://www.mi.com/en/) covers. The requirement is that you have setup [Xiaomi aqara](/integrations/xiaomi_aqara/). - diff --git a/source/_integrations/daikin.markdown b/source/_integrations/daikin.markdown index 2fbee47aab6e..993dffa1889b 100644 --- a/source/_integrations/daikin.markdown +++ b/source/_integrations/daikin.markdown @@ -20,7 +20,7 @@ ha_platforms: ---

- Daikin has removed their local API in newer products. They offer a cloud API accessible only under NDA, which is incompatible with open source. This affects units fitted with the BRP069C4x wifi adapter. Units listed under Supported Hardware below continue to have access to local control. Additionally the older but commonly available BRP072A42 adapter can be fitted to most if not all newer units for access to local control. + Daikin has removed their local API in newer products. They offer a cloud API accessible only under NDA, which is incompatible with open source. This affects units fitted with the BRP069C4x wifi adapter. Units listed under Supported Hardware below continue to have access to local control. Additionally the older but commonly available BRP072A42 adapter can be fitted to most if not all newer units for access to local control.

The `daikin` integration integrates Daikin air conditioning systems into Home Assistant. @@ -42,7 +42,7 @@ There is currently support for the following device types within Home Assistant:
-* The integration for BRP072Cxx and SKYFi based units need API-key / password respectively. The API-key/password can be found on a sticker under the front cover. The other models are auto detected and the API-key and password field must be left empty. +- The integration for BRP072Cxx and SKYFi based units need API-key / password respectively. The API-key/password can be found on a sticker under the front cover. The other models are auto detected and the API-key and password field must be left empty.
@@ -85,8 +85,9 @@ Preset mode **away** translates to Daikin's "Holiday Mode":
_"Holiday mode" is used when you want to turn off your units when you leave you home for a longer time._

_When "Holiday mode" is enabled, the following action take place:_ - - _All connected units are turned OFF._ - - _All schedule timers are disabled._ + +- _All connected units are turned OFF._ +- _All schedule timers are disabled._ @@ -130,7 +131,7 @@ Zones with the name `-` will be ignored, just as the AirBase application is work -Additionally the Daikin Streamer (air purifier) function can be toggled onsupported devices using a switch. Note that it isn't currently possible to reliably detect whether a specific device has streamer support, so the switch may appear in the UI even if the functionality isn't actually supported. +Additionally the Daikin Streamer (air purifier) function can be toggled on supported devices using a switch. Note that it isn't currently possible to reliably detect whether a specific device has streamer support, so the switch may appear in the UI even if the functionality isn't actually supported. ## Region Changing @@ -138,7 +139,8 @@ The European and United States controllers (Most likely the Australian controlle `http://Daikin-IP-Address/common/set_regioncode?reg=XX` Replace XX with your region code of choice. -Currently known region codes: +Currently known region codes: + - AU - EU - JP diff --git a/source/_integrations/demo.markdown b/source/_integrations/demo.markdown index dbad6e5433f4..e6b050f5b585 100644 --- a/source/_integrations/demo.markdown +++ b/source/_integrations/demo.markdown @@ -63,7 +63,6 @@ Available demo platforms: - [Text-to-speech](/integrations/tts/) (`tts`) - [Weather](/integrations/weather/) (`weather`) - To integrate a demo platform in Home Assistant, add the following section to your `configuration.yaml` file: ```yaml diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown index 59beef92eade..76d079c57e32 100644 --- a/source/_integrations/denonavr.markdown +++ b/source/_integrations/denonavr.markdown @@ -107,7 +107,6 @@ A few notes: - To remotely power on Marantz receivers with Home Assistant, the Auto-Standby feature must be enabled in the receiver's settings. - Sound mode: The command to set a specific sound mode is different from the value of the current sound mode reported by the receiver (sound_mode_raw). There is a key-value structure (sound_mode_dict) that matches the raw sound mode to one of the possible commands to set a sound mode (for instance {'MUSIC':['PLII MUSIC']}. If you get a "Not able to match sound mode" warning, please open an issue on the [denonavr library](https://github.com/scarface-4711/denonavr), stating which raw sound mode could not be matched so it can be added to the matching dictionary. You can find the current raw sound mode under **Developer Tools** -> **States**. - #### Service `denonavr.get_command` Denon AVR receivers support a simple text-based network interface for sending commands to the receiver over the network. You can access this interface via the `denonavr.get_command` service. In addition, IR remote codes can also be sent to this interface. diff --git a/source/_integrations/deutsche_bahn.markdown b/source/_integrations/deutsche_bahn.markdown index c52b8bdf2a48..501bb605719d 100644 --- a/source/_integrations/deutsche_bahn.markdown +++ b/source/_integrations/deutsche_bahn.markdown @@ -21,6 +21,7 @@ sensor: from: NAME_OF_START_STATION to: NAME_OF_FINAL_STATION ``` + {% configuration %} from: description: The name of the start station. diff --git a/source/_integrations/device_sun_light_trigger.markdown b/source/_integrations/device_sun_light_trigger.markdown index f9cec7f9b270..153ba9f39a59 100644 --- a/source/_integrations/device_sun_light_trigger.markdown +++ b/source/_integrations/device_sun_light_trigger.markdown @@ -13,9 +13,9 @@ ha_domain: device_sun_light_trigger Home Assistant has a built-in integration called `device_sun_light_trigger` to help you automate your lights. The integration will: - * Fade in the lights when the sun is setting and there are people home - * Turn on the lights when people get home after the sun has set - * Turn off the lights when all people leave the house +* Fade in the lights when the sun is setting and there are people home +* Turn on the lights when people get home after the sun has set +* Turn off the lights when all people leave the house This integration requires the integrations [sun](/integrations/sun/), [device_tracker](/integrations/device_tracker/), [person](/integrations/person/) and [light](/integrations/light/) to be enabled. diff --git a/source/_integrations/device_tracker.xiaomi.markdown b/source/_integrations/device_tracker.xiaomi.markdown index e6e5e8eb2be3..f61f8dd64705 100644 --- a/source/_integrations/device_tracker.xiaomi.markdown +++ b/source/_integrations/device_tracker.xiaomi.markdown @@ -45,4 +45,3 @@ To ensure that your router is compatible, navigate to `http://YOUR_ROUTER_IP/api You should see a listing of the device currently connected to your router. However, some users report that even when the previous URL does not work, they have been able to integrate their Mi Router 3 in Home Assistant. E.g., some users with the Mi Router 3 and firmware version 2.10.46 Stable have integrated their routers successfully and an alternative URL to test integration with is `http://YOUR_ROUTER_IP/cgi-bin/luci/api/misystem/devicelist`. Navigating to this page should show the `{"code":401,"msg":"Invalid token"}` message. - diff --git a/source/_integrations/device_trigger.mqtt.markdown b/source/_integrations/device_trigger.mqtt.markdown index 20b638be2451..c78465388184 100644 --- a/source/_integrations/device_trigger.mqtt.markdown +++ b/source/_integrations/device_trigger.mqtt.markdown @@ -88,19 +88,26 @@ This shows a complete example of defining a remote control type device with two Note that it is not necessary to provide the full device information in each message, but the identifying information, `identifier` in the example, must be the same. -#### Left arrow click configuration: +#### Left arrow click configuration + - Discovery topic: `homeassistant/device_automation/0x90fd9ffffedf1266/action_arrow_left_click/config` -- Discovery payload: +- Discovery payload: + ```json {"automation_type":"trigger","type":"action","subtype":"arrow_left_click","payload":"arrow_left_click","topic":"zigbee2mqtt/0x90fd9ffffedf1266/action","device":{"identifiers":["zigbee2mqtt_0x90fd9ffffedf1266"],"name":"0x90fd9ffffedf1266","sw_version":"Zigbee2mqtt 1.14.0","model":"TRADFRI remote control (E1524/E1810)","manufacturer":"IKEA"}} ``` + - Trigger topic: `zigbee2mqtt/0x90fd9ffffedf1266/action` - Trigger payload: `arrow_left_click` -#### Right arrow click configuration: + +#### Right arrow click configuration + - Discovery topic: `homeassistant/device_automation/0x90fd9ffffedf1266/action_arrow_right_click/config` - Discovery payload: + ```json {"automation_type":"trigger","type":"action","subtype":"arrow_right_click","payload":"arrow_right_click","topic":"zigbee2mqtt/0x90fd9ffffedf1266/action","device":{"identifiers":["zigbee2mqtt_0x90fd9ffffedf1266"]}} ``` + - Trigger topic: `zigbee2mqtt/0x90fd9ffffedf1266/action` - Trigger payload: `arrow_right_click` diff --git a/source/_integrations/dexcom.markdown b/source/_integrations/dexcom.markdown index 00e8a3e4500c..f9b52bb8dc89 100644 --- a/source/_integrations/dexcom.markdown +++ b/source/_integrations/dexcom.markdown @@ -25,22 +25,22 @@ You will need to set up the [Dexcom Share](https://provider.dexcom.com/education Some people have had problems with connecting when their Dexcom passwords are entirely numeric. If you have connection issues in that case, try changing your password to something with a mix of numbers and letters. -#### Server +### Server There are two Dexcom Share servers, `US` for United States customers, and `OUS` for all customers outside of the United States. -#### Unit of measurement +### Unit of measurement The integrations allows both `mg/dL` and `mmol/l` units of measurement for blood glucose values. To change your preferred unit of measurement, got to **Configuration** >> **Integrations** in the UI, and click `OPTIONS`. -### Sensor +## Sensor If you have a sensor session running, and once you have enabled the Dexcom integration, you should see the following sensors: - Blood glucose value sensor - Blood glucose trend sensor -### Example Automation +## Example Automation ```yaml - id: '1234567890123' diff --git a/source/_integrations/discord.markdown b/source/_integrations/discord.markdown index b3a32708f199..10bbcbb3ffa4 100644 --- a/source/_integrations/discord.markdown +++ b/source/_integrations/discord.markdown @@ -18,6 +18,8 @@ Retrieve the **Client ID** from the information section and the (hidden) **Token When setting up the application you can use this [icon](/images/favicon-192x192-full.png). +## Configuration + To use Discord notifications, add the following to your `configuration.yaml` file: ```yaml @@ -39,7 +41,7 @@ token: type: string {% endconfiguration %} -### Setting up the bot +## Setting up the bot Bots can send messages to servers and users or attach local available images. To add the bot to a server you are an admin on, get the details of the bot from the [Discord My Apps page](https://discordapp.com/developers/applications/me). @@ -67,7 +69,7 @@ Right click channel name and copy the channel ID (**Copy ID**). This channel or user ID has to be used as the target when calling the notification service. Multiple channel or user IDs can be specified, across multiple servers or direct messages. -### Discord Service Data +## Discord Service Data The following attributes can be placed inside the `data` key of the service call for extended functionality: @@ -76,7 +78,6 @@ The following attributes can be placed inside the `data` key of the service call | `images` | yes | The file(s) to attach to message. | `embed` | yes | Array of [Discord embeds](https://discordpy.readthedocs.io/en/latest/api.html#embed). *NOTE*: if using `embed`, `message` is still required. - To include messages with embedding, use these attributes underneath the `embed` key: | Attribute | Optional | Description | @@ -90,8 +91,7 @@ To include messages with embedding, use these attributes underneath the `embed` | `thumbnail` | yes | Sets the thumbnail for the embed content. | `fields` | yes | Adds a field to the embed object. `name` and `value` are *required*, `inline` is *true* by default. - -#### Example service call +### Example service call ```yaml - service: notify.discord @@ -104,7 +104,8 @@ To include messages with embedding, use these attributes underneath the `embed` - "/tmp/garage.jpg" ``` -#### Example embed service call +### Example embed service call + ```yaml - service: notify.discord data: @@ -138,7 +139,7 @@ To include messages with embedding, use these attributes underneath the `embed` inline: false ``` -### Notes +## Notes You can tag any user inside a channel by using their user ID in the message like so: `<@userid>` replacing `userid` with the ID you copied. To get the user ID right click on the user name to copy the ID like you did for the channel ID up above.