ST Expansion SW Team / X_NUCLEO_53L0A1_mbed_sdk

Updates to follow mbed SDK coding style guidelines.

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Dependents:   53L0A1_Satellites_with_Interrupts_OS5 Display_53L0A1_OS5

Fork of X_NUCLEO_53L0A1 by ST

Embed: (wiki syntax)

« Back to documentation index

X_NUCLEO_53L0A1 Class Reference
Public Member Functions | Static Public Member Functions

X_NUCLEO_53L0A1 Class Reference

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

#include <x_nucleo_53l0a1.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Class representing the X-NUCLEO-VL53L0A1 expansion board.

Definition at line 59 of file x_nucleo_53l0a1.h.

Constructor & Destructor Documentation

X_NUCLEO_53L0A1 ( DevI2C *  ext_i2c )

Constructor 1.

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

Definition at line 65 of file x_nucleo_53l0a1.h.

X_NUCLEO_53L0A1 ( 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 x_nucleo_53l0a1.h.

~X_NUCLEO_53L0A1 (  )

Destructor.

Definition at line 111 of file x_nucleo_53l0a1.h.

Member Function Documentation

int init_board (  )

Initialize the board and sensors with deft values.

Returns:
0 on success

Definition at line 67 of file x_nucleo_53l0a1.cpp.

X_NUCLEO_53L0A1 * instance ( 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 46 of file x_nucleo_53l0a1.cpp.

X_NUCLEO_53L0A1 * instance ( 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 55 of file x_nucleo_53l0a1.cpp.

Generated on Wed Jul 13 2022 19:35:41 by  doxygen 1.7.2