ST / 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:

  1. on-board VL6180X proximity and ambient light sensor,
  2. up to three additional VL6180X Satellites,
  3. 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

Diff: Components/STMPE1600/STMPE1600.h

Revision:
58:1e9a3a46f814
Parent:
57:fa4c622b04a7
--- a/Components/STMPE1600/STMPE1600.h	Mon Mar 13 19:08:10 2017 +0000
+++ b/Components/STMPE1600/STMPE1600.h	Mon Aug 21 15:44:34 2017 +0000
@@ -104,7 +104,7 @@
      * @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),
+    _dev_i2c(&i2c),
     _expdevaddr(DevAddr),
     _exppinname(outpinname) 
     {
@@ -113,11 +113,11 @@
             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);			
+        _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);			
+        _dev_i2c->i2c_write(data, _expdevaddr, GPDR_0_7, 1);
+        _dev_i2c->i2c_write(&data[1], _expdevaddr, GPDR_8_15, 1);			
         write (lvl);
     }   
 
@@ -131,10 +131,10 @@
         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);
+        _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);
+        _dev_i2c->i2c_write(data, _expdevaddr, GPSR_0_7, 2);
     }
 
   	/**
@@ -147,7 +147,7 @@
     }		
 		
 private:
-    DevI2C &_dev_i2c;
+    DevI2C *_dev_i2c;
     uint8_t _expdevaddr;
     exp_gpio_pin_name _exppinname; 	
 };
@@ -163,14 +163,14 @@
      * @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) 
+    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);
+        _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);
+        _dev_i2c->i2c_write(data, _expdevaddr, GPDR_0_7, 2);
     }         
 
   	/**
@@ -184,7 +184,7 @@
         }
 
         /* read the _exppinname */
-        _dev_i2c.i2c_read(data, _expdevaddr, GPMR_0_7, 2);
+        _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]) {
@@ -198,7 +198,7 @@
     }		
 		
 private:
-    DevI2C &_dev_i2c; 
+    DevI2C *_dev_i2c; 
     uint8_t _expdevaddr;
     exp_gpio_pin_name _exppinname;      
 };
@@ -215,9 +215,9 @@
     * @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)
+    STMPE1600 (DevI2C &i2c, uint8_t DevAddr=STMPE1600_DEF_DEVICE_ADDRESS ) : _dev_i2c(&i2c)
     { 
-        _dev_i2c = i2c;								
+        _dev_i2c = &i2c;								
         _expdevaddr = DevAddr;
         write_sys_ctrl (SOFT_RESET);
 			
@@ -233,7 +233,7 @@
   	 */		
     void write_sys_ctrl (uint8_t data)     // data = SOFT_RESET reset the device
     {
-        _dev_i2c.i2c_write((uint8_t*)SYS_CTRL, _expdevaddr, data, 1);
+        _dev_i2c->i2c_write((uint8_t*)SYS_CTRL, _expdevaddr, data, 1);
     }
       
   	/**
@@ -303,7 +303,7 @@
   	 */					
     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);	
+        _dev_i2c->i2c_read((uint8_t*)reg_16_data, _expdevaddr, reg_16_addr, 2);	
     }				
 
   	/**
@@ -313,11 +313,11 @@
   	 */							
     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);	
+        _dev_i2c->i2c_write((uint8_t*)reg_16_data, _expdevaddr, reg_16_addr, 2);	
     }		
 
 private:					
-    DevI2C &_dev_i2c; 	 
+    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