Messages.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstdint>
#include "PixelTypes.h"
 
namespace Systemic::Pixels::Messages
{
    enum class MessageType : uint8_t
    {
        None = 0,
        WhoAreYou,
        IAmADie,
        RollState,
        Telemetry,
        BulkSetup,
        BulkSetupAck,
        BulkData,
        BulkDataAck,
        TransferAnimSet,
        TransferAnimSetAck,
        TransferAnimSetFinished,
        TransferSettings,
        TransferSettingsAck,
        TransferSettingsFinished,
        TransferTestAnimSet,
        TransferTestAnimSetAck,
        TransferTestAnimSetFinished,
        DebugLog,
        PlayAnim,
        PlayAnimEvent,
        StopAnim,
        RemoteAction,
        RequestRollState,
        RequestAnimSet,
        RequestSettings,
        RequestTelemetry,
        ProgramDefaultAnimSet,
        ProgramDefaultAnimSetFinished,
        Blink,
        BlinkAck,
        RequestDefaultAnimSetColor,
        DefaultAnimSetColor,
        RequestBatteryLevel,
        BatteryLevel,
        RequestRssi,
        Rssi,
        Calibrate,
        CalibrateFace,
        NotifyUser,
        NotifyUserAck,
        TestHardware,
        TestLedLoopback,
        LedLoopback,
        SetTopLevelState,
        ProgramDefaultParameters,
        ProgramDefaultParametersFinished,
        SetDesignAndColor,
        SetDesignAndColorAck,
        SetCurrentBehavior,
        SetCurrentBehaviorAck,
        SetName,
        SetNameAck,
        Sleep,
        ExitValidation,
        TransferInstantAnimSet,
        TransferInstantAnimSetAck,
        TransferInstantAnimSetFinished,
        PlayInstantAnim,
        StopAllAnims,
        RequestTemperature,
        Temperature,
        EnableCharging,
        DisableCharging,
        Discharge,
        BlinkId,
        BlinkIdAck,
    };
 
#pragma pack(push, 1)
 
    /*
     * Base type for all Pixel messages.
     * May also represent any message with no data.
     */
    struct PixelMessage
    {
        const MessageType type;
 
        PixelMessage(MessageType msgType) : type(msgType) {}
    };
 
    struct IAmADie
        : public PixelMessage
    {
        uint8_t ledCount{};
 
        PixelDesignAndColor designAndColor{};
 
    private:
        uint8_t _padding{};
    public:
 
        uint32_t dataSetHash{};
 
        uint32_t pixelId{};
 
        uint16_t availableFlash{};
 
        uint32_t buildTimestamp{};
 
        // Roll state
 
        PixelRollState rollState{};
 
        uint8_t currentFaceIndex{};
 
        // Battery level
 
        uint8_t batteryLevelPercent{};
 
        PixelBatteryState batteryState{};
 
        IAmADie() : PixelMessage(MessageType::IAmADie) {}
    };
 
    struct RollState
        : public PixelMessage
    {
        PixelRollState state{};
 
        uint8_t faceIndex{};
 
        RollState() : PixelMessage(MessageType::RollState) {}
    };
 
    struct Blink
        : public PixelMessage
    {
        uint8_t count{};
 
        uint16_t duration{};
 
        uint32_t color{};
 
        uint32_t faceMask{};
 
        uint8_t fade{};
 
        uint8_t loop{};
 
        Blink() : PixelMessage(MessageType::Blink) {}
    };
 
    struct BatteryLevel
        : public PixelMessage
    {
        uint8_t levelPercent{};
 
        PixelBatteryState state{};
 
        BatteryLevel() : PixelMessage(MessageType::BatteryLevel) {}
    };
 
    enum class TelemetryRequestMode : uint8_t
    {
        Off,
 
        Once,
 
        Automatic,
    };
 
    struct RequestRssi
        : public PixelMessage
    {
        TelemetryRequestMode requestMode{};
 
        uint16_t minInterval{};
 
        RequestRssi() : PixelMessage(MessageType::RequestRssi) {}
    };
 
    struct Rssi
        : public PixelMessage
    {
        int8_t value{};
 
        Rssi() : PixelMessage(MessageType::Rssi) {}
    };
 
#pragma pack(pop)
 
