ws_ds18x20 Class Reference

Class that provides an interface with DS18X20-compatible sensors. More...

#include <ws_ds18x20.h>

Public Member Functions
	ws_ds18x20 ()
	Creates a new WipperSnapper Ds18x20 component.
	~ws_ds18x20 ()
	Destructor for a WipperSnapper DS18X20 component.
bool	addDS18x20 (wippersnapper_ds18x20_v1_Ds18x20InitRequest *msgDs18x20InitReq)
	Initializes a DS18x20 sensor using a configuration sent by the broker and adds it to a vector of ds18x20 sensor drivers. More...
void	deleteDS18x20 (wippersnapper_ds18x20_v1_Ds18x20DeInitRequest *msgDS18x20DeinitReq)
	De-initializes a DS18x20 sensor and releases its pin and resources. More...
void	update ()
	Iterates through each ds18x20 sensor and reports data (if period expired) to Adafruit IO.

Detailed Description

Class that provides an interface with DS18X20-compatible sensors.

Member Function Documentation

addDS18x20()

bool ws_ds18x20::addDS18x20

(

wippersnapper_ds18x20_v1_Ds18x20InitRequest *

msgDs18x20InitReq

)

Initializes a DS18x20 sensor using a configuration sent by the broker and adds it to a vector of ds18x20 sensor drivers.

Parameters

msgDs18x20InitReq

Message containing configuration data for a ds18x20 sensor.

Returns

True if initialized successfully, False otherwise.

deleteDS18x20()

void ws_ds18x20::deleteDS18x20

(

wippersnapper_ds18x20_v1_Ds18x20DeInitRequest *

msgDS18x20DeinitReq

)

De-initializes a DS18x20 sensor and releases its pin and resources.

Parameters

msgDS18x20DeinitReq

Message containing configuration data for a ds18x20 sensor.

---

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

• src/components/ds18x20/ws_ds18x20.h
• src/components/ds18x20/ws_ds18x20.cpp