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

Components/VL6180X/vl6180x_platform.h

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

File content as of revision 58:1e9a3a46f814:

/*******************************************************************************
################################################################################
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License version 2 and only version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
#------------------------------------------------------------------------------
#                             Imaging Division
################################################################################
********************************************************************************/


/* vl6180x_platform.h STM32 Nucleo F401 single device  sample code project */

#ifndef VL6180X_PLATFORM
#define VL6180X_PLATFORM


#include "vl6180x_def.h"


#define VL6180X_SINGLE_DEVICE_DRIVER    0
#define VL6180X_RANGE_STATUS_ERRSTRING  1
#define VL6180X_SAFE_POLLING_ENTER 	    0
#define VL6180X_LOG_ENABLE              0
#define MY_LOG                          1

#define VL6180X_DEV_DATA_ATTR
#define ROMABLE_DATA


#if VL6180X_LOG_ENABLE
/*  dot not include non ansi here trace was a case :( */
#ifdef TRACE
#include "diag/trace.h"
extern volatile uint32_t g_TickCnt;
#define LOG_GET_TIME()  g_TickCnt
//#define LOG_GET_TIME()  HAL_GetTick()
#else
/* these is nto stm32 vl6180x GNuArm eclpse build*/
#define trace_printf(...) (void)0
#define LOG_GET_TIME() (int)0 /* add your code here expect to be an integer native (%d) type  value  */
#endif



#define LOG_FUNCTION_START(fmt, ... ) \
    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)

#define LOG_FUNCTION_END_FMT(status, fmt, ... )\
    trace_printf("End %s @%d %d\t"fmt"\n" , __func__, LOG_GET_TIME(), (int)status, ##__VA_ARGS__)

#define VL6180X_ErrLog(msg, ... )\
    do {\
        trace_printf("ERR in %s line %d\n" msg, __func__, __LINE__, ##__VA_ARGS__);\
    } 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
#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
		
struct MyVL6180Dev_t {
    struct VL6180XDevData_t Data;
    uint8_t I2cAddr;
    //uint8_t DevID;
    
    //misc flags for application 	
    unsigned Present:1;
    unsigned Ready:1;
};
typedef struct MyVL6180Dev_t *VL6180XDev_t;

#define VL6180XDevDataGet(dev, field) (dev->Data.field)
#define VL6180XDevDataSet(dev, field, data) (dev->Data.field)=(data)

#endif  /* VL6180X_PLATFORM */