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 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Extends textlint Terminology list (#12065)

Browse Source
This commit is contained in:
Franck Nijhof 2020-02-12 14:56:50 +01:00 committed by GitHub
parent 752dec4047
commit 6c292ca062
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
25 changed files with 103 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
.textlintrc.json
View File

@ -9,16 +9,68 @@
"skip": ["Blockquote"],
"terms": [
"Abode",
"Acer",
"Actiontec",
"AdGuard Home",
"AdGuard",
"Aeotec",
"AfterShip",
"Airly",
"AirVisual",
"Aladdin Connect",
"Alarm.com",
"AlarmDecoder",
"Alexa",
"Almond",
"Alpha Vantage",
"Amazon Alexa",
"Amazon Polly",
"Amazon Web Services",
"Amazon",
"Ambiclimate",
"Ambient Weather Station",
"Amcrest",
"Android",
"AppleScript",
"AWS",
"Axis",
"Beckhoff",
"Dark Sky",
"deCONZ",
"ecobee",
"Elgato Key Light",
"Elgato",
"ESPHome",
"Everspring",
"FFmpeg",
"Fibaro",
"FreeNAS",
"GitHub",
"Google Assistant",
"Google Home",
"Google",
"Home Assistant Companion",
"Home Assistant Core",
"Home Assistant Supervised",
"Home Assistant Supervisor",
"Home Assistant Operating System",
"Home Assistant OS",
"Home Assistant Supervised",
"Home Assistant Supervisor",
"Home Assistant",
"HomeKit",
"Honeywell",
"iCloud",
"IFTTT",
"IKEA",
"Lovelace",
"macOS",
"Microsoft",
"Zigbee",
[" HA ", "Home Assistant"],
["Alarm ?dot ?com", "Alarm.com"],
["hass", "Home Assistant"],
["Home-?Ass?s?iss?tt?ant", "Home Assistant"],
[" HA ", "Home Assistant"]
["Mac ?OS", "macOS"],
["OS ?X", "macOS"]
]
}
}

15
source/_docs/asterisk_mbox.markdown
View File

