ustd::Doctor Class Reference

muwerk Doctor Class More...

#include <doctor.h>

Public Member Functions
	Doctor (String name="doctor")
void	begin (Scheduler *_pSched)

Detailed Description

muwerk Doctor Class

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

publish: hostname/doctor/memory/get -> hostname/doctor/memory, msgs=free memory. publish: hostname/doctor/timeinfo/get -> hostname/doctor/timeinfo, json time related information. publish: hostname/doctor/diagnostics/get -> hostname/doctor/diagnostics, json system related information. publish: hostname/doctor/restart -> restarts system.

Sample of adding the doctor:

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

Constructor & Destructor Documentation

Doctor()

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

inline

Instantiates a Doctor Task

Member Function Documentation

begin()

void ustd::Doctor::begin ( Scheduler *  _pSched )

inline

Starts the Doctor Task

Parameters

_pSched

Pointer to the muwerk scheduler.

---

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

• doctor.h