471 lines
No EOL
20 KiB
HTML
471 lines
No EOL
20 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>Sense HAT - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate Sense HAT within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.sensehat/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Sense HAT">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.sensehat/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate Sense HAT 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="Sense HAT">
|
||
<meta name="twitter:description" content="Instructions how to integrate Sense HAT 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">
|
||
Sense HAT
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">sensehat</code> sensor platform allows you to display information collected by a <a href="https://www.raspberrypi.org/products/sense-hat/">Sense HAT</a> add-on board for Raspberry Pi.</p>
|
||
|
||
<p>To add this platform to 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.yaml 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">sensehat</span>
|
||
<span class="s">display_options</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">temperature</span>
|
||
<span class="pi">-</span> <span class="s">humidity</span>
|
||
<span class="pi">-</span> <span class="s">pressure</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>display_options</strong> (<em>Requires</em>) array: List of details to monitor. Defaults is <code class="highlighter-rouge">memory_free</code>.
|
||
<ul>
|
||
<li>‘temperature’</li>
|
||
<li>‘humidity’</li>
|
||
<li>‘pressure’</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<h3><a class="title-link" name="installation-instruction-for-the-all-in-one-installer-and-hassbian" href="#installation-instruction-for-the-all-in-one-installer-and-hassbian"></a> Installation instruction for the All-In-One installer and HASSbian</h3>
|
||
|
||
<p>Here are the steps to make the Sense HAT sensor work with a virtual environment.</p>
|
||
|
||
<p>Install SenseHAT package. Switch to the <code class="highlighter-rouge">homeassistant_venv</code> directory and activate the virtual environment.</p>
|
||
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo su -s /bin/bash homeassistant
|
||
<span class="gp">$ </span><span class="nb">source</span> /srv/homeassistant/homeassistant_venv/bin/activate
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Install the <code class="highlighter-rouge">sense-hat</code> module.</p>
|
||
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install sense-hat
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Please be patient, this will take a long while…</p>
|
||
|
||
<p>Type <code class="highlighter-rouge">exit</code> to quit out of the <em>homeassistant_venv</em> back to your <code class="highlighter-rouge">pi</code> environment. As all of the following steps should be under the <code class="highlighter-rouge">pi</code> user environment.</p>
|
||
|
||
<p>Install the <a href="https://github.com/RPi-Distro/RTIMULib">RTIMU</a> Python module:</p>
|
||
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install rtimulib
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Add symlink to RTIMU in <code class="highlighter-rouge">homeassistant_venv</code> directory. Create a symlink using the following command:</p>
|
||
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ln -s /usr/lib/python3/dist-packages/RTIMU.cpython-34m-arm-linux-gnueabihf.so /srv/homeassistant/homeassistant_venv/lib/python3.4/
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Add <code class="highlighter-rouge">homeassistant</code> user to the <code class="highlighter-rouge">input</code> and the <code class="highlighter-rouge">i2c</code> groups.</p>
|
||
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo addgroup homeassistant input
|
||
<span class="gp">$ </span>sudo addgroup homeassistant i2c
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Reboot Raspberry Pi to apply changes.</p>
|
||
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo reboot
|
||
</code></pre>
|
||
</div>
|
||
|
||
<h3><a class="title-link" name="customizing-the-sense-hat-data" href="#customizing-the-sense-hat-data"></a> Customizing the Sense HAT data</h3>
|
||
|
||
<p>To format the sensor values, add the following to your <code class="highlighter-rouge">sensor</code> entry in 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.yaml 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">sensehat</span>
|
||
<span class="s">display_options</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">temperature</span>
|
||
<span class="pi">-</span> <span class="s">humidity</span>
|
||
<span class="pi">-</span> <span class="s">pressure</span>
|
||
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
|
||
<span class="s">sensors</span><span class="pi">:</span>
|
||
<span class="s">sensehat_temperature</span><span class="pi">:</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.sensor.temperature.state</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">round(1)</span><span class="nv"> </span><span class="s">}}'</span>
|
||
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s1">'</span><span class="s">°C'</span>
|
||
<span class="s">sensehat_pressure</span><span class="pi">:</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.sensor.pressure.state</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">round(1)</span><span class="nv"> </span><span class="s">}}'</span>
|
||
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s1">'</span><span class="s">mb'</span>
|
||
<span class="s">sensehat_humidity</span><span class="pi">:</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">states.sensor.humidity.state</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">round(1)</span><span class="nv"> </span><span class="s">}}'</span>
|
||
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s1">'</span><span class="s">%'</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Add the following to your <code class="highlighter-rouge">customize</code> section to set friendly names & icons for the values.</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">customize</span><span class="pi">:</span>
|
||
<span class="s">sensor.sensehat_temperature</span><span class="pi">:</span>
|
||
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:thermometer</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Temperature"</span>
|
||
<span class="s">sensor.sensehat_humidity</span><span class="pi">:</span>
|
||
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:weather-rainy</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Humidity"</span>
|
||
<span class="s">sensor.sensehat_pressure</span><span class="pi">:</span>
|
||
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:gauge</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Pressure"</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Create a group for your Sense HAT details by adding the following to your <code class="highlighter-rouge">groups</code> section.</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">group</span><span class="pi">:</span>
|
||
<span class="s">sense_hat</span><span class="pi">:</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s">Sense HAT</span>
|
||
<span class="s">entities</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">sensor.sensehat_temperature</span>
|
||
<span class="pi">-</span> <span class="s">sensor.sensehat_humidity</span>
|
||
<span class="pi">-</span> <span class="s">sensor.sensehat_pressure</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Add the <em>sense_hat group</em> a group (<em>Kitchen for example</em>)</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">group</span><span class="pi">:</span>
|
||
<span class="s">kitchen</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">group.sense_hat</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
|
||
|
||
</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.sensehat.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/sense-hat.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 Push
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.35
|
||
</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.api_stream/'>API Stream Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.arwn/'>ARWN Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.amcrest/'>Amcrest IP Camera</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.broadlink/'>Broadlink RM2 and A1 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.nut/'>NUT 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.onewire/'>One wire Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.openevse/'>OpenEVSE Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.pilight/'>Pilight Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.qnap/'>QNAP 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.rflink/'>Rflink Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.scrape/'>Scrape Sensor</a>
|
||
</li>
|
||
<li>
|
||
Sense HAT
|
||
</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.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.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.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>
|
||
<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> |