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

Files at this revision

API Documentation at this revision

Revision 19:39ea6bab0e5b, committed 2015-10-28

Comitter:
mapellil
Date:
Wed Oct 28 09:28:52 2015 +0000
Parent:
18:c98aa73dc4a5
Child:
20:dd8390d615bf
Commit message:
Removed some undefined funct preventing the lib to be self contained. Added Serial pc global variable.

Changed in this revision

Components/VL6180X/vl6180x_class.cpp Show annotated file Show diff for this revision Revisions of this file
Components/VL6180X/vl6180x_platform.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Components/VL6180X/vl6180x_class.cpp	Tue Oct 27 15:53:31 2015 +0000
+++ b/Components/VL6180X/vl6180x_class.cpp	Wed Oct 28 09:28:52 2015 +0000
@@ -66,6 +66,10 @@
 #define VL6180X_LOG_ENABLE  0
 #endif
  
+#ifdef MY_LOG 
+Serial pc(USBTX, USBRX);
+#endif 
+ 
 #if VL6180x_RANGE_STATUS_ERRSTRING
 /**@def VL6180x_HAVE_RANGE_STATUS_ERRSTRING
  * @brief is defined when @a #VL6180x_RANGE_STATUS_ERRSTRING is enable
@@ -630,8 +634,7 @@
         if (IntStatus == RES_INT_STAT_GPIO_NEW_SAMPLE_READY) {
             break; /* break on new data (status is 0)  */
         }
- 
-        VL6180x_PollDelay(dev);
+        wait_ms(10);
     };
  
     if (!status) {
@@ -842,8 +845,7 @@
         if( IntStatus.status.Range == RES_INT_STAT_GPIO_NEW_SAMPLE_READY){
             break;
         }
-        
-        VL6180x_PollDelay(dev);
+        wait_ms(10);
     }
  /* //![single_shot_snipet] */
  

--- a/Components/VL6180X/vl6180x_platform.h	Tue Oct 27 15:53:31 2015 +0000
+++ b/Components/VL6180X/vl6180x_platform.h	Wed Oct 28 09:28:52 2015 +0000
@@ -69,11 +69,11 @@
     }while(0)
 
 #else /* VL6180X_LOG_ENABLE no logging */
-  void OnErrLog(void);
-  #define LOG_FUNCTION_START(...) (void)0
-  #define LOG_FUNCTION_END(...) (void)0
-  #define LOG_FUNCTION_END_FMT(...) (void)0
-  #define VL6180x_ErrLog(... ) OnErrLog() //(void)0
+  //void OnErrLog(void);
+  #define LOG_FUNCTION_START(...) //(void)0
+  #define LOG_FUNCTION_END(...) //(void)0
+  #define LOG_FUNCTION_END_FMT(...) //(void)0
+  #define VL6180x_ErrLog(... ) //OnErrLog() //(void)0
 #endif
 
   
@@ -102,12 +102,6 @@
 #define VL6180xDevDataSet(dev, field, data) (dev->Data.field)=(data)
 
 
-void VL6180x_PollDelay(VL6180xDev_t dev);
-
-void DISP_ExecLoopBody(void);
-#define VL6180x_PollDelay(dev)   DISP_ExecLoopBody();
-
-
 #endif  /* VL6180x_PLATFORM */