diff --git a/source/_components/hdmi_cec.markdown b/source/_components/hdmi_cec.markdown index e1350a106bb..4f490389dea 100644 --- a/source/_components/hdmi_cec.markdown +++ b/source/_components/hdmi_cec.markdown @@ -33,20 +33,28 @@ Create a symlink to the `cec` installation. $ ln -s /usr/local/lib/python3.4/dist-packages/cec /path/to/your/venv/lib/python3.4/site-packages ``` -For the default virtual environment of a [Raspberry Pi AIO](/getting-started/installation-raspberry-pi-all-in-one/) the command would be as follows. +For the default virtual environment of a [Raspberry Pi All-In-One installation](/getting-started/installation-raspberry-pi-all-in-one/) the command would be as follows. ```bash $ ln -s /usr/local/lib/python3.4/dist-packages/cec /srv/hass/hass_venv/lib/python3.4/site-packages ```

If after symlinking and adding `hdmi_cec:` to your configuration you are getting the following error in your logs, -`* failed to open vchiq instance` you will also need to add the user account Home Asssistant runs under, to the `video` group. To add the Home Assisitant's user account to the `video` group, run the following command. `$ usermod -a -G video ` +`* failed to open vchiq instance` you will also need to add the user account Home Asssistant runs under, to the `video` group. To add the Home Assistant user account to the `video` group, run the following command. `$ usermod -a -G video `

## {% linkable_title Testing your installation %} -* Login to Raspberry Pi `ssh pi@your_raspberry_pi_ip` -* at the command line type: `echo scan | cec-client -s -d 1` +* Login to Raspberry Pi + +```bash +ssh pi@your_raspberry_pi_ip +``` +* at the command line type: + +```bash +echo scan | cec-client -s -d 1 +``` * This will give you the list of devices that are on the bus ```bash diff --git a/source/_components/sensor.command_line.markdown b/source/_components/sensor.command_line.markdown index cfb660f3e58..a87f844a1ab 100644 --- a/source/_components/sensor.command_line.markdown +++ b/source/_components/sensor.command_line.markdown @@ -44,7 +44,7 @@ There are several ways to get the temperature of your hard drive. A simple solut $ hddtemp -n /dev/sda ``` -To use those information, the entry for a command-line sensor in the `configuration.yaml` file will look like this. +To use this information, the entry for a command-line sensor in the `configuration.yaml` file will look like this. ```yaml # Example configuration.yaml entry @@ -68,10 +68,9 @@ Thanks to the [`proc`](https://en.wikipedia.org/wiki/Procfs) file system, variou value_template: '{% raw %}{{ value | multiply(0.001) }}{% endraw %}' ``` -### {% linkable_title Monitoring the failed login attempt on HA %} - -If you'd like to know how much failed login attempts are made to HA proceed with the following +### {% linkable_title Monitoring failed login attempts on Home Assistant %} +If you'd like to know how many failed login attempts are made to Home Assistant, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -81,7 +80,7 @@ sensor: command: grep -c 'Login attempt' /home/hass/.homeassistant/home-assistant.log ``` -Make sure to configure the logger to monitor the proper component at the proper level. +Make sure to configure the [logger component](/components/logger) to monitor the [http component](https://home-assistant.io/components/http/) at least the `warning` level. ```yaml # Example working logger settings that works @@ -115,7 +114,7 @@ sensor: ### {% linkable_title Use an external script %} -The example is doing the same as the [aREST sensor](/components/sensor.arest/) but with an external Python script. It should give you an idea about interacting with devices which are exposing a RESTful API. +The example is doing the same as the [aREST sensor](/components/sensor.arest/) but with an external Python script. It should give you an idea about interfacing with devices which are exposing a RESTful API. The one-line script to retrieve a value is shown below. Of course would it be possible to use this directly in the `configuration.yaml` file but need extra care about the quotation marks. diff --git a/source/_components/sensor.synologydsm.markdown b/source/_components/sensor.synologydsm.markdown index 0cf3cd86d12..7b7d66ed083 100644 --- a/source/_components/sensor.synologydsm.markdown +++ b/source/_components/sensor.synologydsm.markdown @@ -14,9 +14,9 @@ ha_iot_class: depends --- -This `synologydsm` sensor allows getting various statistics from your [Synology NAS](https://www.synology.com). Please note that using this sensor wakes up your synology if in hibernation mode. +This `synologydsm` sensor allows getting various statistics from your [Synology NAS](https://www.synology.com). Please note that using this sensor wakes up your Synology NAS if in hibernation mode. -To use the SynologyDSM sensor in your installation, add the following to your `configuration.yaml` file: +To use the `synologydsm` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yml entry @@ -30,13 +30,13 @@ sensor: - memory_real_usage - network_up ``` -Note: After booting HASS it can take up to 15 minutes for the sensors to show up. This is due to the fact that sensors are created after HASS has fully been initialised. +Note: After booting Home Assistant it can take up to 15 minutes for the sensors to show up. This is due to the fact that sensors are created after Home Assistant has fully been initialized. Configuration variables: - **host** (*Required*): The IP address of the Synology NAS to monitor -- **port** (*Optional*): The port number on which the NAS is reachable. Defaults to `5000`. -- **username** (*Required*): An user to connect to the Synology NAS (a seperate account is adviced, see the Seperate User Configuration section below for details). +- **port** (*Optional*): The port number on which the Synology NAS is reachable. Defaults to `5000`. +- **username** (*Required*): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details). - **password** (*Required*): The password of the user to connect to the Synology NAS. - **volumes** (*Optional*): Array of volumes to monitor. Defaults to all volumes. - **disks** (*Optional*): Array of disks to monitor. Defaults to all disks. @@ -57,13 +57,13 @@ Configuration variables: - **memory_total_real**: Displays total size of real memory in MB. - **network_up**: Displays total up speed of network interfaces (combines all interfaces). - **network_down**: Displays total down speed of network interfaces (combines all interfaces). - - **disk_name**: Displays the name of the harddisk (creates a new entry for each disk). - - **disk_device**: Displays the path of the harddisk (creates a new entry for each disk). - - **disk_smart_status**: Displays the S.M.A.R.T status of the harddisk (creates a new entry for each disk). - - **disk_status**: Displays the status of the harddisk (creates a new entry for each disk). - - **disk_exceed_bad_sector_thr**: Displays true / false to indicate if the harddisk exceeded the maximum bad sector threshold (creates a new entry for each disk). - - **disk_below_remain_life_thr**: Displays true / false to indicate if the harddisk dropped below the remain life threshold (creates a new entry for each disk). - - **disk_temp**: Displays the temperature of the harddisk (creates a new entry for each disk, uses the unit_system to display in C or F). + - **disk_name**: Displays the name of the hard disk (creates a new entry for each disk). + - **disk_device**: Displays the path of the hard disk (creates a new entry for each disk). + - **disk_smart_status**: Displays the S.M.A.R.T status of the hard disk (creates a new entry for each disk). + - **disk_status**: Displays the status of the hard disk (creates a new entry for each disk). + - **disk_exceed_bad_sector_thr**: Displays true / false to indicate if the hard disk exceeded the maximum bad sector threshold (creates a new entry for each disk). + - **disk_below_remain_life_thr**: Displays true / false to indicate if the hard disk dropped below the remain life threshold (creates a new entry for each disk). + - **disk_temp**: Displays the temperature of the hard disk (creates a new entry for each disk, uses the unit_system to display in C or F). - **volume_status**: Displays the status of the volume (creates a new entry for each volume). - **volume_device_type**: Displays the volume type (RAID, etc) (creates a new entry for each volume). - **volume_size_total**: Displays the total size of the volume in GB's (creates a new entry for each volume). @@ -72,8 +72,8 @@ Configuration variables: - **volume_disk_temp_avg**: Displays the average temperature of all disks in the volume (creates a new entry for each volume). - **volume_disk_temp_max**: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume). -Seperate User Configuration: +Separate User Configuration: -Due to the nature of the Synology DSM Api it is required to grant de user admin rights. This is related to the fact that utilisation information is stored in the core module. +Due to the nature of the Synology DSM API it is required to grant the user admin rights. This is related to the fact that utilization information is stored in the core module. -When creating the user it is possible to deny access to all locations and applications. By doing this the user will not be able to login to the web interface or view any of the files on the NAS. It is still able to read the utilisation and storage information using the API. +When creating the user it is possible to deny access to all locations and applications. By doing this the user will not be able to login to the web interface or view any of the files on the Synology NAS. It is still able to read the utilization and storage information using the API.