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-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Home Assistant etc spelling consistency fixes (#11637)

Browse Source 
* Be consistent with Home Assistant spelling

* Refer to the Configurator without "HASS"

That's what's it calls itself and how it is in the add-on store.

* Be consistent with Hass.io spelling

* Tell vscode to spell HassOS like that
This commit is contained in:
Ville Skyttä 2020-01-05 13:44:21 +02:00 committed by Franck Nijhof
parent 8fba0f8c74
commit 301edb9bd2
33 changed files with 42 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.vscode/cSpell.json vendored
View File

@ -18,8 +18,8 @@
"geizhals",
"Harman",
"hass",
"hass.io",
"hassos",
"Hass.io",
"HassOS",
"hcitool",
"heos",
"hikvision",

4
source/_addons/configurator.markdown
View File

@ -1,5 +1,5 @@
---
title: "HASS Configurator"
title: "Configurator"
description: "Browser-based configuration file editor for Home Assistant."
featured: true
og_image: /images/hassio/screenshots/addon-hass-configurator.png
@ -11,7 +11,7 @@ More information and a standalone version for regular Home Assistant installatio
<p class='img'>
<img src='/images/hassio/screenshots/addon-hass-configurator.png'>
Screenshot of the HASS Configurator.
Screenshot of the Configurator.
</p>
### Feature list

4
source/_addons/snips.markdown
View File

@ -77,7 +77,7 @@ There is an active [discord](https://discordapp.com/invite/3939Kqx) channel and
### Examples
So now you can turn lights on and off, let's check the weather. Log on to the [console](https://console.snips.ai/). If this is your first time, create a new assistant and add the Home Assistant skill, along with the Weather skill by snips. Download your assistant manually and copy it to the `/share` folder on your HassIO installation using the Samba add-on.
So now you can turn lights on and off, let's check the weather. Log on to the [console](https://console.snips.ai/). If this is your first time, create a new assistant and add the Home Assistant skill, along with the Weather skill by snips. Download your assistant manually and copy it to the `/share` folder on your Hass.io installation using the Samba add-on.
Next create a weather sensor, e.g., one for [Dark Sky](/integrations/darksky/), and put the `api_key` in your `secrets.yaml` file. For this example to work you will need to have a valid API key from [Dark Sky](https://darksky.net/dev).
@ -120,6 +120,6 @@ searchWeatherForecast:
{% endraw %}
Now just restart HassIO and ask it what the weather is like.
Now just restart Hass.io and ask it what the weather is like.
[their tutorial]: https://github.com/snipsco/snips-platform-documentation/wiki/2.-Create-an-assistant-using-an-existing-bundle

2
source/_docs/authentication.markdown
View File

@ -81,7 +81,7 @@ While you should hopefully be storing your passwords in a password manager, if y
* `auth`
* `auth_provider.homeassistant`
* `onboarding`
* `hassio` (for hassio users)
* `hassio` (for Hass.io users)
* `cloud` (for nabucasa users)
When you start Home Assistant next, you'll be required to set up authentication again.

2
source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown
View File

@ -40,7 +40,7 @@ http:
ssl_key: /ssl/privkey.pem
```
Non-hass.io:
Non-Hass.io:
```yaml
http:

6
source/_docs/ecosystem/hass-configurator.markdown
View File

@ -1,6 +1,6 @@
---
title: "HASS Configurator"
description: "Instructions on how to install and use the HASS Configurator"
title: "Configurator"
description: "Instructions on how to install and use the Configurator"
redirect_from: /ecosystem/hass-configurator/
---
@ -11,7 +11,7 @@ This is essentially a browser-based alternative to modifying your configuration
<p class='img'>
<img src='/images/hassio/screenshots/addon-hass-configurator.png'>
Screenshot of the HASS Configurator.
Screenshot of the Configurator.
</p>
### Feature list

2
source/_docs/mqtt/broker.markdown
View File

@ -9,7 +9,7 @@ The MQTT integration needs you to run an MQTT broker for Home Assistant to conne
### Run your own
This is the most private option, but it requires a little bit of work to setup. There are multiple free and open-source brokers to pick from: e.g., [Mosquitto](http://mosquitto.org/), [EMQ](https://github.com/emqx/emqx) or [Mosca](http://www.mosca.io/).
For hass.io users, the recommended setup method is to use the [Mosquitto MQTT broker addon](/addons/mosquitto).
For Hass.io users, the recommended setup method is to use the [Mosquitto MQTT broker addon](/addons/mosquitto).
```yaml
# Example configuration.yaml entry

2
source/_docs/z-wave/controllers.markdown
View File

@ -24,7 +24,7 @@ There have [been reports](https://www.raspberrypi.org/forums/viewtopic.php?f=28&
We recommend that you purchase a [Z-Wave Plus](https://z-wavealliance.org/z-wave_plus_certification/) controller, to take advantage of the improvements this provides. As OpenZWave doesn't support S2 or Smart Start, there's no need to buy one just for support of these features.
<div class='note'>
If you're using Hass.io or running HASS in a Docker container, it's recommended to use a USB stick, not a module. Passing a module through Docker is more complicated than passing a USB stick through.
If you're using Hass.io or running Home Assistant in a Docker container, it's recommended to use a USB stick, not a module. Passing a module through Docker is more complicated than passing a USB stick through.
</div>
## Stick Alternatives

2
source/_docs/z-wave/installation.markdown
View File

@ -122,7 +122,7 @@ You can also check what hardware has been found using the [hassio command](/hass
$ hassio hardware info
```
If you did an alternative install of Hass.io on Linux (e.g. installing Ubuntu, then Docker, then Hass.io) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g. dead or unreachable Z-Wave nodes, most notably right after HomeAssistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu).
If you did an alternative install of Hass.io on Linux (e.g. installing Ubuntu, then Docker, then Hass.io) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g. dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu).
### Docker

2
source/_includes/asides/docs_navigation.html
View File

@ -349,7 +349,7 @@
</li>
<li>{% active_link /docs/ecosystem/synology/ Synology %}</li>
<li>
{% active_link /docs/ecosystem/hass-configurator/ HASS Configurator
{% active_link /docs/ecosystem/hass-configurator/ Configurator
%}
</li>
</ul>

2
source/_integrations/apcupsd.markdown
View File

@ -47,7 +47,7 @@ port:
<div class='note'>
If you get `ConnectionRefusedError: Connection refused` errors in the Home assistant logs, ensure the [APCUPSd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [APCUPSd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
</div>

2
source/_integrations/dlna_dmr.markdown
View File

@ -42,7 +42,7 @@ name:
required: false
type: string
callback_url_override:
description: Override the advertised callback URL. In case the home assistant instance is not directly reachable (e.g., running in a docker container without bridged-networking), advertise this callback URL for events.
description: Override the advertised callback URL. In case the Home Assistant instance is not directly reachable (e.g., running in a docker container without bridged-networking), advertise this callback URL for events.
required: false
type: string
{% endconfiguration %}

2
source/_integrations/elkm1.markdown
View File

@ -55,7 +55,7 @@ password:
required: false
type: string
prefix:
description: The prefix to use, if any, for all the devices created for this controller. At most one host can omit the prefix, all others must have a unique prefix within the home assistant instance.
description: The prefix to use, if any, for all the devices created for this controller. At most one host can omit the prefix, all others must have a unique prefix within the Home Assistant instance.
require: false
type: string
temperature_unit:

2
source/_integrations/homekit.markdown
View File

@ -491,7 +491,7 @@ The volume and play/pause controls will show up on the Remote app or Control Cen
#### Resetting accessories
On Home Assistant `0.97.x` or later, you may use the service `homekit.reset_accessory` with one or more entity_ids to reset accessories whose configuration may have changed. This can be useful when changing a media_player's device class to `tv`, linking a battery, or whenever HomeAssistant add supports for new HomeKit features to existing entities.
On Home Assistant `0.97.x` or later, you may use the service `homekit.reset_accessory` with one or more entity_ids to reset accessories whose configuration may have changed. This can be useful when changing a media_player's device class to `tv`, linking a battery, or whenever Home Assistant adds support for new HomeKit features to existing entities.
On earlier versions of Home Assistant, you can reset accessories by removing the entity from HomeKit (via [filter](#configure-filter)) and then re-adding the accessory.

4
source/_integrations/keba.markdown
View File

@ -9,7 +9,7 @@ ha_category:
ha_release: 0.98
---
The `keba` integrates your Keba charging station (wallbox) into your home assistant instance. It was tested with a BMW Wallbox but should also work with a Keba P20/P30 according to the developers [manual](https://www.keba.com/web/downloads/e-mobility/KeContact_P20_P30_UDP_ProgrGuide_en.pdf). The fetching interval to the charging station is set to 5 seconds, same as in the official mobile app.
The `keba` integrates your Keba charging station (wallbox) into your Home Assistant instance. It was tested with a BMW Wallbox but should also work with a Keba P20/P30 according to the developers [manual](https://www.keba.com/web/downloads/e-mobility/KeContact_P20_P30_UDP_ProgrGuide_en.pdf). The fetching interval to the charging station is set to 5 seconds, same as in the official mobile app.
This component provides the following platforms:
@ -44,7 +44,7 @@ keba:
type: string
default: "00845500"
failsafe:
description: Enable failsafe mode at home assistant startup.
description: Enable failsafe mode at Home Assistant startup.
required: false
type: boolean
default: false

2
source/_integrations/openuv.markdown
View File

@ -208,7 +208,7 @@ automation:
service: openuv.update_protection_data
```
Another method (useful when monitoring locations other than the HASS latitude
Another method (useful when monitoring locations other than the Home Assistant latitude
and longitude, in locations where there is a large amount of sunlight per day,
etc.) might be to simply query the API less often:

2
source/_integrations/owntracks.markdown
View File

@ -33,7 +33,7 @@ In the OwnTracks app, open sidebar and click on preferences, then on connection.
- Device ID: `<Device name>`
- Tracker ID: `<xx>` Two character tracker ID. (can be left blank)
Your tracker device will be known in home assistant as `<Username>_<Device name>`. If you entered a Tracker ID the tid attribute will be set to that ID.
Your tracker device will be known in Home Assistant as `<Username>_<Device name>`. If you entered a Tracker ID the tid attribute will be set to that ID.
### Configuring the app - iOS

6
source/_integrations/ptvsd.markdown
View File

@ -32,7 +32,7 @@ port:
default: 5678
type: integer
wait:
description: If true, wait for the debugger to connect before starting up home assistant.
description: If true, wait for the debugger to connect before starting up Home Assistant.
required: false
default: false
type: boolean
@ -40,9 +40,9 @@ wait:
### Security
Ensure if this is a public-facing server, that the port is secured. Anyone who is able to access the debugger port can *execute arbitrary code* on the home assistant server, which is very unsafe.
Ensure if this is a public-facing server, that the port is secured. Anyone who is able to access the debugger port can *execute arbitrary code* on the Home Assistant server, which is very unsafe.
If the home assistant server is behind your firewall with only the http(s) port exposed, then this is safe from outside connections.
If the Home Assistant server is behind your firewall with only the http(s) port exposed, then this is safe from outside connections.
Another way of securing the port is to set `host` to localhost and have a secured SSH TCP tunnel with a client certificate for access from the outside internet.

2
source/_integrations/recorder.markdown
View File

@ -12,7 +12,7 @@ The `recorder` integration is responsible for storing details in a database, whi
Home Assistant uses [SQLAlchemy](https://www.sqlalchemy.org/), which is an Object Relational Mapper (ORM). This means that you can use **any** SQL backend for the recorder that is supported by SQLAlchemy, like [MySQL](https://www.mysql.com/), [MariaDB](https://mariadb.org/), [PostgreSQL](https://www.postgresql.org/), or [MS SQL Server](https://www.microsoft.com/en-us/sql-server/).
The default database engine is [SQLite](https://www.sqlite.org/) which doesn't require any configuration. The database is stored in your Home Assistant configuration directory (`.homeassistant` or '/config/' in HassIO) and called `home-assistant_v2.db`.
The default database engine is [SQLite](https://www.sqlite.org/) which doesn't require any configuration. The database is stored in your Home Assistant configuration directory (`.homeassistant` or '/config/' in Hass.io) and called `home-assistant_v2.db`.
To change the defaults for the `recorder` integration in your installation, add the following to your `configuration.yaml` file:

2
source/_integrations/remote_rpi_gpio.markdown
View File

@ -105,7 +105,7 @@ invert_logic:
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
<div class='note warning'>
Note that a pin managed by HASS is expected to be exclusive to HASS.
Note that a pin managed by Home Assistant is expected to be exclusive to Home Assistant.
</div>
A common question is what does port refer to, this number is the actual GPIO #, not the pin #.

2
source/_integrations/rfxtrx.markdown
View File

@ -57,7 +57,7 @@ Not all protocols as advertised are enabled on the initial setup of your transce
### ser2net
You can host your device on another computer by setting up ser2net and example configuration for ser2net looks like this and then using host/port in your home assistant config.
You can host your device on another computer by setting up ser2net and example configuration for ser2net looks like this and then using host/port in your Home Assistant config.
```text
50000:raw:0:/dev/ttyUSB0:38400 8DATABITS NONE 1STOPBIT

2
source/_integrations/rpi_gpio.markdown
View File

@ -184,7 +184,7 @@ invert_logic:
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#General_purpose_input-output_(GPIO)_connector) about the Raspberry Pi.
<div class='note warning'>
Note that a pin managed by HASS is expected to be exclusive to HASS.
Note that a pin managed by Home Assistant is expected to be exclusive to Home Assistant.
</div>
A common question is what does Port refer to, this number is the actual GPIO #, not the pin #.

2
source/_integrations/sinch.markdown
View File

@ -61,5 +61,5 @@ notify:
service_plan_id: SINCH_SERVICE_PLAN_ID
api_key: SINCH_API_KEY
default_recipient: [PHONE_NO1, PHONE_NO2]
sender: Home assistant
sender: Home Assistant
```

2
source/_integrations/smartthings.markdown
View File

@ -108,7 +108,7 @@ The integration will trigger an event when a device with the [button](https://sm
| Attribute | Description
|---------------------------|------------------------------------------------------------------|
`component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event.
`device_id` | The unique id of the device in SmartThings. This can be located in the HASS device registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/).
`device_id` | The unique id of the device in SmartThings. This can be located in the Home Assistant device registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/).
`location_id` | The unique id of the location the device is part of. This can be found in the config entry registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/).
`value` | Describes the action taken on the button. See the [button](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Button) capability reference for a list of possible values (not all are supported by every device).
`name` | The name given to the device in SmartThings.

2
source/_integrations/tts.markdown
View File

@ -91,7 +91,7 @@ The Google cast devices (Google Home, Chromecast, etc.) present the following pr
* They do not work with URLs that contain hostnames established by local naming means. Let's say your Home Assistant instance is running on a machine made known locally as `ha`. All your machines on your local network are able to access it as `ha`. However, try as you may, your cast device won't download the media files from your `ha` machine. That's because your cast device ignores your local naming setup. In this example, the `say` service creates a URL like `http://ha/path/to/media.mp3` (or `https://...` if you are using SSL). Setting a `base_url` that contains the IP address of your server works around this issue. By using an IP address, the cast device does not have to resolve the hostname.
* An alternative way to force Google cast devices to use internal DNS is to block them from accessing Google DNS at the firewall/router level. This would be useful in the case, for example, where your internal IP of HASS is a private IP and you have your internal DNS server (quite often a split-brain DNS scenario). This method works on both Google Home Mini and Google Chromecasts.
* An alternative way to force Google cast devices to use internal DNS is to block them from accessing Google DNS at the firewall/router level. This would be useful in the case, for example, where your internal IP of Home Assistant is a private IP and you have your internal DNS server (quite often a split-brain DNS scenario). This method works on both Google Home Mini and Google Chromecasts.
## Service say

2
source/_integrations/unifiled.markdown
View File

@ -50,4 +50,4 @@ password:
## Light
The light panels output state and brightness are synchronized with home assistant.
The light panels output state and brightness are synchronized with Home Assistant.

2
source/_integrations/upnp.markdown
View File

@ -54,7 +54,7 @@ ports:
description: Map of ports to map from internal to external. Pass 'hass' as internal port to use the port Home Assistant runs on. Note that you have to enable port_mapping if you wish to map ports.
required: false
type: map
default: Open same port on external router as that HASS runs locally and forwards it.
default: Open same port on external router as that Home Assistant runs locally and forwards it.
{% endconfiguration %}
## Troubleshooting

2
source/_integrations/utility_meter.markdown
View File

@ -16,7 +16,7 @@ From a user perspective, utility meters operate in cycles (usually monthly) for
Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new entity will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).
<div class='note'>
Sensors created with this integration are persistent, so values are retained across restarts of home assistant. The first cycle for each sensor, will be incomplete; a sensor tracking daily usage, will start to be accurate the next day after the integration was activated. A sensor tracking monthly usage, will present accurate data starting the first of the next month after being added to home assistant.
Sensors created with this integration are persistent, so values are retained across restarts of Home Assistant. The first cycle for each sensor, will be incomplete; a sensor tracking daily usage, will start to be accurate the next day after the integration was activated. A sensor tracking monthly usage, will present accurate data starting the first of the next month after being added to Home Assistant.
</div>
## Configuration

2
source/_integrations/vlc_telnet.markdown
View File

@ -62,4 +62,4 @@ media_player:
##### Additional configuration for Rasperry Pi
You can run a VLC Media Player inside your Hassio installation using the [hassio-local-vlc add-on](https://github.com/rodripf/hassio-local-vlc). Using it you can play files on the local network, Internet or files and playlist locally saved to the /share folder of your Hassio installation.
You can run a VLC Media Player inside your Hass.io installation using the [hassio-local-vlc add-on](https://github.com/rodripf/hassio-local-vlc). Using it you can play files on the local network, Internet or files and playlist locally saved to the /share folder of your Hass.io installation.

2
source/_integrations/yeelight.markdown
View File

@ -106,7 +106,7 @@ custom_effects:
#### Music mode
Per default the bulb limits the amount of requests per minute to 60, a limitation which can be bypassed by enabling the music mode. In music mode the bulb is commanded to connect back to a socket provided by the integration and it tries to keep the connection open, which may not be wanted in all use-cases.
**Also note that bulbs in music mode will not update their state to "unavailable" if they are disconnected, which can cause delays in Home Assistant. Bulbs in music mode may also not react to commands from HASS the first time if the connection is dropped. If you experience this issue, turn the light off and back on again in the frontend and everything will return to normal.**
**Also note that bulbs in music mode will not update their state to "unavailable" if they are disconnected, which can cause delays in Home Assistant. Bulbs in music mode may also not react to commands from Home Assistant the first time if the connection is dropped. If you experience this issue, turn the light off and back on again in the frontend and everything will return to normal.**
### Initial setup

4
source/getting-started/configuration.markdown
View File

@ -11,14 +11,14 @@ The steps below only apply if you've installed Home Assistant via Hass.io. If yo
</div>
We are going to help you make your first changes to `configuration.yaml`. To do this, we are going to install an add-on from the Hass.io add-on store: the HASS Configurator. To get to the add-on store, click on the menu icon in the top left, then click on Hass.io. On the new page, open the add-on store tab.
We are going to help you make your first changes to `configuration.yaml`. To do this, we are going to install an add-on from the Hass.io add-on store: the Configurator. To get to the add-on store, click on the menu icon in the top left, then click on Hass.io. On the new page, open the add-on store tab.
<p class='img'>
<img src='/images/hassio/screenshots/main_panel_addon_store.png' />
From the Hass.io main panel, open the add-on store.
</p>
Under the "Core" section you will find HASS Configurator.
Under the "Core" section you will find Configurator.
- Click on Configurator and click on INSTALL. When installation is complete, the UI will go to the add-on details page for the configurator.
- Now start the add-on by clicking on START.

2
source/getting-started/index.markdown
View File

@ -19,7 +19,7 @@ So here are guidelines:
- Do not talk about YAML if it can be partially/fully done in UI.
- Do not tell people about stuff they can do later. This can be added to a
2nd tier guide.
- The first page of the guide is for installation, hence hass.io specific.
- The first page of the guide is for installation, hence Hass.io specific.
Other pages should not refer to it except for the page introducing the last
page that introduces `configuration.yaml`.

2
source/hassio/installation.markdown
View File

@ -39,7 +39,7 @@ The following will take you through the steps required to install Hass.io.
3. Optional - set up the WiFi or static IP. There are two possible places for that:
- on a blank USB stick with a FAT32 partition having partition label `CONFIG`, while in its root directory, create the `network/my-network` file, or
- on the Hassio SD card's first, bootable partition (labeled `hassio-boot`, might not be auto mounted in Linux) create the `CONFIG/network/my-network` file.
- on the Hass.io SD card's first, bootable partition (labeled `hassio-boot`, might not be auto mounted in Linux) create the `CONFIG/network/my-network` file.
For the content of this file, follow the [HassOS howto][hassos-network].