mirror of https://github.com/nymea/nymea.git
144 lines
5.0 KiB
C++
144 lines
5.0 KiB
C++
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* *
|
|
* Copyright (C) 2015 Simon Stürz <simon.stuerz@guh.io> *
|
|
* Copyright (C) 2014-2018 Michael Zanetti <michael.zanetti@guh.io> *
|
|
* *
|
|
* This file is part of nymea. *
|
|
* *
|
|
* This library 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 2.1 of the License, or (at your option) any later version. *
|
|
* *
|
|
* This library 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 this library; If not, see *
|
|
* <http://www.gnu.org/licenses/>. *
|
|
* *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#ifndef DEVICECLASS_H
|
|
#define DEVICECLASS_H
|
|
|
|
#include "libnymea.h"
|
|
#include "typeutils.h"
|
|
#include "types/vendor.h"
|
|
#include "types/eventtype.h"
|
|
#include "types/actiontype.h"
|
|
#include "types/statetype.h"
|
|
#include "types/paramtype.h"
|
|
|
|
#include <QList>
|
|
#include <QUuid>
|
|
|
|
class LIBNYMEA_EXPORT DeviceClass
|
|
{
|
|
Q_GADGET
|
|
Q_ENUMS(CreateMethod)
|
|
Q_ENUMS(SetupMethod)
|
|
Q_ENUMS(BasicTag)
|
|
Q_ENUMS(CreateMethods)
|
|
|
|
public:
|
|
enum CreateMethod {
|
|
CreateMethodUser = 0x01,
|
|
CreateMethodAuto = 0x02,
|
|
CreateMethodDiscovery = 0x04
|
|
};
|
|
Q_DECLARE_FLAGS(CreateMethods, CreateMethod)
|
|
|
|
enum SetupMethod {
|
|
SetupMethodJustAdd,
|
|
SetupMethodDisplayPin,
|
|
SetupMethodEnterPin,
|
|
SetupMethodPushButton
|
|
};
|
|
|
|
DeviceClass(const PluginId &pluginId = PluginId(), const VendorId &vendorId = VendorId(), const DeviceClassId &id = DeviceClassId());
|
|
|
|
DeviceClassId id() const;
|
|
VendorId vendorId() const;
|
|
PluginId pluginId() const;
|
|
bool isValid() const;
|
|
|
|
QString name() const;
|
|
void setName(const QString &name);
|
|
|
|
QString displayName() const;
|
|
void setDisplayName(const QString &displayName);
|
|
|
|
StateTypeId criticalStateTypeId() const;
|
|
void setCriticalStateTypeId(const StateTypeId &criticalStateTypeId);
|
|
|
|
StateTypeId primaryStateTypeId() const;
|
|
void setPrimaryStateTypeId(const StateTypeId &primaryStateTypeId);
|
|
|
|
ActionTypeId primaryActionTypeId() const;
|
|
void setPrimaryActionTypeId(const ActionTypeId &primaryActionTypeId);
|
|
|
|
StateTypes stateTypes() const;
|
|
StateType getStateType(const StateTypeId &stateTypeId);
|
|
void setStateTypes(const QList<StateType> &stateTypes);
|
|
bool hasStateType(const StateTypeId &stateTypeId);
|
|
|
|
EventTypes eventTypes() const;
|
|
void setEventTypes(const QList<EventType> &eventTypes);
|
|
bool hasEventType(const EventTypeId &eventTypeId);
|
|
|
|
ActionTypes actionTypes() const;
|
|
void setActionTypes(const QList<ActionType> &actionTypes);
|
|
bool hasActionType(const ActionTypeId &actionTypeId);
|
|
|
|
QList<ParamType> paramTypes() const;
|
|
void setParamTypes(const QList<ParamType> ¶mTypes);
|
|
|
|
QList<ParamType> discoveryParamTypes() const;
|
|
void setDiscoveryParamTypes(const QList<ParamType> ¶mTypes);
|
|
|
|
CreateMethods createMethods() const;
|
|
void setCreateMethods(CreateMethods createMethods);
|
|
|
|
SetupMethod setupMethod() const;
|
|
void setSetupMethod(SetupMethod setupMethod);
|
|
|
|
QString pairingInfo() const;
|
|
void setPairingInfo(const QString &pairingInfo);
|
|
|
|
QStringList interfaces() const;
|
|
void setInterfaces(const QStringList &interfaces);
|
|
|
|
bool operator==(const DeviceClass &device) const;
|
|
|
|
static QStringList typeProperties();
|
|
static QStringList mandatoryTypeProperties();
|
|
|
|
private:
|
|
DeviceClassId m_id;
|
|
VendorId m_vendorId;
|
|
PluginId m_pluginId;
|
|
QString m_name;
|
|
QString m_displayName;
|
|
StateTypeId m_criticalStateTypeId;
|
|
StateTypeId m_primaryStateTypeId;
|
|
ActionTypeId m_primaryActionTypeId;
|
|
QList<StateType> m_stateTypes;
|
|
QList<EventType> m_eventTypes;
|
|
QList<ActionType> m_actionTypes;
|
|
QList<ParamType> m_paramTypes;
|
|
QList<ParamType> m_discoveryParamTypes;
|
|
CreateMethods m_createMethods;
|
|
SetupMethod m_setupMethod;
|
|
QString m_pairingInfo;
|
|
QStringList m_interfaces;
|
|
};
|
|
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(DeviceClass::CreateMethods)
|
|
|
|
QDebug operator<<(QDebug &dbg, const DeviceClass &deviceClass);
|
|
|
|
#endif
|