diff --git a/atom.xml b/atom.xml index 21b1639f2b..5e463b521c 100644 --- a/atom.xml +++ b/atom.xml @@ -4,7 +4,7 @@
json
, xml
] Try to fetch device names. Defaults to false
if not specified.
In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and ip), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters.
-Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host.
+
In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and ip), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters. +Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host. This does not affect the entites in Home Assistant. They all use their own connection and work as expected.
Most devices have, besides their state, additional attributes like their battery state or valve position. These can be accessed using templates in automations, or even as their own entities using the template sensor component. Here’s an example of a template sensor that exposes the valve state of a thermostat.
@@ -143,7 +143,7 @@ This does not affect the entites in Home Assistant. They all use theirIt is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables.
+
It is possible to read and set values of system variables you have setup on the CCU/Homegear. The supported types for setting values are float- and bool-variables.
The states of the variables are available through the attributes of your hub entity (e.g. homematic.rf
). Use templates (as mentioned above) to make your variables available to automations or as entities.
The values of variables are polled from the CCU/Homegear in an interval of 30 seconds. Setting the value of a variable happens instantly and is directly pushed.
If you are familiar with the internals of HomeMatic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented.
+
If you are familiar with the internals of HomeMatic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented.
Using this service provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above rf
, wired
and ip
would be valid values.
Manually turn on a switch actor
...
diff --git a/components/keyboard_remote/index.html b/components/keyboard_remote/index.html
index 4c054915ed..1a5b6c6f2f 100644
--- a/components/keyboard_remote/index.html
+++ b/components/keyboard_remote/index.html
@@ -137,17 +137,17 @@ When the keyboard reconnects, an event keyboard_
There might be permissions problems with the event input device file. If this is the case, the user that hass runs as must be allowed read and write permissions with:
-sudo setfacl -m u:HASS_USER:rw /dev/input/event*
+There might be permissions problems with the event input device file. If this is the case, the user that Home Assistant runs as must be allowed read and write permissions with:
+$ sudo setfacl -m u:HASS_USER:rw /dev/input/event*
-where HASS_USER
is the user hass runs as.
+where HASS_USER
is the user who runs Home Assistant.
If you want to make this permanent, you can use a udev rule that sets it for all event input devices. Add a file /etc/udev/rules.d/99-userdev-input.rules
containing:
-KERNEL=="event*", SUBSYSTEM=="input", RUN+="/usr/bin/setfacl -m u:HASS_USER:rw $env{DEVNAME}"
+KERNEL=="event*", SUBSYSTEM=="input", RUN+="/usr/bin/setfacl -m u:HASS_USER:rw $env{DEVNAME}"
You can check ACLs permissions with
-getfacl /dev/input/event*
+$ getfacl /dev/input/event*
diff --git a/components/notify.html5/index.html b/components/notify.html5/index.html
index 9a7aaf8beb..d57f71a7a1 100644
--- a/components/notify.html5/index.html
+++ b/components/notify.html5/index.html
@@ -268,7 +268,7 @@
Making notifications work with NGINX proxy
-If you use NGINX as an proxy with authentication in front of HASS, you may have trouble with receiving events back to HASS. It’s because of authentication token that cannot be passed through the proxy.
+If you use NGINX as an proxy with authentication in front of your Home Assistant instance, you may have trouble with receiving events back to Home Assistant. It’s because of authentication token that cannot be passed through the proxy.
To solve the issue put additional location into your nginx site’s configuration:
location /api/notify.html5/callback {
if ($http_authorization = "") { return 403; }
diff --git a/components/notify.nfandroidtv/index.html b/components/notify.nfandroidtv/index.html
index 570e9056de..4f077eaa1d 100644
--- a/components/notify.nfandroidtv/index.html
+++ b/components/notify.nfandroidtv/index.html
@@ -68,7 +68,7 @@
Notification platform for Notifications for Android TV and Notifications for FireTV.
The notifications are in the global scope of your Android TV device. They will be displayed regardless of which application is running.
-The In-App purchases only apply to the client for Android smartphones, so there isn’t any limit when pushing notifications from HASS.
+The In-App purchases only apply to the client for Android smartphones, so there isn’t any limit when pushing notifications from Home Assistant.
To enable the notification platform, add the following to your configuration.yaml
file:
# Example configuration.yaml entry
notify:
diff --git a/components/remote.harmony/index.html b/components/remote.harmony/index.html
index 086a4c6c1a..a1d98e2837 100644
--- a/components/remote.harmony/index.html
+++ b/components/remote.harmony/index.html
@@ -84,9 +84,9 @@
Configuration variables:
- - name (Required): The hub’s name to display in the front end.
+ - name (Required): The hub’s name to display in the frontend.
- host (Required): The Harmony device’s IP address.
- - port (Optional): The Harmony device’s port. 5222 is default.
+ - port (Optional): The Harmony device’s port. Defaults to 5222.
- activity (Optional): Activity to use when turnon service is called without any data.
- scan_interval (Optional): Amount in seconds in between polling for device’s current activity. Defaults to 30 seconds.
@@ -99,10 +99,10 @@
Supported services:
- - Turn Off: Turn off all devices that were switched on from the start of the current activity
- - Turn On: Start an activity, will start the default activity from configuration.yaml if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your HASS config directory. The service will respond faster if the activity ID is passed instead of the name
- - Send Command: Send a command to one device, device ID and available commands are written to the configuration file at startup
- - Sync: Synchronizes the Harmony device with the Harmony web service if any changes are made from the web portal or app
+ - Turn Off: Turn off all devices that were switched on from the start of the current activity.
+ - Turn On: Start an activity, will start the default activity from configuration.yaml if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your Home Assistant configuration directory. The service will respond faster if the activity ID is passed instead of the name.
+ - Send Command: Send a command to one device, device ID and available commands are written to the configuration file at startup.
+ - Sync: Synchronizes the Harmony device with the Harmony web service if any changes are made from the web portal or app.
Examples
A template switch can be used to display and control the state of an activity in the frontend.
@@ -131,7 +131,7 @@
friendly_name: 'bedroom'
-The example below shows how to control an input_boolean
switch using the Harmony remote’s current activity. The switch will turn on when the remote’s state changes and the Kodi activity is started and off when the remote’s state changes and the current activity is PowerOff.
+The example below shows how to control an input_boolean
switch using the Harmony remote’s current activity. The switch will turn on when the remote’s state changes and the Kodi activity is started and off when the remote’s state changes and the current activity is PowerOff.
automation:
- alias: "Watch TV started from harmony hub"
trigger:
diff --git a/components/rflink/index.html b/components/rflink/index.html
index cb8dcfb337..4b7a2a471b 100644
--- a/components/rflink/index.html
+++ b/components/rflink/index.html
@@ -143,7 +143,7 @@ When re-flashing the Arduino MEGA, disconnect the ESP8266 to avoid programming d
Technical overview
- The
rflink
Python module a asyncio transport/protocol is setup that fires an callback for every (valid/supported) packet received by the RFLink gateway.
- - This component uses this callback to distribute ‘rflink packet events’ over the HASS bus which can be subscribed to by entities/platform implementations.
+ - This component uses this callback to distribute ‘rflink packet events’ over Home Assistant’s bus which can be subscribed to by entities/platform implementations.
- The platform implementions take care of creating new devices (if enabled) for unsees incoming packet id’s.
- Device entities take care of matching to the packet ID, interpreting and performing actions based on the packet contents. Common entitiy logic is maintained in this main component.
@@ -157,14 +157,14 @@ When re-flashing the Arduino MEGA, disconnect the ESP8266 to avoid programming d
This will give you output looking like this:
-17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: 20;00;Nod
-17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: o RadioFrequencyLink - R
-17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: FLink Gateway V1.1 - R45
-17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: ;
-17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] got packet: 20;00;Nodo RadioFrequencyLink - RFLink Gateway V1.1 - R45;
-17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] decoded packet: {'firmware': 'RFLink Gateway', 'revision': '45', 'node': 'gateway', 'protocol': 'unknown', 'hardware': 'Nodo RadioFrequencyLink', 'version': '1.1'}
-17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] got event: {'version': '1.1', 'firmware': 'RFLink Gateway', 'revision': '45', 'hardware': 'Nodo RadioFrequencyLink', 'id': 'rflink'}
-17-03-07 20:12:05 DEBUG (MainThread) [homeassistant.components.rflink] event of type unknown: {'version': '1.1', 'firmware': 'RFLink Gateway', 'revision': '45', 'hardware': 'Nodo RadioFrequencyLink', 'id': 'rflink'}
+17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: 20;00;Nod
+17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: o RadioFrequencyLink - R
+17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: FLink Gateway V1.1 - R45
+17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] received data: ;
+17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] got packet: 20;00;Nodo RadioFrequencyLink - RFLink Gateway V1.1 - R45;
+17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] decoded packet: {'firmware': 'RFLink Gateway', 'revision': '45', 'node': 'gateway', 'protocol': 'unknown', 'hardware': 'Nodo RadioFrequencyLink', 'version': '1.1'}
+17-03-07 20:12:05 DEBUG (MainThread) [rflink.protocol] got event: {'version': '1.1', 'firmware': 'RFLink Gateway', 'revision': '45', 'hardware': 'Nodo RadioFrequencyLink', 'id': 'rflink'}
+17-03-07 20:12:05 DEBUG (MainThread) [homeassistant.components.rflink] event of type unknown: {'version': '1.1', 'firmware': 'RFLink Gateway', 'revision': '45', 'hardware': 'Nodo RadioFrequencyLink', 'id': 'rflink'}
diff --git a/components/sensor.dnsip/index.html b/components/sensor.dnsip/index.html
index 1caea58a4c..63e0c9c64b 100644
--- a/components/sensor.dnsip/index.html
+++ b/components/sensor.dnsip/index.html
@@ -68,7 +68,7 @@
The dnsip
sensor will expose an IP address, fetched via DNS resolution, as its value. There are two operational modes:
- - When you enable the sensor with minimal configuration, it will query OpenDNS’ nameserver with the hostname
myip.opendns.com
, which will resolve to your external/public IP address.
+ - When you enable the sensor with minimal configuration, it will query the OpenDNS nameservers with the hostname
myip.opendns.com
, which will resolve to your external/public IP address.
- If you specify a
hostname
, a regular DNS lookup will be performed, providing you the IP the hostname resolves to.
You may also override the nameserver that is being used by setting the resolver
parameter to any nameserver you like.
@@ -82,7 +82,7 @@
- hostname (Optional): The hostname for which to perform the DNS query. Default:
myip.opendns.com
(special hostname that resolves to your public IP)
- resolver (Optional): The DNS server to target the query at. Default:
208.67.222.222
(OpenDNS)
- - ipv6 (Optional): Set this to
true
or false
if IPv6 should be used. When resolving the public IP, this will be the IP of the machine HASS is running on.
+ - ipv6 (Optional): Set this to
true
or false
if IPv6 should be used. When resolving the public IP, this will be the IP of the machine where Home Assistant is running on.
- resolver_ipv6 (Optional): The IPv6 DNS server to target the query at. Default:
2620:0:ccc::2
(OpenDNS)
- scan_interval (Optional): Defines number of seconds for polling interval. Default:
120
seconds.
diff --git a/components/sensor.miflora/index.html b/components/sensor.miflora/index.html
index 9797c2b49b..27ab5596f3 100644
--- a/components/sensor.miflora/index.html
+++ b/components/sensor.miflora/index.html
@@ -66,7 +66,7 @@
- The Mi Flora plant sensor is a small Bluetooth Low Energy device that monitors not only the moisture, but also light, temperature and conductivity. As only a single BLE device can be polled at the same time, the library implements locking to make sure this is the case.
+ The miflora
sensor platform allows one to monitor to plants. The Mi Flora plant sensor is a small Bluetooth Low Energy device that monitors not only the moisture, but also light, temperature and conductivity. As only a single BLE device can be polled at the same time, the library implements locking to make sure this is the case.
To use your Mi Flora plant sensor in your installation, add the following to your configuration.yaml
file:
# Example configuration.yaml entry
sensor:
diff --git a/components/sensor.modem_callerid/index.html b/components/sensor.modem_callerid/index.html
index a8d0397779..d634416022 100644
--- a/components/sensor.modem_callerid/index.html
+++ b/components/sensor.modem_callerid/index.html
@@ -66,12 +66,11 @@
- The modem_callerid
sensor platform uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1).
+ The modem_callerid
sensor platform uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1).
To enable the sensor, add the following lines to your configuration.yaml
:
# Example configuration.yaml entry
sensor:
- platform: modem_callerid
-
Configuration variables:
@@ -81,7 +80,7 @@
To find the path of your USB modem, run:
$ ls /dev/ttyACM*
-If hass
runs with another user (e.g. homeassistant on Hassbian) give access to the stick with:
+If Home Assistant (hass
) runs with another user (e.g. homeassistant
on Hassbian) give access to the stick with:
$ sudo usermod -a -G dialout homeassistant
Depending on what’s plugged into your USB ports, the name found above may change. You can lock in a name, such as /dev/modem
, by following these instructions.
When the sensor detects a new call, it’s state changes to ‘ring’ for each ring and ‘callerid’ when caller id information is received. It returns to ‘idle’ once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number.
@@ -91,7 +90,7 @@
trigger:
platform: state
entity_id: sensor.modem_callerid
- state: "callerid"
+ state: "callerid"
action:
service: notify.notify
data:
diff --git a/docs/installation/virtualenv/index.html b/docs/installation/virtualenv/index.html
index f1445fe306..22f3e0b113 100644
--- a/docs/installation/virtualenv/index.html
+++ b/docs/installation/virtualenv/index.html
@@ -101,7 +101,7 @@
The su
command means ‘switch’ user. We use the ‘-s’ flag because the homeassistant
user is a system user and doesn’t have a default shell by default (to prevent attackers from being able to log in as that user).
Step 4: Set up the virtualenv
All this step does is stick a Python environment in the directory we’re using. That’s it. It’s just a directory. There’s nothing special about it, and it is entirely self-contained.
-It will include a bin
directory, which will contain all the executables used in the virtualenv (including hass itself). It also includes a script called activate
which we will use to activate the virtualenv.
+It will include a bin
directory, which will contain all the executables used in the virtualenv (including Home Assistant itself). It also includes a script called activate
which we will use to activate the virtualenv.
$ virtualenv -p python3 /srv/homeassistant
diff --git a/docs/z-wave/index.html b/docs/z-wave/index.html
index 6bc1aee35c..7a1bd72b19 100644
--- a/docs/z-wave/index.html
+++ b/docs/z-wave/index.html
@@ -123,10 +123,10 @@ Instead of make install
, you can alternat
ignored (Optional): Ignore this entity completely. It won’t be shown in the Web Interface and no events are generated for it.
refresh_value (Optional): Enable refreshing of the node value. Only the light component uses this. Defaults to False.
delay (Optional): Specify the delay for refreshing of node value. Only the light component uses this. Defaults to 2 seconds.
- invert_openclose_buttons (Optional): Inverts function of the open and close buttons for the cover domain. Defaults to False
+ invert_openclose_buttons (Optional): Inverts function of the open and close buttons for the cover domain. Defaults to False
.
- debug (Optional): Print verbose z-wave info to log. Defaults to False.
+ debug (Optional): Print verbose z-wave info to log. Defaults to False
.
To find the path of your Z-Wave USB stick or module, run:
$ ls /dev/ttyUSB*
@@ -135,7 +135,7 @@ Instead of make install
, you can alternat
Or, on some other systems (such as Raspberry Pi), use:
$ ls /dev/ttyACM*
-# If `hass` runs with another user (e.g. *homeassistant* on Hassbian) give access to the stick with:
+# If Home Assistant (`hass`) runs with another user (e.g. *homeassistant* on Hassbian) give access to the stick with:
$ sudo usermod -a -G dialout homeassistant
diff --git a/sitemap.xml b/sitemap.xml
index aa6a7c4a49..99902dd804 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -3193,62 +3193,62 @@
https://home-assistant.io/demo/frontend.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/index.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-event.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-info.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-service.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-state.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-template.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/panels/ha-panel-history.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/panels/ha-panel-iframe.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/panels/ha-panel-logbook.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/demo/panels/ha-panel-map.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/googlef4f3693c209fe788.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:05+00:00
https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:06+00:00
https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:06+00:00
https://home-assistant.io/static/mdi-demo.html
-2017-04-24T06:15:38+00:00
+2017-04-24T07:33:06+00:00