Shih-Ho Hsieh / Mbed 2 deprecated pololu5mag_with_platform

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

Fork of Motor_XYZ_UI_SPI_I2C_5mag by Shih-Ho Hsieh

Embed: (wiki syntax)

« Back to documentation index

Component Class Reference
Public Member Functions

Component Class Reference

An abstract class for Generic components. More...

#include <Component.h>

Inherited by GyroSensor, HumiditySensor, LightSensor, MagneticSensor, MotionSensor, PressureSensor, RangeSensor, and TempSensor.

Public Member Functions

virtual int init (void *init)=0
 Initializing the component.
virtual int read_id (uint8_t *id)=0
 Getting the ID of the component.
virtual ~Component ()
 Destructor.

Detailed Description

An abstract class for Generic components.

Definition at line 56 of file Component.h.

Constructor & Destructor Documentation

virtual ~Component (  ) [virtual]

Destructor.

Definition at line 76 of file Component.h.

Member Function Documentation

virtual int init ( void *  init ) [pure virtual]

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]

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 Fri Jul 15 2022 03:22:25 by  doxygen 1.7.2