jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Edit for clarity and grammar (#13314)

Browse Source
This commit is contained in:
Michael A. Alderete 2020-05-06 23:29:50 -07:00 committed by GitHub
parent e2540687f4
commit a2e0f0c742
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/_integrations/synology_dsm.markdown
View File

@ -12,15 +12,15 @@ ha_codeowners:
ha_config_flow: true ha_config_flow: true
--- ---
The `synology_dsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com). The `synology_dsm` sensor platform provides access to various statistics from your [Synology NAS](https://www.synology.com).
## Configuration ## Configuration
There are two ways to integrate Synology DSM in Home Assistant. There are two ways to integrate your Synology DSM into Home Assistant.
### Via the frontend ### Via the frontend
Menu: *Configuration* -> *Integrations*. Search for "Synology DSM", fill the configuration form, click submit. Menu: *Configuration* -> *Integrations*. Search for "Synology DSM", fill in the configuration form with your username and password, and then click **Submit**.
### Via the configuration file ### Via the configuration file
@ -29,14 +29,14 @@ Add the following section to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
synology_dsm: synology_dsm:
- host: IP_ADDRESS_OR_DNS_OF_SYNOLOGY_NAS - host: IP_ADDRESS_OR_HOSTNAME_OF_SYNOLOGY_NAS
username: YOUR_USERNAME username: YOUR_USERNAME
password: YOUR_PASSWORD password: YOUR_PASSWORD
``` ```
{% configuration %} {% configuration %}
host: host:
description: The IP address or DNS of the Synology NAS to monitor. description: The IP address or DNS hostname of the Synology NAS to monitor.
required: true required: true
type: string type: string
port: port:
@ -50,7 +50,7 @@ ssl:
default: true default: true
type: boolean type: boolean
username: username:
description: An user to connect to the Synology NAS (a separate account is advised, see the (Separate User Configuration)[#separate-user-configuration] section below for details). description: The account username to connect to the Synology NAS. Using a separate account is advised, see the [Separate User Configuration](#separate-user-configuration) section below for details.
required: true required: true
type: string type: string
password: password:
@ -58,11 +58,11 @@ password:
required: true required: true
type: string type: string
volumes: volumes:
description: "Array of volumes to monitor. Defaults to all volumes. Replace any spaces in the volume name with underscores, e.g., `volume 1` with `volume_1`." description: "Array of volumes to monitor. Defaults to all volumes. Replace any spaces in the volume name with underscores. For example, replace `volume 1` with `volume_1`."
required: false required: false
type: list type: list
disks: disks:
description: "Array of disks to monitor. Defaults to all disks. Use only disk names like `sda`, `sdb`, etc." description: "Array of disks to monitor. Defaults to all disks. Use only disk names like `sda`, `sdb`, and so on."
required: false required: false
type: list type: list
{% endconfiguration %} {% endconfiguration %}
@ -82,7 +82,7 @@ When creating the user, it is possible to deny access to all locations and appli
<div class='note warning'> <div class='note warning'>
Using two-factor authentication is not supported. Please use a strong, randomly generated password. The Home Assistant integration doesn't support two-factor authentication for Synology DSM accounts. Use a strong, randomly generated password to improve security.
</div> </div>
@ -90,7 +90,7 @@ Using two-factor authentication is not supported. Please use a strong, randomly
## Created sensors ## Created sensors
Sensors are: Sensors are:
- `cpu_other_load`: Displays unspecified load in percentage. - `cpu_other_load`: Displays unspecified (that is, not user or system) load in percentage.
- `cpu_user_load`: Displays user load in percentage. - `cpu_user_load`: Displays user load in percentage.
- `cpu_system_load`: Displays system load in percentage. - `cpu_system_load`: Displays system load in percentage.
- `cpu_total_load`: Displays combined load in percentage. - `cpu_total_load`: Displays combined load in percentage.