home-assistant.github.io/components/sensor.envirophat/index.html
2017-06-17 20:00:42 +00:00

476 lines
21 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Enviro pHAT - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate the Enviro pHAT within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.envirophat/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Enviro pHAT">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.envirophat/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate the Enviro pHAT 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="Enviro pHAT">
<meta name="twitter:description" content="Instructions how to integrate the Enviro pHAT 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">
Enviro pHAT
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">envirophat</code> sensor platform allows you to display information collected by an <a href="https://shop.pimoroni.com/products/enviro-phat">Enviro pHAT</a> add-on board for the Raspberry Pi. The board featues a wide range of sensors, such as:</p>
<ul>
<li>BMP280 temperature/pressure sensor</li>
<li>TCS3472 light and RGB colour sensor with two LEDs for illumination</li>
<li>LSM303D accelerometer/magnetometer sensor</li>
<li>ADS1015 4-channel 3.3v, analog to digital sensor (ADC)</li>
</ul>
<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="c1"># which is equivalent to the default setup</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">envirophat</span>
<span class="s">use_led</span><span class="pi">:</span> <span class="s">false</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">pressure</span>
<span class="pi">-</span> <span class="s">light</span>
<span class="pi">-</span> <span class="s">light_red</span>
<span class="pi">-</span> <span class="s">light_green</span>
<span class="pi">-</span> <span class="s">light_blue</span>
<span class="pi">-</span> <span class="s">accelerometer_x</span>
<span class="pi">-</span> <span class="s">accelerometer_y</span>
<span class="pi">-</span> <span class="s">accelerometer_z</span>
<span class="pi">-</span> <span class="s">magnetometer_x</span>
<span class="pi">-</span> <span class="s">magnetometer_y</span>
<span class="pi">-</span> <span class="s">magnetometer_z</span>
<span class="pi">-</span> <span class="s">voltage_0</span>
<span class="pi">-</span> <span class="s">voltage_1</span>
<span class="pi">-</span> <span class="s">voltage_2</span>
<span class="pi">-</span> <span class="s">voltage_3</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>display_options</strong> (<em>Optional</em>) array: List of readings to monitor. Default is monitoring all of them:
<ul>
<li><strong>temperature</strong>: ambient temperature in Celsius. Since the sensor is close to the Raspberry Pi, that migth affect the accuracy of the reading (ie. the Pi might heat up the sensor)</li>
<li><strong>pressure</strong>: atmospheric pressure in hPa.</li>
<li><strong>light</strong>: ambient light, as an integer in the 0-65535 range</li>
<li><strong>light_red</strong>: red color reading scaled to the ambient light, as an integer in the 0-255 range</li>
<li><strong>light_green</strong>: green color reading scaled to the ambient light, as an integer in the 0-255 range</li>
<li><strong>light_blue</strong>: blue color reading scaled to the ambient light, as an integer in the 0-255 range</li>
<li><strong>accelerometer_x</strong>: accelerometer reading in units of G, along the X axis</li>
<li><strong>accelerometer_y</strong>: accelerometer reading in units of G, along the Y axis</li>
<li><strong>accelerometer_z</strong>: accelerometer reading in units of G, along the Z axis</li>
<li><strong>magnetometer_x</strong>: magnetometer reading, the X component of the raw vector</li>
<li><strong>magnetometer_y</strong>: magnetometer reading, the Y component of the raw vector</li>
<li><strong>magnetometer_z</strong>: magnetometer reading, the X component of the raw vector</li>
<li><strong>voltage_0</strong>: voltage reading on Analog In 0 in units of V</li>
<li><strong>voltage_1</strong>: voltage reading on Analog In 1 in units of V</li>
<li><strong>voltage_2</strong>: voltage reading on Analog In 2 in units of V</li>
<li><strong>voltage_3</strong>: voltage reading on Analog In 3 in units of V</li>
</ul>
</li>
<li><strong>use_led</strong> (<em>Optional</em>) True / False boolean; Default value is False, declaring that the onboard LEDs are <em>not</em> used for the color measurements thus these readings are based on the ambient light. If the value is set to True, the onboard LEDs will blink whenever a reading is taken.</li>
</ul>
<h3>Notes</h3>
<ul>
<li><strong>X, Y, Z axes</strong>
<ul>
<li>X is parallel with the long edge of the board</li>
<li>Y is parallel with the short edge of the board</li>
<li>Z is perpendicular to the board</li>
</ul>
</li>
<li><strong>Voltages</strong>
<ul>
<li>voltage readings are done in the 0-3.3V range, please do not connect higher voltages than that! See the <a href="https://learn.pimoroni.com/tutorial/sandyj/getting-started-with-enviro-phat">Enviro pHATs getting started guide</a> regarding how to make a voltage divider</li>
</ul>
</li>
</ul>
<h3>Give the values friendly names &amp; icons</h3>
<p>Add something like the following to your <a href="/docs/configuration/customizing-devices/">customize section</a>:</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.accelerometer_z</span><span class="pi">:</span>
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:airplane-landing</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Acc</span><span class="nv"> </span><span class="s">Z"</span>
<span class="s">sensor.magnetometer_x</span><span class="pi">:</span>
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:arrow-up-bold-hexagon-outline</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Magnetic</span><span class="nv"> </span><span class="s">X"</span>
<span class="s">sensor.pressure</span><span class="pi">:</span>
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:weight</span>
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Pressure"</span>
</code></pre>
</div>
<h3>Create groups</h3>
<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">enviro_phat_voltages</span><span class="pi">:</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Enviro pHAT Volages`</span>
<span class="s">entities</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sensor.voltage_0</span>
<span class="pi">-</span> <span class="s">sensor.voltage_1</span>
<span class="pi">-</span> <span class="s">sensor.voltage_2</span>
<span class="pi">-</span> <span class="s">sensor.voltage_3</span>
</code></pre>
</div>
<h3>Enabling the required <code class="highlighter-rouge">i2c-1</code> device</h3>
<p>Since the Enviro pHAT communicates over I2C, you might also need to make sure that the I2C devices are enabled, by adding or uncommenting the following line in <code class="highlighter-rouge">/boot/config.txt</code> (see the <a href="https://www.raspberrypi.org/documentation/configuration/device-tree.md">DT Parameters section</a> in the Raspberry Pi documentation):</p>
<div class="highlighter-rouge"><pre class="highlight"><code>dtparam=i2c_arm=on
</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.envirophat.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/raspberry-pi.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.44
</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.arlo/'>Arlo 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.dyson/'>Dyson Purifier Sensor</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>
Enviro pHAT
</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.file/'>File Sensor</a>
</li>
<li>
<a href='/components/sensor.gpsd/'>GPSD</a>
</li>
<li>
<a href='/components/sensor.gitter/'>Gitter Sensor</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.juicenet/'>Juicenet Sensor</a>
</li>
<li>
<a href='/components/sensor.kwb/'>KWB Easyfire Sensor</a>
</li>
<li>
<a href='/components/sensor.kira/'>Kira 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.mold_indicator/'>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>
<a href='/components/sensor.qnap/'>QNAP Sensor</a>
</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.radarr/'>Radarr 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.ted5000/'>TED5000 electricity monitoring</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>