ST » Code » X_NUCLEO_6180XA1

Library to handle the X-NUCLEO-6180XA1 Proximity and ambient light sensor expansion board based on VL6180X.

Dependencies: X_NUCLEO_COMMON ST_INTERFACES

Dependents: HelloWorld_6180XA1 SunTracker_BLE Servo_6180XA1 BLE_HR_Light ... more

Fork of X_NUCLEO_6180XA1 by ST Expansion SW Team

X-NUCLEO-6180XA1 Proximity and Ambient Light Sensor Expansion Board Firmware Package

Introduction

This firmware package includes Components Device Drivers and Board Support Package for STMicroelectronics' X-NUCLEO-6180XA1 Proximity and ambient light sensor expansion board based on VL6180X.

Firmware Library

Class X_NUCLEO_6180XA1 is intended to represent the Proximity and ambient light sensor expansion board with the same name.

The expansion board is providing the support of the following components:

on-board VL6180X proximity and ambient light sensor,
up to three additional VL6180X Satellites,
on-board 4-digit display

It is intentionally implemented as a singleton because only one X-NUCLEO-VL6180XA1 at a time might be deployed in a HW component stack. In order to get the singleton instance you have to call class method `Instance()`, e.g.:

// Sensors expansion board singleton instance
static X_NUCLEO_6180XA1 *6180X_expansion_board = X_NUCLEO_6180XA1::Instance();

Arduino Connector Compatibility Warning

Using the X-NUCLEO-6180XA1 expansion board with the NUCLEO-F429ZI requires adopting the following patch:

to remove R46 resistor connected to A3 pin;
to solder R47 resistor connected to A5 pin.

Alternatively, you can route the Nucleo board’s A5 pin directly to the expansion board’s A3 pin with a wire. In case you patch your expansion board or route the pin, the interrupt signal for the front sensor will be driven on A5 pin rather than on A3 pin.

Example Applications

Components/STMPE1600/STMPE1600.h

Committer:: nikapov
Date:: 2017-08-21
Revision:: 58:1e9a3a46f814
Parent:: 57:fa4c622b04a7

File content as of revision 58:1e9a3a46f814:

/**
 ******************************************************************************
 * @file    STMPE1600.h
 * @author  AST / EST
 * @version V0.0.1
 * @date    14-April-2015
 * @brief   Header file for component stmpe1600
 ******************************************************************************
 * @attention
 *
 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright notice,
 *      this list of conditions and the following disclaimer in the documentation
 *      and/or other materials provided with the distribution.
 *   3. Neither the name of STMicroelectronics nor the names of its contributors
 *      may be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************
*/
#ifndef __STMPE1600_CLASS
#define __STMPE1600_CLASS
/* Includes ------------------------------------------------------------------*/
#include    "DevI2C.h"

#define STMPE1600_DEF_DEVICE_ADDRESS  (uint8_t)0x42*2   
#define STMPE1600_DEF_DIGIOUT_LVL      1

/**  STMPE1600 registr map **/
#define ChipID_0_7      (uint8_t)0x00
#define ChipID_8_15     (uint8_t)0x01
#define VersionId       (uint8_t)0x02
#define SYS_CTRL        (uint8_t)0x03
#define IEGPIOR_0_7	    (uint8_t)0x08
#define IEGPIOR_8_15	  (uint8_t)0x09
#define ISGPIOR_0_7	    (uint8_t)0x0A
#define ISGPIOR_8_15	  (uint8_t)0x0B
#define GPMR_0_7	      (uint8_t)0x10
#define GPMR_8_15	      (uint8_t)0x11
#define GPSR_0_7	      (uint8_t)0x12
#define GPSR_8_15	      (uint8_t)0x13
#define GPDR_0_7	      (uint8_t)0x14
#define GPDR_8_15	      (uint8_t)0x15
#define GPIR_0_7	      (uint8_t)0x16
#define GPIR_8_15	      (uint8_t)0x17

#define SOFT_RESET			(uint8_t)0x80

typedef enum {
    // GPIO Expander pin names
    GPIO_0=0,
    GPIO_1,
    GPIO_2,
    GPIO_3,            
    GPIO_4,
    GPIO_5,
    GPIO_6,
    GPIO_7,            
    GPIO_8,
    GPIO_9,
    GPIO_10,
    GPIO_11,            
    GPIO_12,
    GPIO_13,
    GPIO_14,
    GPIO_15,
	  NOT_CON
} exp_gpio_pin_name;   

typedef enum {
    INPUT = 0,
    OUTPUT,
    NOT_CONNECTED
} exp_gpio_pin_direction;


/* Classes -------------------------------------------------------------------*/

/**
 * Class representing a single stmpe1600 GPIO expander output pin
 */
