nymea/libnymea-core/integrations/thingmanagerimplementation.h

214 lines
10 KiB
C++

// 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 nymea.
*
* nymea 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.
*
* nymea 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 nymea. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#ifndef THINGMANAGERIMPLEMENTATION_H
#define THINGMANAGERIMPLEMENTATION_H
#include "libnymea.h"
#include "integrations/thing.h"
#include "integrations/thingdescriptor.h"
#include "integrations/pluginmetadata.h"
#include "integrations/ioconnection.h"
#include "types/thingclass.h"
#include "types/interface.h"
#include "types/event.h"
#include "types/action.h"
#include "types/vendor.h"
#include <QObject>
#include <QTimer>
#include <QLocale>
#include <QPluginLoader>
#include <QTranslator>
#include "hardwaremanager.h"
#include "integrations/thingmanager.h"
class Thing;
class IntegrationPlugin;
class ThingPairingInfo;
class HardwareManager;
class Translator;
class ApiKeysProvidersLoader;
class LogEngine;
class Logger;
class ThingManagerImplementation: public ThingManager
{
Q_OBJECT
friend class IntegrationPlugin;
public:
explicit ThingManagerImplementation(HardwareManager *hardwareManager, LogEngine *logEngine, const QLocale &locale, QObject *parent = nullptr);
~ThingManagerImplementation() override;
static QStringList pluginSearchDirs();
static QList<QJsonObject> pluginsMetadata();
void registerStaticPlugin(IntegrationPlugin* plugin);
IntegrationPlugins plugins() const override;
IntegrationPlugin *plugin(const PluginId &pluginId) const override;
Thing::ThingError setPluginConfig(const PluginId &pluginId, const ParamList &pluginConfig) override;
Vendors supportedVendors() const override;
Interfaces supportedInterfaces() const override;
ThingClasses supportedThings(const VendorId &vendorId = VendorId()) const override;
Things configuredThings() const override;
Thing* findConfiguredThing(const ThingId &id) const override;
Things findConfiguredThings(const ThingClassId &thingClassId) const override;
Things findConfiguredThings(const QString &interface) const override;
Things findChilds(const ThingId &id) const override;
ThingClass findThingClass(const ThingClassId &thingClassId) const override;
ThingDiscoveryInfo* discoverThings(const ThingClassId &thingClassId, const ParamList &params) override;
ThingSetupInfo* addConfiguredThing(const ThingClassId &thingClassId, const ParamList &params, const QString &name = QString()) override;
ThingSetupInfo* addConfiguredThing(const ThingDescriptorId &thingDescriptorId, const ParamList &params = ParamList(), const QString &name = QString()) override;
ThingSetupInfo* reconfigureThing(const ThingId &thingId, const ParamList &params, const QString &name = QString()) override;
ThingSetupInfo* reconfigureThing(const ThingDescriptorId &thingDescriptorId, const ParamList &params = ParamList(), const QString &name = QString()) override;
ThingPairingInfo* pairThing(const ThingClassId &thingClassId, const ParamList &params, const QString &name = QString()) override;
ThingPairingInfo* pairThing(const ThingDescriptorId &thingDescriptorId, const ParamList &params = ParamList(), const QString &name = QString()) override;
ThingPairingInfo* pairThing(const ThingId &thingId, const ParamList &params, const QString &name = QString()) override;
ThingPairingInfo* confirmPairing(const PairingTransactionId &pairingTransactionId, const QString &username, const QString &secret) override;
Thing::ThingError editThing(const ThingId &thingId, const QString &name) override;
Thing::ThingError setThingSettings(const ThingId &thingId, const ParamList &settings) override;
Thing::ThingError setStateLogging(const ThingId &thingId, const StateTypeId &stateTypeId, bool enabled) override;
Thing::ThingError setEventLogging(const ThingId &thingId, const EventTypeId &eventTypeId, bool enabled) override;
Thing::ThingError setActionLogging(const ThingId &thingId, const ActionTypeId &actionTypeId, bool enabled) override;
Thing::ThingError setStateFilter(const ThingId &thingId, const StateTypeId &stateTypeId, Types::StateValueFilter filter) override;
Thing::ThingError removeConfiguredThing(const ThingId &thingId) override;
ThingActionInfo* executeAction(const Action &action) override;
BrowseResult* browseThing(const ThingId &thingId, const QString &itemId, const QLocale &locale) override;
BrowserItemResult* browserItemDetails(const ThingId &thingId, const QString &itemId, const QLocale &locale) override;
BrowserActionInfo *executeBrowserItem(const BrowserAction &browserAction) override;
BrowserItemActionInfo *executeBrowserItemAction(const BrowserItemAction &browserItemAction) override;
IOConnections ioConnections(const ThingId &thingId = ThingId()) const override;
IOConnectionResult connectIO(const IOConnection &connection) override;
Thing::ThingError disconnectIO(const IOConnectionId &ioConnectionId) override;
QString translate(const PluginId &pluginId, const QString &string, const QLocale &locale) override;
ParamType translateParamType(const PluginId &pluginId, const ParamType &paramType, const QLocale &locale) override;
StateType translateStateType(const PluginId &pluginId, const StateType &stateType, const QLocale &locale) override;
EventType translateEventType(const PluginId &pluginId, const EventType &eventType, const QLocale &locale) override;
ActionType translateActionType(const PluginId &pluginId, const ActionType &actionType, const QLocale &locale) override;
ThingClass translateThingClass(const ThingClass &thingClass, const QLocale &locale) override;
Vendor translateVendor(const Vendor &vendor, const QLocale &locale) override;
private slots:
void loadPlugins();
void loadPlugin(IntegrationPlugin *pluginIface);
void loadConfiguredThings();
void storeConfiguredThings();
void startMonitoringAutoThings();
void onAutoThingsAppeared(const ThingDescriptors &thingDescriptors);
void onAutoThingDisappeared(const ThingId &thingId);
void onLoaded();
void cleanupThingStateCache();
void onEventTriggered(Event event);
// Only connect this to Things. It will query the sender()
void slotThingStateValueChanged(const StateTypeId &stateTypeId, const QVariant &value, const QVariant &minValue, const QVariant &maxValue, const QVariantList &possibleValues);
void slotThingSettingChanged(const ParamTypeId &paramTypeId, const QVariant &value);
void slotThingNameChanged();
private:
// Builds a list of params ready to create a thing.
// Template is thingClass.paramtypes, "first" has highest priority. If a param is not found neither in first nor in second, defaults apply.
ParamList buildParams(const ParamTypes &types, const ParamList &first, const ParamList &second = ParamList());
void pairThingInternal(ThingPairingInfo *info);
ThingSetupInfo *addConfiguredThingInternal(const ThingClassId &thingClassId, const QString &name, const ParamList &params, const ThingId &parentId = ThingId());
void removeConfiguredThingInternal(Thing *thing);
ThingSetupInfo *reconfigureThingInternal(Thing *thing, const ParamList &params, const QString &name = QString());
ThingSetupInfo *setupThing(Thing *thing, bool initialSetup);
void initThing(Thing *thing);
void trySetupThing(Thing *thing);
void registerThing(Thing *thing);
void postSetupThing(Thing *thing);
QString statesCacheFile(const ThingId &thingId);
void storeThingStates(Thing *thing);
void storeThingState(Thing *thing, const StateTypeId &stateTypeId);
void loadThingStates(Thing *thing);
void storeIOConnections();
void loadIOConnections();
void syncIOConnection(Thing *inputThing, const StateTypeId &stateTypeId);
QVariant mapValue(const QVariant &value, const State &fromState, const State &toState, bool inverted) const;
void registerStateLogger(Thing *thing, const StateTypeId &stateTypeId);
void unregisterStateLogger(Thing *thing, const StateTypeId &stateTypeId);
void registerEventLogger(Thing *thing, const EventTypeId &eventTypeId);
void unregisterEventLogger(Thing *thing, const EventTypeId &eventTypeId);
void registerActionLogger(Thing *thing, const ActionTypeId &actionTypeId);
void unregisterActionLogger(Thing *thing, const ActionTypeId &actionTypeId);
IntegrationPlugin *createCppIntegrationPlugin(const QString &absoluteFilePath);
private:
HardwareManager *m_hardwareManager;
LogEngine *m_logEngine;
QLocale m_locale;
Translator *m_translator = nullptr;
QHash<VendorId, Vendor> m_supportedVendors;
QHash<QString, Interface> m_supportedInterfaces;
QHash<VendorId, QList<ThingClassId> > m_vendorThingMap;
QHash<ThingClassId, ThingClass> m_supportedThings;
QHash<ThingId, Thing*> m_configuredThings;
QHash<ThingDescriptorId, ThingDescriptor> m_discoveredThings;
QHash<QString, Logger*> m_stateLoggers;
QHash<QString, Logger*> m_actionLoggers;
QHash<QString, Logger*> m_eventLoggers;
QHash<PluginId, IntegrationPlugin*> m_integrationPlugins;
class PairingContext {
public:
ThingId thingId;
ThingClassId thingClassId;
ThingId parentId;
ParamList params;
QString thingName;
};
QHash<PairingTransactionId, PairingContext> m_pendingPairings;
QHash<ThingId, ThingSetupInfo*> m_pendingSetups;
QHash<IOConnectionId, IOConnection> m_ioConnections;
ApiKeysProvidersLoader *m_apiKeysProvidersLoader = nullptr;
};
#endif // THINGMANAGERIMPLEMENTATION_H