jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 17:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed e.g., in the docs (#8488)

Browse Source 
* Fixed e.g., in the docs

* More fix
This commit is contained in:
Alok Saboo 2019-02-11 13:26:22 -05:00 committed by Klaas Schoute
parent 2443d26ae2
commit 6429c9d0b2
30 changed files with 44 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_components/aqualogic.markdown
View File

@ -28,7 +28,7 @@ aqualogic:
{% configuration %}
host:
description: The domain name or IP address of the RS-485 to Ethernet adapter connected to the pool controller, eg. 192.168.1.1.
description: The domain name or IP address of the RS-485 to Ethernet adapter connected to the pool controller, e.g., 192.168.1.1.
required: true
type: string
port:

6
source/_components/asuswrt.markdown
View File

@ -28,7 +28,7 @@ asuswrt:
{% 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:
@ -80,5 +80,5 @@ sensors:
{% endconfiguration %}
<p class='note warning'>
You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.
</p>
You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.
</p>

2
source/_components/camera.generic.markdown
View File

@ -30,7 +30,7 @@ camera:
{% configuration %}
still_image_url:
description: "The URL your camera serves the image on, eg. http://192.168.1.21:2112/. Can be a [template](/topics/templating/)."
description: "The URL your camera serves the image on, e.g., http://192.168.1.21:2112/. Can be a [template](/topics/templating/)."
required: true
type: string
name:

2
source/_components/camera.mjpeg.markdown
View File

@ -30,7 +30,7 @@ camera:
{% configuration %}
mjpeg_url:
description: The URL your camera serves the video on, eg. http://192.168.1.21:2112/
description: The URL your camera serves the video on, e.g., http://192.168.1.21:2112/
required: true
type: string
still_image_url:

4
source/_components/cover.rfxtrx.markdown
View File

@ -42,7 +42,7 @@ cover:
##### {% linkable_title RFY %}
The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. Eg, if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr eg, id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`.
The [RFXtrx433e](http://www.rfxcom.com/RFXtrx433E-USB-43392MHz-Transceiver/en) is required for RFY support, however it does not support receive for the RFY protocol - as such devices cannot be automatically added. Instead, configure the device in the [rfxmngr](http://www.rfxcom.com/downloads.htm) tool. Make a note of the assigned ID and Unit Code and then add a device to the configuration with the following id `071a0000[id][unit_code]`. E.g., if the id was `0a` `00` `01`, and the unit code was `01` then the fully qualified id would be `071a00000a000101`, if you set your id/code to single digit in the rfxmngr, e.g., id: `1` `02` `04` and unit code: `1` you will need to add `0` before, so `102031` becomes `071a000001020301`.
##### {% linkable_title Common %}
@ -88,6 +88,6 @@ signal_repetitions:
{% endconfiguration %}
<p class='note warning'>
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.
</p>

3
source/_components/device_tracker.actiontec.markdown
View File

@ -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.

3
source/_components/dialogflow.markdown
View File

@ -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 %}

2
source/_components/dyson.markdown
View File

@ -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

2
source/_components/hue.markdown
View File

@ -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:

4
source/_components/isy994.markdown
View File

@ -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}

3
source/_components/light.opple.markdown
View File

@ -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 %}

2
source/_components/light.tplink.markdown
View File

@ -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 %}

2
source/_components/media_player.aquostv.markdown
View File

@ -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:

4
source/_components/media_player.samsungtv.markdown
View File

@ -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 %}

2
source/_components/media_player.squeezebox.markdown
View File

@ -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:

2
source/_components/mysensors.markdown
View File

@ -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.

2
source/_components/notify.smtp.markdown
View File

@ -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

2
source/_components/octoprint.markdown
View File

@ -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":

2
source/_components/point.markdown
View File

@ -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**.

2
source/_components/scene.hunterdouglas_powerview.markdown
View File

@ -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 %}

2
source/_components/sensor.bitcoin.markdown
View File

@ -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

4
source/_components/sensor.deutsche_bahn.markdown
View File

@ -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

2
source/_components/sensor.dwd_weather_warnings.markdown
View File

@ -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_<x>_level` | *(int)* Issued warning level between 0 and 4. <br/>0: Keine Warnungen <br/>1: Wetterwarnungen <br/>2: Warnungen vor markantem Wetter<br/>3: Unwetterwarnungen<br/>4: Warnungen vor extremem Unwetter |

2
source/_components/sensor.openweathermap.markdown
View File

@ -45,7 +45,7 @@ sensor:
default: false
type: string
language:
description: The language in which you want text results to be returned. It's a two-characters string, eg. `en`, `es`, `ru`, `it`, etc.
description: The language in which you want text results to be returned. It's a two-characters string, e.g., `en`, `es`, `ru`, `it`, etc.
required: false
default: en
type: string

2
source/_components/sensor.snmp.markdown
View File

@ -27,7 +27,7 @@ sensor:
{% configuration %}
host:
description: The IP address of your host, eg. `192.168.1.32`.
description: The IP address of your host, e.g., `192.168.1.32`.
required: false
type: string
default: 'localhost'

18
source/_components/sensor.systemmonitor.markdown
View File

@ -49,9 +49,9 @@ file.
| Type (`type:`) | Argument (`arg:`) |
| :------------------ |:--------------------------|
| disk_use_percent | Path, eg. `/` |
| disk_use | Path, eg. `/` |
| disk_free | Path, eg. `/` |
| disk_use_percent | Path, e.g., `/` |
| disk_use | Path, e.g., `/` |
| disk_free | Path, e.g., `/` |
| memory_use_percent | |
| memory_use | |
| memory_free | |
@ -61,12 +61,12 @@ file.
| load_1m | |
| load_5m | |
| load_15m | |
| network_in | Interface, eg. `eth0` |
| network_out | Interface, eg. `eth0` |
| packets_in | Interface, eg. `eth0` |
| packets_out | Interface, eg. `eth0` |
| ipv4_address | Interface, eg. `eth0` |
| ipv6_address | Interface, eg. `eth0` |
| network_in | Interface, e.g., `eth0` |
| network_out | Interface, e.g., `eth0` |
| packets_in | Interface, e.g., `eth0` |
| packets_out | Interface, e.g., `eth0` |
| ipv4_address | Interface, e.g., `eth0` |
| ipv6_address | Interface, e.g., `eth0` |
| processor_use | |
| process | Binary, e.g., `octave-cli` |
| last_boot | |

2
source/_components/sensor.worldclock.markdown
View File

@ -32,7 +32,7 @@ time_zone:
required: true
type: string
name:
description: The name of the sensor, eg. the city.
description: The name of the sensor, e.g., the city.
required: false
type: string
default: Worldclock Sensor

2
source/_components/switch.deluge.markdown
View File

@ -31,7 +31,7 @@ switch:
host:
required: true
type: string
description: This is the IP address of your Deluge daemon, eg., 192.168.1.32.
description: This is the IP address of your Deluge daemon, e.g., 192.168.1.32.
username:
required: true
type: string

2
source/_components/switch.pilight.markdown
View File

@ -68,7 +68,7 @@ switches:
Variables for the different codes (`on_code` and `off_code`):
- **protocol** (*Required*): Protocol to use, eg. `intertechno_old` or `daycom`.
- **protocol** (*Required*): Protocol to use, e.g., `intertechno_old` or `daycom`.
- **systemcode** (*Optional*): The systemcode of the device.
- **unit** (*Optional*): The unit to use (is equivalent to `pilight-send --unit`).
- **unitcode** (*Optional*): The unitcode to use (is equivalent to `pilight-send --unitcode`).

2
source/_components/switch.tplink.markdown
View File

@ -41,7 +41,7 @@ name:
type: string
default: TP-Link Switch
host:
description: "The IP address of your TP-Link switch, eg. `192.168.1.32`."
description: "The IP address of your TP-Link switch, e.g., `192.168.1.32`."
required: true
type: string
enable_leds: