|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: "SynologyDSM Sensor" |
| 4 | +description: "Instructions how to integrate the SynologyDSM sensor within Home Assistant." |
| 5 | +date: 2016-10-30 23:21 |
| 6 | +sidebar: true |
| 7 | +comments: false |
| 8 | +sharing: true |
| 9 | +footer: true |
| 10 | +logo: synologydsm.png |
| 11 | +ha_category: Sensor |
| 12 | +ha_release: 0.31.1 |
| 13 | +ha_iot_class: depends |
| 14 | +--- |
| 15 | + |
| 16 | + |
| 17 | +This `SynologyDSM` sensor allows getting various statistics from your Synology NAS. Please note that using this sensor wakes up your synology if in hibernation mode. |
| 18 | + |
| 19 | +To use the SynologyDSM sensor in your installation, add the following to your `configuration.yaml` file: |
| 20 | + |
| 21 | +```yaml |
| 22 | +# Example configuration.yml entry |
| 23 | +sensor: |
| 24 | + - platform: synologydsm |
| 25 | + host: <Synology IP> |
| 26 | + port: <Synology Port, Default: 5000> |
| 27 | + username: <Username> |
| 28 | + password: <Password> |
| 29 | + monitored_conditions: |
| 30 | + - cpu_total_load |
| 31 | + - memory_real_usage |
| 32 | + - network_up |
| 33 | + - network_down |
| 34 | + - disk_smart_status |
| 35 | + - disk_temp |
| 36 | + - volume_status |
| 37 | + - volume_size_used |
| 38 | +``` |
| 39 | +
|
| 40 | +Configuration variables: |
| 41 | +
|
| 42 | +- **host** (*Required*): The IP address of the Synology NAS to monitor |
| 43 | +- **port** (*Optional*): The port number on which the NAS is reachable (defaults to 5000). |
| 44 | +- **username** (*Required*): An user to connect to the Synology NAS (a seperate account is adviced). |
| 45 | +- **password** (*Required*): The password of the user to connect to the Synology NAS. |
| 46 | +- **volumes** (*Optional*): Array of volumes to monitor (defaults to all volumes). |
| 47 | +- **disks** (*Optional*): Array of disks to monitor (defaults to all disks). |
| 48 | +- **monitored_conditions** (*Required*): Defines a [template](/topics/templating/) to extract a value from the payload. |
| 49 | + - **cpu_other_load**: Displays unspecified load in percentage |
| 50 | + - **cpu_user_load**: Displays user load in percentage |
| 51 | + - **cpu_system_load**: Displays system load in percentage |
| 52 | + - **cpu_total_load**: Displays combined load in percentage |
| 53 | + - **cpu_1min_load**: Displays maximum load in past minute |
| 54 | + - **cpu_5min_load**: Displays maximum load in past 5 minutes |
| 55 | + - **cpu_15min_load**: Displays maximum load in past 15 minutes |
| 56 | + - **memory_real_usage**: Displays percentage of memory used |
| 57 | + - **memory_size**: Displays total size of memory in MB's |
| 58 | + - **memory_cached**: Displays total size of cache in MB's |
| 59 | + - **memory_available_swap**: Displays total size of available swap in MB's |
| 60 | + - **memory_available_real**: Displays total size of memory used (based on real memory) in MB's |
| 61 | + - **memory_total_swap**: Displays total size of actual memory in MB's |
| 62 | + - **memory_total_real**: Displays total size of real memory in MB's |
| 63 | + - **network_up**: Displays total up speed of network interfaces (combines all interfaces) |
| 64 | + - **network_down**: Displays total down speed of network interfaces (combines all interfaces) |
| 65 | + - **disk_name**: Displays the name of the harddisk (creates a new entry for each disk) |
| 66 | + - **disk_device**: Displays the path of the harddisk (creates a new entry for each disk) |
| 67 | + - **disk_smart_status**: Displays the S.M.A.R.T status of the harddisk (creates a new entry for each disk) |
| 68 | + - **disk_status**: Displays the status of the harddisk (creates a new entry for each disk) |
| 69 | + - **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) |
| 70 | + - **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) |
| 71 | + - **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) |
| 72 | + - **volume_status**: Displays the status of the volume (creates a new entry for each volume) |
| 73 | + - **volume_device_type**: Displays the volume type (RAID, etc) (creates a new entry for each volume) |
| 74 | + - **volume_size_total**: Displays the total size of the volume in GB's (creates a new entry for each volume) |
| 75 | + - **volume_size_used**: Displays the used space on this volume in GB's (creates a new entry for each volume) |
| 76 | + - **volume_percentage_used**: Displays the percentage used for this volume in GB's (creates a new entry for each volume) |
| 77 | + - **volume_disk_temp_avg**: Displays the average temperature of all disks in the volume (creates a new entry for each volume) |
| 78 | + - **volume_disk_temp_max**: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume) |
0 commit comments