class STMPE1600DigiOut {
public: 
    /** Constructor
     * @param[in] &i2c device I2C to be used for communication
     * @param[in] outpinname the desired out pin name to be created
     * @param[in] DevAddr the stmpe1600 I2C device addres (deft STMPE1600_DEF_DEVICE_ADDRESS)
     * @param[in] lvl the default ot pin level  
     */ 
	    STMPE1600DigiOut (DevI2C &i2c, exp_gpio_pin_name outpinname, uint8_t DevAddr=STMPE1600_DEF_DEVICE_ADDRESS, bool lvl=STMPE1600_DEF_DIGIOUT_LVL):
    _dev_i2c(&i2c),
    _expdevaddr(DevAddr),
    _exppinname(outpinname) 
    {
        uint8_t data[2];				
        if (_exppinname == NOT_CON) {
            return;
        }
        /* set the _exppinname as output */
        _dev_i2c->i2c_read(data, _expdevaddr, GPDR_0_7, 1);
        _dev_i2c->i2c_read(&data[1], _expdevaddr, GPDR_8_15, 1);			
        *(uint16_t*)data = *(uint16_t*)data | (1<<(uint16_t)_exppinname);  // set gpio as out 			
        _dev_i2c->i2c_write(data, _expdevaddr, GPDR_0_7, 1);
        _dev_i2c->i2c_write(&data[1], _expdevaddr, GPDR_8_15, 1);			
        write (lvl);
    }   

  	/**
  	 * @brief       Write on the out pin
  	 * @param[in]   lvl level to write
  	 * @return      0 on Success
  	 */			
    void write (int lvl) 
    {
        uint8_t data[2];			
			  if (_exppinname == NOT_CON) return;			
        /* set the _exppinname state to lvl */
        _dev_i2c->i2c_read(data, _expdevaddr, GPSR_0_7, 2);
        *(uint16_t*)data = *(uint16_t*)data & (uint16_t)(~(1<<(uint16_t)_exppinname));  // set pin mask 			
        if (lvl) *(uint16_t*)data = *(uint16_t*)data | (uint16_t)(1<<(uint16_t)_exppinname);
        _dev_i2c->i2c_write(data, _expdevaddr, GPSR_0_7, 2);
    }

  	/**
  	 * @brief       Overload assignement operator
  	 */					
    STMPE1600DigiOut& operator=(int lvl)
    {
        write (lvl);
        return *this;
    }		
		
private:
    DevI2C *_dev_i2c;
    uint8_t _expdevaddr;
    exp_gpio_pin_name _exppinname; 	
};

/* Classes -------------------------------------------------------------------*/
/** Class representing a single stmpe1600 GPIO expander input pin
 */
class STMPE1600DigiIn 
{	
public:
    /** Constructor
     * @param[in] &i2c device I2C to be used for communication
     * @param[in] inpinname the desired input pin name to be created
     * @param[in] DevAddr the stmpe1600 I2C device addres (deft STMPE1600_DEF_DEVICE_ADDRESS)
     */ 
    STMPE1600DigiIn (DevI2C &i2c, exp_gpio_pin_name inpinname, uint8_t DevAddr=STMPE1600_DEF_DEVICE_ADDRESS): _dev_i2c(&i2c), _expdevaddr(DevAddr), _exppinname(inpinname) 
    {
        uint8_t data[2];
        if (_exppinname == NOT_CON) return;			
        /* set the _exppinname as input pin direction */
        _dev_i2c->i2c_read(data, _expdevaddr, GPDR_0_7, 2);
        *(uint16_t*)data = *(uint16_t*)data & (uint16_t)(~(1<<(uint16_t) _exppinname));  // set gpio as in			
        _dev_i2c->i2c_write(data, _expdevaddr, GPDR_0_7, 2);
    }         

  	/**
  	 * @brief       Read the input pin
  	 * @return      The pin logical state 0 or 1
  	 */			
    bool read () {
        uint8_t data[2];
        if (_exppinname == NOT_CON) {
            return 0;						
        }

        /* read the _exppinname */
        _dev_i2c->i2c_read(data, _expdevaddr, GPMR_0_7, 2);
        *(uint16_t*)data = *(uint16_t*)data & (uint16_t)(1<<(uint16_t)_exppinname);  // mask the in gpio

        if (data[0] || data[1]) {
            return 1;
        }
        return 0;
    }
		
    operator int() {		
        return read();
    }		
		
private:
    DevI2C *_dev_i2c; 
    uint8_t _expdevaddr;
    exp_gpio_pin_name _exppinname;      
};


/* Classes -------------------------------------------------------------------*/

/**
 * Class representing a whole stmpe1600 component (16 gpio)
 */
