Skip to content

Commit 7c05b9c

Browse files
authored
Make monitored_conditions optional. (home-assistant#3142)
1 parent f80d45c commit 7c05b9c

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

source/_components/sensor.sonarr.markdown

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,34 @@ ha_iot_class: "Local Polling"
1414
---
1515

1616

17-
This `sonarr` sensor platform pulls data from a given Sonarr instance.
17+
This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance.
1818

19-
To use your [Sonarr](https://sonarr.tv/) sensor in your installation, add the following to your `configuration.yaml` file:
19+
To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file:
2020

2121
```yaml
2222
# Example configuration.yml entry
2323
sensor:
2424
- platform: sonarr
2525
api_key: YOUR_API_KEY
26-
host: IP_ADDRESS
27-
port: PORT
2826
```
2927
3028
Configuration variables:
3129
3230
- **api_key** (*Required*): Your Sonarr API key, found in Settings > General in the Sonarr Web UI.
33-
- **monitored_conditions** array (*Required*): Conditions to display on the frontend.
31+
- **host** (*Optional*): The host Sonarr is running on. Defaults to `localhost`.
32+
- **port** (*Optional*): The port Sonarr is running on. Defaults to 8989.
33+
- **monitored_conditions** array (*Optional*): Conditions to display on the frontend. Defaults to `upcoming`.
3434
- **series**: The number of series in Sonarr.
3535
- **upcoming**: The number of upcoming episodes.
3636
- **wanted**: The number of episodes still 'wanted'.
3737
- **queue**: The number of episodes in the queue.
3838
- **commands**: The number of commands being run.
3939
- **diskspace**: Available disk space.
40-
- **host** (*Optional*): The host Sonarr is running on (Default: localhost).
41-
- **port** (*Optional*): The port Sonarr is running on (Default: 8989).
42-
- **urlbase** (*Optional*): The base URL Sonarr is running under (Default: /).
43-
- **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only (Default: 1).
40+
41+
- **urlbase** (*Optional*): The base URL Sonarr is running under. Defaults to `/`.
42+
- **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only. Defaults to 1.
4443
- **include_paths** (*Optional*): Array of filepaths to include when calculating diskspace. Leave blank to include all.
45-
- **unit**: (*Optional*): The unit to display disk space in (Default: GB).
44+
- **unit**: (*Optional*): The unit to display disk space in. Defaults to GB.
4645
- **ssl**: boolean (*Optional*): Whether or not to use SSL for Sonarr.
4746

4847
## {% linkable_title Examples %}

0 commit comments

Comments
 (0)