@ -54,13 +54,13 @@ Before beginning make sure that you have the following:
```
- **host** (*Optional*): The IP address to listen on for client requests. This defaults to all IP addresses on the server. To listen only locally, choose `127.0.0.1`
- **port** (*Optional*): The port to listen on for client requests. Defaults to 12345.
- **password** (*Required*): A password shared between client and server. Use only alpha-numeric characters and spaces
- **mbox\_path** (*Required*): The path to the storage location of mailbox files. This is typically `/var/spool/asterisk/voicemail/default/<mailbox>/`
- **cache\_file** (*Required*): A fully-qualified path to a file that can be written by the server containing transcriptions of voicemails. Example: `/var/spool/asterisk/transcription.cache`
- **google\_key** (*Required*): Your 40 characters Google API key.
- **cdr** (*Optional*): Where to find CDR data. Supports various SQL databases as well as a file log. Configuring the CDR will enable the `asterisk_cdr` platfom.
- `host` (*Optional*): The IP address to listen on for client requests. This defaults to all IP addresses on the server. To listen only locally, choose `127.0.0.1`
- `port` (*Optional*): The port to listen on for client requests. Defaults to 12345.
- `password` (*Required*): A password shared between client and server. Use only alpha-numeric characters and spaces
- `mbox_path` (*Required*): The path to the storage location of mailbox files. This is typically `/var/spool/asterisk/voicemail/default/<mailbox>/`
- `cache_file` (*Required*): A fully-qualified path to a file that can be written by the server containing transcriptions of voicemails. Example: `/var/spool/asterisk/transcription.cache`
- `google_key` (*Required*): Your 40 characters Google API key.
- `cdr` (*Optional*): Where to find CDR data. Supports various SQL databases as well as a file log. Configuring the CDR will enable the `asterisk_cdr` platform.
Once complete, ensure this file is only accessible by the Asterisk user:
@ -68,6 +68,7 @@ Before beginning make sure that you have the following:
sudo chown asterisk:asterisk /etc/asterisk/asterisk_mbox.ini
sudo chmod 600 /etc/asterisk/asterisk_mbox.ini
```
4. Interactively start the server to verify it is functioning
```bash

2
source/_docs/configuration/templating.markdown
View File

@ -11,7 +11,7 @@ This is an advanced feature of Home Assistant. You'll need a basic understanding
Templating is a powerful feature that allows you to control information going into and out of the system. It is used for:
- Formatting outgoing messages in, for example, the [notify](/integrations/notify/) platforms and [alexa](/integrations/alexa/) component.
- Formatting outgoing messages in, for example, the [notify](/integrations/notify/) platforms and [Alexa](/integrations/alexa/) component.
- Process incoming data from sources that provide raw data, like [MQTT](/integrations/mqtt/), [`rest` sensor](/integrations/rest/) or the [`command_line` sensor](/integrations/sensor.command_line/).
- [Automation Templating](/docs/automation/templating/).

2
source/_docs/scripts/service-calls.markdown
View File

@ -94,7 +94,7 @@ There are four `homeassistant` services that aren't tied to any single domain, t
* `homeassistant.turn_on` - Turns on an entity (that supports being turned on), for example an `automation`, `switch`, etc
* `homeassistant.turn_off` - Turns off an entity (that supports being turned off), for example an `automation`, `switch`, etc
* `homeassistant.toggle` - Turns off an entity that is on, or turns on an entity that is off (that supports being turned on and off)
* `homeassistant.update_entity` - Request the update of an entity, rather than waiting for the next scheduled update, for example [google travel time] sensor, a [template sensor], or a [light]
* `homeassistant.update_entity` - Request the update of an entity, rather than waiting for the next scheduled update, for example [Google travel time] sensor, a [template sensor], or a [light]
Complete service details and examples can be found on the [Home Assistant integration][homeassistant-integration-services] page.

4
source/_integrations/aftership.markdown
View File

@ -44,7 +44,7 @@ api_key:
## Service `add_tracking`
You can use the service `aftership.add_tracking` to add trackings to Aftership.
You can use the service `aftership.add_tracking` to add trackings to AfterShip.
| Service data attribute | Required | Type | Description |
| ---------------------- | -------- | -------- | ----------- |
@ -54,7 +54,7 @@ api_key:
## Service `remove_tracking`
You can use the service `aftership.remove_tracking` to remove trackings from Aftership.
You can use the service `aftership.remove_tracking` to remove trackings from AfterShip.
| Service data attribute | Required | Type | Description |
| ---------------------- | -------- | -------- | ----------- |

2
source/_integrations/airvisual.markdown
View File

@ -14,7 +14,7 @@ The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/)
This platform requires an AirVisual API key, which can be obtained [here](https://airvisual.com/api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all).
The Community API key is valid for 12 months after which it will expire. You must then go back to the Airvisual website, delete your old key, create a new one following the same steps and update your configuration with the new key.
The Community API key is valid for 12 months after which it will expire. You must then go back to the AirVisual website, delete your old key, create a new one following the same steps and update your configuration with the new key.
<div class='note warning'>

2
source/_integrations/alarm_control_panel.template.markdown
View File

@ -13,7 +13,7 @@ The `template` integrations creates alarm control panels that combine integratio
There are several powerful ways to use this integration, including grouping existing integrations into a simpler integrations, or adding logic that Home Assistant will execute when accessed.
For example, if you want to expose a true alarm panel to Google Home, Alexa, or Homekit - but limit its ability to disarm when there's no one home, you can do that using a template.
For example, if you want to expose a true alarm panel to Google Home, Alexa, or HomeKit - but limit its ability to disarm when there's no one home, you can do that using a template.
Another use case could be grouping a series of sensors and services together to represent various "armed" and "disarmed" states and actions.

2
source/_integrations/alarmdecoder.markdown
View File

@ -108,7 +108,7 @@ zones:
required: false
type: integer
relayaddr:
description: "Address of the relay or zone expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. Alarmdecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed."
description: "Address of the relay or zone expander board to associate with the zone. (ex: 12, 13, 14, or 15). Typically used in cases where a panel will not send bypassed zones such as motion during an armed home state, the Vista 20P is an example of this. AlarmDecoder can emulate a zone expander board and the panel can be programmed to push zone events to this virtual expander. This allows the bypassed zone binary sensors to be utilized. One example is using bypassed motion sensors at night for motion-based automated lights while the system is armed with the motion sensor bypassed."
required: inclusive
type: integer
relaychan:

2
source/_integrations/amcrest.markdown
View File

@ -140,7 +140,7 @@ your camera's configuration manager. If you defined the *stream_source* to
Newer Amcrest firmware may not work, then **rtsp** is recommended instead.
**Note:** If you set the `stream_source` option to `rtsp`,
make sure to follow the steps mentioned at [FFMPEG](/integrations/ffmpeg/)
make sure to follow the steps mentioned at [FFmpeg](/integrations/ffmpeg/)
documentation to install the `ffmpeg`.
## Services

2
source/_integrations/arlo.markdown
View File

@ -152,7 +152,7 @@ ffmpeg_arguments:
type: string
{% endconfiguration %}
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/integrations/ffmpeg/) documentation.
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFmpeg](/integrations/ffmpeg/) documentation.
## Sensor

2
source/_integrations/camera.ffmpeg.markdown
View File

@ -12,7 +12,7 @@ The `ffmpeg` platform allows you to use any video feed as a camera in Home Assis
## Configuration
To enable your FFmpeg feed in your installation you must first configure the [ffmpeg integration](/integrations/ffmpeg/), then add the following to your `configuration.yaml` file:
To enable your FFmpeg feed in your installation you must first configure the [FFmpeg integration](/integrations/ffmpeg/), then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

2
source/_integrations/darksky.markdown
View File

@ -176,7 +176,7 @@ scan_interval:
#### Language options
All language options are described in this table that you can use for the dark sky sensor.
All language options are described in this table that you can use for the Dark Sky sensor.
|Language|Variable Code|
|---|---|

4
source/_integrations/deconz.markdown
View File

@ -313,9 +313,9 @@ class RemoteControl(hass.Hass):
{% endraw %}
#### Appdaemon Ikea Tradfri remote template
#### Appdaemon IKEA Tradfri remote template
Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track.
Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an IKEA Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track.
{% raw %}

4
source/_integrations/ecobee.markdown
View File

@ -1,5 +1,5 @@
---
title: Ecobee
title: ecobee
description: Instructions for how to integrate ecobee thermostats and sensors within Home Assistant.
logo: ecobee.png
ha_category:
@ -76,7 +76,7 @@ api_key:
The first time you (re)run Home Assistant with this integration it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar.
The PIN can be found in the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in the States developer tool.
The PIN can be found in the Home Assistant portal on the ecobee card or from the `configurator.ecobee` entity in the States developer tool.
- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this, you can temporarily comment out the `default_view` section or add the `configurator.ecobee` integration to your `default_view` and restart Home Assistant.

2
source/_integrations/ffmpeg_motion.markdown
View File

@ -11,7 +11,7 @@ The `ffmpeg` platform allows you to use any video feed with [FFmpeg](https://www
<div class='note'>
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the FFmpeg process of sensor, use the service `ffmpeg.start`, `ffmpeg.stop`, `ffmpeg.restart`.
</div>

4
source/_integrations/ffmpeg_noise.markdown
View File

@ -11,7 +11,7 @@ The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](ht
<div class='note'>
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the FFmpeg process of sensor, use the service `ffmpeg.start`, `ffmpeg.stop`, `ffmpeg.restart`.
</div>
@ -36,7 +36,7 @@ name:
required: false
type: string
initial_state:
description: Start ffmpeg with home-assistant.
description: Start FFmpeg with home-assistant.
required: false
type: boolean
default: true

2
source/_integrations/google_travel_time.markdown
View File

@ -77,7 +77,7 @@ options:
required: exclusive
type: [time, string]
avoid:
description: "Indicate what google should avoid when calculating the travel time, you can choose from: `tolls`, `highways`, `ferries`, `indoor`."
description: "Indicate what Google should avoid when calculating the travel time, you can choose from: `tolls`, `highways`, `ferries`, `indoor`."
required: false
type: string
transit_mode:

5
source/_integrations/pandora.markdown
View File

@ -10,18 +10,17 @@ ha_iot_class: Local Polling
If you have a Pandora account, you can control it from Home Assistant with this media player.
### Installation of Pianobar
This media player uses the [Pianobar command-line Pandora client](https://github.com/PromyLOPh/pianobar), which you have to install separately. This can be done on a Raspberry Pi 2/3 with Raspbian Jessie as follows . _(Note: Other platforms may have different installation processes)_
The version of pianobar that comes with Jessie has a bug, so you have to build a more recent version. The latest version depends on a recent version of libraries associated with ffmpeg, so you should make sure you go through the backport process documented in [The FFmpeg component](/integrations/ffmpeg/) before doing this. Install the following basic dependencies:
The version of pianobar that comes with Jessie has a bug, so you have to build a more recent version. The latest version depends on a recent version of libraries associated with FFmpeg, so you should make sure you go through the backport process documented in [The FFmpeg component](/integrations/ffmpeg/) before doing this. Install the following basic dependencies:
```bash
sudo apt-get install git libao-dev libgcrypt11-dev libfaad-dev libmad0-dev libjson-c-dev make pkg-config libcurl4-openssl-dev
```
And now install the backported ffmpeg-related libraries (note that if you're using an older version of ffmpeg for other things on this machine, you may encounter issues after doings this):
And now install the backported FFmpeg-related libraries (note that if you're using an older version of FFmpeg for other things on this machine, you may encounter issues after doings this):
```bash
sudo apt-get -t jessie-backports install libav-tools libavcodec-extra libavcodec-dev libavfilter-dev libavformat-dev