class STMPE1600 {
public: 
    /** Constructor
    * @param[in] &i2c device I2C to be used for communication
    * @param[in] DevAddr the stmpe1600 I2C device addres (deft STMPE1600_DEF_DEVICE_ADDRESS)
    */ 
    STMPE1600 (DevI2C &i2c, uint8_t DevAddr=STMPE1600_DEF_DEVICE_ADDRESS ) : _dev_i2c(&i2c)
    { 
        _dev_i2c = &i2c;								
        _expdevaddr = DevAddr;
        write_sys_ctrl (SOFT_RESET);
			
        _gpdro_15 = (uint16_t)0;	// gpio dir all IN
        write_16_bit_reg (GPDR_0_7, &_gpdro_15);			
        _gpsro_15 = (uint16_t)0x0ffff;  // gpio status all 1
        write_16_bit_reg (GPSR_0_7, &_gpsro_15);			
    }

  	/**
  	 * @brief       Write the SYS_CTRL register 
  	 * @param[in]   Data to be written (bit fields)
  	 */		
    void write_sys_ctrl (uint8_t data)     // data = SOFT_RESET reset the device
    {
        _dev_i2c->i2c_write((uint8_t*)SYS_CTRL, _expdevaddr, data, 1);
    }
      
  	/**
  	 * @brief       Set the out pin
  	 * @param[in]   The pin name
  	 * @return      0 on Success
  	 */			
  	bool set_gpio (exp_gpio_pin_name pin_name) 
  	{
  		  if (pin_name == NOT_CON) return true;			
  		  _gpsro_15 = _gpsro_15 | ((uint16_t)0x0001<<pin_name);
  		  write_16_bit_reg (GPSR_0_7 , &_gpsro_15);
  		  return false;
  	}
  	
  	/**
  	 * @brief       Clear the out pin
  	 * @param[in]   The pin name
  	 * @return      0 on Success
  	 */			
  	bool clr_gpio (exp_gpio_pin_name pin_name) 
  	{
  		  if (pin_name == NOT_CON) return true;			
  		  _gpsro_15 = _gpsro_15 & (~((uint16_t)0x0001<<pin_name));
  		  write_16_bit_reg (GPSR_0_7 , &_gpsro_15);
  		  return false;
  	}		
  	
  	/**
  	 * @brief       Read the input pin
  	 * @param[in]   The pin name
  	 * @return      The logical pin level
  	 */					
  	bool rd_gpio (exp_gpio_pin_name pin_name) 
  	{				
  		  uint16_t gpmr0_15;
  		  if (pin_name == NOT_CON) return true;
  		  read_16_bit_reg (GPMR_0_7, &gpmr0_15);
  		  gpmr0_15 = gpmr0_15 & ((uint16_t)0x0001<<pin_name);
  		  if (gpmr0_15) {
            return true;
        }
  		  return false;			
  	}
	
  	/**
  	 * @brief       Set the pin direction
  	 * @param[in]   The pin name
  	 * @param[in]   The pin direction	 
  	 * @return      0 on success
  	 */
  	bool set_gpio_dir (exp_gpio_pin_name pin_name, exp_gpio_pin_direction pin_dir) 
  	{
        if (pin_name == NOT_CON || pin_dir == NOT_CONNECTED) {
            return true;
        }
        _gpdro_15 = _gpdro_15 & (~((uint16_t)0x0001<<pin_name));  // clear the Pin
        _gpdro_15 = _gpdro_15 | ((uint16_t)pin_dir<<pin_name);
        write_16_bit_reg (GPDR_0_7 , &_gpdro_15);
        return false;
  	}

  	/**
  	 * @brief       Read a 16 bits register
  	 * @param[in]   The register address
  	 * @param[in]   The pointer to the read data
  	 */					
    void read_16_bit_reg (uint8_t reg_16_addr, uint16_t *reg_16_data)
    {
        _dev_i2c->i2c_read((uint8_t*)reg_16_data, _expdevaddr, reg_16_addr, 2);	
    }				

  	/**
  	 * @brief       Write a 16 bits register
  	 * @param[in]   The register address
  	 * @param[in]   The pointer to the data to be written
  	 */							
    void write_16_bit_reg (uint8_t reg_16_addr, uint16_t *reg_16_data)
    {
        _dev_i2c->i2c_write((uint8_t*)reg_16_data, _expdevaddr, reg_16_addr, 2);	
    }		

private:					
    DevI2C *_dev_i2c; 	 
    uint16_t _gpdro_15;   // local copy of bit direction reg 
    uint16_t _gpsro_15;   // local copy of bit status reg 
    uint8_t _expdevaddr; // expander device i2c addr
};

#endif // __STMPE1600_CLASS

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	03 Dec 2015
Imports:	261
Forks:	5
Commits:	59
Dependents:	17
Dependencies:	2
Followers:	405

The code in this repository is Apache licensed.

Components

X-NUCLEO-6180XA1 Proximity and Ambient Light Sensor