Your Smart IOT

<div class="section tutorial-page">
<h2 id="introduction">Introduction</h2>
<p>The <a href="http://bit.ly/2n4YeRk" target="_blank">ZX Distance and Gesture Sensor</a> is a collaboration product with <a href="http://bit.ly/2mPsTju" target="_blank">XYZ Interactive</a>. The very smart people at XYZ Interactive have created a unique technology that allows for simple infrared beams to be used to detect an object’s location in two dimensions.</p>
<p>The ZX Sensor is a touchless sensor that is capable of looking for simple gestures in the air above the sensor (e.g. swipe left or right). Additionally, the sensor can also recognize the distance of an object away from the sensor up to about 10 inches (25 cm), which we will call the “Z” axis, and the location of the object from side to side across the sensor in about a 6 inch (15 cm) span, which we will call the “X” axis.</p>
<p><a href="http://bit.ly/2n5lGhh" target="_blank"><img alt="The ZX Sensor" src="http://bit.ly/2n5lGhh" /></a></p>
<h3>Covered in This Tutorial</h3>
<p>We can use I<sup>2</sup>C or UART to communicate with the ZX Sensor. In this tutorial, we will show you how to connect the sensor to an <a href="http://bit.ly/1XReOgM" itemprop="url" target="_bank" title="Arduino"><strong>Arduino</strong></a> as well as a computer. The tutorial is divided into the following sections:</p>
<ul>
<li><a href="http://bit.ly/2n5921W" target="_blank">Board Overview</a> – We go over the various pins and jumper settings on the ZX Sensor.</li>
<li><a href="http://bit.ly/2mPsVrC" target="_blank">Hardware Hookup</a> – How to connect the sensor to an Arduino.</li>
<li><a href="http://bit.ly/2n5eF0a" target="_blank">Arduino Library Installation</a> – Install the ZX Sensor library if you plan to use it with an Arduino</li>
<li><a href="http://bit.ly/2mPsn58" target="_blank">Arduino: ZX Example</a> – How to read Z- and X- axis data from the sensor on an Arduino.</li>
<li><a href="http://bit.ly/2n57pkD" target="_blank">Arduino: Gesture Example</a> – How to read gestures with an Arduino.</li>
<li><a href="http://bit.ly/2mPsvBu" target="_blank">PC: ZX Example</a> – How to read Z- and X- axis data on a Windows computer.</li>
<li><a href="http://bit.ly/2n55X21" target="_blank">Resources and Going Further</a> – This section gives you some additional resources for getting more use out of the ZX Sensor.</li>
</ul>
<h3>Materials Used</h3>
<p>In addition to the sensor itself, you will need a few extra components to follow along with the Arduino examples:</p>
<div>
<div id="wish-list-113932" class="sfe-wish-list">
<div class="sfe-title"><a href="http://bit.ly/2mPuDsS" target="_blank"><strong>ZX Gesture and Distance Sensor Hookup Guide</strong> <span class="sfewl">SparkFun Wish List</span></a><br />
<form action="http://bit.ly/2n4Z0Og" method="post"><input class="btn btn-default" type="submit" value="Add all to cart" /></form>
</div>
<div class="sfe-inner">
<div class="sfe-row"><a href="http://bit.ly/2n4YeRk" target="_blank"><img alt="" class="sfe-thumbnail" height="58" src="http://bit.ly/2mPsvS0" width="58" /><span class="sfe-text"><span class="sfe-item-title">ZX Distance and Gesture Sensor<span class="sfe-sku">SEN-12780</span></span><span class="sfe-description">The ZX Distance and Gesture Sensor is a touchless sensor that is capable of looking for simple gestures. Developed in conjunction with [XYZ Interactiv…</span></span></a></div>
<div class="sfe-row"><a href="http://bit.ly/2n51xYL" target="_blank"><img alt="" class="sfe-thumbnail" height="58" src="http://bit.ly/2mPs4ad" width="58" /><span class="sfe-text"><span class="sfe-item-title">SparkFun USB Mini-B Cable – 6 Foot<span class="sfe-sku">CAB-11301</span></span><span class="sfe-description">This is a USB 2.0 type A to Mini-B 5-pin cable. You know, the mini-B connector that usually comes with USB Hubs, Cameras, MP3 players, etc. You can us…</span></span></a></div>
<div class="sfe-row"><a href="http://bit.ly/2n4Z1Sk" target="_blank"><img alt="" class="sfe-thumbnail" height="58" src="http://bit.ly/2mPehAQ" width="58" /><span class="sfe-text"><span class="sfe-item-title">SparkFun RedBoard – Programmed with Arduino<span class="sfe-sku">DEV-12757</span></span><span class="sfe-description">At SparkFun we use many Arduinos and we’re always looking for the simplest, most stable one. Each board is a bit different and no one board has everyt…</span></span></a></div>
<div class="sfe-row"><a href="http://bit.ly/2n56JMs" target="_blank"><img alt="" class="sfe-thumbnail" height="58" src="http://bit.ly/2mPkzQD" width="58" /><span class="sfe-text"><span class="sfe-item-title">Breadboard – Mini Modular (White)<span class="sfe-sku">PRT-12043</span></span><span class="sfe-description">This white Mini Breadboard is a great way to prototype your small projects! With 170 tie points there’s just enough room to build and test simple circ…</span></span></a></div>
<div class="sfe-row"><a href="http://bit.ly/24g3L7Y" target="_blank"><img alt="" class="sfe-thumbnail" height="58" src="http://bit.ly/2mPnE3a" width="58" /><span class="sfe-text"><span class="sfe-item-title">Jumper Wires Premium 6″ M/M Pack of 10<span class="sfe-sku">PRT-08431</span></span><span class="sfe-description">This is a SparkFun exclusive! These are 155mm long jumpers with male connectors on both ends. Use these to jumper from any female header on any board,…</span></span></a></div>
<div class="sfe-row"><a href="http://bit.ly/2n51A6T" target="_blank"><img alt="" class="sfe-thumbnail" height="58" src="http://bit.ly/2mPcETv" width="58" /><span class="sfe-text"><span class="sfe-item-title">Break Away Headers – Straight<span class="sfe-sku">PRT-00116</span></span><span class="sfe-description">A row of headers – break to fit. 40 pins that can be cut to any size. Used with custom PCBs or general custom headers.**Features: *** Pin Style: Squar…</span></span></a></div>
<div class="sfe-footer"><a class="button" href="http://bit.ly/2mPuDsS" target="_blank">VIEW <strong>ZX GESTURE AND DISTANCE SENSOR HOOKUP GUIDE</strong> ON SPARKFUN.COM</a></div>
</div>
</div>
</div>
<p>If you would like to try the ZX Sensor on a Windows-based PC, you will need an FTDI Breakout:</p>
<div>
<div class="tile product-tile has_addl_actions grid" data-id="9716">
<div class="actions-wrap"><a class="thumb" href="http://bit.ly/2n55Wet" target="_blank"><img alt="SparkFun FTDI Basic Breakout - 5V" height="140" src="http://bit.ly/2mPCres" /></a></div>
<div class="main">
<h3 class="title"><a href="http://bit.ly/2n55Wet" target="_blank">SparkFun FTDI Basic Breakout – 5V</a></h3>
<p><span class="bubbles"><a data-toggle="notify" href="http://bit.ly/2n4YjVi" target="_blank" title="in stock"><span class="sfe-icon-stock-in"><span class="visuallyhidden">In stock</span></span></a></span> <span class="sku">DEV-09716</span></p>
</div>
<div>
<div class="prices"><span class="price price-sale calculated">$14.95</span></div>
</div>
<p><span class="star_rating"><span class="count">87</span></span></p>
</div>
</div>
<div class="clearfix"></div>
<h3>Recommended Reading</h3>
<p>There are a few concepts that you should be familiar with before getting started with the ZX Sensor. Consider reading some of these tutorials before continuing:</p>
<ul>
<li><a href="http://bit.ly/2mPs4qZ" target="_blank">What is an Arduino?</a> – Two of the examples use an Arduino to control the ZX Sensor</li>
<li><a href="http://bit.ly/1r9FXRc" target="_blank">I<sup>2</sup>C</a> – I<sup>2</sup>C is the one of the protocols used by the ZX Sensor</li>
<li><a href="http://bit.ly/1ToVAex" target="_blank">Serial Communication</a> – We use serial communications to program the Arduino, view debugging information, and transmit data from the ZX Sensor</li>
<li><a href="http://bit.ly/2kamGiX" target="_blank">How to Use a Breadboard</a> – The breadboard ties the Arduino to the ZX Sensor</li>
<li><a href="http://bit.ly/2mPqpS0" target="_blank">How to Install FTDI Drivers</a> – If you are programming an Arduino or using the ZX Sensor demo app, chances are you will need to use an FTDI</li>
</ul>
</div>
<div class="section tutorial-page">
<h2 id="board-overview">Board Overview</h2>
<p>The ZX Sensor works by bouncing infrared (IR) beams of <a href="http://bit.ly/1VNpzU4" itemprop="url" target="_bank" title="light"><strong>light</strong></a> from the two LEDs on either side off of an object above the sensor. The bounced <a href="http://bit.ly/1T1Ll2n" itemprop="url" target="_bank" title="Create your own musical light show with Raspberry Pi"><strong>light</strong></a> returns to the receiver in the center of the sensor, and a microcontroller on the back of the sensor interprets the data. We can read the results using an I<sup>2</sup>C or UART connection.</p>
<h3>Pin Descriptions</h3>
<p>The ZX Sensor gives us 2 ports to connect to: I<sup>2</sup>C and UART.</p>
<p><a href="http://bit.ly/2n57NQc" target="_blank"><img alt="ZX Sensor front" src="http://bit.ly/2n57NQc" /></a></p>
<center>
<table class="pin_table">
<tbody>
<tr>
<th>Pin Label</th>
<th>Description</th>
</tr>
<tr>
<td>GRN</td>
<td>Not used</td>
</tr>
<tr>
<td>TXO</td>
<td>UART transmit out from the ZX Sensor</td>
</tr>
<tr>
<td>RXI</td>
<td>UART receive. Not used at this time.</td>
</tr>
<tr>
<td>VCC</td>
<td>3.3 – 5 V power supply</td>
</tr>
<tr>
<td>GND</td>
<td>Connect to ground</td>
</tr>
<tr>
<td>BLK</td>
<td>Not used, but connected to GND</td>
</tr>
<tr>
<td>DR</td>
<td>Data Ready. High when there is data to be read via I<sup>2</sup>C</td>
</tr>
<tr>
<td>CL</td>
<td>I<sup>2</sup>C clock</td>
</tr>
<tr>
<td>DA</td>
<td>I<sup>2</sup>C data</td>
</tr>
</tbody>
</table>
</center>
<h3>Setting the Jumpers</h3>
<p>The ZX Sensor has a couple of jumpers on the back of the board that can be opened or closed with a soldering iron.</p>
<p><a href="http://bit.ly/2mPkMDw" target="_blank"><img alt="ZX Sensor back" src="http://bit.ly/2mPkMDw" /></a></p>
<p><strong>I2C Pullups</strong> – The ZX Sensor, by default, comes with 4.7 kΩ pull-up resistors on the SDA and SCL I<sup>2</sup>C lines. Remove the solder on this jumper to disconnect the pull-ups.</p>
<p><strong>I2C Addr</strong> – By default, this jumper is open. Close it to change the I<sup>2</sup>C address of the sensor.</p>
<center>
<table class="pin_table">
<tbody>
<tr>
<th>Jumper</th>
<th>I<sup>2</sup>C Address</th>
</tr>
<tr>
<td>Open</td>
<td>0x10</td>
</tr>
<tr>
<td>Closed</td>
<td>0x11</td>
</tr>
</tbody>
</table>
</center>
<h3>The Infrared Shields</h3>
<p>See those little brass tubes on the LEDs? They are needed to block any IR light going directly from the LEDs (inside the brass tubes) to the receiver (the black domed component in the center of the sensor). We want the light to bounce off an object first.</p>
<p><a href="http://bit.ly/2n58ngN" target="_blank"><img alt="LED blinders" src="http://bit.ly/2mPhBMb" /></a></p>
<p>They are held on with Super Glue. You can remove them, but it might require a bit of <a href="http://bit.ly/2n5aPUT" target="_blank">acetone</a>. If you plan to mount the ZX Sensors in your own housing, make sure IR light can’t travel directly from the sides of the LEDs to the receiver (i.e. you will want to make your own IR shields).</p>
</div>
<div class="section tutorial-page">
<h2 id="hardware-hookup">Hardware Hookup</h2>
<h3>Add Headers</h3>
<p><a href="http://bit.ly/2mPjY1B" target="_blank">Solder</a> a row of <a href="http://bit.ly/2n51A6T" target="_blank">break away male headers</a> to the 9 headers holes on the board.</p>
<p><a href="http://bit.ly/2n5kV7X" target="_blank"><img alt="Solder headers onto the ZX Sensor" src="http://bit.ly/2mPtXnw" /></a></p>
<h3>Connect the Breakout Board</h3>
<p>For the Arduino examples, we will be using I<sup>2</sup>C. Connect the breakout board to the following RedBoard pins:</p>
<p><a href="http://bit.ly/2n57ODK" target="_blank"><img alt="ZX Sensor to Arduino Fritzing diagram" src="http://bit.ly/2mPkUmp" /></a></p>
<center>
<table class="connection_table">
<tbody>
<tr>
<th>ZX Sensor</th>
<th>RedBoard</th>
</tr>
<tr>
<td>VCC</td>
<td>5V</td>
</tr>
<tr>
<td>GND</td>
<td>GND</td>
</tr>
<tr>
<td>DR</td>
<td>2</td>
</tr>
<tr>
<td>CL</td>
<td>A5</td>
</tr>
<tr>
<td>DA</td>
<td>A4</td>
</tr>
</tbody>
</table>
</center>
<br />
Note that we connect the DR pin, but we will only use it in the <a href="http://bit.ly/2n57pkD" target="_blank">Arduino: Gesture Example</a>. DR stands for “Data Ready,” which is active high whenever data is ready to be read from the ZX Sensor. We can attach this to an Arduino interrupt so we don’t have to continuously poll the sensor.
<p><a href="http://bit.ly/2n58o4l" target="_blank"><img alt="ZX Sensor connected to RedBoard" src="http://bit.ly/2mPnOYm" /></a></p>
</div>
<div class="section tutorial-page">
<h2 id="arduino-library-installation">Arduino <a href="http://bit.ly/2730gk8" itemprop="url" target="_bank" title="Library"><strong>Library</strong></a> Installation</h2>
<p>All of the hard work for the ZX Sensor is being accomplished in the microcontroller on the sensor itself. All we need to do is read the results! We have created an Arduino library to make that even easier for you. Click the button to download the latest version of the ZX Sensor Arduino Library.</p>
<p><a class="btn btn-default" href="http://bit.ly/2mPsVI8" target="_blank">DOWNLOAD THE ZX SENSOR ARDUINO LIBRARY!</a></p>
<p>Unzip the downloaded file. Follow <a href="http://bit.ly/2n5b5TE" target="_blank">this guide on installing Arduino libraries</a> to install the files as an Arduino library.</p>
</div>
<div class="section tutorial-page">
<h2 id="arduino-zx-example">Arduino: ZX Example</h2>
<h3>Load the ZX Demo</h3>
<p>Open up the Arduino program and select File → Examples → SparkFun_ZX_Distance_and_Gesture_Sensor → I2C_ZX_Demo.</p>
<p><a href="http://bit.ly/2mPs4qJ" target="_blank"><img alt="I2C ZX Demo" src="http://bit.ly/2n54Hfh" /></a></p>
<p>Attach a <a href="http://bit.ly/2n51xYL" target="_blank">USB mini</a> cable from your computer to the RedBoard. If you have not previously done so, <a href="http://bit.ly/2mPqpS0" target="_blank">install the FTDI drivers</a>.</p>
<div class="ezAdsense adsense adsense-midtext" style="text-align:center;margin:12px;"><script async="" src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js" type="text/javascript">
</script> <ins class="adsbygoogle" style="display:block" data-ad-client="ca-pub-2979805726071943" data-ad-slot="7471922310" data-ad-format="auto"></ins> <script type="text/javascript">
//<![CDATA[
(adsbygoogle = window.adsbygoogle || []).push({});
//]]>
</script></div>
<p>For reference, here is the <code>I2C_ZX_Demo.ino</code> sketch.</p>
<div class="copy-code" data-code-id="code-0"><button class="btn btn-default btn-sm">COPY CODE</button></div>
<pre data-language="language:c ,c">
<code class="rainbow">    <span class="comment">/****************************************************************
I2C_ZX_Demo.ino
XYZ Interactive ZX Sensor
Shawn Hymel @ SparkFun Electronics
May 6, 2015
http://bit.ly/2mPCqXW

Tests the ZX sensor's ability to read ZX data over I2C. This demo
configures the ZX sensor and periodically polls for Z-axis and X-axis data.

Hardware Connections:

Arduino Pin  ZX Sensor Board  Function
 ---------------------------------------
 5V           VCC              Power
 GND          GND              Ground
 A4           DA               I2C Data
 A5           CL               I2C Clock

Resources:
Include Wire.h and ZX_Sensor.h

Development environment specifics:
Written in Arduino 1.6.3
Tested with a SparkFun RedBoard

This code is beerware; if you see me (or any other SparkFun 
employee) at the local, and you've found our code helpful, please
buy us a round!

Distributed as-is; no warranty is given.
****************************************************************/</span>

<span class="comment">#include <Wire.h></span>
<span class="comment">#include <ZX_Sensor.h></span>

<span class="comment">// Global Variables</span>
ZX_Sensor zx_sensor <span class="keyword operator">=</span> <span class="function call">ZX_Sensor</span>(ZX_ADDR);
uint8_t x_pos;
uint8_t z_pos;

<span class="keyword">void</span> <span class="function call">setup</span>() {

uint8_t ver;

<span class="comment">// Initialize Serial port</span>
  Serial.<span class="function call">begin</span>(<span class="constant numeric">9600</span>);
  Serial.<span class="function call">println</span>();
  Serial.<span class="function call">println</span>(<span class="string">"-----------------------------------"</span>);
  Serial.<span class="function call">println</span>(<span class="string">"SparkFun/GestureSense - I2C ZX Demo"</span>);
  Serial.<span class="function call">println</span>(<span class="string">"-----------------------------------"</span>);

<span class="comment">// Initialize ZX Sensor (configure I2C and read model ID)</span>
  <span class="keyword">if</span> ( zx_sensor.<span class="function call">init</span>() ) {
    Serial.<span class="function call">println</span>(<span class="string">"ZX Sensor initialization complete"</span>);
  } <span class="keyword">else</span> {
    Serial.<span class="function call">println</span>(<span class="string">"Something went wrong during ZX Sensor init!"</span>);
  }

<span class="comment">// Read the model version number and ensure the library will work</span>
  ver <span class="keyword operator">=</span> zx_sensor.<span class="function call">getModelVersion</span>();
  <span class="keyword">if</span> ( ver <span class="keyword operator">=</span><span class="keyword operator">=</span> ZX_ERROR ) {
    Serial.<span class="function call">println</span>(<span class="string">"Error reading model version number"</span>);
  } <span class="keyword">else</span> {
    Serial.<span class="keyword">print</span>(<span class="string">"Model version: "</span>);
    Serial.<span class="function call">println</span>(ver);
  }
  <span class="keyword">if</span> ( ver <span class="keyword operator">!</span><span class="keyword operator">=</span> ZX_MODEL_VER ) {
    Serial.<span class="keyword">print</span>(<span class="string">"Model version needs to be "</span>);
    Serial.<span class="keyword">print</span>(ZX_MODEL_VER);
    Serial.<span class="keyword">print</span>(<span class="string">" to work with this library. Stopping."</span>);
    <span class="keyword">while</span>(<span class="constant numeric">1</span>);
  }

<span class="comment">// Read the register map version and ensure the library will work</span>
  ver <span class="keyword operator">=</span> zx_sensor.<span class="function call">getRegMapVersion</span>();
  <span class="keyword">if</span> ( ver <span class="keyword operator">=</span><span class="keyword operator">=</span> ZX_ERROR ) {
    Serial.<span class="function call">println</span>(<span class="string">"Error reading register map version number"</span>);
  } <span class="keyword">else</span> {
    Serial.<span class="keyword">print</span>(<span class="string">"Register Map Version: "</span>);
    Serial.<span class="function call">println</span>(ver);
  }
  <span class="keyword">if</span> ( ver <span class="keyword operator">!</span><span class="keyword operator">=</span> ZX_REG_MAP_VER ) {
    Serial.<span class="keyword">print</span>(<span class="string">"Register map version needs to be "</span>);
    Serial.<span class="keyword">print</span>(ZX_REG_MAP_VER);
    Serial.<span class="keyword">print</span>(<span class="string">" to work with this library. Stopping."</span>);
    <span class="keyword">while</span>(<span class="constant numeric">1</span>);
  }
}

<span class="keyword">void</span> <span class="function call">loop</span>() {

<span class="comment">// If there is position data available, read and print it</span>
  <span class="keyword">if</span> ( zx_sensor.<span class="function call">positionAvailable</span>() ) {
    x_pos <span class="keyword operator">=</span> zx_sensor.<span class="function call">readX</span>();
    <span class="keyword">if</span> ( x_pos <span class="keyword operator">!</span><span class="keyword operator">=</span> ZX_ERROR ) {
      Serial.<span class="keyword">print</span>(<span class="string">"X: "</span>);
      Serial.<span class="keyword">print</span>(x_pos);
    }
    z_pos <span class="keyword operator">=</span> zx_sensor.<span class="function call">readZ</span>();
    <span class="keyword">if</span> ( z_pos <span class="keyword operator">!</span><span class="keyword operator">=</span> ZX_ERROR ) {
      Serial.<span class="keyword">print</span>(<span class="string">" Z: "</span>);
      Serial.<span class="function call">println</span>(z_pos);
    }
  }
}
</code>
</pre>
<h3>Run</h3>
<p>Make sure you have the correct serial port selected under Tools → Serial Port and “Arduino Uno” selected under Tools → Board. If you have never used the Arduino IDE before, <a href="http://bit.ly/2n54I2P" target="_blank">this turoial</a> should get you started.</p>
<p>Click the Upload button and wait for the program to finish uploading to the Arduino. Select Tools → Serial Monitor to open up the serial terminal. More info on the Serial Terminal can be found <a href="http://bit.ly/2mPsw8w" target="_blank">here</a>. Note that the Serial Monitor settings are the default settings (9600, 8, n, 1). You should see a couple of messages noting that “ZX Sensor initialization complete.”</p>
<p><a href="http://bit.ly/2n5cJ7Q" target="_blank"><img alt="ZX Sensor initialization" src="http://bit.ly/2n5cJ7Q" /></a></p>
<p>Hover your <a href="http://bit.ly/2dBP8pn" itemprop="url" target="_bank" title="hand"><strong>hand</strong></a> 4 to 10 inches (10 to 25 cm) above the sensor.</p>
<p><a href="http://bit.ly/2n52uQV" target="_blank"><img alt="Move your hand above the ZX Sensor" src="http://bit.ly/2mPei7S" /></a></p>
<p>Move your <a href="http://bit.ly/1PhUuAm" itemprop="url" target="_bank" title="ANIMATRONIC ROBOTIC HAND"><strong>hand</strong></a> around above the sensor, and you should see Z (height above the sensor) and X (position side to side) appear in the serial terminal.</p>
<p><a href="http://bit.ly/2mPtiCv" target="_blank"><img alt="ZX Sensor showing position data" src="http://bit.ly/2mPtiCv" /></a></p>
<div class="alert alert-info"><b>NOTE:</b> Z- and X- data is given as an unsigned integer between 0 and 240 (inclusive).</div>
</div>
<div class="section tutorial-page">
<h2 id="arduino-gesture-example">Arduino: Gesture Example</h2>
<h3>Load the Gesture Interrupt Demo</h3>
<p>In addition to providing Z- and X- axis data about an object, the ZX Sensor is also capable of detecting simple gestures. To see an example of this, open File → Examples → SparkFun_ZX_Distance_and_Gesture_Sensor → I2C_Gesture_Interrupt.</p>
<p><a href="http://bit.ly/2n52X5B" target="_blank"><img alt="ZX Sensor Gesture Demo" src="http://bit.ly/2mPkMn0" /></a></p>
<p>Here is the <code>I2C_Gesture_Interrupt.ino</code> sketch for reference.</p>
<div class="copy-code" data-code-id="code-1"><button class="btn btn-default btn-sm">COPY CODE</button></div>
<pre data-language="language:c ,c">
<code class="rainbow">    <span class="comment">/****************************************************************
I2C_Gesture_Interrupt.ino
XYZ Interactive ZX Sensor
Shawn Hymel @ SparkFun Electronics
May 6, 2015
http://bit.ly/2mPCqXW

Tests the ZX sensor's ability to read gesture data over I2C using 
an interrupt pin. This program configures I2C and sets up an
interrupt to occur whenever the ZX Sensor throws its DR pin high.
The gesture is displayed along with its "speed" (how long it takes
to complete the gesture). Note that higher numbers of "speed"
indicate a slower speed.

Hardware Connections:

Arduino Pin  ZX Sensor Board  Function
 ---------------------------------------
 5V           VCC              Power
 GND          GND              Ground
 A4           DA               I2C Data
 A5           CL               I2C Clock
 2            DR               Data Ready

Resources:
Include Wire.h and ZX_Sensor.h

Development environment specifics:
Written in Arduino 1.6.3
Tested with a SparkFun RedBoard

This code is beerware; if you see me (or any other SparkFun 
employee) at the local, and you've found our code helpful, please
buy us a round!

Distributed as-is; no warranty is given.
****************************************************************/</span>

<span class="comment">#include <Wire.h></span>
<span class="comment">#include <ZX_Sensor.h></span>

<span class="comment">// Constants</span>
<span class="keyword">const</span> <span class="keyword">int</span> ZX_ADDR <span class="keyword operator">=</span> <span class="constant numeric">0x10</span>;    <span class="comment">// ZX Sensor I2C address</span>
<span class="keyword">const</span> <span class="keyword">int</span> INTERRUPT_NUM <span class="keyword operator">=</span> <span class="constant numeric">0</span>; <span class="comment">// Pin 2 on the UNO</span>

<span class="comment">// Global Variables</span>
ZX_Sensor zx_sensor <span class="keyword operator">=</span> <span class="function call">ZX_Sensor</span>(ZX_ADDR);
volatile GestureType gesture;
volatile <span class="keyword">bool</span> interrupt_flag;
uint8_t gesture_speed;

<span class="keyword">void</span> <span class="function call">setup</span>() {

uint8_t ver;

<span class="comment">// Initialize gesture to no gesture</span>
  gesture <span class="keyword operator">=</span> NO_GESTURE;

<span class="comment">// Initialize Serial port</span>
  Serial.<span class="function call">begin</span>(<span class="constant numeric">9600</span>);
  Serial.<span class="function call">println</span>();
  Serial.<span class="function call">println</span>(<span class="string">"---------------------------------------------"</span>);
  Serial.<span class="function call">println</span>(<span class="string">"SparkFun/GestureSense - I2C Gesture Interrupt"</span>);
  Serial.<span class="function call">println</span>(<span class="string">"Note: higher 'speed' numbers mean slower"</span>);
  Serial.<span class="function call">println</span>(<span class="string">"---------------------------------------------"</span>);

<span class="comment">// Initialize ZX Sensor (configure I2C and read model ID)</span>
  <span class="keyword">if</span> ( zx_sensor.<span class="function call">init</span>(GESTURE_INTERRUPTS) ) {
    Serial.<span class="function call">println</span>(<span class="string">"ZX Sensor initialization complete"</span>);
  } <span class="keyword">else</span> {
    Serial.<span class="function call">println</span>(<span class="string">"Something went wrong during ZX Sensor init!"</span>);
  }

<span class="comment">// Initialize interrupt service routine</span>
  interrupt_flag <span class="keyword operator">=</span> <span class="constant language">false</span>;
  zx_sensor.<span class="function call">clearInterrupt</span>();
  <span class="function call">attachInterrupt</span>(INTERRUPT_NUM, interruptRoutine, RISING);
  Serial.<span class="function call">println</span>(<span class="string">"Interrupts now configured. Gesture away!"</span>);
}

<span class="keyword">void</span> <span class="function call">loop</span>() {

<span class="comment">// If we have an interrupt, read and print the gesture</span>
  <span class="keyword">if</span> ( interrupt_flag ) {

<span class="comment">// Clear the interrupt flag</span>
    interrupt_flag <span class="keyword operator">=</span> <span class="constant language">false</span>;

<span class="comment">// You MUST read the STATUS register to clear interrupt!</span>
    zx_sensor.<span class="function call">clearInterrupt</span>();

<span class="comment">// Read last gesture</span>
    gesture <span class="keyword operator">=</span> zx_sensor.<span class="function call">readGesture</span>();
    gesture_speed <span class="keyword operator">=</span> zx_sensor.<span class="function call">readGestureSpeed</span>();
    <span class="keyword">switch</span> ( gesture ) {
      <span class="keyword">case</span> NO_GESTURE:
        Serial.<span class="function call">println</span>(<span class="string">"No Gesture"</span>);
        <span class="keyword">break</span>;
      <span class="keyword">case</span> RIGHT_SWIPE:
        Serial.<span class="keyword">print</span>(<span class="string">"Right Swipe. Speed: "</span>);
        Serial.<span class="function call">println</span>(gesture_speed, DEC);
        <span class="keyword">break</span>;
      <span class="keyword">case</span> LEFT_SWIPE:
        Serial.<span class="keyword">print</span>(<span class="string">"Left Swipe. Speed: "</span>);
        Serial.<span class="function call">println</span>(gesture_speed, DEC);
        <span class="keyword">break</span>;
      <span class="keyword">case</span> UP_SWIPE:
        Serial.<span class="keyword">print</span>(<span class="string">"Up Swipe. Speed: "</span>);
        Serial.<span class="function call">println</span>(gesture_speed, DEC);
        <span class="keyword">break</span>;
      default:
        <span class="keyword">break</span>;
    }
  }
}

<span class="keyword">void</span> <span class="function call">interruptRoutine</span>() {
  interrupt_flag <span class="keyword operator">=</span> <span class="constant language">true</span>;
}
</code>
</pre>
<h3>Run</h3>
<p>Upload the sketch, and open the Serial Monitor. You should see a message stating that initialization is complete.</p>
<p><a href="http://bit.ly/2n56f8V" target="_blank"><img alt="ZX Sensor Gesture initialization" src="http://bit.ly/2n56f8V" /></a></p>
<p>Start with your hand off to one side (a “side” being the one of the infrared LEDs with the brass covers) about 4 to 10 inches (10 to 25 cm) above the sensor. Swipe your hand horizontally across the sensor so that your hand passes over the one infrared LED and then the next infrared LED.</p>
<p><a href="http://bit.ly/2mPkAnF" target="_blank"><img alt="Move your hand from one side to the other" src="http://bit.ly/2n5eG4e" /></a></p>
<p>If you performed the gesture correctly, you should see a message appear in the Serial Monitor.</p>
<p><a href="http://bit.ly/2mPhBvF" target="_blank"><img alt="Performing gestures with the ZX Sensor" src="http://bit.ly/2mPhBvF" /></a></p>
<div class="alert alert-info"><b>NOTE:</b> The “Speed” of the gesture is a measure of how fast the gesture occurred. Note that the <i>lower</i> the number, the <i>faster</i> the gesture occurred (e.g. 3 being very fast and 25 being very slow).</div>
<h3>Supported Gestures</h3>
<p>Here is a list of the currently supported gestures. Make sure each gesture begins outside of the range of the sensor, moves into the range of the sensor, and ends outside the range of the sensor.</p>
<center>
<table class="gesture_table">
<tbody>
<tr>
<th>Gesture</th>
<th>Description</th>
</tr>
<tr>
<td>Right Swipe</td>
<td>A swipe from the left side of the board to the right and out of range of the sensor. Make sure that your wrist/arm is not in the sensor’s range at the end of the swipe!</td>
</tr>
<tr>
<td>Left Swipe</td>
<td>A swipe from the right side of the board to the left and out of range of the sensor.</td>
</tr>
<tr>
<td>Up Swipe</td>
<td>Object starts near the sensor, hovers for at least 1 second, and then moves up above and out of range of the sensor.</td>
</tr>
<tr>
<td>No Gesture</td>
<td>The sensor could not correctly determine the gesture being performed.</td>
</tr>
</tbody>
</table>
</center>
</div>
<div class="section tutorial-page">
<h2 id="pc-zx-example">PC: ZX Example</h2>
<p>The ZX Sensor, in addition to responding to I<sup>2</sup>C commands, continually transmits ZX data over its UART port. We can connect an <a href="http://bit.ly/2n55Wet" target="_blank">FTDI Breakout</a> directly to the ZX Sensor and read the output. You can use <a href="http://bit.ly/2mPsw8w" target="_blank">serial applications</a> or the <a href="http://bit.ly/2n57ox5" target="_blank">screen command</a> (Linux or Mac) to view the output.</p>
<div class="alert alert-info"><b>NOTE:</b> You can use either 3.3 V or 5 V FTDI. 5 V gives you a bit better range with the sensor.</div>
<p>If you are on a Windows computer, you can use the demo application (linked below) provided by XYZ Interactive to test the ZX Sensor.</p>
<h3>Setup</h3>
<p>Connect the FTDI Breakout board to the ZX Sensor. Ensure the pins on the FTDI Brekaout line up with the pins on the ZX Sensor (e.g. GRN connects to GRN and BLK connects to BLK). Connect the FTDI Breakout to your computer with a USB cable.</p>
<p><a href="http://bit.ly/2mPs7Da" target="_blank"><img alt="ZX Sensor connected to FTDI breakout board" src="http://bit.ly/2n5aOQP" /></a></p>
<p>Download the ZX Demo application, and unzip it.</p>
<p><a class="btn btn-default" href="http://bit.ly/2mPs4Y1" target="_blank">DOWNLOAD THE ZX DEMO APPLICATION</a></p>
<h3>Run</h3>
<p>Double-click to run the ZX Demo application. Under “Input:” on the right side, drop down the list and select the COM port that corresponds to your FTDI Breakout (if you need a refresher on find the right COM port, check out <a href="http://bit.ly/2n57pB9" target="_blank">this section</a> of the Terminal Basics tutorial). You do not need to choose an “Output:” port.</p>
<p>Click <strong>Open</strong> to connect to the FTDI Breakout.</p>
<p><a href="http://bit.ly/2mPtX70" target="_blank"><img alt="ZX Sensor demo application" src="http://bit.ly/2n5cKbU" /></a></p>
<p>Move your hand around above the sensor, and you should see the red ball move.</p>
<p><a href="http://bit.ly/2mPkU5T" target="_blank"><img alt="Using the ZX Sensor connected to a computer" src="http://bit.ly/2n51ThY" /></a></p>
<p>Try out the other tabs in the application! The Z-Control tab lets your try moving your hand toward and away from the sensor, and the Gestures tab computes a few different gestures based on the Z- and X- data.</p>
</div>
<div class="section tutorial-page">
<h2 id="resources-and-going-further">Resources and Going Further</h2>
<p>After trying the basic ZX and gesture demos, you can try the other examples in the Arduino library. A description of each of the examples is given below:</p>
<ul>
<li><strong>I2C_Gesture_Demo</strong> – Poll the sensor over I<sup>2</sup>C to see if any gestures have occurred.</li>
<li><strong>I2C_Gesture_Interrupt</strong> – The DR pin will go from low to high when a gesture is detected. This example reads the gesture over I2C and tells the sensor to clear DR.</li>
<li><strong>I2C_ZX_Demo</strong> – Poll the sensor periodically over I<sup>2</sup>C for Z- and X- axis data.</li>
<li><strong>I2C_ZX_Interrupt</strong> – The ZX Sensor will throw DR high whenever valid ZX data is ready.</li>
<li><strong>UART_Gesture_Demo</strong> – <strong>NOTE:</strong> Gestures over UART are not supported at this time. This demo is a placeholder for the time being.</li>
<li><strong>UART_ZX_Demo</strong> – Read Z- and X- axis data from a software serial port and display them on the Serial Monitor.</li>
</ul>
<h3>Resources</h3>
<p>Here are some additional resources to help you with the ZX Sensor:</p>
<ul>
<li><a href="http://bit.ly/2mPDsmN" target="_blank">ZX Sensor Datasheet</a></li>
<li><a href="http://bit.ly/2n4Z14M" target="_blank">Using the ZX Sensor with Arduino</a></li>
<li><a href="http://bit.ly/2mPcGL7" target="_blank">ZX Sensor Schematic</a></li>
<li><a href="http://bit.ly/2n51yMj" target="_blank">ZX Sensor GitHub Repository</a></li>
<li><a href="http://bit.ly/2mPntVR" target="_blank">ZX Sensor I2C Register Map</a></li>
</ul>
</div>
<div id="huge-it-share-buttons-top" class="huge-it-share-buttons nobackground">
<h3>Share This:</h3>
<ul class="huge-it-share-buttons-list">
<li class=" nobackground"><a href="http://bit.ly/1XReO0c" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/1XReO0c','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -0px -120px" target="_blank"></a></li>
<li class=" nobackground"><a href="https://twitter.com/share?status=http://yoursmart.mobi/feed&text=ZX%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('https://twitter.com/share?status=http://yoursmart.mobi/feed&text=ZX Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -30px -120px" target="_blank"></a></li>
<li class=" nobackground"><a href="http://bit.ly/2n4YgbU%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2n4YgbU Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -60px -120px" target="_blank"></a></li>
<li class=" nobackground"><a href="http://bit.ly/1XReO0d" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/1XReO0d','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -90px -120px" target="_blank"></a></li>
<li class=" nobackground"><a href="http://bit.ly/2mPuDJo%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide&mini=true&url=http://bit.ly/1XReO0g" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2mPuDJo Distance and Gesture Sensor Hookup Guide&mini=true&url=http://bit.ly/1XReO0g','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -120px -120px" target="_blank"></a></li>
<li class=" nobackground"><a href="http://bit.ly/2n51zjl%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2n51zjl Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -150px -120px" target="_blank"></a></li>
<li class=" nobackground"><a href="http://di.gg/2mPqq8w%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://di.gg/2mPqq8w Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -180px -120px" target="_blank"></a></li>
<li class=" nobackground"><a href="http://stumble.it/2n52Xm7%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://stumble.it/2n52Xm7 Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -210px -120px" target="_blank"></a></li>
<li class=" nobackground"><a href="http://bit.ly/1XReO0l" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/1XReO0l','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -240px -120px" target="_blank"></a></li>
<li class="none nobackground"><a href="http://bit.ly/2mPkMU2%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2mPkMU2 Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -270px -120px" target="_blank"></a></li>
<li class="none nobackground"><a href="http://bit.ly/2n59w8q%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2n59w8q Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -300px -120px" target="_blank"></a></li>
<li class="none nobackground"><a href="http://bit.ly/1VNpzTU" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/1VNpzTU','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -330px -120px" target="_blank"></a></li>
<li class="none nobackground"><a href="http://bit.ly/2mPcFa1%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2mPcFa1 Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -360px -120px" target="_blank"></a></li>
<li class="none nobackground"><a href="http://bit.ly/1VNpzTX" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/1VNpzTX','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -390px -120px" target="_blank"></a></li>
<li class="none nobackground"><a href="http://bit.ly/2n59BsF%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2n59BsF Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -420px -120px" target="_blank"></a></li>
<li class="none nobackground"><a href="http://bit.ly/2mPkUCV%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide&pic=&ralateUid=&" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2mPkUCV Distance and Gesture Sensor Hookup Guide&pic=&ralateUid=&','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -450px -120px" target="_blank"></a></li>
<li class="none nobackground"><a href="http://bit.ly/2n55Xix%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2n55Xix Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -480px -120px" target="_blank"></a></li>
<li class="none nobackground"><a href="http://bit.ly/2mPhDDN%20Distance%20and%20Gesture%20Sensor%20Hookup%20Guide" id="backforunical958" name="backforunical958" onclick="javascript:void window.open('http://bit.ly/2mPhDDN Distance and Gesture Sensor Hookup Guide','1410949501326','width=700,height=500,toolbar=0,menubar=0,location=0,status=1,scrollbars=1,resizable=1,left=0,top=0');return false;" style="background-position: -510px -120px" target="_blank"></a></li>
</ul>
<div class="clear"></div>
</div>
View more at: <a href="http://bit.ly/1XReQFr">http://bit.ly/1XReQFr</a>

ZX Distance and Gesture Sensor Hookup Guide

Introduction The ZX Distance and Gesture Sensor is a collaboration product with XYZ Interactive . The very smart people at XYZ Interactiv...

ZX Distance and Gesture Sensor Hookup Guide

Contact Form