Libraries/IOControl/include/IO/Device.h

Go to the documentation of this file.

#pragma once

#include "Request.h"
#include "DeviceType.h"
#include <ArduinoJson.h>
#include <Data/LinkedObjectList.h>

namespace IO
{
class Device;
class Controller;

class Device : public LinkedObjectTemplate<Device>
{
    friend Request;
    friend Controller;

public:
    class Factory
    {
    public:
        virtual Device* createDevice(IO::Controller& controller, const char* id) const = 0;

        virtual const FlashString& controllerClass() const = 0;

        virtual const FlashString& deviceClass() const = 0;

        bool operator==(const String& className) const
        {
            return this->deviceClass() == className;
        }
    };

    using OwnedList = OwnedLinkedObjectListTemplate<Device>;

    struct Config {
        String name;
    };

    /*
    * Device state is used to automate initialisation and fault recovery.
    *
    *  uninitialised -> initialising -> normal
    *
    * First initialisation fails, retried
    *
    *  uninitialised -> initialising -> fault -> initialising -> normal
    *
    * Failed during operation, re-initialised
    *
    *  normal -> fault -> initialising -> normal
    */
    enum class State {
        stopped,  
        starting, 
        fault,  
        normal,   
    };

    Device(Controller& controller, const char* id) : controller(controller), id(id)
    {
    }

    virtual ~Device()
    {
    }

    virtual const DeviceType type() const = 0;

    ErrorCode init(const Config& config);
    virtual ErrorCode init(JsonObjectConst config) = 0;

    virtual Request* createRequest() = 0;

    const CString& getId() const
    {
        return id;
    }

    bool operator==(const String& id) const
    {
        return this->id == id;
    }

    const CString& getName() const
    {
        return name ?: id;
    }

    virtual uint16_t address() const
    {
        return 0;
    }

    String caption() const;

    Controller& getController() const
    {
        return controller;
    }

    State getState()
    {
        return state;
    }

    virtual DevNode::ID nodeIdMin() const
    {
        return 0;
    }

    virtual DevNode::ID nodeIdMax() const
    {
        return 0;
    }

    virtual uint16_t maxNodes() const
    {
        return 0;
    }

    virtual DevNode::States getNodeStates(DevNode node) const
    {
        return DevNode::States{};
    }

    virtual void handleEvent(Request* request, Event event);

protected:
    void parseJson(JsonObjectConst json, Config& cfg);

    virtual ErrorCode start();
    virtual ErrorCode stop();

    void submit(Request* request);

    Controller& controller;

private:
    CString id;
    CString name;
    State state{};
};

} // namespace IO