@@ -13,34 +13,32 @@ ha_release: 0.47
13
13
---
14
14
15
15
16
- This ` radarr ` sensor platform pulls data from a given Radarr instance.
16
+ This ` radarr ` sensor platform pulls data from a given [ Radarr] ( https://radarr.video/ ) instance.
17
17
18
- To use your [ Radarr] ( https://radarr.video/ ) sensor in your installation, add the following to your ` configuration.yaml ` file:
18
+ To use your Radarr sensor in your installation, add the following to your ` configuration.yaml ` file:
19
19
20
20
``` yaml
21
21
# Example configuration.yml entry
22
22
sensor :
23
23
- platform : radarr
24
24
api_key : YOUR_API_KEY
25
- host : IP_ADDRESS
26
- port : PORT
27
25
` ` `
28
26
29
27
Configuration variables:
30
28
31
29
- **api_key** (*Required*): Your Radarr API key, found in Settings > General in the Radarr Web UI.
32
- - **monitored_conditions** array (*Required*): Conditions to display on the frontend.
30
+ - **host** (*Optional*): The host Radarr is running on. Defaults to ` localhost`.
31
+ - **port** (*Optional*): The port Radarr is running on. Defaults to 7878.
32
+ - **urlbase** (*Optional*): The base URL Radarr is running under. Defaults to `/`.
33
+ - **monitored_conditions** array (*Optional*): Conditions to display on the frontend. Defaults to `movies`.
33
34
- **movies**: The number of movies in Radarr.
34
35
- **upcoming**: The number of upcoming movie releases (physical and in cinemas).
35
36
- **commands**: The number of commands being run.
36
- - **diskspace**: Available disk space.
37
- - **status**: System status information
38
- - **host** (*Optional*): The host Radarr is running on (Default: localhost).
39
- - **port** (*Optional*): The port Radarr is running on (Default: 7878).
40
- - **urlbase** (*Optional*): The base URL Radarr is running under (Default: /).
41
- - **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only (Default: 1).
37
+ - **diskspace**: The available disk space.
38
+ - **status**: The current system status information.
39
+ - **days** (*Optional*): How many days to look ahead for the upcoming sensor, 1 means today only. Defaults to 1.
42
40
- **include_paths** (*Optional*): Array of filepaths to include when calculating diskspace. Leave blank to include all.
43
- - **unit**: (*Optional*): The unit to display disk space in (Default: GB) .
41
+ - **unit**: (*Optional*): The unit to display disk space in. Defaults to GB .
44
42
- **ssl**: boolean (*Optional*): Whether or not to use SSL for Radarr.
45
43
46
44
# # {% linkable_title Examples %}
0 commit comments