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-15 05:16:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make monitored_conditions optional. (#3142)

Browse Source
This commit is contained in:
Fabian Affolter 2017-08-06 10:07:35 +02:00 committed by GitHub
parent f80d45c802
commit 7c05b9cd28
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
source/_components/sensor.sonarr.markdown
View File

@ -14,35 +14,34 @@ ha_iot_class: "Local Polling"
--- ---
This `sonarr` sensor platform pulls data from a given Sonarr instance. This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance.
To use your [Sonarr](https://sonarr.tv/) sensor in your installation, add the following to your `configuration.yaml` file: To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yml entry # Example configuration.yml entry
sensor: sensor:
- platform: sonarr - platform: sonarr
api_key: YOUR_API_KEY api_key: YOUR_API_KEY
host: IP_ADDRESS
port: PORT
``` ```
Configuration variables: Configuration variables:
- **api_key** (*Required*): Your Sonarr API key, found in Settings > General in the Sonarr Web UI. - **api_key** (*Required*): Your Sonarr API key, found in Settings > General in the Sonarr Web UI.
- **monitored_conditions** array (*Required*): Conditions to display on the frontend. - **host** (*Optional*): The host Sonarr is running on. Defaults to `localhost`.
- **port** (*Optional*): The port Sonarr is running on. Defaults to 8989.
- **monitored_conditions** array (*Optional*): Conditions to display on the frontend. Defaults to `upcoming`.
- **series**: The number of series in Sonarr. - **series**: The number of series in Sonarr.
- **upcoming**: The number of upcoming episodes. - **upcoming**: The number of upcoming episodes.
- **wanted**: The number of episodes still 'wanted'. - **wanted**: The number of episodes still 'wanted'.
- **queue**: The number of episodes in the queue. - **queue**: The number of episodes in the queue.
- **commands**: The number of commands being run. - **commands**: The number of commands being run.
- **diskspace**: Available disk space. - **diskspace**: Available disk space.
- **host** (*Optional*): The host Sonarr is running on (Default: localhost).
- **port** (*Optional*): The port Sonarr is running on (Default: 8989). - **urlbase** (*Optional*): The base URL Sonarr is running under. Defaults to `/`.
- **urlbase** (*Optional*): The base URL Sonarr is running under (Default: /). - **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only. Defaults to 1.
- **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only (Default: 1).
- **include_paths** (*Optional*): Array of filepaths to include when calculating diskspace. Leave blank to include all. - **include_paths** (*Optional*): Array of filepaths to include when calculating diskspace. Leave blank to include all.
- **unit**: (*Optional*): The unit to display disk space in (Default: GB). - **unit**: (*Optional*): The unit to display disk space in. Defaults to GB.
- **ssl**: boolean (*Optional*): Whether or not to use SSL for Sonarr. - **ssl**: boolean (*Optional*): Whether or not to use SSL for Sonarr.
## {% linkable_title Examples %} ## {% linkable_title Examples %}