awtrix-light/lib/home-assistant-integration/src/HAMqtt.cpp

#include "HAMqtt.h"

#ifndef ARDUINOHA_TEST
#include <PubSubClient.h>
#endif

#include "HADevice.h"
#include "device-types/HABaseDeviceType.h"
#include "mocks/PubSubClientMock.h"

#define HAMQTT_INIT                                               \
    _device(device),                                              \
        _messageCallback(nullptr),                                \
        _connectedCallback(nullptr),                              \
        _initialized(false),                                      \
        _discoveryPrefix(DefaultDiscoveryPrefix),                 \
        _dataPrefix(DefaultDataPrefix),                           \
        _username(nullptr),                                       \
        _password(nullptr),                                       \
        _lastConnectionAttemptAt(0),                              \
        _devicesTypesNb(0),                                       \
        _maxDevicesTypesNb(maxDevicesTypesNb),                    \
        _devicesTypes(new HABaseDeviceType *[maxDevicesTypesNb]), \
        _lastWillTopic(nullptr),                                  \
        _lastWillMessage(nullptr),                                \
        _lastWillRetain(false)

static const char *DefaultDiscoveryPrefix = "homeassistant";
static const char *DefaultDataPrefix = "SHA";

HAMqtt *HAMqtt::_instance = nullptr;

void onMessageReceived(char *topic, uint8_t *payload, unsigned int length)
{
    if (HAMqtt::instance() == nullptr || length > UINT16_MAX)
    {
        return;
    }

    HAMqtt::instance()->processMessage(topic, payload, static_cast<uint16_t>(length));
}

#ifdef ARDUINOHA_TEST
HAMqtt::HAMqtt(
    PubSubClientMock *pubSub,
    HADevice &device,
    uint8_t maxDevicesTypesNb) : _mqtt(pubSub),
                                 HAMQTT_INIT
{
    _instance = this;
}
#else
HAMqtt::HAMqtt(
    Client &netClient,
    HADevice &device,
    uint8_t maxDevicesTypesNb) : _mqtt(new PubSubClient(netClient)),
                                 HAMQTT_INIT
{
    _instance = this;
}
#endif

HAMqtt::~HAMqtt()
{
    delete[] _devicesTypes;

    if (_mqtt)
    {
        delete _mqtt;
    }

    _instance = nullptr;
}

bool HAMqtt::begin(
    const IPAddress serverIp,
    const uint16_t serverPort,
    const char *username,
    const char *password,
    const char *clientID)
{
    ARDUINOHA_DEBUG_PRINT(F("AHA: init server "))
    ARDUINOHA_DEBUG_PRINT(serverIp)
    ARDUINOHA_DEBUG_PRINT(F(":"))
    ARDUINOHA_DEBUG_PRINTLN(serverPort)

    if (_initialized)
    {
        ARDUINOHA_DEBUG_PRINTLN(F("AHA: already initialized"))
        return false;
    }

    _username = username;
    _password = password;
    _initialized = true;
    _clientID = clientID;
    _mqtt->setServer(serverIp, serverPort);
    _mqtt->setCallback(onMessageReceived);

    return true;
}

bool HAMqtt::begin(
    const IPAddress serverIp,
    const char *username,
    const char *password,
    const char *userid)
{
    return begin(serverIp, HAMQTT_DEFAULT_PORT, username, password, userid);
}

bool HAMqtt::begin(
    const char *serverHostname,
    const uint16_t serverPort,
    const char *username,
    const char *password,
    const char *clientID)
{
    ARDUINOHA_DEBUG_PRINT(F("AHA: init server "))
    ARDUINOHA_DEBUG_PRINT(serverHostname)
    ARDUINOHA_DEBUG_PRINT(F(":"))
    ARDUINOHA_DEBUG_PRINTLN(serverPort)

    if (_initialized)
    {
        ARDUINOHA_DEBUG_PRINTLN(F("AHA: already initialized"))
        return false;
    }

    _username = username;
    _password = password;
    _initialized = true;
    _clientID = clientID;

    _mqtt->setServer(serverHostname, serverPort);
    _mqtt->setCallback(onMessageReceived);

    return true;
}

bool HAMqtt::begin(
    const char *serverHostname,
    const char *username,
    const char *password,
    const char *userid)
{
    return begin(serverHostname, HAMQTT_DEFAULT_PORT, username, password, userid);
}