    inline const char* getMessageName(MessageType type)
    {
        switch (type)
        {
        case MessageType::None:
            return "None";
        case MessageType::WhoAreYou:
            return "WhoAreYou";
        case MessageType::IAmADie:
            return "IAmADie";
        case MessageType::RollState:
            return "RollState";
        case MessageType::Telemetry:
            return "Telemetry";
        case MessageType::BulkSetup:
            return "BulkSetup";
        case MessageType::BulkSetupAck:
            return "BulkSetupAck";
        case MessageType::BulkData:
            return "BulkData";
        case MessageType::BulkDataAck:
            return "BulkDataAck";
        case MessageType::TransferAnimSet:
            return "TransferAnimSet";
        case MessageType::TransferAnimSetAck:
            return "TransferAnimSetAck";
        case MessageType::TransferAnimSetFinished:
            return "TransferAnimSetFinished";
        case MessageType::TransferSettings:
            return "TransferSettings";
        case MessageType::TransferSettingsAck:
            return "TransferSettingsAck";
        case MessageType::TransferSettingsFinished:
            return "TransferSettingsFinished";
        case MessageType::TransferTestAnimSet:
            return "TransferTestAnimSet";
        case MessageType::TransferTestAnimSetAck:
            return "TransferTestAnimSetAck";
        case MessageType::TransferTestAnimSetFinished:
            return "TransferTestAnimSetFinished";
        case MessageType::DebugLog:
            return "DebugLog";
        case MessageType::PlayAnim:
            return "PlayAnim";
        case MessageType::PlayAnimEvent:
            return "PlayAnimEvent";
        case MessageType::StopAnim:
            return "StopAnim";
        case MessageType::RemoteAction:
            return "RemoteAction";
        case MessageType::RequestRollState:
            return "RequestRollState";
        case MessageType::RequestAnimSet:
            return "RequestAnimSet";
        case MessageType::RequestSettings:
            return "RequestSettings";
        case MessageType::RequestTelemetry:
            return "RequestTelemetry";
        case MessageType::ProgramDefaultAnimSet:
            return "ProgramDefaultAnimSet";
        case MessageType::ProgramDefaultAnimSetFinished:
            return "ProgramDefaultAnimSetFinished";
        case MessageType::Blink:
            return "Blink";
        case MessageType::BlinkAck:
            return "BlinkAck";
        case MessageType::RequestDefaultAnimSetColor:
            return "RequestDefaultAnimSetColor";
        case MessageType::DefaultAnimSetColor:
            return "DefaultAnimSetColor";
        case MessageType::RequestBatteryLevel:
            return "RequestBatteryLevel";
        case MessageType::BatteryLevel:
            return "BatteryLevel";
        case MessageType::RequestRssi:
            return "RequestRssi";
        case MessageType::Rssi:
            return "Rssi";
        case MessageType::Calibrate:
            return "Calibrate";
        case MessageType::CalibrateFace:
            return "CalibrateFace";
        case MessageType::NotifyUser:
            return "NotifyUser";
        case MessageType::NotifyUserAck:
            return "NotifyUserAck";
        case MessageType::TestHardware:
            return "TestHardware";
        case MessageType::TestLedLoopback:
            return "TestLedLoopback";
        case MessageType::LedLoopback:
            return "LedLoopback";
        case MessageType::SetTopLevelState:
            return "SetTopLevelState";
        case MessageType::ProgramDefaultParameters:
            return "ProgramDefaultParameters";
        case MessageType::ProgramDefaultParametersFinished:
            return "ProgramDefaultParametersFinished";
        case MessageType::SetDesignAndColor:
            return "SetDesignAndColor";
        case MessageType::SetDesignAndColorAck:
            return "SetDesignAndColorAck";
        case MessageType::SetCurrentBehavior:
            return "SetCurrentBehavior";
        case MessageType::SetCurrentBehaviorAck:
            return "SetCurrentBehaviorAck";
        case MessageType::SetName:
            return "SetName";
        case MessageType::SetNameAck:
            return "SetNameAck";
        case MessageType::Sleep:
            return "Sleep";
        case MessageType::ExitValidation:
            return "ExitValidation";
        case MessageType::TransferInstantAnimSet:
            return "TransferInstantAnimSet";
        case MessageType::TransferInstantAnimSetAck:
            return "TransferInstantAnimSetAck";
        case MessageType::TransferInstantAnimSetFinished:
            return "TransferInstantAnimSetFinished";
        case MessageType::PlayInstantAnim:
            return "PlayInstantAnim";
        case MessageType::StopAllAnims:
            return "StopAllAnims";
        case MessageType::RequestTemperature:
            return "RequestTemperature";
        case MessageType::Temperature:
            return "Temperature";
        case MessageType::EnableCharging:
            return "EnableCharging";
        case MessageType::DisableCharging:
            return "DisableCharging";
        case MessageType::Discharge:
            return "Discharge";
        case MessageType::BlinkId:
            return "BlinkId";
        case MessageType::BlinkIdAck:
            return "BlinkIdAck";
        }
        return "";
    }
};