You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/sensor.synologydsm.markdown
+14-14Lines changed: 14 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ This `synologydms` sensor allows getting various statistics from your [Synology
20
20
This sensor will wake up your Synology NAS if it's in hibernation mode.
21
21
</p>
22
22
23
-
To use the SynologyDSM sensor in your installation, add the following to your `configuration.yaml` file:
23
+
To use the `synologydsm` sensor in your installation, add the following to your `configuration.yaml` file:
24
24
25
25
```yaml
26
26
# Example configuration.yml entry
@@ -34,13 +34,13 @@ sensor:
34
34
- memory_real_usage
35
35
- network_up
36
36
```
37
-
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.
37
+
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.
38
38
39
39
Configuration variables:
40
40
41
41
- **host** (*Required*): The IP address of the Synology NAS to monitor
42
-
- **port** (*Optional*): The port number on which the NAS is reachable. Defaults to `5000`.
43
-
- **username** (*Required*): An user to connect to the Synology NAS (a seperate account is adviced, see the Seperate User Configuration section below for details).
42
+
- **port** (*Optional*): The port number on which the Synology NAS is reachable. Defaults to `5000`.
43
+
- **username** (*Required*): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details).
44
44
- **password** (*Required*): The password of the user to connect to the Synology NAS.
45
45
- **volumes** (*Optional*): Array of volumes to monitor. Defaults to all volumes.
46
46
- **disks** (*Optional*): Array of disks to monitor. Defaults to all disks.
@@ -61,13 +61,13 @@ Configuration variables:
61
61
- **memory_total_real**: Displays total size of real memory in MB.
62
62
- **network_up**: Displays total up speed of network interfaces (combines all interfaces).
63
63
- **network_down**: Displays total down speed of network interfaces (combines all interfaces).
64
-
- **disk_name**: Displays the name of the harddisk (creates a new entry for each disk).
65
-
- **disk_device**: Displays the path of the harddisk (creates a new entry for each disk).
66
-
- **disk_smart_status**: Displays the S.M.A.R.T status of the harddisk (creates a new entry for each disk).
67
-
- **disk_status**: Displays the status of the harddisk (creates a new entry for each disk).
68
-
- **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).
69
-
- **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).
70
-
- **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).
64
+
- **disk_name**: Displays the name of the hard disk (creates a new entry for each disk).
65
+
- **disk_device**: Displays the path of the hard disk (creates a new entry for each disk).
66
+
- **disk_smart_status**: Displays the S.M.A.R.T status of the hard disk (creates a new entry for each disk).
67
+
- **disk_status**: Displays the status of the hard disk (creates a new entry for each disk).
68
+
- **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).
69
+
- **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).
70
+
- **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).
71
71
- **volume_status**: Displays the status of the volume (creates a new entry for each volume).
72
72
- **volume_device_type**: Displays the volume type (RAID, etc) (creates a new entry for each volume).
73
73
- **volume_size_total**: Displays the total size of the volume in GB's (creates a new entry for each volume).
@@ -76,8 +76,8 @@ Configuration variables:
76
76
- **volume_disk_temp_avg**: Displays the average temperature of all disks in the volume (creates a new entry for each volume).
77
77
- **volume_disk_temp_max**: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume).
78
78
79
-
Seperate User Configuration:
79
+
Separate User Configuration:
80
80
81
-
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.
81
+
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.
82
82
83
-
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.
83
+
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.
0 commit comments