John Alexander / X_NUCLEO_53L1A1_mbed

initial release

Dependencies:   VL53L1X_mbed

Embed: (wiki syntax)

« Back to documentation index

XNucleo53L1A1 Class Reference
Public Member Functions | Static Public Member Functions

XNucleo53L1A1 Class Reference

Class representing the X-NUCLEO-VL53L1A1 expansion board. More...

#include <XNucleo53L1A1.h>

Public Member Functions

 XNucleo53L1A1 (VL53L1X_DevI2C *ext_i2c)
 Constructor 1.
 XNucleo53L1A1 (VL53L1X_DevI2C *ext_i2c, PinName gpio1_centre, PinName gpio1_left, PinName gpio1_right)
 Constructor 2.
 ~XNucleo53L1A1 ()
 Destructor.
int init_board ()
 Initialize the board and sensors with deft values.

Static Public Member Functions

static XNucleo53L1A1 * instance (VL53L1X_DevI2C *ext_i2c)
 Creates a singleton object instance.
static XNucleo53L1A1 * instance (VL53L1X_DevI2C *ext_i2c, PinName gpio1_centre, PinName gpio1_left, PinName gpio1_right)
 Creates a singleton object instance.

Detailed Description

Class representing the X-NUCLEO-VL53L1A1 expansion board.

Definition at line 61 of file XNucleo53L1A1.h.

Constructor & Destructor Documentation

XNucleo53L1A1 ( VL53L1X_DevI2C *  ext_i2c )

Constructor 1.

Parameters:
[in]&i2cdevice I2C to be used for communication

Definition at line 67 of file XNucleo53L1A1.h.

XNucleo53L1A1 ( VL53L1X_DevI2C *  ext_i2c,
PinName  gpio1_centre,
PinName  gpio1_left,
PinName  gpio1_right 
)

Constructor 2.

Parameters:
[in]&i2cdevice I2C to be used for communication
[in]PinNamegpio1_top Mbed DigitalOut pin name to be used as a top sensor GPIO_1 INT
[in]PinNamegpio1_bottom Mbed DigitalOut pin name to be used as a bottom sensor GPIO_1 INT
[in]PinNamegpio1_left Mbed DigitalOut pin name to be used as a left sensor GPIO_1 INT
[in]PinNamegpio1_right Mbed DigitalOut pin name to be used as a right sensor GPIO_1 INT

Definition at line 90 of file XNucleo53L1A1.h.

~XNucleo53L1A1 (  )

Destructor.

Definition at line 110 of file XNucleo53L1A1.h.

Member Function Documentation

int init_board (  )

Initialize the board and sensors with deft values.

Returns:
0 on success

Definition at line 29 of file XNucleo53L1A1.cpp.

XNucleo53L1A1 * instance ( VL53L1X_DevI2C *  ext_i2c ) [static]

Creates a singleton object instance.

Parameters:
[in]&i2cdevice I2C to be used for communication
Returns:
Pointer to the object instance

Definition at line 6 of file XNucleo53L1A1.cpp.

XNucleo53L1A1 * instance ( VL53L1X_DevI2C *  ext_i2c,
PinName  gpio1_centre,
PinName  gpio1_left,
PinName  gpio1_right 
) [static]

Creates a singleton object instance.

Parameters:
[in]&i2cdevice I2C to be used for communication
[in]PinNamegpio1_centre the pin connected to top sensor INT
[in]PinNamegpio1_left the pin connected to left sensor INT
[in]PinNamegpio1_right the pin connected to right sensor INT
Returns:
Pointer to the object instance

Definition at line 16 of file XNucleo53L1A1.cpp.

Generated on Thu Jul 14 2022 03:53:35 by  doxygen 1.7.2