zdp_descriptors.h

#ifndef DECONZ_ZDP_DESCRIPTORS_H
#define DECONZ_ZDP_DESCRIPTORS_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 <QObject>
#include <deconz/zcl.h>
#include <deconz/types.h>
 
class zme : public QObject
{
    Q_OBJECT
 
    Q_ENUMS(NodeServerMask)
 
public:
    enum NodeServerFlag
    {
        PrimaryTrustCenter       = (1 << 0), 
        BackupTrustCenter        = (1 << 1), 
        PrimaryBindingTableCache = (1 << 2), 
        BackupBindingTableCache  = (1 << 3), 
        PrimaryDiscoveryCache    = (1 << 4), 
        BackupDiscoveryCache     = (1 << 5), 
        NetworkManager           = (1 << 6), 
    };
 
    Q_DECLARE_FLAGS(NodeServerFlags, NodeServerFlag)
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(zme::NodeServerFlags)
 
 
namespace deCONZ {
 
enum MacCapability : unsigned char
{
    MacAlternatePanCoordinator = (1 << 0), 
    MacDeviceIsFFD             = (1 << 1), 
    MacIsMainsPowered          = (1 << 2), 
    MacReceiverOnWhenIdle      = (1 << 3), 
    MacSecuritySupport         = (1 << 6), 
    MacAllocateAddress         = (1 << 7)  
};
 
Q_DECLARE_FLAGS(MacCapabilities, MacCapability)
Q_DECLARE_OPERATORS_FOR_FLAGS(deCONZ::MacCapabilities)
 
 
enum PowerMode
{
    ModeOnWhenIdle  = 0x00, 
    ModePeriodic    = 0x01, 
    ModeStimulated  = 0x02  
};
 
enum PowerSource
{
    PowerSourceUnknown       = 0x00,
    PowerSourceMains         = 0x01, 
    PowerSourceRechargeable  = 0x02, 
    PowerSourceDisposable    = 0x04  
};
 
Q_DECLARE_FLAGS(PowerSources, PowerSource)
Q_DECLARE_OPERATORS_FOR_FLAGS(PowerSources)
 
 
enum PowerSourceLevel
{
    PowerLevelCritical = 0x00, 
    PowerLevel33       = 0x04, 
    PowerLevel66       = 0x08, 
    PowerLevel100      = 0x0c  
};
 
class NodeDescriptorPrivate;
 
class DECONZ_DLLSPEC NodeDescriptor
{
 
public:
    NodeDescriptor();
    NodeDescriptor(const NodeDescriptor &other);
    NodeDescriptor &operator=(const NodeDescriptor &other);
    ~NodeDescriptor();
    void readFromStream(QDataStream &stream);
    deCONZ::DeviceType deviceType() const;
    void setDeviceType(deCONZ::DeviceType deviceType);
    uint16_t manufacturerCode() const;
    ManufacturerCode_t manufacturerCode_t() const;
    void setManufacturerCode(quint16 code);
    void setManufacturerCode(ManufacturerCode_t code);
    MacCapabilities macCapabilities() const;
    void setMacCapabilities(MacCapabilities cap);
    bool hasComplexDescriptor() const;
    void setHasComplexDescriptor(bool hasComplex);
    bool hasUserDescriptor() const;
    void setHasUserDescriptor(bool hasUser);
    deCONZ::FrequencyBand frequencyBand() const;
    void setFrequenzyBand(deCONZ::FrequencyBand freq);
    const char *frequencyBandString() const;
    bool isAlternatePanCoordinator() const;
    void setIsAlternatePanCoordinator(bool isAlt);
    bool isFullFunctionDevice() const;
    void setIsFFD(bool isFFD);
    bool isMainsPowered() const;
    void setIsMainsPowered(bool isMains);
    bool receiverOnWhenIdle() const;
    void setRxOnWhenIdle(bool on);
    bool securitySupport() const;
    void setSecuritySupport(bool supported);
    bool allocateAddress() const;
    bool hasEndpointList() const;
    bool hasSimpleDescriptorList() const;
    const zme::NodeServerFlags serverMask() const;
    uint8_t maxBufferSize() const;
    uint16_t maxIncomingTransferSize() const;
    uint16_t maxOutgoingTransferSize() const;
    bool isNull() const;
    void setIsNull(bool isNull);
    QByteArray toByteArray() const;
    unsigned stackRevision() const;
 
private:
    NodeDescriptorPrivate *d = nullptr;
};
 
class PowerDescriptorPrivate;
 
class DECONZ_DLLSPEC PowerDescriptor
{
public:
    PowerDescriptor();
    PowerDescriptor(const PowerDescriptor &other);
    PowerDescriptor &operator=(const PowerDescriptor &other);
    PowerDescriptor(const QByteArray &data);
    ~PowerDescriptor();
    PowerMode currentPowerMode() const;
    PowerSources availablePowerSources() const;
    PowerSource currentPowerSource() const;
    PowerSourceLevel currentPowerLevel() const;
    bool isValid() const;
    QByteArray toByteArray() const;
 
private:
    PowerDescriptorPrivate *d = nullptr;
};
 
class SimpleDescriptorPrivate;
 
class DECONZ_DLLSPEC SimpleDescriptor
{
public:
    SimpleDescriptor();
    SimpleDescriptor(const SimpleDescriptor &other);
    SimpleDescriptor &operator=(const SimpleDescriptor &other);
    ~SimpleDescriptor();
    void readFromStream(QDataStream &stream, quint16 mfcode);
    void writeToStream(QDataStream &stream) const;
    uint8_t endpoint() const;
    void setEndpoint(uint8_t endpoint);
    uint16_t profileId() const;
    void setProfileId(uint16_t profileId);
    uint16_t deviceId() const;
    void setDeviceId(uint16_t deviceId);
    uint8_t deviceVersion() const;
    void setDeviceVersion(uint8_t version);
    bool isValid() const;
    std::vector<ZclCluster> &inClusters();
    const std::vector<ZclCluster> &inClusters() const;
    std::vector<ZclCluster> &outClusters();
    const std::vector<ZclCluster> &outClusters() const;
    /* \cond INTERNAL_SYMBOLS */ // TODO: move in SimpleDescriptorPrivate
    ZclCluster *cluster(uint16_t id, ZclClusterSide side);
    std::vector<ZclCluster> &clusters(ZclClusterSide side);
    const std::vector<ZclCluster> &clusters(ZclClusterSide side) const;
    /* \endcond */
 
private:
    SimpleDescriptorPrivate *d = nullptr;
};
 
} // namespace deCONZ
 
#endif // DECONZ_ZDP_DESCRIPTORS_H