aps.h

#ifndef DECONZ_APS_H
#define DECONZ_APS_H
 
/*
 * Copyright (c) 2012-2023 dresden elektronik ingenieurtechnik gmbh.
 * All rights reserved.
 *
 * The software in this package is published under the terms of the BSD
 * style license a copy of which has been included with this distribution in
 * the LICENSE.txt file.
 *
 */
 
#include <array>
#include <QByteArray>
#include <QFlags>
#include <QString>
#include <QMetaType>
 
#include "deconz/types.h"
#include "deconz/timeref.h"
#include "deconz/declspec.h"
 
namespace deCONZ
{
 
enum ApsAddressMode : unsigned char
{
    ApsNoAddress    = 0x0, 
    ApsGroupAddress = 0x1, 
    ApsNwkAddress   = 0x2, 
    ApsExtAddress   = 0x3, 
    ApsNwkExtAddress   = 0x4  
};
 
enum ApsTxOption : unsigned char
{
    ApsTxSecurityEnabledTransmission = 0x01, 
    ApsTxUseNwk                      = 0x02, 
    ApsTxAcknowledgedTransmission    = 0x04, 
    ApsTxFragmentationPermitted      = 0x08  
};
 
Q_DECLARE_FLAGS(ApsTxOptions, ApsTxOption)
Q_DECLARE_OPERATORS_FOR_FLAGS(deCONZ::ApsTxOptions)
 
class AddressPrivate;
 
class DECONZ_DLLSPEC Address
{
public:
    Address() = default;
    Address(const Address &other);
    Address &operator= (const Address &other);
    ~Address() = default;
    bool isNwkUnicast() const;
    bool isNwkBroadcast() const;
    bool hasNwk() const;
    bool hasExt() const;
    bool hasGroup() const;
    uint16_t nwk() const;
    uint64_t ext() const;
    uint16_t group() const;
    void setNwk(uint16_t addr);
    void setExt(uint64_t addr);
    void setGroup(uint16_t addr);
    void clear();
    API_DEPRECATED QString toStringExt() const;
    API_DEPRECATED QString toStringNwk() const;
    API_DEPRECATED QString toStringGroup() const;
    API_DEPRECATED bool fromStringExt(const QString &str);
    API_DEPRECATED bool fromStringNwk(const QString &str);
    bool operator==(const Address &other) const;
    bool operator !=(const Address &other) const;
 
private:
    uint64_t m_ext{0};
    uint16_t m_nwk{0};
    uint16_t m_group{0};
    uint8_t m_addrModes{deCONZ::NoAddress};
    uint8_t _pad[3];
};
 
class ApsDataRequestPrivate;
 
class DECONZ_DLLSPEC ApsDataRequest
{
public:
    ApsDataRequest();
    ApsDataRequest(const ApsDataRequest &other);
    ApsDataRequest(ApsDataRequest &&other) noexcept;
    ApsDataRequest& operator=(const ApsDataRequest &other);
    ApsDataRequest& operator=(ApsDataRequest &&other) noexcept;
    ~ApsDataRequest();
    uint8_t id() const;
    Address &dstAddress();
    const Address &dstAddress() const;
    deCONZ::ApsAddressMode dstAddressMode() const;
    void setDstAddressMode(ApsAddressMode mode);
    uint8_t srcEndpoint() const;
    void setSrcEndpoint(uint8_t ep);
    uint8_t dstEndpoint() const;
    void setDstEndpoint(uint8_t ep);
    uint16_t profileId() const;
    void setProfileId(uint16_t profileId);
    uint16_t clusterId() const;
    void setClusterId(uint16_t clusterId);
    uint16_t responseClusterId() const;
    void setResponseClusterId(uint16_t clusterId);
    const QByteArray &asdu() const;
    QByteArray &asdu();
    void setAsdu(const QByteArray &asdu);
    uint8_t radius() const;
    void setRadius(uint8_t radius);
    ApsTxOptions txOptions() const;
    void setTxOptions(ApsTxOptions txOptions);
    int writeToStream(QDataStream &stream) const;
    void readFromStream(QDataStream &stream);
    void clear();
 
