Device Class Reference

Implements the recovery system for Sensor and Storage objects. More...

#include <Device.h>

Inheritance diagram for Device:

Collaboration diagram for Device:

Public Member Functions
	Device (String device_name)
	Default constructor, sets a max_attempt of 1 (device recovery won't be attempted)
	Device (String device_name, int max_attempts, int wait_factor)
const String &	getDeviceName ()
virtual bool	verify ()=0
	Verifies if the Device is connected and working.
bool	getVerified ()
	Get if the Device is Verified.
void	recoveryConfig (int max_attempts, int wait_factor)
	Set recovery config (used keep default constructor)
void	setWaitFactor (int wait_factor)
	Set wait_factor.
void	setMaxAttempts (int max_attempts)
	Set max_attempts.
bool	attemptConnection ()
	If the sensor is verified, return true, if not and it has been long enough since the last attempt (decided by wait_factor and attempt_number), attempt to reverify (reinitialize) it.

Protected Attributes
bool	verified
String	device_name

Private Attributes
unsigned long	last_attempt
int	max_attempts
int	attempt_number
unsigned long	wait_factor

Detailed Description

Implements the recovery system for Sensor and Storage objects.

Constructor & Destructor Documentation

Device() [1/2]

Device::Device ( String  device_name )

inline

Default constructor, sets a max_attempt of 1 (device recovery won't be attempted)

Device() [2/2]

Device::Device ( String  device_name, int  max_attempts, int  wait_factor  )

inline

Parameters

max_attempts	Maximum attempts before no longer trying to recover the sensor
wait_factor	Amount to increase wait time between each attempt by for each failed attempt

Member Function Documentation

attemptConnection()

bool Device::attemptConnection ( )

inline

If the sensor is verified, return true, if not and it has been long enough since the last attempt (decided by wait_factor and attempt_number), attempt to reverify (reinitialize) it.

Returns

true If verified

false If unverified

Here is the call graph for this function:

getDeviceName()

const String & Device::getDeviceName ( )

inline

Here is the caller graph for this function:

getVerified()

bool Device::getVerified ( )

inline

Get if the Device is Verified.

Returns

true

false

Here is the caller graph for this function:

recoveryConfig()

void Device::recoveryConfig ( int  max_attempts, int  wait_factor  )

inline

Set recovery config (used keep default constructor)

Parameters

max_attempts	Maximum attempts before no longer trying to recover the sensor
wait_factor	Amount to increase wait time between each attempt by for each failed attempt

Here is the call graph for this function:

Here is the caller graph for this function:

setMaxAttempts()

void Device::setMaxAttempts ( int  max_attempts )

inline

Set max_attempts.

Parameters

max_attempts

Maximum attempts before no longer trying to recover the sensor

Here is the caller graph for this function:

setWaitFactor()

void Device::setWaitFactor ( int  wait_factor )

inline

Set wait_factor.

Parameters

wait_factor

Amount to increase wait time between each attempt by for each failed attempt

Here is the caller graph for this function:

verify()

virtual bool Device::verify ( )

pure virtual

Verifies if the Device is connected and working.

Returns

true, if connected

false, if not connected

Implemented in TMP117Sensor, AS7331Sensor, BME280Sensor, BME680Sensor, BMP390Sensor, DS3231Sensor, ENS160Sensor, FlashStorage, ICM20948Sensor, INA260Sensor, LSM9DS1Sensor, MTK3339Sensor, OzoneSensor, PCF8523Sensor, RadioStorage, SCD40Sensor, SDStorage, SGP30Sensor, SHTC3Sensor, TempSensor, Sensor, and Storage.

Here is the caller graph for this function:

Member Data Documentation

attempt_number

int Device::attempt_number

private

device_name

String Device::device_name

protected

last_attempt

unsigned long Device::last_attempt

private

max_attempts

int Device::max_attempts

private

verified

bool Device::verified

protected

wait_factor

unsigned long Device::wait_factor

private

---

The documentation for this class was generated from the following file:

• Device.h