mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-28 19:57:12 +00:00
Update Synology component configuration variable (#6735)
This commit is contained in:
Klaas Schoute
Fabian Affolter
parent
0e987955a8
commit
99131191de
@ -27,14 +27,39 @@ camera:
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **url** (*Required*): The URL to your synology, including port.
|
||||
- **username** (*Required*): The username for accessing surveillance station.
|
||||
- **password** (*Required*): The password for accessing surveillance station.
|
||||
- **timeout** (*Optional*): The timeout in seconds used when connecting to the Surveillance Station. Defaults to 5.
|
||||
- **whitelist** (*Optional*): A list of which cameras you want to add, the names must be the same as in Surveillance Station. If omitted all cameras are added.
|
||||
- **verify_ssl** (*Optional*): True to require a valid certificate, False to disable certificate checking. Defaults to `True`.
|
||||
{% configuration %}
|
||||
name:
|
||||
description: A name for this synology camera component.
|
||||
required: false
|
||||
default: Synology Camera
|
||||
type: string
|
||||
url:
|
||||
description: The URL to your synology, including port.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: The username for accessing surveillance station.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password for accessing surveillance station.
|
||||
required: true
|
||||
type: string
|
||||
timeout:
|
||||
description: The timeout in seconds used when connecting to the Surveillance Station.
|
||||
required: false
|
||||
default: 5
|
||||
type: integer
|
||||
whitelist:
|
||||
description: A list of which cameras you want to add, the names must be the same as in Surveillance Station. If omitted all cameras are added.
|
||||
required: false
|
||||
type: list
|
||||
verify_ssl:
|
||||
description: True to require a valid certificate, False to disable certificate checking.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
A full sample configuration for the `synology` platform is shown below:
|
||||
|
||||
|
||||
@ -26,9 +26,15 @@ notify:
|
||||
resource: https://example.your.synology.com/webapi/entry.cgi?api=SYNO.Chat.External&method=incoming&version=1&token=ABCDEFG
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Required*): Setting the parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
||||
- **resource** (*Required*): The incoming webhook URL.
|
||||
{% configuration %}
|
||||
name:
|
||||
description: "Setting the parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`."
|
||||
required: true
|
||||
type: string
|
||||
resource:
|
||||
description: The incoming webhook URL.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|
||||
|
||||
@ -33,46 +33,103 @@ sensor:
|
||||
- network_up
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address of the Synology NAS to monitor.
|
||||
- **port** (*Optional*): The port number on which the Synology NAS is reachable. Defaults to `5001`.
|
||||
- **username** (*Required*): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details).
|
||||
- **password** (*Required*): The password of the user to connect to the Synology NAS.
|
||||
- **ssl** (*Optional*): Determine if HTTPS should be used. Defaults to `True` which by default runs on port `5001`.
|
||||
- **volumes** (*Optional*): Array of volumes to monitor. Defaults to all volumes.
|
||||
- **disks** (*Optional*): Array of disks to monitor. Defaults to all disks.
|
||||
- **monitored_conditions** (*Required*): Defines a [template](/topics/templating/) to extract a value from the payload.
|
||||
- **cpu_other_load**: Displays unspecified load in percentage.
|
||||
- **cpu_user_load**: Displays user load in percentage.
|
||||
- **cpu_system_load**: Displays system load in percentage.
|
||||
- **cpu_total_load**: Displays combined load in percentage.
|
||||
- **cpu_1min_load**: Displays maximum load in past minute.
|
||||
- **cpu_5min_load**: Displays maximum load in past 5 minutes.
|
||||
- **cpu_15min_load**: Displays maximum load in past 15 minutes.
|
||||
- **memory_real_usage**: Displays percentage of memory used.
|
||||
- **memory_size**: Displays total size of memory in MB.
|
||||
- **memory_cached**: Displays total size of cache in MB.
|
||||
- **memory_available_swap**: Displays total size of available swap in MB.
|
||||
- **memory_available_real**: Displays total size of memory used (based on real memory) in MB.
|
||||
- **memory_total_swap**: Displays total size of actual memory in MB.
|
||||
- **memory_total_real**: Displays total size of real memory in MB.
|
||||
- **network_up**: Displays total up speed of network interfaces (combines all interfaces).
|
||||
- **network_down**: Displays total down speed of network interfaces (combines all interfaces).
|
||||
- **disk_name**: Displays the name of the hard disk (creates a new entry for each disk).
|
||||
- **disk_device**: Displays the path of the hard disk (creates a new entry for each disk).
|
||||
- **disk_smart_status**: Displays the S.M.A.R.T status of the hard disk (creates a new entry for each disk).
|
||||
- **disk_status**: Displays the status of the hard disk (creates a new entry for each disk).
|
||||
- **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).
|
||||
- **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).
|
||||
- **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).
|
||||
- **volume_status**: Displays the status of 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).
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address of the Synology NAS to monitor.
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: The port number on which the Synology NAS is reachable.
|
||||
required: false
|
||||
default: 5001
|
||||
type: integer
|
||||
username:
|
||||
description: An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details).
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
description: The password of the user to connect to the Synology NAS.
|
||||
required: true
|
||||
type: string
|
||||
ssl:
|
||||
description: Determine if HTTPS should be used.
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
volumes:
|
||||
description: Array of volumes to monitor. Defaults to all volumes.
|
||||
required: false
|
||||
type: list
|
||||
disks:
|
||||
description: Array of disks to monitor. Defaults to all disks.
|
||||
required: false
|
||||
type: list
|
||||
monitored_conditions:
|
||||
description: Defines a [template](/topics/templating/) to extract a value from the payload.
|
||||
required: true
|
||||
type: list
|
||||
keys:
|
||||
cpu_other_load:
|
||||
description: Displays unspecified load in percentage.
|
||||
cpu_user_load:
|
||||
description: Displays user load in percentage.
|
||||
cpu_system_load:
|
||||
description: Displays system load in percentage.
|
||||
cpu_total_load:
|
||||
description: Displays combined load in percentage.
|
||||
cpu_1min_load:
|
||||
description: Displays maximum load in past minute.
|
||||
cpu_5min_load:
|
||||
description: Displays maximum load in past 5 minutes.
|
||||
cpu_15min_load:
|
||||
description: Displays maximum load in past 15 minutes.
|
||||
memory_real_usage:
|
||||
description: Displays percentage of memory used.
|
||||
memory_size:
|
||||
description: Displays total size of memory in MB.
|
||||
memory_cached:
|
||||
description: Displays total size of cache in MB.
|
||||
memory_available_swap:
|
||||
description: Displays total size of available swap in MB.
|
||||
memory_available_real:
|
||||
description: Displays total size of memory used (based on real memory) in MB.
|
||||
memory_total_swap:
|
||||
description: Displays total size of actual memory in MB.
|
||||
memory_total_real:
|
||||
description: Displays total size of real memory in MB.
|
||||
network_up:
|
||||
description: Displays total up speed of network interfaces (combines all interfaces).
|
||||
network_down:
|
||||
description: Displays total down speed of network interfaces (combines all interfaces).
|
||||
disk_name:
|
||||
description: Displays the name of the hard disk (creates a new entry for each disk).
|
||||
disk_device:
|
||||
description: Displays the path of the hard disk (creates a new entry for each disk).
|
||||
disk_smart_status:
|
||||
description: Displays the S.M.A.R.T status of the hard disk (creates a new entry for each disk).
|
||||
disk_status:
|
||||
description: Displays the status of the hard disk (creates a new entry for each disk).
|
||||
disk_exceed_bad_sector_thr:
|
||||
description: Displays true / false to indicate if the hard disk exceeded the maximum bad sector threshold (creates a new entry for each disk).
|
||||
disk_below_remain_life_thr:
|
||||
description: Displays true / false to indicate if the hard disk dropped below the remain life threshold (creates a new entry for each disk).
|
||||
disk_temp:
|
||||
description: Displays the temperature of the hard disk (creates a new entry for each disk, uses the unit_system to display in C or F).
|
||||
volume_status:
|
||||
description: Displays the status of the volume (creates a new entry for each volume).
|
||||
volume_device_type:
|
||||
description: Displays the volume type (RAID, etc) (creates a new entry for each volume).
|
||||
volume_size_total:
|
||||
description: Displays the total size of the volume in GB's (creates a new entry for each volume).
|
||||
volume_size_used:
|
||||
description: Displays the used space on this volume in GB's (creates a new entry for each volume).
|
||||
volume_percentage_used:
|
||||
description: Displays the percentage used for this volume in GB's (creates a new entry for each volume).
|
||||
volume_disk_temp_avg:
|
||||
description: Displays the average temperature of all disks in the volume (creates a new entry for each volume).
|
||||
volume_disk_temp_max:
|
||||
description: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume).
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user