    /* \cond INTERNAL_SYMBOLS */
    void setSendAfter(deCONZ::SteadyTimeRef t);
    deCONZ::SteadyTimeRef sendAfter() const;
    uint8_t version() const;
    void setVersion(uint8_t version) const;
    uint16_t nodeId() const;
    void setNodeId(uint16_t id) const;
    deCONZ::SteadyTimeRef timeout() const;
    void setTimeout(deCONZ::SteadyTimeRef timeout);
    CommonState state() const;
    void setState(CommonState state);
    int sendDelay() const;
    void setSendDelay(int delayMs);
    bool confirmed() const;
    void setConfirmed(bool confirmed);
    void setSourceRoute(const std::array<quint16, 9> &relays, size_t size, const uint srHash);
    uint sourceRouteUuidHash() const;
    /* \endcond */
 
private:
    ApsDataRequestPrivate *d_ptr = nullptr;
    Q_DECLARE_PRIVATE(ApsDataRequest)
};
 
class DECONZ_DLLSPEC ApsDataConfirm
{
public:
    ApsDataConfirm() = default;
    ApsDataConfirm(uint8_t reqId, uint8_t status);
    ApsDataConfirm(const ApsDataRequest &req, uint8_t status);
    ApsDataConfirm(const ApsDataConfirm &other) = default;
    ApsDataConfirm &operator=(const ApsDataConfirm &other) = default;
    ~ApsDataConfirm() = default;
    uint8_t id() const;
    void setId(uint8_t id);
    Address &dstAddress();
    const Address &dstAddress() const;
    ApsAddressMode dstAddressMode() const;
    void setDstAddressMode(ApsAddressMode mode);
    uint8_t dstEndpoint() const;
    uint8_t srcEndpoint() const;
    uint8_t status() const;
    uint32_t txTime() const;
    void readFromStream(QDataStream &stream);
 
private:
    Address m_dstAddr{};
    ApsAddressMode m_dstAddrMode = deCONZ::ApsNoAddress;
    uint8_t m_id = 0;
    uint8_t m_dstEndpoint = 0xFF;
    uint8_t m_srcEndpoint = 0xFF;
    uint8_t m_status = 0xFF;
};
 
class ApsDataIndicationPrivate;
 
class DECONZ_DLLSPEC ApsDataIndication
{
public:
    ApsDataIndication();
    ApsDataIndication(const ApsDataIndication &other);
    ApsDataIndication &operator=(const ApsDataIndication &other);
    ~ApsDataIndication();
    ApsAddressMode dstAddressMode() const;
    void setDstAddressMode(ApsAddressMode mode);
    Address &dstAddress();
    const Address &dstAddress() const;
    uint8_t dstEndpoint() const;
    void setDstEndpoint(uint8_t ep);
    ApsAddressMode srcAddressMode() const;
    void setSrcAddressMode(ApsAddressMode mode);
    Address &srcAddress();
    const Address &srcAddress() const;
    uint8_t srcEndpoint() const;
    void setSrcEndpoint(uint8_t ep);
    uint16_t profileId() const;
    void setProfileId(uint16_t profileId);
    uint16_t clusterId() const;
    void setClusterId(uint16_t clusterId);
    const QByteArray &asdu() const;
    QByteArray &asdu();
    void setAsdu(const QByteArray &asdu);
    uint8_t status() const;
    void setStatus(uint8_t status);
    uint8_t securityStatus() const;
    void setSecurityStatus(uint8_t status);
    uint8_t linkQuality() const;
    void setLinkQuality(uint8_t lqi);
    uint32_t rxTime() const;
    void setRxTime(uint32_t time);
    int8_t rssi() const;
    void setRssi(int8_t rssi);
    quint16 previousHop() const;
    void readFromStream(QDataStream &stream);
    void writeToStream(QDataStream &stream) const;
    /* \cond INTERNAL_SYMBOLS */
    int version() const;
    void setVersion(int version) const;
    /* \endcond */
    void reset();
 
private:
    ApsDataIndicationPrivate *d_ptr = nullptr;
    Q_DECLARE_PRIVATE(ApsDataIndication)
};
 
class ApsMemoryPrivate;
 
class DECONZ_DLLSPEC ApsMemory
{
public:
    ApsMemory();
    ~ApsMemory();
 
    /* \cond INTERNAL_SYMBOLS */
    ApsMemoryPrivate *d = nullptr; // opaque pointer only used internally
    /* \endcond */
};
 
} // namespace deCONZ
 
uint8_t DECONZ_DLLSPEC APS_NextApsRequestId();
 
Q_DECLARE_METATYPE(deCONZ::ApsDataRequest)
Q_DECLARE_METATYPE(deCONZ::ApsDataConfirm)
Q_DECLARE_METATYPE(deCONZ::ApsDataIndication)
 
#endif // DECONZ_APS_H