bool HAMqtt::disconnect()
{
    if (!_initialized)
    {
        return false;
    }

    ARDUINOHA_DEBUG_PRINTLN(F("AHA: disconnecting"))

    _initialized = false;
    _lastConnectionAttemptAt = 0;
    _mqtt->disconnect();

    return true;
}

void HAMqtt::disableHA()
{
    noHA = true;
}

void HAMqtt::loop()
{
    if (_initialized && !_mqtt->loop())
    {
        connectToServer();
    }
}

bool HAMqtt::isConnected() const
{
    return _mqtt->connected();
}

void HAMqtt::addDeviceType(HABaseDeviceType *deviceType)
{
    if (_devicesTypesNb + 1 >= _maxDevicesTypesNb)
    {
        return;
    }

    _devicesTypes[_devicesTypesNb++] = deviceType;
}

bool HAMqtt::publish(const char *topic, const char *payload, bool retained)
{
    if (!isConnected())
    {
        return false;
    }

    ARDUINOHA_DEBUG_PRINT(F("AHA: publishing "))
    ARDUINOHA_DEBUG_PRINT(topic)
    ARDUINOHA_DEBUG_PRINT(F(", len: "))
    ARDUINOHA_DEBUG_PRINTLN(strlen(payload))

    _mqtt->beginPublish(topic, strlen(payload), retained);
    _mqtt->write((const uint8_t *)(payload), strlen(payload));
    return _mqtt->endPublish();
}

bool HAMqtt::beginPublish(
    const char *topic,
    uint16_t payloadLength,
    bool retained)
{
    ARDUINOHA_DEBUG_PRINT(F("AHA: begin publish "))
    ARDUINOHA_DEBUG_PRINT(topic)
    ARDUINOHA_DEBUG_PRINT(F(", len: "))
    ARDUINOHA_DEBUG_PRINTLN(payloadLength)

    return _mqtt->beginPublish(topic, payloadLength, retained);
}

void HAMqtt::writePayload(const char *data, const uint16_t length)
{
    writePayload(reinterpret_cast<const uint8_t *>(data), length);
}

void HAMqtt::writePayload(const uint8_t *data, const uint16_t length)
{
    _mqtt->write(data, length);
}

void HAMqtt::writePayload(const __FlashStringHelper *src)
{
    _mqtt->print(src);
}

bool HAMqtt::endPublish()
{
    return _mqtt->endPublish();
}

bool HAMqtt::subscribe(const char *topic)
{
    ARDUINOHA_DEBUG_PRINT(F("AHA: subscribing "))
    ARDUINOHA_DEBUG_PRINTLN(topic)

    return _mqtt->subscribe(topic);
}

void HAMqtt::processMessage(const char *topic, const uint8_t *payload, uint16_t length)
{
    ARDUINOHA_DEBUG_PRINT(F("AHA: received call "))
    ARDUINOHA_DEBUG_PRINT(topic)
    ARDUINOHA_DEBUG_PRINT(F(", len: "))
    ARDUINOHA_DEBUG_PRINTLN(length)

    if (_messageCallback)
    {
        _messageCallback(topic, payload, length);
    }

    if (!noHA)
    {
        for (uint8_t i = 0; i < _devicesTypesNb; i++)
        {
            _devicesTypes[i]->onMqttMessage(topic, payload, length);
        }
    }
}

void HAMqtt::connectToServer()
{
    if (_lastConnectionAttemptAt > 0 &&
        (millis() - _lastConnectionAttemptAt) < ReconnectInterval)
    {
        return;
    }

    _lastConnectionAttemptAt = millis();

    _mqtt->connect(
        _clientID,
        _username,
        _password,
        _lastWillTopic,
        0,
        _lastWillRetain,
        _lastWillMessage,
        true);

    if (isConnected())
    {
        ARDUINOHA_DEBUG_PRINTLN(F("AHA: connected"))
        if (_connectedCallback)
        {
            _connectedCallback();
        }
        if (!noHA)
            onConnectedLogic();
    }
    else
    {
        ARDUINOHA_DEBUG_PRINTLN(F("AHA: failed to connect"))
    }
}

void HAMqtt::onConnectedLogic()
{

    _device.publishAvailability();

    for (uint8_t i = 0; i < _devicesTypesNb; i++)
    {
        _devicesTypes[i]->onMqttConnected();
    }
}