363 lines
No EOL
16 KiB
HTML
363 lines
No EOL
16 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>SynologyDSM Sensor - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate the SynologyDSM sensor within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.synologydsm/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="SynologyDSM Sensor">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.synologydsm/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate the SynologyDSM sensor within Home Assistant.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
|
||
<meta name="twitter:title" content="SynologyDSM Sensor">
|
||
<meta name="twitter:description" content="Instructions how to integrate the SynologyDSM sensor within Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
|
||
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
|
||
<body >
|
||
|
||
<header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/ecosystem/">Ecosystem</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</header>
|
||
|
||
|
||
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
|
||
|
||
<article class="page">
|
||
|
||
|
||
|
||
|
||
<header>
|
||
<h1 class="title indent">
|
||
SynologyDSM Sensor
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>This <code class="highlighter-rouge">synologydms</code> sensor allows getting various statistics from your <a href="https://www.synology.com">Synology NAS</a>. Please note that using this sensor wakes up your synology if in hibernation mode.</p>
|
||
|
||
<p>To use the SynologyDSM sensor in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry</span>
|
||
<span class="s">sensor</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">synologydsm</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS_OF_SYNOLOGY_NAS</span>
|
||
<span class="s">username</span><span class="pi">:</span> <span class="s">USERNAME</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">PASSWORD</span>
|
||
<span class="s">monitored_conditions</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">cpu_total_load</span>
|
||
<span class="pi">-</span> <span class="s">memory_real_usage</span>
|
||
<span class="pi">-</span> <span class="s">network_up</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>host</strong> (<em>Required</em>): The IP address of the Synology NAS to monitor</li>
|
||
<li><strong>port</strong> (<em>Optional</em>): The port number on which the NAS is reachable. Defaults to <code class="highlighter-rouge">5000</code>.</li>
|
||
<li><strong>username</strong> (<em>Required</em>): An user to connect to the Synology NAS (a seperate account is adviced).</li>
|
||
<li><strong>password</strong> (<em>Required</em>): The password of the user to connect to the Synology NAS.</li>
|
||
<li><strong>volumes</strong> (<em>Optional</em>): Array of volumes to monitor. Defaults to all volumes.</li>
|
||
<li><strong>disks</strong> (<em>Optional</em>): Array of disks to monitor. Defaults to all disks.</li>
|
||
<li><strong>monitored_conditions</strong> (<em>Required</em>): Defines a <a href="/topics/templating/">template</a> to extract a value from the payload.
|
||
<ul>
|
||
<li><strong>cpu_other_load</strong>: Displays unspecified load in percentage.</li>
|
||
<li><strong>cpu_user_load</strong>: Displays user load in percentage.</li>
|
||
<li><strong>cpu_system_load</strong>: Displays system load in percentage.</li>
|
||
<li><strong>cpu_total_load</strong>: Displays combined load in percentage.</li>
|
||
<li><strong>cpu_1min_load</strong>: Displays maximum load in past minute.</li>
|
||
<li><strong>cpu_5min_load</strong>: Displays maximum load in past 5 minutes.</li>
|
||
<li><strong>cpu_15min_load</strong>: Displays maximum load in past 15 minutes.</li>
|
||
<li><strong>memory_real_usage</strong>: Displays percentage of memory used.</li>
|
||
<li><strong>memory_size</strong>: Displays total size of memory in MB.</li>
|
||
<li><strong>memory_cached</strong>: Displays total size of cache in MB.</li>
|
||
<li><strong>memory_available_swap</strong>: Displays total size of available swap in MB.</li>
|
||
<li><strong>memory_available_real</strong>: Displays total size of memory used (based on real memory) in MB.</li>
|
||
<li><strong>memory_total_swap</strong>: Displays total size of actual memory in MB.</li>
|
||
<li><strong>memory_total_real</strong>: Displays total size of real memory in MB.</li>
|
||
<li><strong>network_up</strong>: Displays total up speed of network interfaces (combines all interfaces).</li>
|
||
<li><strong>network_down</strong>: Displays total down speed of network interfaces (combines all interfaces).</li>
|
||
<li><strong>disk_name</strong>: Displays the name of the harddisk (creates a new entry for each disk).</li>
|
||
<li><strong>disk_device</strong>: Displays the path of the harddisk (creates a new entry for each disk).</li>
|
||
<li><strong>disk_smart_status</strong>: Displays the S.M.A.R.T status of the harddisk (creates a new entry for each disk).</li>
|
||
<li><strong>disk_status</strong>: Displays the status of the harddisk (creates a new entry for each disk).</li>
|
||
<li><strong>disk_exceed_bad_sector_thr</strong>: Displays true / false to indicate if the harddisk exceeded the maximum bad sector threshold (creates a new entry for each disk).</li>
|
||
<li><strong>disk_below_remain_life_thr</strong>: Displays true / false to indicate if the harddisk dropped below the remain life threshold (creates a new entry for each disk).</li>
|
||
<li><strong>disk_temp</strong>: Displays the temperature of the harddisk (creates a new entry for each disk, uses the unit_system to display in C or F).</li>
|
||
<li><strong>volume_status</strong>: Displays the status of the volume (creates a new entry for each volume).</li>
|
||
<li><strong>volume_device_type</strong>: Displays the volume type (RAID, etc) (creates a new entry for each volume).</li>
|
||
<li><strong>volume_size_total</strong>: Displays the total size of the volume in GB’s (creates a new entry for each volume).</li>
|
||
<li><strong>volume_size_used</strong>: Displays the used space on this volume in GB’s (creates a new entry for each volume).</li>
|
||
<li><strong>volume_percentage_used</strong>: Displays the percentage used for this volume in GB’s (creates a new entry for each volume).</li>
|
||
<li><strong>volume_disk_temp_avg</strong>: Displays the average temperature of all disks in the volume (creates a new entry for each volume).</li>
|
||
<li><strong>volume_disk_temp_max</strong>: Displays the maximum temperature of all disks in the volume (creates a new entry for each volume).</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
</article>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
|
||
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.synologydsm.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/synologydsm.png' />
|
||
</div>
|
||
<div class='section'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: depends
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.32
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Sensor</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/sensor.apcupsd/'>APCUPSd Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.arwn/'>ARWN Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.bbox/'>Bbox Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.bloomsky/'>BloomSky Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.command_line/'>Command line Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dweet/'>Dweet.io</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.emoncms/'>Emoncms Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.enocean/'>EnOcean Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.envisalink/'>Envisalink Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.gpsd/'>GPSD</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.http/'>HTTP Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.haveibeenpwned/'>HaveIBeenPwned Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.homematic/'>Homematic Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.imap_email_content/'>IMAP Email Content</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.imap/'>IMAP Unread E-mail</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.isy994/'>ISY994 Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.influxdb/'>InfluxDB Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mhz19/'>MH-Z19 CO2 Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mqtt/'>MQTT Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.min_max/'>Min/max Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.modbus/'>Modbus Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.moldindicator/'>Mold Indicator</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mysensors/'>MySensors Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.nest/'>Nest Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.octoprint/'>OctoPrint Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.onewire/'>One wire Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.pilight/'>Pilight Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.rest/'>RESTful Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.rfxtrx/'>RFXtrx Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.random/'>Random Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.scrape/'>Scrape Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.sleepiq/'>SleepIQ Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.statistics/'>Statistics Sensor</a>
|
||
</li>
|
||
<li>
|
||
SynologyDSM Sensor
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.tcp/'>TCP Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.temper/'>TEMPer Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.tellstick/'>TellStick Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.tellduslive/'>Telldus Live sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.template/'>Template Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.thinkingcleaner/'>Thinking Cleaner sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.vera/'>Vera Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.verisure/'>Verisure Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.wink/'>Wink Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.zwave/'>Z-Wave Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.zigbee/'>ZigBee Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.zoneminder/'>ZoneMinder Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.arest/'>aREST Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.mfi/'>mFi Sensor</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
|
||
</div>
|
||
</aside>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
</body>
|
||
</html> |