ST / X_NUCLEO_6180XA1

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

x_nucleo_6180xa1.cpp

Committer:
gallonm
Date:
2015-11-04
Revision:
27:22c6f69967d9
Parent:
20:dd8390d615bf
Child:
28:7c9031e96c22

File content as of revision 27:22c6f69967d9:

/**
 ******************************************************************************
 * @file    x_nucleo_6180xa1.cpp
 * @author  AST / EST
 * @version V0.0.1
 * @date    13-April-2015
 * @brief   Implementation file for the X_NUCLEO_VL6180XA1 singleton class
 ******************************************************************************
 * @attention
 *
 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright notice,
 *      this list of conditions and the following disclaimer in the documentation
 *      and/or other materials provided with the distribution.
 *   3. Neither the name of STMicroelectronics nor the names of its contributors
 *      may be used to endorse or promote products derived from this software
 *      without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************
 */


/* Includes ------------------------------------------------------------------*/
#include "x_nucleo_6180xa1.h"

/* Static variables ----------------------------------------------------------*/
X_NUCLEO_6180XA1* X_NUCLEO_6180XA1::_instance = NULL;


X_NUCLEO_6180XA1* X_NUCLEO_6180XA1::Instance(DevI2C *ext_i2c)
{
   if(_instance==NULL)
      _instance=new X_NUCLEO_6180XA1(ext_i2c);
   else
      printf("Failed to init X_NUCLEO_6180XA1 board!\n");
   return _instance;
}


int X_NUCLEO_6180XA1::InitBoard()
{	
   int status, n_dev=0;
	
   sensor_top->VL6180x_Off();
   sensor_bottom->VL6180x_Off();
   sensor_left->VL6180x_Off();
   sensor_right->VL6180x_Off();
   status=sensor_top->InitSensor(NEW_SENSOR_TOP_ADDRESS);
   if(status)
   {
      delete sensor_top;
      delete gpio0_top;
      sensor_top=NULL;
      gpio0_top=NULL;
      printf("Sensor top not present\n\r");
   }
   else
   {
      printf("Sensor top present\n\r");
      n_dev++;
   }
   status=sensor_bottom->InitSensor(NEW_SENSOR_BOTTOM_ADDRESS);
   if(status)
   {
      delete sensor_bottom;
      delete gpio0_bottom;
      sensor_bottom=NULL;
      gpio0_bottom=NULL;
      printf("Sensor bottom not present\n\r");
   }
   else
   {
      printf("Sensor bottom present\n\r");
      n_dev++;
   }
   status=sensor_left->InitSensor(NEW_SENSOR_LEFT_ADDRESS);
   if(status)
   {
      delete sensor_left;
      delete gpio0_left;
      sensor_left=NULL;
      gpio0_left=NULL;
      printf("Sensor left not present\n\r");
   }
   else
   {
      printf("Sensor left present\n\r");
      n_dev++;
   }
   status=sensor_right->InitSensor(NEW_SENSOR_RIGHT_ADDRESS);
   if(status)
   {
      delete sensor_right;
      delete gpio0_right;
      sensor_right=NULL;
      gpio0_right=NULL;
      printf("Sensor right not present\n\r");
   }
   else
   {
      printf("Sensor right present\n\r");
      n_dev++;
   }
   if(n_dev==0)
      return 1;
   else
      return 0;
}