MessageProcessors.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry).
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 *
 * MessageProcessors.h - standard message processors that decode tcMenu messages.
 */
 
#ifndef _TCMENU_MESSAGEPROCESSORS_H_
#define _TCMENU_MESSAGEPROCESSORS_H_
 
#include <PlatformDetermination.h>
#include <SimpleCollections.h>
#include "tcMenu.h"
 
class TagValueRemoteConnector; // forward reference
struct FieldAndValue; // forward reference
 
union MessageProcessorInfo {
    struct {
        MenuItem* item;
        int changeValue;
        uint32_t correlation;
        ChangeType changeType;
    } value;
    struct {
        uint8_t major, minor;
        ApiPlatform platform;
        bool authProvided;
    } join;
    struct {
        char name[20];
    } pairing;
    struct {
        char mode;
        uint8_t button;
        uint32_t correlation;
    } dialog;
    struct {
        HeartbeatMode hbMode;
    } hb;
    struct {
        uint8_t data[20];
    } custom;
    struct {
        uint16_t length;
        const uint8_t* data;
    } formLoad;
};
 
typedef void (*FieldUpdateFunction)(TagValueRemoteConnector*, FieldAndValue*, MessageProcessorInfo*);
 
class MsgHandler {
private:
    FieldUpdateFunction fieldUpdateFn;
 
    uint16_t msgType;
 
public:
    // as this class is stored in a btree list, it needs copy constructors and = operators implemented
    MsgHandler() : fieldUpdateFn(nullptr), msgType(0xffff) {}
    MsgHandler(uint16_t msgType, FieldUpdateFunction fn) : fieldUpdateFn(fn), msgType(msgType) {}
    MsgHandler(const MsgHandler& other) = default;
    MsgHandler& operator=(const MsgHandler& other) = default;
    uint16_t getKey() const { return msgType; }
    void invoke(TagValueRemoteConnector* rc, FieldAndValue* fv, MessageProcessorInfo* info) {
        if(fieldUpdateFn) fieldUpdateFn(rc, fv, info);
    }
};
 
void fieldUpdateJoinMsg(TagValueRemoteConnector* connector, FieldAndValue* field, MessageProcessorInfo* info);
 
void fieldUpdateValueMsg(TagValueRemoteConnector* connector, FieldAndValue* field, MessageProcessorInfo* info);
 
void fieldUpdatePairingMsg(TagValueRemoteConnector* connector, FieldAndValue* field, MessageProcessorInfo* info);
 
void fieldUpdateDialogMsg(TagValueRemoteConnector* connector, FieldAndValue* field, MessageProcessorInfo* info);
 
void fieldUpdateHeartbeatMsg(TagValueRemoteConnector* connector, FieldAndValue* field, MessageProcessorInfo* info);
void fieldGetFormNames(TagValueRemoteConnector* connector, FieldAndValue* field, MessageProcessorInfo* info);
void fieldHandleFormRequest(TagValueRemoteConnector* connector, FieldAndValue* field, MessageProcessorInfo* info);
 
struct EmbedControlFlashedForm {
    const char* formName;
    const uint8_t* formDataGzipped;
    const uint16_t formDataLen;
};
 
class CombinedMessageProcessor {
private:
    MessageProcessorInfo val;
    BtreeList<uint16_t, MsgHandler> messageHandlers;
    MsgHandler* currHandler;
    static const EmbedControlFlashedForm** flashedFormTemplates;
public:
    static void setFormTemplatesInFlash(const EmbedControlFlashedForm** formTemplatesInFlash) { flashedFormTemplates = formTemplatesInFlash; }
    static const EmbedControlFlashedForm** getFormTemplatesInFlash() { return flashedFormTemplates; }
 
    CombinedMessageProcessor();
 
    void initialise();
 
    void newMsg(uint16_t msgType);
    void fieldUpdate(TagValueRemoteConnector* connector, FieldAndValue* field);
 
     void addCustomMsgHandler(uint16_t msgType, FieldUpdateFunction callback) {
         messageHandlers.add(MsgHandler(msgType, callback));
     }
};
 
#endif /* _TCMENU_MESSAGEPROCESSORS_H_ */