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

Revision:
56:37d1736bd896
Parent:
20:dd8390d615bf
Child:
57:fa4c622b04a7
--- a/Components/VL6180X/vl6180x_platform.h	Fri Mar 03 15:06:18 2017 +0000
+++ b/Components/VL6180X/vl6180x_platform.h	Mon Mar 13 17:57:03 2017 +0100
@@ -29,9 +29,9 @@
 #include "vl6180x_def.h"
 
 
-#define VL6180x_SINGLE_DEVICE_DRIVER 	0
+#define VL6180x_SINGLE_DEVICE_DRIVER    0
 #define VL6180x_RANGE_STATUS_ERRSTRING  1
-#define VL6180X_SAFE_POLLING_ENTER 	0
+#define VL6180X_SAFE_POLLING_ENTER 	    0
 #define VL6180X_LOG_ENABLE              0
 #define MY_LOG                          1
 
@@ -58,15 +58,15 @@
     trace_printf("beg %s start @%d\t" fmt "\n", __func__, LOG_GET_TIME(), ##__VA_ARGS__)
 
 #define LOG_FUNCTION_END(status)\
-        trace_printf("end %s @%d %d\n", __func__, LOG_GET_TIME(), (int)status)
+    trace_printf("end %s @%d %d\n", __func__, LOG_GET_TIME(), (int)status)
 
 #define LOG_FUNCTION_END_FMT(status, fmt, ... )\
-        trace_printf("End %s @%d %d\t"fmt"\n" , __func__, LOG_GET_TIME(), (int)status, ##__VA_ARGS__)
+    trace_printf("End %s @%d %d\t"fmt"\n" , __func__, LOG_GET_TIME(), (int)status, ##__VA_ARGS__)
 
 #define VL6180x_ErrLog(msg, ... )\
-    do{\
+    do {\
         trace_printf("ERR in %s line %d\n" msg, __func__, __LINE__, ##__VA_ARGS__);\
-    }while(0)
+    } while(0)
 
 #else /* VL6180X_LOG_ENABLE no logging */
   //void OnErrLog(void);
@@ -76,13 +76,11 @@
   #define VL6180x_ErrLog(... ) //OnErrLog() //(void)0
 #endif
 
-  
 #ifdef MY_LOG  /* define printf as pc.printf in order to change the baudrate */
   extern Serial pc;
   #define printf(...) pc.printf(__VA_ARGS__)
 #endif
 
-
 #if  VL6180x_SINGLE_DEVICE_DRIVER
     #error "VL6180x_SINGLE_DEVICE_DRIVER must be set"
 #endif
@@ -101,8 +99,4 @@
 #define VL6180xDevDataGet(dev, field) (dev->Data.field)
 #define VL6180xDevDataSet(dev, field, data) (dev->Data.field)=(data)
 
-
 #endif  /* VL6180x_PLATFORM */
-
-
-