nymea-app/libnymea-app/zigbee/zigbeemanager.h

// SPDX-License-Identifier: LGPL-3.0-or-later

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright (C) 2013 - 2024, nymea GmbH
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
*
* This file is part of libnymea-app.
*
* libnymea-app is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* libnymea-app is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with libnymea-app. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef ZIGBEEMANAGER_H
#define ZIGBEEMANAGER_H

#include <QObject>
#include "zigbeeadapters.h"
#include "zigbeenetworks.h"
#include "engine.h"

class JsonRpcClient;
class ZigbeeNode;
class ZigbeeNodes;
class ZigbeeNodeBinding;

class ZigbeeManager : public QObject
{
    Q_OBJECT
    Q_PROPERTY(Engine* engine READ engine WRITE setEngine NOTIFY engineChanged)
    Q_PROPERTY(bool fetchingData READ fetchingData NOTIFY fetchingDataChanged)

    Q_PROPERTY(QStringList availableBackends READ availableBackends NOTIFY availableBackendsChanged)
    Q_PROPERTY(ZigbeeAdapters *adapters READ adapters CONSTANT)
    Q_PROPERTY(ZigbeeNetworks *networks READ networks CONSTANT)

public:
    enum ZigbeeError {
        ZigbeeErrorNoError,
        ZigbeeErrorAdapterNotAvailable,
        ZigbeeErrorAdapterAlreadyInUse,
        ZigbeeErrorNetworkUuidNotFound,
        ZigbeeErrorDurationOutOfRange,
        ZigbeeErrorNetworkOffline,
        ZigbeeErrorUnknownBackend,
        ZigbeeErrorNodeNotFound,
        ZigbeeErrorForbidden,
        ZigbeeErrorInvalidChannel,
        ZigbeeErrorNetworkError,
        ZigbeeErrorTimeoutError
    };
    Q_ENUM(ZigbeeError)

    enum ZigbeeChannel {
        ZigbeeChannel11 = 0x00000800,
        ZigbeeChannel12 = 0x00001000,
        ZigbeeChannel13 = 0x00002000,
        ZigbeeChannel14 = 0x00004000,
        ZigbeeChannel15 = 0x00008000,
        ZigbeeChannel16 = 0x00010000,
        ZigbeeChannel17 = 0x00020000,
        ZigbeeChannel18 = 0x00040000,
        ZigbeeChannel19 = 0x00080000,
        ZigbeeChannel20 = 0x00100000,
        ZigbeeChannel21 = 0x00200000,
        ZigbeeChannel22 = 0x00400000,
        ZigbeeChannel23 = 0x00800000,
        ZigbeeChannel24 = 0x01000000,
        ZigbeeChannel25 = 0x02000000,
        ZigbeeChannel26 = 0x04000000,
        ZigbeeChannelPrimaryLightLink = 0x02108800,
        ZigbeeChannelAll = 0x07fff800
    };
    Q_DECLARE_FLAGS(ZigbeeChannels, ZigbeeChannel)
    Q_FLAG(ZigbeeChannels)

    explicit ZigbeeManager(QObject *parent = nullptr);
    ~ZigbeeManager();

    void setEngine(Engine *engine);
    Engine *engine() const;

    bool fetchingData() const;

    QStringList availableBackends() const;
    ZigbeeAdapters *adapters() const;
    ZigbeeNetworks *networks() const;

    // Network
    Q_INVOKABLE int addNetwork(const QString &serialPort, uint baudRate, const QString &backend, ZigbeeChannels channels);
    Q_INVOKABLE void removeNetwork(const QUuid &networkUuid);
    Q_INVOKABLE void setPermitJoin(const QUuid &networkUuid, uint duration = 120);
    Q_INVOKABLE void factoryResetNetwork(const QUuid &networkUuid);
    Q_INVOKABLE void getNodes(const QUuid &networkUuid);
    Q_INVOKABLE int removeNode(const QUuid &networkUuid, const QString &ieeeAddress);
    Q_INVOKABLE void refreshNeighborTables(const QUuid &networkUuid);
    Q_INVOKABLE int createBinding(const QUuid &networkUuid, const QString &sourceAddress, quint8 sourceEndpointId, quint16 clusterId, const QString &destinationAddress, quint8 destinationEndpointId);
    Q_INVOKABLE int createGroupBinding(const QUuid &networkUuid, const QString &sourceAddress, quint8 sourceEndpointId, quint16 clusterId, quint16 destinationGroupAddress);
    Q_INVOKABLE int removeBinding(const QUuid &networkUuid, ZigbeeNodeBinding *binding);

signals:
    void engineChanged();
    void fetchingDataChanged();
    void availableBackendsChanged();
    void addNetworkReply(int commandId, ZigbeeError error, const QUuid &networkUuid);
    void removeNetworkReply(int commandId, ZigbeeError error);
    void factoryResetNetworkReply(int commandId, ZigbeeError error);
    void removeNodeReply(int commandId, ZigbeeError error);
    void createBindingReply(int commandId, ZigbeeError error);
    void removeBindingReply(int commandId, ZigbeeError error);

private:
    void init();

    Q_INVOKABLE void getAvailableBackendsResponse(int commandId, const QVariantMap &params);
    Q_INVOKABLE void getAdaptersResponse(int commandId, const QVariantMap &params);
    Q_INVOKABLE void getNetworksResponse(int commandId, const QVariantMap &params);

    Q_INVOKABLE void addNetworkResponse(int commandId, const QVariantMap &params);
    Q_INVOKABLE void removeNetworkResponse(int commandId, const QVariantMap &params);
    Q_INVOKABLE void setPermitJoinResponse(int commandId, const QVariantMap &params);
    Q_INVOKABLE void factoryResetNetworkResponse(int commandId, const QVariantMap &params);

    Q_INVOKABLE void getNodesResponse(int commandId, const QVariantMap &params);
    Q_INVOKABLE void removeNodeResponse(int commandId, const QVariantMap &params);

    Q_INVOKABLE void createBindingResponse(int commandId, const QVariantMap &params);
    Q_INVOKABLE void removeBindingResponse(int commandId, const QVariantMap &params);

    Q_INVOKABLE void notificationReceived(const QVariantMap &notification);

private:
    Engine* m_engine = nullptr;
    bool m_fetchingData = false;
    QStringList m_availableBackends;
    ZigbeeAdapters *m_adapters = nullptr;
    ZigbeeNetworks *m_networks = nullptr;

    ZigbeeAdapter *unpackAdapter(const QVariantMap &adapterMap);
    ZigbeeNetwork *unpackNetwork(const QVariantMap &networkMap);
    ZigbeeNode *unpackNode(const QVariantMap &nodeMap);

    void fillNetworkData(ZigbeeNetwork *network, const QVariantMap &networkMap);
    void addOrUpdateNode(ZigbeeNetwork *network, const QVariantMap &nodeMap);
    void updateNodeProperties(ZigbeeNode *node, const QVariantMap &nodeMap);
};

#endif // ZIGBEEMANAGER_H