3
source/_integrations/panel_iframe.markdown
View File

@ -32,7 +32,6 @@ panel_iframe:
url: '/otherapp'
```
{% configuration %}
panel_iframe:
description: Enables the panel_iframe component. Only allowed once.
@ -65,6 +64,6 @@ panel_iframe:
<div class='note warning'>
Do **not** create one that is named `lovelace` it will overwrite lovelace causing it to never load.
Do **not** create one that is named `lovelace` it will overwrite Lovelace causing it to never load.
</div>

2
source/_integrations/rflink.markdown
View File

@ -85,7 +85,7 @@ Tested with Wifi serial bridge [esp-link V2.2.3](https://github.com/jeelabs/esp-
<div class='note warning'>
Due to different logic levels, a voltage level shifter is required between the 3.3V NodeMCU and 5V Arduino MEGA 2560 pins. The BSS138 bidirectional logic level converter has been tested for serial pins and the [link](https://www.aliexpress.com/item/8CH-IIC-I2C-Logic-Level-Converter-Bi-Directional-Module-DC-DC-5V-to-3-3V-Setp/32238089139.html) is recommended for the CC2500 transceiver (used for Ikea Ansluta and Philips Living Colors)
Due to different logic levels, a voltage level shifter is required between the 3.3V NodeMCU and 5V Arduino MEGA 2560 pins. The BSS138 bidirectional logic level converter has been tested for serial pins and the [link](https://www.aliexpress.com/item/8CH-IIC-I2C-Logic-Level-Converter-Bi-Directional-Module-DC-DC-5V-to-3-3V-Setp/32238089139.html) is recommended for the CC2500 transceiver (used for IKEA Ansluta and Philips Living Colors)
</div>

2
source/_integrations/stream.markdown
View File

@ -55,7 +55,7 @@ action:
## Streaming in Lovelace
As of Home Assistant version 0.92 you can now live-stream a camera feed directly in lovelace.
To do this add either [picture-entity](/lovelace/picture-entity/), [picture-glance](/lovelace/picture-glance/) or [picture-elements](/lovelace/picture-elements/), set `camera_image` to a stream-ready camera entity and set `camera_view` to `live` in one of your lovelace views.
To do this add either [picture-entity](/lovelace/picture-entity/), [picture-glance](/lovelace/picture-glance/) or [picture-elements](/lovelace/picture-elements/), set `camera_image` to a stream-ready camera entity and set `camera_view` to `live` in one of your Lovelace views.
## Troubleshooting

2
source/_integrations/zha.markdown
View File

@ -71,7 +71,7 @@ Use the plus button in the bottom right to add a new integration called **ZHA**.
In the popup:
- USB Device Path - on a linux system will be something like `/dev/ttyUSB0`
- Radio type - select device type **ezsp**, **deconz** or **xbee**
- Radio type - select device type `ezsp`, `deconz` or `xbee`
- Submit
The success dialog will appear or an error will be displayed in the popup. An error is likely if Home Assistant can't access the USB device or your device is not up to date (see troubleshooting).

2
source/_lovelace/picture-entity.markdown
View File

@ -223,7 +223,7 @@ state_image:
"off": /local/bed_light_off.png
```
Displaying a live feed from an FFMPEG camera:
Displaying a live feed from an FFmpeg camera:
{% raw %}
```yaml

2
source/lovelace/changelog.markdown
View File

@ -64,7 +64,7 @@ description: "Changelog of the Lovelace UI."
- ❤️ Theming: New CSS switch style: `switch-unchecked-track-color` [#4017](https://github.com/home-assistant/home-assistant-polymer/pull/4017) @iantrich
- 📣 Upgrade MDI icons to 4.5.95 [#3977](https://github.com/home-assistant/home-assistant-polymer/pull/3977) @bonanitech
- 📣 Display card errors in YAML instead of JSON [#4018](https://github.com/home-assistant/home-assistant-polymer/pull/4018) @iantrich
- ⚠️ revert lovelace selectable text [#4095](https://github.com/home-assistant/home-assistant-polymer/pull/4095) @iantrich
- ⚠️ revert Lovelace selectable text [#4095](https://github.com/home-assistant/home-assistant-polymer/pull/4095) @iantrich
- 🔧 [alarm panel card]: Visual accessibility changes [#3991](https://github.com/home-assistant/home-assistant-polymer/pull/3991) @mr-awk
- 🔧 [entities card]: Fix media row secondary info [#3957](https://github.com/home-assistant/home-assistant-polymer/pull/3957) @iantrich
- 🔧 [light card]: Fix name wrapping [#3972](https://github.com/home-assistant/home-assistant-polymer/pull/3972) @shbatm

2
source/lovelace/index.markdown
View File

@ -25,7 +25,7 @@ To try it yourself, check out [the demo](https://demo.home-assistant.io).
## Discuss Lovelace
- Suggestions are welcome in the [home-assistant-polymer repository](https://github.com/home-assistant/home-assistant-polymer/)
- For help with Lovelace, join the #lovelace channel on [our chat](/join-chat/) or [our forums](https://community.home-assistant.io/c/projects/frontend)
- For help with Lovelace, join the `#frontend` channel on [our chat](/join-chat/) or [our forums](https://community.home-assistant.io/c/projects/frontend)
## Additional Lovelace Resources