407 lines
18 KiB
HTML
407 lines
18 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>QNAP Sensor - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate the QNAP sensor within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.qnap/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="QNAP Sensor">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.qnap/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate the QNAP 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="QNAP Sensor">
|
||
<meta name="twitter:description" content="Instructions how to integrate the QNAP 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="/docs/">Docs</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">
|
||
QNAP Sensor
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>This <code class="highlighter-rouge">qnap</code> sensor allows getting various statistics from your <a href="https://www.qnap.com/en-us/">QNAP NAS</a>.</p>
|
||
<p>To use the <code class="highlighter-rouge">qnap</code> 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">qnap</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS_OF_QNAP_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">status</span>
|
||
<span class="pi">-</span> <span class="s">cpu_usage</span>
|
||
<span class="pi">-</span> <span class="s">memory_percent_used</span>
|
||
<span class="pi">-</span> <span class="s">network_tx</span>
|
||
<span class="pi">-</span> <span class="s">volume_percentage_used</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>host</strong> (<em>Required</em>): The IP address of the QNAP NAS to monitor</li>
|
||
<li><strong>port</strong> (<em>Optional</em>): The port number on which the QNAP NAS web interface is reachable. Defaults to <code class="highlighter-rouge">8080</code>.</li>
|
||
<li><strong>ssl</strong> (<em>Optional</em>): Whether to connect via <code class="highlighter-rouge">https</code>. Defaults to <code class="highlighter-rouge">false</code>.</li>
|
||
<li><strong>verify_ssl</strong> (<em>Optional</em>): Whether SSL certificates should be validated. Defaults to <code class="highlighter-rouge">true</code>.</li>
|
||
<li><strong>timeout</strong> (<em>Optional</em>): How long (in seconds) to wait for a response from the QNAP device before giving up. Defaults to <code class="highlighter-rouge">10</code>.</li>
|
||
<li><strong>username</strong> (<em>Required</em>): An user to connect to the QNAP NAS.</li>
|
||
<li><strong>password</strong> (<em>Required</em>): The password of the user to connect to the QNAP NAS.</li>
|
||
<li><strong>drives</strong> (<em>Optional</em>): Array of drives to monitor (ex: <code class="highlighter-rouge">0:1</code>). Defaults to all drives.</li>
|
||
<li><strong>volumes</strong> (<em>Optional</em>): Array of volumes to monitor (ex: <code class="highlighter-rouge">DataVol1</code>). Defaults to all volumes.</li>
|
||
<li><strong>nics</strong> (<em>Optional</em>): Array of network interfaces to monitor (ex: <code class="highlighter-rouge">eth0</code>). Defaults to all NICs.</li>
|
||
<li><strong>monitored_conditions</strong> (<em>Required</em>): Defines the stats to monitor as sensors.
|
||
<ul>
|
||
<li><strong>status</strong>: Displays overall system health.</li>
|
||
<li><strong>system_temp</strong>: Displays the overall system temperature.</li>
|
||
<li><strong>cpu_temp</strong>: Displays the CPU’s temperature.</li>
|
||
<li><strong>cpu_usage</strong>: Displays the CPU’s utilization as a percentage.</li>
|
||
<li><strong>memory_free</strong>: Displays the size of available RAM in GB.</li>
|
||
<li><strong>memory_used</strong>: Displays the size of used RAM in GB.</li>
|
||
<li><strong>memory_percent_used</strong>: Displays the size of used RAM as a percentage of total RAM.</li>
|
||
<li><strong>network_link_status</strong>: Displays whether the network interfaces is up (creates a new entry for each interface).</li>
|
||
<li><strong>network_tx</strong>: Displays the upload speed of a network interface in MB/s (creates a new entry for each interface).</li>
|
||
<li><strong>network_rx</strong>: Displays the download speed of a network interface in MB/s (creates a new entry for each interface).</li>
|
||
<li><strong>drive_smart_status</strong>: Displays the S.M.A.R.T. status of the drive (creates a new entry for each drive).</li>
|
||
<li><strong>drive_temp</strong>: Displays the temperature of the drive (creates a new entry for each drive).</li>
|
||
<li><strong>volume_size_free</strong>: Displays the available space of the volume in GB (creates a new entry for each volume).</li>
|
||
<li><strong>volume_size_used</strong>: Displays the used space of the volume in GB (creates a new entry for each volume).</li>
|
||
<li><strong>volume_percentage_used</strong>: Displays the used space of the volume as a percentage (creates a new entry for each volume).</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h3>Self-signed certificates</h3>
|
||
<p>If your QNAP device uses self-signed certificates, set the <code class="highlighter-rouge">verify_ssl</code> option to <code class="highlighter-rouge">false</code>.</p>
|
||
<h3>QNAP device support:</h3>
|
||
<p>This component has been tested on the following devices:</p>
|
||
<ul>
|
||
<li>TS-410 (QTS 4.2.3)</li>
|
||
<li>TS-451 (QTS 4.2.2)</li>
|
||
<li>TS-639 (QTS 4.2.3)</li>
|
||
</ul>
|
||
<p>Other QNAP NAS devices using similar firmware should work fine. For more information about supported devices, or to report issues with your device, please visit the <a href="https://github.com/colinodell/python-qnapstats#device-support">qnapstats project</a>.</p>
|
||
</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.qnap.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/qnap.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>: Local Polling
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.38
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Sensor</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/sensor.api_stream/'>API Stream Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.arwn/'>ARWN Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.alarmdecoder/'>AlarmDecoder Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.amcrest/'>Amcrest IP Camera</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.android_ip_webcam/'>Android IP Webcam Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.bbox/'>Bbox Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.blink/'>Blink Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.bloomsky/'>BloomSky Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.broadlink/'>Broadlink RM2 and A1 sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.modem_callerid/'>Caller ID Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.command_line/'>Command line Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.crimereports/'>Crime Reports</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dnsip/'>DNS IP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dweet/'>Dweet.io</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.ebox/'>EBox</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.eight_sleep/'>Eight Sleep Sensor</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.envirophat/'>Enviro pHAT</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.envisalink/'>Envisalink Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.fedex/'>Fedex Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.fido/'>Fido</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.history_stats/'>History Statistics 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.kwb/'>KWB Easyfire 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.neato/'>Neato Robotics 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.openevse/'>OpenEVSE Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.opensky/'>OpenSky Network</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.pilight/'>Pilight Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.pocketcasts/'>PocketCasts</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.pushbullet/'>Pushbullet Mirrors</a>
|
||
</li>
|
||
<li>
|
||
QNAP Sensor
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.rest/'>RESTful Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.rflink/'>RFLink 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.ring/'>Ring Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.scrape/'>Scrape Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.sensehat/'>Sense HAT</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.sleepiq/'>SleepIQ Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.sonarr/'>Sonarr Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.statistics/'>Statistics Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.synologydsm/'>SynologyDSM Sensor</a>
|
||
</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.tado/'>Tado 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.ups/'>UPS Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.usps/'>USPS 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.zha/'>ZigBee Home Automation 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> (no support!).<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>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</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>
|