From 1170f37732fcf02196acacb6285274ac328a62e6 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 11 Jul 2023 14:44:41 +0200 Subject: [PATCH] Enforce Markdown unordered list style (#28172) --- .remarkrc.js | 1 + CODE_OF_CONDUCT.md | 20 +- package-lock.json | 19 ++ package.json | 1 + .../authentication/multi-factor-auth.markdown | 4 +- .../_docs/authentication/providers.markdown | 2 +- source/_docs/z-wave/controllers.markdown | 6 +- source/_includes/common-tasks/backups.md | 10 +- .../_includes/common-tasks/flashing_n2_otg.md | 12 +- source/_includes/installation/container.md | 4 +- .../installation/operating_system.md | 30 +-- .../alarm_control_panel.ifttt.markdown | 16 +- source/_integrations/anthemav.markdown | 16 +- source/_integrations/arris_tg2492lg.markdown | 4 +- source/_integrations/aten_pe.markdown | 2 +- source/_integrations/awair.markdown | 16 +- source/_integrations/broadlink.markdown | 16 +- source/_integrations/buienradar.markdown | 36 +-- .../_integrations/cisco_webex_teams.markdown | 40 +-- .../device_sun_light_trigger.markdown | 6 +- .../device_tracker.mqtt.markdown | 4 +- .../devolo_home_network.markdown | 76 +++--- source/_integrations/discovery.markdown | 22 +- source/_integrations/dlna_dmr.markdown | 22 +- source/_integrations/ecobee.markdown | 54 ++-- source/_integrations/emulated_roku.markdown | 30 +-- source/_integrations/enocean.markdown | 8 +- source/_integrations/flume.markdown | 6 +- source/_integrations/folder_watcher.markdown | 10 +- source/_integrations/foobot.markdown | 12 +- source/_integrations/freebox.markdown | 24 +- .../_integrations/frontier_silicon.markdown | 12 +- source/_integrations/futurenow.markdown | 4 +- source/_integrations/google.markdown | 26 +- source/_integrations/google_cloud.markdown | 14 +- source/_integrations/habitica.markdown | 32 +-- source/_integrations/hdmi_cec.markdown | 10 +- .../_integrations/homematicip_cloud.markdown | 234 +++++++++--------- source/_integrations/html5.markdown | 14 +- source/_integrations/imap.markdown | 6 +- source/_integrations/iqvia.markdown | 36 +-- source/_integrations/kodi.markdown | 30 +-- source/_integrations/lametric.markdown | 12 +- source/_integrations/local_calendar.markdown | 6 +- source/_integrations/lock.markdown | 22 +- source/_integrations/logi_circle.markdown | 46 ++-- source/_integrations/media_extractor.markdown | 20 +- source/_integrations/meteoalarm.markdown | 6 +- source/_integrations/motioneye.markdown | 40 +-- source/_integrations/nest.markdown | 28 +-- source/_integrations/nissan_leaf.markdown | 24 +- source/_integrations/opentherm_gw.markdown | 132 +++++----- source/_integrations/openuv.markdown | 50 ++-- source/_integrations/oralb.markdown | 12 +- source/_integrations/owntracks.markdown | 4 +- source/_integrations/plex.markdown | 68 ++--- source/_integrations/profiler.markdown | 40 +-- source/_integrations/purpleair.markdown | 10 +- source/_integrations/remote.markdown | 10 +- source/_integrations/repetier.markdown | 10 +- source/_integrations/ridwell.markdown | 6 +- source/_integrations/screenlogic.markdown | 2 +- source/_integrations/sentry.markdown | 2 +- source/_integrations/serial_pm.markdown | 16 +- source/_integrations/simplisafe.markdown | 66 ++--- source/_integrations/starlingbank.markdown | 6 +- source/_integrations/telegram.markdown | 32 +-- source/_integrations/unifiprotect.markdown | 95 +++---- source/_integrations/watttime.markdown | 6 +- source/_integrations/wyoming.markdown | 4 +- source/_integrations/xiaomi.markdown | 8 +- source/_integrations/xiaomi_ble.markdown | 26 +- .../_integrations/yamaha_musiccast.markdown | 4 +- source/_integrations/yi.markdown | 8 +- source/_integrations/yolink.markdown | 36 +-- source/_integrations/youless.markdown | 6 +- source/_integrations/youtube.markdown | 4 +- source/_integrations/zha.markdown | 6 +- source/_integrations/zwave_js.markdown | 70 +++--- .../_posts/2015-01-24-release-notes.markdown | 10 +- .../2015-02-07-looking-at-the-past.markdown | 4 +- ...015-05-09-utc-time-zone-awareness.markdown | 6 +- .../_posts/2015-06-10-release-notes.markdown | 22 +- ...neywell-thermostats-now-supported.markdown | 28 +-- ...otifications-hue-fake-unification.markdown | 12 +- ...2016-10-24-explaining-the-updater.markdown | 10 +- ...16-12-03-remote-websockets-sonarr.markdown | 12 +- .../2017-03-28-http-to-mqtt-bridge.markdown | 16 +- source/_posts/2017-09-09-release-53.markdown | 4 +- ...rea-entity-registry-and-event-cli.markdown | 40 +-- source/_posts/2019-03-20-release-90.markdown | 10 +- source/_posts/2019-04-03-release-91.markdown | 4 +- .../_posts/2019-04-15-hassio-ingress.markdown | 26 +- source/_posts/2019-04-24-release-92.markdown | 6 +- source/_posts/2019-05-16-release-93.markdown | 8 +- source/_posts/2019-06-05-release-94.markdown | 4 +- source/_posts/2019-09-18-release-99.markdown | 4 +- ...20-08-05-mobile-apps-new-features.markdown | 10 +- .../2020-08-28-android-230-release.markdown | 36 +-- ...-04-09-android-april-2021-release.markdown | 14 +- ...-21-android-december-2021-release.markdown | 24 +- .../_posts/2022-01-07-android-quest.markdown | 10 +- .../2022-02-08-android-february.markdown | 42 ++-- source/examples/index.markdown | 4 +- .../concepts-terminology.markdown | 6 +- source/getting-started/onboarding.markdown | 16 +- source/tos/index.markdown | 18 +- .../voice_control/builtin_sentences.markdown | 46 ++-- .../voice_control/custom_sentences.markdown | 10 +- .../thirteen-usd-voice-remote.markdown | 64 ++--- source/voice_control/troubleshooting.markdown | 6 +- .../using_voice_assistants_overview.markdown | 12 +- ...rlds-most-private-voice-assistant.markdown | 80 +++--- 113 files changed, 1268 insertions(+), 1246 deletions(-) diff --git a/.remarkrc.js b/.remarkrc.js index 060a9a1dcac..e121facc0ff 100644 --- a/.remarkrc.js +++ b/.remarkrc.js @@ -14,6 +14,7 @@ var remarkrc = { ["lint-no-shell-dollars"], ["remark-lint-heading-increment"], ["remark-lint-heading-style", "atx"], + ["remark-lint-unordered-list-marker-style", "-"], [ "remark-lint-prohibited-strings", [ diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f9b1ea79314..d09bbfd8cd5 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or +- The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities diff --git a/package-lock.json b/package-lock.json index 170e0b77ad5..1419f59dc70 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,6 +16,7 @@ "remark-lint-heading-style": "^3.1.2", "remark-lint-no-shell-dollars": "^3.1.2", "remark-lint-prohibited-strings": "^3.1.0", + "remark-lint-unordered-list-marker-style": "^3.1.2", "remark-stringify": "^10.0.3", "textlint": "^13.3.3", "textlint-filter-rule-comments": "^1.2.2", @@ -3614,6 +3615,24 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/remark-lint-unordered-list-marker-style": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/remark-lint-unordered-list-marker-style/-/remark-lint-unordered-list-marker-style-3.1.2.tgz", + "integrity": "sha512-JFiyB4ZprJGGndCaFB8FssXd48m4Kh+CUqzNgu3lBLEiW8dEAGRlD9M2AzyyA+Q29WJP/FntDCbP22DeON91UA==", + "dev": true, + "dependencies": { + "@types/mdast": "^3.0.0", + "unified": "^10.0.0", + "unified-lint-rule": "^2.0.0", + "unist-util-generated": "^2.0.0", + "unist-util-position": "^4.0.0", + "unist-util-visit": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, "node_modules/remark-message-control": { "version": "7.1.1", "resolved": "https://registry.npmjs.org/remark-message-control/-/remark-message-control-7.1.1.tgz", diff --git a/package.json b/package.json index b50622f3092..12a5cf1c1b5 100644 --- a/package.json +++ b/package.json @@ -11,6 +11,7 @@ "remark-lint-heading-style": "^3.1.2", "remark-lint-no-shell-dollars": "^3.1.2", "remark-lint-prohibited-strings": "^3.1.0", + "remark-lint-unordered-list-marker-style": "^3.1.2", "remark-stringify": "^10.0.3", "textlint": "^13.3.3", "textlint-filter-rule-comments": "^1.2.2", diff --git a/source/_docs/authentication/multi-factor-auth.markdown b/source/_docs/authentication/multi-factor-auth.markdown index 468e7564038..78cedd3abf7 100644 --- a/source/_docs/authentication/multi-factor-auth.markdown +++ b/source/_docs/authentication/multi-factor-auth.markdown @@ -7,8 +7,8 @@ The Multi-factor Authentication (MFA) modules require you to solve a second chal A password can be compromised in a number of ways, for example, it can be guessed if it is a simple password. MFA provides a second level of defense by requiring: -* something you know, like your username and password, and -* something you have, like a one-time password sent to your phone. +- something you know, like your username and password, and +- something you have, like a one-time password sent to your phone. You can use MFA with any of the other authentication providers. If more than one MFA module is enabled, you can choose one when you log in. diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index 14903b0d2e0..d6ef3e71590 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -179,7 +179,7 @@ name = John Doe Leading and trailing whitespace, as well as lines starting with `#` are ignored. The following variables are supported. More may be added in the future. -* `name`: The real name of the user to be displayed in their profile. +- `name`: The real name of the user to be displayed in their profile. Stderr is not read at all and just passed through to that of the Home Assistant process, hence you can use it for status messages or suchlike. diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown index 2b10523b240..5b503f0825d 100644 --- a/source/_docs/z-wave/controllers.markdown +++ b/source/_docs/z-wave/controllers.markdown @@ -128,9 +128,9 @@ You should also check the README for details on the overlays. You might find it This procedure has been tested with the following modules: - * Aeotec Z-Pi 7 Raspberry Pi HAT/Shield - * Z-Wave.Me RaZberry 7 - * Z-Wave.Me RaZberry 7 Pro + - Aeotec Z-Pi 7 Raspberry Pi HAT/Shield + - Z-Wave.Me RaZberry 7 + - Z-Wave.Me RaZberry 7 Pro 1. Make sure the module is properly seated on the Home Assistant Yellow. ![Aeotec Z-Pi 7 on Home Assistant Yellow](/images/docs/z-wave/zpi-7-yellow.jpg). diff --git a/source/_includes/common-tasks/backups.md b/source/_includes/common-tasks/backups.md index 30a00904d66..18f71e269b7 100644 --- a/source/_includes/common-tasks/backups.md +++ b/source/_includes/common-tasks/backups.md @@ -4,11 +4,11 @@ Backup of your Home Assistant and add-on data and configuration. They are stored A full backup includes the following directories: -* `config` -* `share` -* `addons` (only manually installed or created add-ons, not those installed from the store) -* `ssl` -* `media` +- `config` +- `share` +- `addons` (only manually installed or created add-ons, not those installed from the store) +- `ssl` +- `media` A partial backup consists of any number of the above default directories and installed add-ons. diff --git a/source/_includes/common-tasks/flashing_n2_otg.md b/source/_includes/common-tasks/flashing_n2_otg.md index 994823ec3ee..3b0c93b3ed9 100644 --- a/source/_includes/common-tasks/flashing_n2_otg.md +++ b/source/_includes/common-tasks/flashing_n2_otg.md @@ -63,17 +63,17 @@ This will configure the ODROID-N2+ and OTG to act as a memory card reader: 1. Connect the ODROID-N2+ to your PC via the micro-USB port at the front of the ODROID-N2+. 1. When the ODROID-N2 is recognized as a USB connected storage device, you can flash the eMMC with [Etcher](https://www.balena.io/etcher/). - * Use the latest stable version of Home Assistant OS for the [ODROID-N2+](https://github.com/home-assistant/operating-system/releases/download/{{site.data.version_data.hassos['odroid-n2']}}/haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz) (haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz). + - Use the latest stable version of Home Assistant OS for the [ODROID-N2+](https://github.com/home-assistant/operating-system/releases/download/{{site.data.version_data.hassos['odroid-n2']}}/haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz) (haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz). 1. When the flash process is complete, disconnect the ODROID-N2+ from your PC. - * Remove the power cable. - * Remove the USB and HDMI cables. - * Make sure to toggle the boot mode switch back to MMC. + - Remove the power cable. + - Remove the USB and HDMI cables. + - Make sure to toggle the boot mode switch back to MMC. 1. Put the ODROID back in its case. 1. Connect your ODROID-N2+ to your network with an Ethernet cable and plug in power. 1. If your router supports mDNS, you can reach your installation at `http://homeassistant.local:8123`. - * If your network doesn’t support mDNS, you’ll have to use the IP address of your ODROID-N2+ instead of `homeassistant.local`. For example, `http://192.168.0.9:8123`. - * You should be able to find the IP address of your ODROID-N2+ from the admin interface of your router. + - If your network doesn’t support mDNS, you’ll have to use the IP address of your ODROID-N2+ instead of `homeassistant.local`. For example, `http://192.168.0.9:8123`. + - You should be able to find the IP address of your ODROID-N2+ from the admin interface of your router. 1. Continue with [onboarding](/getting-started/onboarding/). \ No newline at end of file diff --git a/source/_includes/installation/container.md b/source/_includes/installation/container.md index a8379be6a29..abf11f994d0 100644 --- a/source/_includes/installation/container.md +++ b/source/_includes/installation/container.md @@ -15,8 +15,8 @@ If you are using Docker then you need to be on at least version 19.03.9, ideally Installation with Docker is straightforward. Adjust the following command so that: -* `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration and run it. -* `MY_TIME_ZONE` is a [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), like `TZ=America/Los_Angeles`. +- `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration and run it. +- `MY_TIME_ZONE` is a [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), like `TZ=America/Los_Angeles`. {% endif %} diff --git a/source/_includes/installation/operating_system.md b/source/_includes/installation/operating_system.md index d76f6d3eb8f..da3b894202b 100644 --- a/source/_includes/installation/operating_system.md +++ b/source/_includes/installation/operating_system.md @@ -21,25 +21,25 @@ Home Assistant bundles (US market): The bundles come with Home Assistant pre-installed. -* [ODROID N2+: 2 GB RAM / 16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729286935?ref=eeb6nfw07e) -* [ODROID N2+: 4 GB RAM / 64 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729221399?ref=eeb6nfw07e) -* ODROID M1: 4 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573028119?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940567831?ref=eeb6nfw07e) -* ODROID M1: 8 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573093655?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940633367?ref=eeb6nfw07e) -* [ODROID M1: 8 GB RAM / 1 TB NVMe / 64 GB eMMC ](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940698903?ref=eeb6nfw07e) -* ODROID XU4: 2 GB RAM / [32 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729352471?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748782305559?ref=eeb6nfw07e) +- [ODROID N2+: 2 GB RAM / 16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729286935?ref=eeb6nfw07e) +- [ODROID N2+: 4 GB RAM / 64 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729221399?ref=eeb6nfw07e) +- ODROID M1: 4 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573028119?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940567831?ref=eeb6nfw07e) +- ODROID M1: 8 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573093655?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940633367?ref=eeb6nfw07e) +- [ODROID M1: 8 GB RAM / 1 TB NVMe / 64 GB eMMC ](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940698903?ref=eeb6nfw07e) +- ODROID XU4: 2 GB RAM / [32 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729352471?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748782305559?ref=eeb6nfw07e) Variants without pre-installed Home Assistant: -* ODROID N2+, [2 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828719650?ref=eeb6nfw07e) or [4 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828752418?ref=eeb6nfw07e) -* [ODROID C4](https://ameridroid.com/products/odroid-c4?ref=eeb6nfw07e) -* [ODROID M1](https://ameridroid.com/products/odroid-M1?ref=eeb6nfw07e) +- ODROID N2+, [2 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828719650?ref=eeb6nfw07e) or [4 GB RAM](https://ameridroid.com/products/odroid-n2-plus?variant=40371828752418?ref=eeb6nfw07e) +- [ODROID C4](https://ameridroid.com/products/odroid-c4?ref=eeb6nfw07e) +- [ODROID M1](https://ameridroid.com/products/odroid-M1?ref=eeb6nfw07e) -* [Power Supply](https://ameridroid.com/products/12v-2a-power-supply-plug?ref=eeb6nfw07e) -* [CR2032 Coin Cell](https://ameridroid.com/products/rtc-bios-battery?ref=eeb6nfw07e) -* [eMMC Module](https://ameridroid.com/products/emmc-module-n2-linux-red-dot?ref=eeb6nfw07e) -* [Case](https://ameridroid.com/products/odroid-n2-case?ref=eeb6nfw07e) +- [Power Supply](https://ameridroid.com/products/12v-2a-power-supply-plug?ref=eeb6nfw07e) +- [CR2032 Coin Cell](https://ameridroid.com/products/rtc-bios-battery?ref=eeb6nfw07e) +- [eMMC Module](https://ameridroid.com/products/emmc-module-n2-linux-red-dot?ref=eeb6nfw07e) +- [Case](https://ameridroid.com/products/odroid-n2-case?ref=eeb6nfw07e) -* These are affiliated links. We get commissions for purchases made through links in this post.* +*These are affiliated links. We get commissions for purchases made through links in this post.* {% endif %} @@ -165,7 +165,7 @@ _Select and copy the URL or use the "copy" button that appear when you hover it. ![Screenshot of the Etcher software showing the Flash button highlighted.](/images/installation/etcher5.png) 1. When Balena Etcher has finished writing the image, you will see a confirmation. ![Screenshot of the Etcher software showing that the installation has completed.](/images/installation/etcher6.png) - * If you are having issues with Balena Etcher, try version [1.10](https://github.com/balena-io/etcher/releases/tag/v1.10.4). + - If you are having issues with Balena Etcher, try version [1.10](https://github.com/balena-io/etcher/releases/tag/v1.10.4). ### Start up your {{site.installation.types[page.installation_type].board}} diff --git a/source/_integrations/alarm_control_panel.ifttt.markdown b/source/_integrations/alarm_control_panel.ifttt.markdown index cc1655404f1..f7eab602254 100644 --- a/source/_integrations/alarm_control_panel.ifttt.markdown +++ b/source/_integrations/alarm_control_panel.ifttt.markdown @@ -89,11 +89,11 @@ This platform supports the services `alarm_disarm`, `alarm_arm_away`, `alarm_arm For this system to operate correctly, the following IFTTT applets have to be setup. Obviously, if your alarm device does not support some states, no applets have to be provided for those. -* **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** disarm the alarm system. -* **IF** Webhook event `YOUR_ARM_HOME_EVENT` is called, **THEN** set the alarm system to armed home. -* **IF** Webhook event `YOUR_ARM_NIGHT_EVENT` is called, **THEN** set the alarm system to armed away. -* **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** set the alarm system to armed night. -* **IF** the alarm system was disarmed, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "disarmed"}`. -* **IF** the alarm system state changed to armed home, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_home"}`. -* **IF** the alarm system state changed to armed away, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_away"}`. -* **IF** the alarm system state changed to armed night, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_night"}`. +- **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** disarm the alarm system. +- **IF** Webhook event `YOUR_ARM_HOME_EVENT` is called, **THEN** set the alarm system to armed home. +- **IF** Webhook event `YOUR_ARM_NIGHT_EVENT` is called, **THEN** set the alarm system to armed away. +- **IF** Webhook event `YOUR_DISARM_EVENT` is called, **THEN** set the alarm system to armed night. +- **IF** the alarm system was disarmed, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "disarmed"}`. +- **IF** the alarm system state changed to armed home, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_home"}`. +- **IF** the alarm system state changed to armed away, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_away"}`. +- **IF** the alarm system state changed to armed night, **THEN** perform a Webhook `POST` web request to URL `https://HASS_URL/api/services/ifttt/push_alarm_state?api_password=API_PASSWORD` with content type `application/json` and body `{"entity_id": "alarm_control_panel.DEVICE_NAME", "state": "armed_night"}`. diff --git a/source/_integrations/anthemav.markdown b/source/_integrations/anthemav.markdown index 91fdd467423..9c652c92d3f 100644 --- a/source/_integrations/anthemav.markdown +++ b/source/_integrations/anthemav.markdown @@ -20,18 +20,18 @@ Both [Anthem]'s current and last generation of A/V Receivers and Processors supp ### A/V Receiver -* [MRX 540](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-540/page=overview), [MRX 740](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-740/page=overview), [MRX 1140](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-1140/page=overview) -* [MRX 520](https://www.anthemav.com/products-current/series=mrx-series-gen3/model=mrx-520/page=overview), [MRX 720](https://www.anthemav.com/products-current/collection=performance/model=mrx-720/page=overview), [MRX 1120](https://www.anthemav.com/products-current/collection=performance/model=mrx-1120/page=overview) -* [MRX 310](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-310/page=overview), [MRX 510](https://www.anthemav.com/products-archived/series=mrx-series/model=mrx-510/page=overview), [MRX 710](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-710/page=overview) +- [MRX 540](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-540/page=overview), [MRX 740](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-740/page=overview), [MRX 1140](https://www.anthemav.com/products-current/type=av-receiver/model=mrx-1140/page=overview) +- [MRX 520](https://www.anthemav.com/products-current/series=mrx-series-gen3/model=mrx-520/page=overview), [MRX 720](https://www.anthemav.com/products-current/collection=performance/model=mrx-720/page=overview), [MRX 1120](https://www.anthemav.com/products-current/collection=performance/model=mrx-1120/page=overview) +- [MRX 310](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-310/page=overview), [MRX 510](https://www.anthemav.com/products-archived/series=mrx-series/model=mrx-510/page=overview), [MRX 710](https://www.anthemav.com/products-archived/type=av-receiver/model=mrx-710/page=overview) ### A/V Processor -* [AVM 60](https://www.anthemav.com/products-current/model=avm-60/page=overview) +- [AVM 60](https://www.anthemav.com/products-current/model=avm-60/page=overview) ### 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) +- [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) If your model is not on the list then give it a test, if everything works correctly then add it to the list by clicking on the **Edit this page on GitHub** link above. @@ -51,8 +51,8 @@ port: ## Notes and Limitations -* The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls. -* Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant. +- The tuner is currently unsupported as are the `media_player` play, pause, prev, and next controls. +- Enabling this platform will set and enforce "Standby IP Control On" in your Anthem device. You almost certainly want this. If you disable it on the device, it will just get re-enabled by Home Assistant.
diff --git a/source/_integrations/arris_tg2492lg.markdown b/source/_integrations/arris_tg2492lg.markdown index e8ea437206e..dab9af1fc42 100644 --- a/source/_integrations/arris_tg2492lg.markdown +++ b/source/_integrations/arris_tg2492lg.markdown @@ -17,8 +17,8 @@ This platform allows you to detect presence by looking at connected devices to a 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. +- [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.
The router prevents the admin user from logging in twice. This can cause problems with accessing the router's configuration pages while this platform is active. diff --git a/source/_integrations/aten_pe.markdown b/source/_integrations/aten_pe.markdown index 9273ff9b23d..43437995cc5 100644 --- a/source/_integrations/aten_pe.markdown +++ b/source/_integrations/aten_pe.markdown @@ -19,7 +19,7 @@ In order to use it, SNMP must be enabled on your PDU. It is recommended to use S 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: diff --git a/source/_integrations/awair.markdown b/source/_integrations/awair.markdown index 15ef993f23f..ad7487f40eb 100644 --- a/source/_integrations/awair.markdown +++ b/source/_integrations/awair.markdown @@ -37,13 +37,13 @@ This integration refreshes once every 5 minutes, based on the [default per-devic The integration will fetch data from each device. 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). diff --git a/source/_integrations/broadlink.markdown b/source/_integrations/broadlink.markdown index 7c5a57867ce..dca8784700a 100644 --- a/source/_integrations/broadlink.markdown +++ b/source/_integrations/broadlink.markdown @@ -282,11 +282,11 @@ script: You can use `remote.delete_command` to remove commands that you've learned with the `remote.learn_command` service. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ------------------------------------- | -| `entity_id` | no | ID of the remote. | -| `device` | no | Name of the device. | -| `command` | no | Names of the commands to be deleted. | +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------ | +| `entity_id` | no | ID of the remote. | +| `device` | no | Name of the device. | +| `command` | no | Names of the commands to be deleted. | #### Deleting a command @@ -656,9 +656,9 @@ After a success, do one of the following two options: ``` 2. To learn a button hold RF code, hold the button you wish to learn for 1-2 seconds then immediately press enter. - * You will see the same prompts for a short press as shown above. You should see it return a different base64 code. - * Test the base64 code to ensure it performs the button 'hold' command as expected, rather than the button 'press' command. - * This might take some trial and error to get the hold timing right before hitting enter to scan for the code. + - You will see the same prompts for a short press as shown above. You should see it return a different base64 code. + - Test the base64 code to ensure it performs the button 'hold' command as expected, rather than the button 'press' command. + - This might take some trial and error to get the hold timing right before hitting enter to scan for the code. ### Conversion of codes from other projects diff --git a/source/_integrations/buienradar.markdown b/source/_integrations/buienradar.markdown index 36509708f9e..a745840b290 100644 --- a/source/_integrations/buienradar.markdown +++ b/source/_integrations/buienradar.markdown @@ -49,24 +49,24 @@ The following entities will be created: - **Barometer forecast**: A numeric barometric forecast (1 to 7) - **Barometer forecast name**: A textual representation of the barometer forecast (eg: Thunderstorms, Stable, etc.) - **Condition code**: A symbol and a unique code identifying the current weather condition - * `a`: sunny/clear - * `b`: Mix of clear and medium or low clouds - * `j`: Mix of clear and high clouds - * `o/r`: Partly cloudy (increasing character increases the condition) - * `c`: Heavily clouded - * `p`: Cloudy - * `d`: Alternating cloudy with local fog - * `n`: Clear and local mist or fog - * `f`: Alternatingly cloudy with some light rain - * `h/k/l`: rainy (increasing character increases the condition) - * `q`: Heavily clouded with rain - * `w`: Heavily clouded with rain and winter precipitation - * `m`: Heavily clouded with some light rain - * `u`: Cloudy with light snow - * `i/v`: Heavily clouded with light snowfall (increasing character increases the condition) - * `t`: (Heavy snowfall) - * `g`: (Clear with (possibly) some heavy lightning) - * `s`: (Cloudy with (possibly) some heavy (thunderstorms) showers) + - `a`: sunny/clear + - `b`: Mix of clear and medium or low clouds + - `j`: Mix of clear and high clouds + - `o/r`: Partly cloudy (increasing character increases the condition) + - `c`: Heavily clouded + - `p`: Cloudy + - `d`: Alternating cloudy with local fog + - `n`: Clear and local mist or fog + - `f`: Alternatingly cloudy with some light rain + - `h/k/l`: rainy (increasing character increases the condition) + - `q`: Heavily clouded with rain + - `w`: Heavily clouded with rain and winter precipitation + - `m`: Heavily clouded with some light rain + - `u`: Cloudy with light snow + - `i/v`: Heavily clouded with light snowfall (increasing character increases the condition) + - `t`: (Heavy snowfall) + - `g`: (Clear with (possibly) some heavy lightning) + - `s`: (Cloudy with (possibly) some heavy (thunderstorms) showers) - **Condition**: A symbol and the current weather condition (`clear`, `cloudy`, `fog`, `rainy`, `snowy` or `lightning`) - **Condition detailed**: A symbol and detailed current weather condition (`clear`, `partlycloudy`, `cloudy`, `partlycloudy-fog`, `partlycloudy-light-rain`, `partlycloudy-rain`, `light-rain`, `rainy`, `snowy-rainy`, `partlycloudy-light-snow`, `partlycloudy-snow`, `light-snow`, `snowy`, `partlycloudy-lightning` or `lightning`) - **Condition exact**: A symbol with the full current weather condition (in English) diff --git a/source/_integrations/cisco_webex_teams.markdown b/source/_integrations/cisco_webex_teams.markdown index 1a7e8d0a589..a76593f9eaf 100644 --- a/source/_integrations/cisco_webex_teams.markdown +++ b/source/_integrations/cisco_webex_teams.markdown @@ -17,14 +17,14 @@ The `cisco_webex_teams` notification platform allows you to deliver rich notific To use this notification platform you will need an app (bot) token. To obtain a token visit [Cisco Webex for Developers](https://developer.webex.com/). -* Detailed instructions can be found in the section titled **Creating a Webex Teams Bot** on the [Webex Teams bot documentation](https://developer.webex.com/docs/bots). +- Detailed instructions can be found in the section titled **Creating a Webex Teams Bot** on the [Webex Teams bot documentation](https://developer.webex.com/docs/bots). You also need to specify the `room_id` that you wish to post messages into. The `room_id` can be found in one of two ways: 1. Logging in at [Cisco Webex for Developers](https://developer.webex.com/) and navigate to `Documentation`>`API Reference`>`Messages` and select List Messages, or 2. Log into the web client at [teams.webex.com](https://teams.webex.com/), - * select the room (or create a new room), - * then copying the room ID from the URL. + - select the room (or create a new room), + - then copying the room ID from the URL.
@@ -118,23 +118,23 @@ Here are the automations for the above screenshot: The following is a list of the allowed html tags and attributes: -Tag | More Info ---- | --- -`<@personEmail:email@examplecompany.com>` | Used to tag another Webex Team user by email address. -`` | Defines a hyperlink. Allows attribute `href`. -`
` | Defines a section that is quoted from another source. Allows attribute `class` with allowed values `danger`, `warning`, `info`, `primary`, `secondary`. -`` | Defines bold text. -`` | Defines important text. -`` | Defines italic text. -`` | Defines emphasized text. -`
` | Defines preformatted text.
-`` | Defines a piece of computer code.
-`
` | Defines a single line break.
-`
` | Defines a paragraph.
-`