ustd::I2CDoctor Class Reference

muwerk I2CDoctor Class More...

#include <i2cdoctor.h>

Public Member Functions
	I2CDoctor (String name="doctor")
void	begin (Scheduler *_pSched, TwoWire *_pWire)

Detailed Description

muwerk I2CDoctor Class

The I2CDoctor class implements a remote diagnostics for i2c-devices interface via pub/sub messages. If the system is connected to MQTT, any MQTT client can be used to access diagnostics.

publish: hostname/doctor/i2cinfo/get -> hostname/doctor/i2cinfo, json list of used i2c-ports in the system.

Sample of adding the i2c-doctor:

#include <scheduler.h>
 
#include <doctor.h>
#include <console.h>
 
ustd::Scheduler sched( 10, 16, 32 );
ustd::I2CDoctor i2cdoc;
ustd::Net net(LED_BUILTIN);
ustd::Mqtt mqtt;
 
void apploop() {}
 
void setup() {
    net.begin(&sched);
    mqtt.begin(&sched);
 
    i2cdoc.begin(&sched);
    int tID = sched.add( apploop, "main", 50000 );
}
 
void loop() {
    sched.loop();
}

Constructor & Destructor Documentation

I2CDoctor()

ustd::I2CDoctor::I2CDoctor ( String  name = "doctor" )

inline

Instantiates an I2CDoctor Task

Member Function Documentation

begin()

void ustd::I2CDoctor::begin ( Scheduler *  _pSched, TwoWire *  _pWire  )

inline

Starts the Doctor Task

Wire.begin() must have been called before calling this. ESP32 will crash otherwise.

Parameters

_pSched	Pointer to the muwerk scheduler.
_pWire	Pointer to Wire-instance, use &Wire for default

---

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

• i2cdoctor.h