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

Files at this revision

API Documentation at this revision

Revision 45:70e4abd970a9, committed 2016-03-15

Comitter:: mapellil
Date:: Tue Mar 15 16:26:36 2016 +0000
Parent:: 44:36d12d319078
Child:: 46:116dadbc80f1
Commit message:: functions VL6180x_I2Cxx are now called passing dev rather than Device as a function argument

Changed in this revision

Components/VL6180X/vl6180x_class.cpp

Show annotated file Show diff for this revision Revisions of this file

--- a/Components/VL6180X/vl6180x_class.cpp	Tue Mar 15 12:51:39 2016 +0000
+++ b/Components/VL6180X/vl6180x_class.cpp	Tue Mar 15 16:26:36 2016 +0000
@@ -2508,7 +2508,7 @@
 {
    int  status;
  
-   status=VL6180x_I2CWrite(Device->I2cAddr, index, &data,(uint8_t)1);
+   status=VL6180x_I2CWrite(dev->I2cAddr, index, &data,(uint8_t)1);
    return status;
 }
  
@@ -2516,7 +2516,7 @@
 {
    int  status;
    
-   status=VL6180x_I2CWrite(Device->I2cAddr, index, (uint8_t *)&data,(uint8_t)2);
+   status=VL6180x_I2CWrite(dev->I2cAddr, index, (uint8_t *)&data,(uint8_t)2);
    return status;
 }
  
@@ -2524,7 +2524,7 @@
 {
    int  status;
    
-   status=VL6180x_I2CWrite(Device->I2cAddr, index, (uint8_t *)&data,(uint8_t)4);
+   status=VL6180x_I2CWrite(dev->I2cAddr, index, (uint8_t *)&data,(uint8_t)4);
    return status;
 }
  
@@ -2533,7 +2533,7 @@
    int  status;
     
    uint8_t buffer;
-   status=VL6180x_I2CRead(Device->I2cAddr, index, &buffer,1);
+   status=VL6180x_I2CRead(dev->I2cAddr, index, &buffer,1);
    if(!status)
    {
       *data=buffer;
@@ -2546,7 +2546,7 @@
    int  status;
     
    uint8_t buffer[2];
-   status=VL6180x_I2CRead(Device->I2cAddr, index, buffer, 2);
+   status=VL6180x_I2CRead(dev->I2cAddr, index, buffer, 2);
    if(!status)
    {
       memcpy(data, buffer, 2);
@@ -2558,7 +2558,7 @@
 {
    int status;
    uint8_t buffer[4];
-   status=VL6180x_I2CRead(Device->I2cAddr, index, buffer,4);
+   status=VL6180x_I2CRead(dev->I2cAddr, index, buffer,4);
    if(!status)
    {
       memcpy(data, buffer, 4);
@@ -2571,15 +2571,15 @@
    int  status;
    uint8_t buffer;
  
-   status=VL6180x_I2CWrite(Device->I2cAddr, index, (uint8_t *)&buffer,(uint8_t)0);
+   status=VL6180x_I2CWrite(dev->I2cAddr, index, (uint8_t *)&buffer,(uint8_t)0);
    if(!status)
    {
       /* read data direct onto buffer */
-      status=VL6180x_I2CRead(Device->I2cAddr, index, &buffer,1);
+      status=VL6180x_I2CRead(dev->I2cAddr, index, &buffer,1);
       if(!status)
       {
          buffer=(buffer & AndData)|OrData;
-         status=VL6180x_I2CWrite(Device->I2cAddr, index, &buffer, (uint8_t)1);
+         status=VL6180x_I2CWrite(dev->I2cAddr, index, &buffer, (uint8_t)1);
       }
    }
    return status;
@@ -2820,8 +2820,8 @@
            return (r_status|l_status);
        
       case(range_continuous_polling_high_threshold):
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_HIGH);
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_HIGH);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=RangeSetHighThreshold(high);
@@ -2834,8 +2834,8 @@
            return (r_status|l_status);
                 
       case(range_continuous_polling_out_of_window):
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW);
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=VL6180x_RangeSetThresholds(Device,low,high,1);
@@ -2848,8 +2848,8 @@
            return (r_status|l_status);
                 
       case(als_continuous_polling_low_threshold):
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_LOW);
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_LOW);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=AlsSetLowThreshold(low);
@@ -2862,8 +2862,8 @@
            return (r_status|l_status);
             
       case(als_continuous_polling_high_threshold):
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_HIGH);
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_HIGH);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=AlsSetHighThreshold(high);
@@ -2876,8 +2876,8 @@
            return (r_status|l_status);
                 
       case(als_continuous_polling_out_of_window):
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW);
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=VL6180x_AlsSetThresholds(Device,low,high);
@@ -2890,8 +2890,8 @@
            return (r_status|l_status);
                 
       case(range_continuous_interrupt_low_threshold):
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_LOW);
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_LOW);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=RangeSetLowThreshold(low);
@@ -2904,8 +2904,8 @@
            return (r_status|l_status);                  
             
       case(range_continuous_interrupt_high_threshold):   
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_HIGH);
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_HIGH);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=RangeSetHighThreshold(high);
@@ -2918,8 +2918,8 @@
            return (r_status|l_status);
                 
        case(range_continuous_interrupt_out_of_window):
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW);
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=VL6180x_RangeSetThresholds(Device,low,high,1);
@@ -2932,8 +2932,8 @@
            return (r_status|l_status);
             
       case(als_continuous_interrupt_low_threshold):
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_LOW);
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_LOW);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=AlsSetLowThreshold(low);
@@ -2946,8 +2946,8 @@
            return (r_status|l_status);  
                 
       case(als_continuous_interrupt_high_threshold):
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_HIGH);
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_LEVEL_HIGH);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=AlsSetHighThreshold(high);
@@ -2960,8 +2960,8 @@
            return (r_status|l_status);
                 
       case(als_continuous_interrupt_out_of_window):
-        status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW);
-        status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
+        l_status=VL6180x_AlsConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_OUT_OF_WINDOW);
+        r_status=VL6180x_RangeConfigInterrupt(Device, CONFIG_GPIO_INTERRUPT_DISABLED);
         if((!r_status)&&(!l_status))
         {
            status=VL6180x_AlsSetThresholds(Device,low,high);

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:	406

The code in this repository is Apache licensed.

Components

X-NUCLEO-6180XA1 Proximity and Ambient Light Sensor