@@ -14,35 +14,34 @@ ha_iot_class: "Local Polling"
14
14
---
15
15
16
16
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.
18
18
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:
20
20
21
21
``` yaml
22
22
# Example configuration.yml entry
23
23
sensor :
24
24
- platform : sonarr
25
25
api_key : YOUR_API_KEY
26
- host : IP_ADDRESS
27
- port : PORT
28
26
` ` `
29
27
30
28
Configuration variables:
31
29
32
30
- **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`.
34
34
- **series**: The number of series in Sonarr.
35
35
- **upcoming**: The number of upcoming episodes.
36
36
- **wanted**: The number of episodes still 'wanted'.
37
37
- **queue**: The number of episodes in the queue.
38
38
- **commands**: The number of commands being run.
39
39
- **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.
44
43
- **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 .
46
45
- **ssl**: boolean (*Optional*): Whether or not to use SSL for Sonarr.
47
46
48
47
# # {% linkable_title Examples %}
0 commit comments