From 6429c9d0b2ff214728b99c14123e177c295656e2 Mon Sep 17 00:00:00 2001
From: Alok Saboo
-You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.
-
-If a device ID consists of only numbers, please make sure to surround it with quotes. +If a device ID consists of only numbers, please make sure to surround it with quotes. This is a known limitation in YAML, because the device ID will be interpreted as a number otherwise.
diff --git a/source/_components/device_tracker.actiontec.markdown b/source/_components/device_tracker.actiontec.markdown index f33d631b8f3..524cc707a5d 100644 --- a/source/_components/device_tracker.actiontec.markdown +++ b/source/_components/device_tracker.actiontec.markdown @@ -35,7 +35,7 @@ device_tracker: {% configuration %} host: - description: The IP address of your router, eg. `192.168.1.1`. + description: The IP address of your router, e.g., `192.168.1.1`. required: true type: string username: @@ -49,4 +49,3 @@ password: {% endconfiguration %} See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. - diff --git a/source/_components/dialogflow.markdown b/source/_components/dialogflow.markdown index b90f327c7d3..e81b69d7602 100644 --- a/source/_components/dialogflow.markdown +++ b/source/_components/dialogflow.markdown @@ -49,7 +49,7 @@ To get the webhook URL, go to the integrations page in the configuration screen - Click "Save" - Create a new intent - Below "User says" write one phrase that you, the user, will tell Dialogflow, e.g., `What is the temperature at home?` -- In "Action" set some key (this will be the bind with Home Assistant configuration), eg.: GetTemperature +- In "Action" set some key (this will be the bind with Home Assistant configuration), e.g.,: GetTemperature - In "Response" set "Cannot connect to Home Assistant or it is taking to long" (fall back response) - At the end of the page, click on "Fulfillment" and check "Use webhook" - Click "Save" @@ -114,4 +114,3 @@ intent_script: entity_id: "switch.light_{{ Room | replace(' ', '_') }}" ``` {% endraw %} - diff --git a/source/_components/dyson.markdown b/source/_components/dyson.markdown index 6bccfa636a2..af08ef9269a 100644 --- a/source/_components/dyson.markdown +++ b/source/_components/dyson.markdown @@ -26,7 +26,7 @@ dyson: password: YOUR_DYSON_PASSWORD language: YOUR_DYSON_ACCOUNT_LANGUAGE devices: - - device_id: DEVICE_ID_1 # eg. Serial number: XXX-XX-XXXXXXXX + - device_id: DEVICE_ID_1 # e.g., Serial number: XXX-XX-XXXXXXXX device_ip: DEVICE_IP_1 - device_id: DEVICE_ID_2 device_ip: DEVICE_IP_2 diff --git a/source/_components/hue.markdown b/source/_components/hue.markdown index 46182598590..688376dc85c 100644 --- a/source/_components/hue.markdown +++ b/source/_components/hue.markdown @@ -35,7 +35,7 @@ hue: {% configuration %} host: - description: The IP address of the device, eg. 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges. + description: The IP address of the device, e.g., 192.168.1.10. Required if not using the `discovery` component to discover Hue bridges. required: true type: string allow_unreachable: diff --git a/source/_components/isy994.markdown b/source/_components/isy994.markdown index b9b4781ad88..6ea7d8de01d 100644 --- a/source/_components/isy994.markdown +++ b/source/_components/isy994.markdown @@ -58,7 +58,7 @@ isy994: {% configuration %} host: - description: The host entry should be in full URL format, eg. http://192.168.10.100:80 + description: The host entry should be in full URL format, e.g., http://192.168.10.100:80 required: true type: string username: @@ -75,7 +75,7 @@ sensor_string: type: string default: sensor ignore_string: - description: Any devices that contain this string in their name (or folder path) will be ignored by Home Assistant. They will not become entities at all. + description: Any devices that contain this string in their name (or folder path) will be ignored by Home Assistant. They will not become entities at all. required: false type: string default: {IGNORE ME} diff --git a/source/_components/light.opple.markdown b/source/_components/light.opple.markdown index 6af52c83db1..dd4572db2cd 100644 --- a/source/_components/light.opple.markdown +++ b/source/_components/light.opple.markdown @@ -35,8 +35,7 @@ name: type: string default: opple light host: - description: "The IP address of your Opple light, eg. `192.168.0.21`." + description: "The IP address of your Opple light, e.g., `192.168.0.21`." required: true type: string {% endconfiguration %} - diff --git a/source/_components/light.tplink.markdown b/source/_components/light.tplink.markdown index 608e748066d..95deb5f127a 100644 --- a/source/_components/light.tplink.markdown +++ b/source/_components/light.tplink.markdown @@ -42,7 +42,7 @@ name: type: string default: TP-Link Light host: - description: "The IP address of your TP-Link bulb, eg. `192.168.1.32`." + description: "The IP address of your TP-Link bulb, e.g., `192.168.1.32`." required: true type: string {% endconfiguration %} diff --git a/source/_components/media_player.aquostv.markdown b/source/_components/media_player.aquostv.markdown index f2d57ff5148..be6a68167c9 100644 --- a/source/_components/media_player.aquostv.markdown +++ b/source/_components/media_player.aquostv.markdown @@ -29,7 +29,7 @@ media_player: {% configuration %} host: - description: The IP/Hostname of the Sharp Aquos TV, eg. `192.168.0.10`. + description: The IP/Hostname of the Sharp Aquos TV, e.g., `192.168.0.10`. required: true type: string port: diff --git a/source/_components/media_player.samsungtv.markdown b/source/_components/media_player.samsungtv.markdown index 01a0c10c51a..85042d85ef2 100644 --- a/source/_components/media_player.samsungtv.markdown +++ b/source/_components/media_player.samsungtv.markdown @@ -31,7 +31,7 @@ media_player: {% configuration %} host: - description: "The IP of the Samsung Smart TV, eg. `192.168.0.10`." + description: "The IP of the Samsung Smart TV, e.g., `192.168.0.10`." required: true type: string port: @@ -49,7 +49,7 @@ timeout: type: time default: 0 (no timeout) mac: - description: "The MAC address of the Samsung Smart TV, eg. `00:11:22:33:44:55:66`. Required for power on support via wake on lan." + description: "The MAC address of the Samsung Smart TV, e.g., `00:11:22:33:44:55:66`. Required for power on support via wake on lan." required: false type: string {% endconfiguration %} diff --git a/source/_components/media_player.squeezebox.markdown b/source/_components/media_player.squeezebox.markdown index 147b402f5ed..e119e97b42c 100644 --- a/source/_components/media_player.squeezebox.markdown +++ b/source/_components/media_player.squeezebox.markdown @@ -27,7 +27,7 @@ media_player: {% configuration %} host: - description: The host name or address of the Logitech Media Server, eg. 192.168.1.21. + description: The host name or address of the Logitech Media Server, e.g., 192.168.1.21. required: true type: string port: diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index 89059d2a971..832ad97b9d2 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -254,7 +254,7 @@ logger: homeassistant.components.mysensors: debug mysensors: debug ``` -The log should inform you of messages that failed validation or if a child value is missing that is required for a certain child type. Note that the log will log all possible combinations of platforms for a child type that failed validation. It is normal to see some platforms fail validation if the child type supports multiple platforms and your sketch doesn't send all corresponding value types. Eg. the `S_BARO` child type supports both `V_PRESSURE` and `V_FORECAST` value types. If you only send a `V_PRESSURE` value, an `S_BARO` entity with `V_PRESSURE` value will be set up for the sensor platform. However, the log will inform of a sensor platform that failed validation due to missing `V_FORECAST` value type for the `S_BARO` child. Home Assistant will log failed validations of child values at warning level if one required value type for a platform has been received, but other required value types are missing. Most failed validations are logged at debug level. +The log should inform you of messages that failed validation or if a child value is missing that is required for a certain child type. Note that the log will log all possible combinations of platforms for a child type that failed validation. It is normal to see some platforms fail validation if the child type supports multiple platforms and your sketch doesn't send all corresponding value types. e.g., the `S_BARO` child type supports both `V_PRESSURE` and `V_FORECAST` value types. If you only send a `V_PRESSURE` value, an `S_BARO` entity with `V_PRESSURE` value will be set up for the sensor platform. However, the log will inform of a sensor platform that failed validation due to missing `V_FORECAST` value type for the `S_BARO` child. Home Assistant will log failed validations of child values at warning level if one required value type for a platform has been received, but other required value types are missing. Most failed validations are logged at debug level. Message validation was introduced in version 0.52 of Home Assistant. diff --git a/source/_components/notify.smtp.markdown b/source/_components/notify.smtp.markdown index 7e10071eccf..c41695aabda 100644 --- a/source/_components/notify.smtp.markdown +++ b/source/_components/notify.smtp.markdown @@ -73,7 +73,7 @@ sender_name: required: false type: string debug: - description: Enables Debug, eg. True or False. + description: Enables Debug, e.g., True or False. required: false type: boolean default: false diff --git a/source/_components/octoprint.markdown b/source/_components/octoprint.markdown index a1dbd4bf5b3..646f766afd6 100644 --- a/source/_components/octoprint.markdown +++ b/source/_components/octoprint.markdown @@ -82,7 +82,7 @@ octoprint: "Current State": description: Text of current state. "Temperatures": - description: Temperatures of all available tools, eg. `print`, `head`, `print bed`, etc. These will be displayed as `tool0`, `tool1`, or `toolN` please refer to your OctoPrint frontend to associate the tool number with an actual device. + description: Temperatures of all available tools, e.g., `print`, `head`, `print bed`, etc. These will be displayed as `tool0`, `tool1`, or `toolN` please refer to your OctoPrint frontend to associate the tool number with an actual device. "Job Percentage": description: Percentage of the job. "Time Elapsed": diff --git a/source/_components/point.markdown b/source/_components/point.markdown index 4e5fdae6ddc..36d790aca80 100644 --- a/source/_components/point.markdown +++ b/source/_components/point.markdown @@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling" ha_qa_scale: silver --- -The Point component is the main component to integrate the [Minut Point](https://minut.com/). To connect Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` using the `callback url` as `base_url` + `/api/minut` eg. `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below. +The Point component is the main component to integrate the [Minut Point](https://minut.com/). To connect Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` using the `callback url` as `base_url` + `/api/minut`, e.g., `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below. Once Home Assistant is started, a configurator will pop up asking you to Authenticate your Point account via a link when you follow the link and have clicked on **Accept** you will be redirected to the `callback url` and the Point integration will be automatically configured and you can go back to the original dialog and press **Submit**. diff --git a/source/_components/scene.hunterdouglas_powerview.markdown b/source/_components/scene.hunterdouglas_powerview.markdown index a418c8f4ddd..84674b2a10c 100644 --- a/source/_components/scene.hunterdouglas_powerview.markdown +++ b/source/_components/scene.hunterdouglas_powerview.markdown @@ -25,7 +25,7 @@ scene: {% configuration %} address: - description: IP address of the PowerView Hub, eg. 192.168.1.10. + description: IP address of the PowerView Hub, e.g., 192.168.1.10. required: true type: string {% endconfiguration %} diff --git a/source/_components/sensor.bitcoin.markdown b/source/_components/sensor.bitcoin.markdown index 4465554c50c..dadf5ed96ad 100644 --- a/source/_components/sensor.bitcoin.markdown +++ b/source/_components/sensor.bitcoin.markdown @@ -29,7 +29,7 @@ sensor: {% configuration %} currency: - description: The currency to exchange to, eg. CHF, USD, EUR, etc. + description: The currency to exchange to, e.g., CHF, USD, EUR, etc. required: false type: string default: USD diff --git a/source/_components/sensor.deutsche_bahn.markdown b/source/_components/sensor.deutsche_bahn.markdown index 6586e49452a..fdba0b5e711 100644 --- a/source/_components/sensor.deutsche_bahn.markdown +++ b/source/_components/sensor.deutsche_bahn.markdown @@ -14,7 +14,7 @@ ha_release: 0.14 --- -The `deutsche_bahn` sensor will give you the departure time of the next train for the given connection. In case of a delay, the delay is also shown. Additional details are used to inform about eg. the type of the train, price, and if it is on time. +The `deutsche_bahn` sensor will give you the departure time of the next train for the given connection. In case of a delay, the delay is also shown. Additional details are used to inform about, e.g., the type of the train, price, and if it is on time. To enable this sensor, add the following lines to your `configuration.yaml` file: @@ -41,7 +41,7 @@ only_direct: default: false {% endconfiguration %} -This sensor stores a lot of attributes which can be accessed by other sensors eg. a [template sensor](/components/sensor.template/). +This sensor stores a lot of attributes which can be accessed by other sensors, e.g., a [template sensor](/components/sensor.template/). ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.dwd_weather_warnings.markdown b/source/_components/sensor.dwd_weather_warnings.markdown index 3f5372012db..2b24add44e3 100644 --- a/source/_components/sensor.dwd_weather_warnings.markdown +++ b/source/_components/sensor.dwd_weather_warnings.markdown @@ -57,7 +57,7 @@ name: | ------------ | -------------------------------------- | | `last_updated` | Information last update from DWD service. | | `region_name` | Requested region name. This should be the same as the region name in the configuration. | -| `region_state` | State (Bundesland) in abriviated form the requested region is located, eg. "HE" for "Hessen". | +| `region_state` | State (Bundesland) in abriviated form the requested region is located, e.g., "HE" for "Hessen". | | `region_id` | Region ID assigned by DWD. | | `warning_count` | *(int)* Number of issued warnings. There can be more than one warning issued at once. | | `warning_