Class daisy::Tlv493d¶

template <typename Transport>

Device support for TLV493D Magnetic Sensor. More...

#include <tlv493d.h>

Classes¶

Type	Name
struct	AccessMode_t
struct	Config
struct	RegMask_t

Public Types¶

Type	Name
enum	AccessMode_e
enum	Registers_e
enum	Result

Public Attributes¶

Type	Name
const RegMask_t	RegMasks = `/* multi line expression */`
const AccessMode_t	accModes = `/* multi line expression */`

Public Functions¶

Type	Name
void	CalcParity ()
int16_t	ConcatResults (uint8_t upperByte, uint8_t lowerByte, bool upperFull)
void	EnableTemp (bool enable)
float	GetAmount ()
float	GetAzimuth ()
uint16_t	GetMeasurementDelay ()
float	GetPolar ()
uint8_t	GetRegBits (uint8_t regMaskIndex)
float	GetTemp ()
float	GetX ()
float	GetY ()
float	GetZ ()
Result	Init (Config config)
void	ReadOut ()
void	SetAccessMode (AccessMode_e mode)
void	SetInterrupt (bool enable)
void	SetRegBits (uint8_t regMaskIndex, uint8_t data)
	Tlv493d ()
void	UpdateData ()
void	WriteOut ()
	~Tlv493d ()

Detailed Description¶

Author:

beserge

Date:

December 2021

Public Types Documentation¶

enum AccessMode_e¶

enum daisy::Tlv493d::AccessMode_e {
    POWERDOWNMODE = 0,
    FASTMODE,
    LOWPOWERMODE,
    ULTRALOWPOWERMODE,
    MASTERCONTROLLEDMODE
};

enum Registers_e¶

enum daisy::Tlv493d::Registers_e {
    R_BX1 = 0,
    R_BX2,
    R_BY1,
    R_BY2,
    R_BZ1,
    R_BZ2,
    R_TEMP1,
    R_TEMP2,
    R_FRAMECOUNTER,
    R_CHANNEL,
    R_POWERDOWNFLAG,
    R_RES1,
    R_RES2,
    R_RES3,
    W_PARITY,
    W_ADDR,
    W_INT,
    W_FAST,
    W_LOWPOWER,
    W_TEMP_NEN,
    W_LP_PERIOD,
    W_PARITY_EN,
    W_RES1,
    W_RES2,
    W_RES3
};

enum Result¶

enum daisy::Tlv493d::Result {
    OK = 0,
    ERR
};

Public Attributes Documentation¶

variable RegMasks¶

const RegMask_t daisy::Tlv493d< Transport >::RegMasks[25];

variable accModes¶

const AccessMode_t daisy::Tlv493d< Transport >::accModes[5];

Public Functions Documentation¶

function CalcParity¶

inline void daisy::Tlv493d::CalcParity ()

function ConcatResults¶

inline int16_t daisy::Tlv493d::ConcatResults (
    uint8_t upperByte,
    uint8_t lowerByte,
    bool upperFull
)

function EnableTemp¶

inline void daisy::Tlv493d::EnableTemp (
    bool enable
)

function GetAmount¶

inline float daisy::Tlv493d::GetAmount ()

function GetAzimuth¶

inline float daisy::Tlv493d::GetAzimuth ()

function GetMeasurementDelay¶

inline uint16_t daisy::Tlv493d::GetMeasurementDelay ()

function GetPolar¶

inline float daisy::Tlv493d::GetPolar ()

function GetRegBits¶

inline uint8_t daisy::Tlv493d::GetRegBits (
    uint8_t regMaskIndex
)

function GetTemp¶

inline float daisy::Tlv493d::GetTemp ()

function GetX¶

inline float daisy::Tlv493d::GetX ()

function GetY¶

inline float daisy::Tlv493d::GetY ()

function GetZ¶

inline float daisy::Tlv493d::GetZ ()

function Init¶

inline Result daisy::Tlv493d::Init (
    Config config
)

Initialize the TLV493D device

Parameters:

config Configuration settings

function ReadOut¶

inline void daisy::Tlv493d::ReadOut ()

function SetAccessMode¶

inline void daisy::Tlv493d::SetAccessMode (
    AccessMode_e mode
)

function SetInterrupt¶

inline void daisy::Tlv493d::SetInterrupt (
    bool enable
)

function SetRegBits¶

inline void daisy::Tlv493d::SetRegBits (
    uint8_t regMaskIndex,
    uint8_t data
)

function Tlv493d¶

inline daisy::Tlv493d::Tlv493d ()

function UpdateData¶

inline void daisy::Tlv493d::UpdateData ()

function WriteOut¶

inline void daisy::Tlv493d::WriteOut ()

function ~Tlv493d¶

inline daisy::Tlv493d::~Tlv493d ()

The documentation for this class was generated from the following file external-docs/libDaisy/src/dev/tlv493d.h