diff --git a/libnymea-core/devices/devicemanagerimplementation.cpp b/libnymea-core/devices/devicemanagerimplementation.cpp index 2c47d778..cce4154f 100644 --- a/libnymea-core/devices/devicemanagerimplementation.cpp +++ b/libnymea-core/devices/devicemanagerimplementation.cpp @@ -21,73 +21,6 @@ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ - -// Signals - -/*! \fn void DeviceManager::loaded(); - The DeviceManager will emit this signal when all \l{Device}{Devices} are loaded. -*/ - -/*! \fn void DeviceManager::languageUpdated(); - The DeviceManager will emit this signal when all system language has been updated. -*/ - -/*! \fn void DeviceManager::pluginConfigChanged(const PluginId &id, const ParamList &config); - The DeviceManager will emit this signal when the \a config \l{ParamList}{Params} of the \l{DevicePlugin}{plugin} with the given \a id has changed. -*/ - -/*! \fn void DeviceManager::deviceSetupFinished(Device *device, DeviceError status); - This signal is emitted when the setup of a \a device is finished. The \a status parameter describes the - \l{Device::DeviceError}{DeviceError} that occurred. -*/ - -/*! \fn void DeviceManager::deviceStateChanged(Device *device, const QUuid &stateTypeId, const QVariant &value); - This signal is emitted when the \l{State} of a \a device changed. The \a stateTypeId parameter describes the - \l{StateType} and the \a value parameter holds the new value. -*/ - -/*! \fn void DeviceManager::deviceDisappeared(const DeviceId &deviceId); - This signal is emitted when the automatically created \l{Device} with the given \a deviceId dissapeard. This signal will - create the Devices.DeviceRemoved notification. -*/ - -/*! \fn void DeviceManager::deviceRemoved(const DeviceId &deviceId); - This signal is emitted when the \l{Device} with the given \a deviceId was removed from the system. This signal will - create the Devices.DeviceRemoved notification. -*/ - -/*! \fn void DeviceManager::deviceAdded(Device *device); - This signal is emitted when a \a \device was added to the system. This signal will - create the Devices.DeviceAdded notification. -*/ - -/*! \fn void DeviceManager::deviceChanged(Device *device); - This signal is emitted when a \a \device was changed in the system (by edit or rediscover). This signal will - create the Devices.DeviceParamsChanged notification. -*/ - -/*! \fn void DeviceManager::deviceReconfigurationFinished(Device *device, DeviceError status); - This signal is emitted when the edit process of a \a device is finished. The \a status parameter describes the - \l{Device::DeviceError}{DeviceError} that occurred. -*/ - -/*! \fn void DeviceManager::actionExecutionFinished(const ActionId &actionId, DeviceError status); - The DeviceManager will emit a this signal when the \l{Action} with the given \a actionId is finished. - The \a status of the \l{Action} execution will be described as \l{Device::DeviceError}{DeviceError}. -*/ - -/*! \fn void DeviceManager::pairingFinished(const PairingTransactionId &pairingTransactionId, DeviceError status, const DeviceId &deviceId = DeviceId()); - The DeviceManager will emit a this signal when the pairing of a \l{Device} with the \a deviceId and \a pairingTransactionId is finished. - The \a status of the pairing will be described as \l{Device::DeviceError}{DeviceError}. -*/ - -/*! \fn void DeviceManager::eventTriggered(const Event &event) - The DeviceManager will emit a \l{Event} described in \a event whenever a Device - creates one. Normally only \l{nymeaserver::NymeaCore} should connect to this and execute actions - after checking back with the \{nymeaserver::RulesEngine}. Exceptions might be monitoring interfaces - or similar, but you should never directly react to this in a \l{DevicePlugin}. -*/ - #include "devicemanagerimplementation.h" #include "translator.h" diff --git a/libnymea/devices/devicemanager.h b/libnymea/devices/devicemanager.h index 575c9145..a77140c1 100644 --- a/libnymea/devices/devicemanager.h +++ b/libnymea/devices/devicemanager.h @@ -33,6 +33,49 @@ #include "types/browseraction.h" #include "types/browseritemaction.h" +// Signals + +/*! \fn void DeviceManager::loaded(); + The DeviceManager will emit this signal when all \l{Device}{Devices} are loaded. +*/ + +/*! \fn void DeviceManager::pluginConfigChanged(const PluginId &id, const ParamList &config); + The DeviceManager will emit this signal when the \a config \l{ParamList}{Params} of the \l{DevicePlugin}{plugin} with the given \a id has changed. +*/ + +/*! \fn void DeviceManager::deviceStateChanged(Device *device, const QUuid &stateTypeId, const QVariant &value); + This signal is emitted when the \l{State} of a \a device changed. The \a stateTypeId parameter describes the + \l{StateType} and the \a value parameter holds the new value. +*/ + +/*! \fn void DeviceManager::deviceDisappeared(const DeviceId &deviceId); + This signal is emitted when the automatically created \l{Device} with the given \a deviceId dissapeard. This signal will + create the Devices.DeviceRemoved notification. +*/ + +/*! \fn void DeviceManager::deviceRemoved(const DeviceId &deviceId); + This signal is emitted when the \l{Device} with the given \a deviceId was removed from the system. This signal will + create the Devices.DeviceRemoved notification. +*/ + +/*! \fn void DeviceManager::deviceAdded(Device *device); + This signal is emitted when a \a \device was added to the system. This signal will + create the Devices.DeviceAdded notification. +*/ + +/*! \fn void DeviceManager::deviceChanged(Device *device); + This signal is emitted when a \a \device was changed in the system (by edit or rediscover). This signal will + create the Devices.DeviceParamsChanged notification. +*/ + +/*! \fn void DeviceManager::eventTriggered(const Event &event) + The DeviceManager will emit a \l{Event} described in \a event whenever a Device + creates one. Normally only \l{nymeaserver::NymeaCore} should connect to this and execute actions + after checking back with the \{nymeaserver::RulesEngine}. Exceptions might be monitoring interfaces + or similar, but you should never directly react to this in a \l{DevicePlugin}. +*/ + + class DeviceManager : public QObject { Q_OBJECT