Shih-Ho Hsieh / Mbed 2 deprecated Motor_XYZ_UI_SPI_I2C_5mag

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

RangeSensor Class Reference
Public Member Functions

RangeSensor Class Reference

An abstract class for range sensors. More...

#include <RangeSensor.h>

Inherits Component.

Public Member Functions

virtual int get_distance (uint32_t *pi_data)=0
 Get current range [mm].
virtual ~RangeSensor ()
 Destructor.
virtual int init (void *init)=0
 Initializing the component.
virtual int read_id (uint8_t *id)=0
 Getting the ID of the component.

Detailed Description

An abstract class for range sensors.

Definition at line 56 of file RangeSensor.h.

Constructor & Destructor Documentation

virtual ~RangeSensor (  ) [virtual]

Destructor.

Definition at line 69 of file RangeSensor.h.

Member Function Documentation

virtual int get_distance ( uint32_t *  pi_data ) [pure virtual]

Get current range [mm].

Parameters:
[out]pi_dataPointer to where to store range to
Returns:
0 in case of success, an error code otherwise
virtual int init ( void *  init ) [pure virtual, inherited]

Initializing the component.

Parameters:
[in]initpointer to device specific initalization structure.
Return values:
0in case of success, an error code otherwise.

Implemented in LIS3MDL, LPS25H, and LSM6DS33.

virtual int read_id ( uint8_t *  id ) [pure virtual, inherited]

Getting the ID of the component.

Parameters:
[out]idpointer to an allocated variable to store the ID into.
Return values:
0in case of success, an error code otherwise.

Implemented in LIS3MDL, LPS25H, and LSM6DS33.

Generated on Tue Jul 12 2022 17:30:24 by  doxygen 1.7.2