mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 01:06:52 +00:00
Minior changes
This commit is contained in:
Fabian Affolter
parent
52ff254734
commit
2ad0aa0c62
@ -1,78 +1,73 @@
|
|||||||
---
|
---
|
||||||
layout: page
|
layout: page
|
||||||
title: "SynologyDSM Sensor"
|
title: "SynologyDSM Sensor"
|
||||||
description: "Instructions how to integrate the SynologyDSM sensor within Home Assistant."
|
description: "Instructions how to integrate the SynologyDSM sensor within Home Assistant."
|
||||||
date: 2016-10-30 23:21
|
date: 2016-10-30 23:21
|
||||||
sidebar: true
|
sidebar: true
|
||||||
comments: false
|
comments: false
|
||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: synologydsm.png
|
logo: synologydsm.png
|
||||||
ha_category: Sensor
|
ha_category: Sensor
|
||||||
ha_release: 0.31.1
|
ha_release: 0.32
|
||||||
ha_iot_class: depends
|
ha_iot_class: depends
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
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.
|
This `synologydms` sensor allows getting various statistics from your [Synology NAS](https://www.synology.com). Please note that using this sensor wakes up your synology if in hibernation mode.
|
||||||
|
|
||||||
To use the SynologyDSM sensor in your installation, add the following to your `configuration.yaml` file:
|
To use the SynologyDSM sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yml entry
|
# Example configuration.yml entry
|
||||||
sensor:
|
sensor:
|
||||||
- platform: synologydsm
|
- platform: synologydsm
|
||||||
host: <Synology IP>
|
host: IP_ADDRESS_OF_SYNOLOGY_NAS
|
||||||
port: <Synology Port, Default: 5000>
|
username: USERNAME
|
||||||
username: <Username>
|
password: PASSWORD
|
||||||
password: <Password>
|
monitored_conditions:
|
||||||
monitored_conditions:
|
- cpu_total_load
|
||||||
- cpu_total_load
|
- memory_real_usage
|
||||||
- memory_real_usage
|
- network_up
|
||||||
- network_up
|
```
|
||||||
- network_down
|
|
||||||
- disk_smart_status
|
Configuration variables:
|
||||||
- disk_temp
|
|
||||||
- volume_status
|
- **host** (*Required*): The IP address of the Synology NAS to monitor
|
||||||
- volume_size_used
|
- **port** (*Optional*): The port number on which the NAS is reachable. Defaults to `5000`.
|
||||||
```
|
- **username** (*Required*): An user to connect to the Synology NAS (a seperate account is adviced).
|
||||||
|
- **password** (*Required*): The password of the user to connect to the Synology NAS.
|
||||||
Configuration variables:
|
- **volumes** (*Optional*): Array of volumes to monitor. Defaults to all volumes.
|
||||||
|
- **disks** (*Optional*): Array of disks to monitor. Defaults to all disks.
|
||||||
- **host** (*Required*): The IP address of the Synology NAS to monitor
|
- **monitored_conditions** (*Required*): Defines a [template](/topics/templating/) to extract a value from the payload.
|
||||||
- **port** (*Optional*): The port number on which the NAS is reachable (defaults to 5000).
|
- **cpu_other_load**: Displays unspecified load in percentage.
|
||||||
- **username** (*Required*): An user to connect to the Synology NAS (a seperate account is adviced).
|
- **cpu_user_load**: Displays user load in percentage.
|
||||||
- **password** (*Required*): The password of the user to connect to the Synology NAS.
|
- **cpu_system_load**: Displays system load in percentage.
|
||||||
- **volumes** (*Optional*): Array of volumes to monitor (defaults to all volumes).
|
- **cpu_total_load**: Displays combined load in percentage.
|
||||||
- **disks** (*Optional*): Array of disks to monitor (defaults to all disks).
|
- **cpu_1min_load**: Displays maximum load in past minute.
|
||||||
- **monitored_conditions** (*Required*): Defines a [template](/topics/templating/) to extract a value from the payload.
|
- **cpu_5min_load**: Displays maximum load in past 5 minutes.
|
||||||
- **cpu_other_load**: Displays unspecified load in percentage
|
- **cpu_15min_load**: Displays maximum load in past 15 minutes.
|
||||||
- **cpu_user_load**: Displays user load in percentage
|
- **memory_real_usage**: Displays percentage of memory used.
|
||||||
- **cpu_system_load**: Displays system load in percentage
|
- **memory_size**: Displays total size of memory in MB.
|
||||||
- **cpu_total_load**: Displays combined load in percentage
|
- **memory_cached**: Displays total size of cache in MB.
|
||||||
- **cpu_1min_load**: Displays maximum load in past minute
|
- **memory_available_swap**: Displays total size of available swap in MB.
|
||||||
- **cpu_5min_load**: Displays maximum load in past 5 minutes
|
- **memory_available_real**: Displays total size of memory used (based on real memory) in MB.
|
||||||
- **cpu_15min_load**: Displays maximum load in past 15 minutes
|
- **memory_total_swap**: Displays total size of actual memory in MB.
|
||||||
- **memory_real_usage**: Displays percentage of memory used
|
- **memory_total_real**: Displays total size of real memory in MB.
|
||||||
- **memory_size**: Displays total size of memory in MB's
|
- **network_up**: Displays total up speed of network interfaces (combines all interfaces).
|
||||||
- **memory_cached**: Displays total size of cache in MB's
|
- **network_down**: Displays total down speed of network interfaces (combines all interfaces).
|
||||||
- **memory_available_swap**: Displays total size of available swap in MB's
|
- **disk_name**: Displays the name of the harddisk (creates a new entry for each disk).
|
||||||
- **memory_available_real**: Displays total size of memory used (based on real memory) in MB's
|
- **disk_device**: Displays the path of the harddisk (creates a new entry for each disk).
|
||||||
- **memory_total_swap**: Displays total size of actual memory in MB's
|
- **disk_smart_status**: Displays the S.M.A.R.T status of the harddisk (creates a new entry for each disk).
|
||||||
- **memory_total_real**: Displays total size of real memory in MB's
|
- **disk_status**: Displays the status of the harddisk (creates a new entry for each disk).
|
||||||
- **network_up**: Displays total up speed of network interfaces (combines all interfaces)
|
- **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).
|
||||||
- **network_down**: Displays total down speed of network interfaces (combines all interfaces)
|
- **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).
|
||||||
- **disk_name**: Displays the name of the harddisk (creates a new entry for each disk)
|
- **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).
|
||||||
- **disk_device**: Displays the path of the harddisk (creates a new entry for each disk)
|
- **volume_status**: Displays the status of the volume (creates a new entry for each volume).
|
||||||
- **disk_smart_status**: Displays the S.M.A.R.T status of the harddisk (creates a new entry for each disk)
|
- **volume_device_type**: Displays the volume type (RAID, etc) (creates a new entry for each volume).
|
||||||
- **disk_status**: Displays the status of the harddisk (creates a new entry for each disk)
|
- **volume_size_total**: Displays the total size of the volume in GB's (creates a new entry for each volume).
|
||||||
- **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)
|
- **volume_size_used**: Displays the used space on this volume in GB's (creates a new entry for each volume).
|
||||||
- **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)
|
- **volume_percentage_used**: Displays the percentage used for this volume in GB's (creates a new entry for each volume).
|
||||||
- **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)
|
- **volume_disk_temp_avg**: Displays the average temperature of all disks in the volume (creates a new entry for each volume).
|
||||||
- **volume_status**: Displays the status of the volume (creates a new entry for each volume)
|
- **volume_disk_temp_max**: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume).
|
||||||
- **volume_device_type**: Displays the volume type (RAID, etc) (creates a new entry for each volume)
|
|
||||||
- **volume_size_total**: Displays the total size of the volume in GB's (creates a new entry for each volume)
|
|
||||||
- **volume_size_used**: Displays the used space on this volume in GB's (creates a new entry for each volume)
|
|
||||||
- **volume_percentage_used**: Displays the percentage used for this volume in GB's (creates a new entry for each volume)
|
|
||||||
- **volume_disk_temp_avg**: Displays the average temperature of all disks in the volume (creates a new entry for each volume)
|
|
||||||
- **volume_disk_temp_max**: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume)
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user