M5Unit-THERMO 0.4.0 git rev:7cce598
Loading...
Searching...
No Matches
m5::unit::mlx90614::ConfigRegister Struct Reference

Config Register1 (EEPROM 0x05, command 0x25) bit fields. More...

#include <unit_MLX90614_data.hpp>

Public Member Functions

 ConfigRegister (const uint16_t v=0)
 Constructor.
 
IIR iir () const
 Gets the IIR filter (bits 2:0)
 
Output output () const
 Gets the PWM output mode (bits 5:4)
 
FIR fir () const
 Gets the FIR filter (bits 10:8)
 
Gain gain () const
 Gets the amplifier gain (bits 13:11)
 
IRSensor irSensor () const
 Gets the IR sensor mode (bit 6)
 
bool positiveKs () const
 Gets the sign of Ks (bit 7)
 
bool positiveKt2 () const
 Gets the sign of Kt2 (bit 14)
 
void iir (const IIR iir)
 Sets the IIR filter (bits 2:0)
 
void output (const Output o)
 Sets the PWM output mode (bits 5:4)
 
void fir (const FIR fir)
 Sets the FIR filter (bits 10:8)
 
void gain (const Gain gain)
 Sets the amplifier gain (bits 13:11)
 
void irSensor (const IRSensor irs)
 Sets the IR sensor mode (bit 6)
 
void positiveKs (const bool pos)
 Sets the sign of Ks (bit 7)
 
void positiveKt2 (const bool pos)
 Sets the sign of Kt2 (bit 14)
 

Public Attributes

uint16_t value {}
 Raw register value.
 

Detailed Description

Config Register1 (EEPROM 0x05, command 0x25) bit fields.

Constructor & Destructor Documentation

◆ ConfigRegister()

m5::unit::mlx90614::ConfigRegister::ConfigRegister ( const uint16_t v = 0)
inlineexplicit

Constructor.

Parameters
vRaw register value

Member Function Documentation

◆ fir() [1/2]

FIR m5::unit::mlx90614::ConfigRegister::fir ( ) const
inline

Gets the FIR filter (bits 10:8)

Returns
FIR

◆ fir() [2/2]

void m5::unit::mlx90614::ConfigRegister::fir ( const FIR fir)
inline

Sets the FIR filter (bits 10:8)

Parameters
firFIR

◆ gain() [1/2]

Gain m5::unit::mlx90614::ConfigRegister::gain ( ) const
inline

Gets the amplifier gain (bits 13:11)

Returns
Gain (field value 7 is returned as Gain::Coeff100, its duplicate)

◆ gain() [2/2]

void m5::unit::mlx90614::ConfigRegister::gain ( const Gain gain)
inline

Sets the amplifier gain (bits 13:11)

Parameters
gainGain

◆ iir() [1/2]

IIR m5::unit::mlx90614::ConfigRegister::iir ( ) const
inline

Gets the IIR filter (bits 2:0)

Returns
IIR

◆ iir() [2/2]

void m5::unit::mlx90614::ConfigRegister::iir ( const IIR iir)
inline

Sets the IIR filter (bits 2:0)

Parameters
iirIIR

◆ irSensor() [1/2]

IRSensor m5::unit::mlx90614::ConfigRegister::irSensor ( ) const
inline

Gets the IR sensor mode (bit 6)

Returns
IRSensor

◆ irSensor() [2/2]

void m5::unit::mlx90614::ConfigRegister::irSensor ( const IRSensor irs)
inline

Sets the IR sensor mode (bit 6)

Parameters
irsIRSensor

◆ output() [1/2]

Output m5::unit::mlx90614::ConfigRegister::output ( ) const
inline

Gets the PWM output mode (bits 5:4)

Returns
Output

◆ output() [2/2]

void m5::unit::mlx90614::ConfigRegister::output ( const Output o)
inline

Sets the PWM output mode (bits 5:4)

Parameters
oOutput

◆ positiveKs() [1/2]

bool m5::unit::mlx90614::ConfigRegister::positiveKs ( ) const
inline

Gets the sign of Ks (bit 7)

Returns
True if positive (bit 7 is 0)

◆ positiveKs() [2/2]

void m5::unit::mlx90614::ConfigRegister::positiveKs ( const bool pos)
inline

Sets the sign of Ks (bit 7)

Parameters
posPositive (bit 7 = 0) if true

◆ positiveKt2() [1/2]

bool m5::unit::mlx90614::ConfigRegister::positiveKt2 ( ) const
inline

Gets the sign of Kt2 (bit 14)

Returns
True if positive (bit 14 is 0)

◆ positiveKt2() [2/2]

void m5::unit::mlx90614::ConfigRegister::positiveKt2 ( const bool pos)
inline

Sets the sign of Kt2 (bit 14)

Parameters
posPositive (bit 14 = 0) if true