ST Expansion SW Team / X_NUCLEO_53L1CB

Dependencies:   VL53L1

Dependents:   VL53L1CB_shield_sensor_polling VL53L1CB_MB2_NoShield_3sensors_interrupt_ranging VL53L1CB_MB5_NoShield_3sensors_interrupt_ranging VL53L1CB_MB5_NoShield_3sensors_interrupt_ranging

Embed: (wiki syntax)

« Back to documentation index

XNucleo53L1A2 Class Reference

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

#include <XNucleo53L1A2.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Class representing the X-NUCLEO-VL53L1A2 expansion board.

Definition at line 76 of file XNucleo53L1A2.h.


Constructor & Destructor Documentation

XNucleo53L1A2 ( ToF_DevI2C *  ext_i2c )

Constructor 1.

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

Definition at line 82 of file XNucleo53L1A2.h.

XNucleo53L1A2 ( ToF_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_centre Mbed DigitalOut pin name to be used as a centre 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 106 of file XNucleo53L1A2.h.

~XNucleo53L1A2 (  )

Destructor.

Definition at line 127 of file XNucleo53L1A2.h.


Member Function Documentation

int init_board (  )

Initialize the board and sensors with deft values.

Returns:
0 on success

Definition at line 47 of file XNucleo53L1A2.cpp.

XNucleo53L1A2 * instance ( ToF_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 23 of file XNucleo53L1A2.cpp.

XNucleo53L1A2 * instance ( ToF_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 centre 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 33 of file XNucleo53L1A2.cpp.