273 lines
13 KiB
C++
273 lines
13 KiB
C++
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
*
|
|
* Copyright 2013 - 2020, nymea GmbH
|
|
* Contact: contact@nymea.io
|
|
*
|
|
* This file is part of nymea.
|
|
* This project including source code and documentation is protected by
|
|
* copyright law, and remains the property of nymea GmbH. All rights, including
|
|
* reproduction, publication, editing and translation, are reserved. The use of
|
|
* this project is subject to the terms of a license agreement to be concluded
|
|
* with nymea GmbH in accordance with the terms of use of nymea GmbH, available
|
|
* under https://nymea.io/license
|
|
*
|
|
* GNU Lesser General Public License Usage
|
|
* Alternatively, this project may be redistributed and/or modified under the
|
|
* terms of the GNU Lesser General Public License as published by the Free
|
|
* Software Foundation; version 3. This project 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 project. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
* For any further details and any questions please contact us under
|
|
* contact@nymea.io or see our FAQ/Licensing Information on
|
|
* https://nymea.io/license/faq
|
|
*
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#include "integrationpluginaqi.h"
|
|
#include "plugininfo.h"
|
|
#include "nymeasettings.h"
|
|
|
|
#include <QNetworkAccessManager>
|
|
|
|
IntegrationPluginAqi::IntegrationPluginAqi()
|
|
{
|
|
connect(this, &IntegrationPluginAqi::configValueChanged, this, [this] (const ParamTypeId ¶mTypeId, const QVariant &value) {
|
|
|
|
if (paramTypeId == airQualityIndexPluginApiKeyParamTypeId && m_aqiConnection) {
|
|
if (!value.toString().isEmpty()) {
|
|
qCDebug(dcAirQualityIndex()) << "Custom API key updated";
|
|
m_aqiConnection->setApiKey(value.toString());
|
|
} else {
|
|
qCDebug(dcAirQualityIndex()) << "Custom API key has been deleted";
|
|
QString apiKey = apiKeyStorage()->requestKey("aqi").data("apiKey");
|
|
if (apiKey.isEmpty()) {
|
|
qCWarning(dcApiKeys()) << "No API Key is available, keeping the AQI connection as it is";
|
|
} else {
|
|
m_aqiConnection->setApiKey(apiKey);
|
|
}
|
|
}
|
|
}
|
|
});
|
|
}
|
|
|
|
void IntegrationPluginAqi::discoverThings(ThingDiscoveryInfo *info)
|
|
{
|
|
if (!m_aqiConnection) {
|
|
if(!createAqiConnection()) {
|
|
return info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("API key is not available."));
|
|
}
|
|
connect(info, &ThingDiscoveryInfo::aborted, [this] {
|
|
if (myThings().filterByThingClassId(airQualityIndexThingClassId).isEmpty()) {
|
|
m_aqiConnection->deleteLater();
|
|
m_aqiConnection = nullptr;
|
|
}
|
|
});
|
|
} else {
|
|
qCDebug(dcAirQualityIndex()) << "AQI connection alread created";
|
|
}
|
|
QUuid requestId = m_aqiConnection->getDataByIp();
|
|
m_asyncDiscovery.insert(requestId, info);
|
|
connect(info, &ThingDiscoveryInfo::aborted, [=] {m_asyncDiscovery.remove(requestId);});
|
|
}
|
|
|
|
void IntegrationPluginAqi::setupThing(ThingSetupInfo *info)
|
|
{
|
|
if (info->thing()->thingClassId() == airQualityIndexThingClassId) {
|
|
if (!m_aqiConnection) {
|
|
if(!createAqiConnection()) {
|
|
return info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("API key is not available."));
|
|
}
|
|
double longitude = info->thing()->paramValue(airQualityIndexThingLongitudeParamTypeId).toDouble();
|
|
double latitude = info->thing()->paramValue(airQualityIndexThingLatitudeParamTypeId).toDouble();
|
|
QUuid requestId = m_aqiConnection->getDataByGeolocation(latitude, longitude);
|
|
m_asyncSetups.insert(requestId, info);
|
|
|
|
connect(info, &ThingSetupInfo::aborted, [requestId, this] {
|
|
m_asyncSetups.remove(requestId);
|
|
if (myThings().filterByThingClassId(airQualityIndexThingClassId).isEmpty()) {
|
|
m_aqiConnection->deleteLater();
|
|
m_aqiConnection = nullptr;
|
|
}
|
|
});
|
|
} else {
|
|
// An AQI connection might be setup because of an discovery request
|
|
// or because there is already another thing using the connection
|
|
info->finish(Thing::ThingErrorNoError);
|
|
}
|
|
} else {
|
|
qCWarning(dcAirQualityIndex()) << "setupThing - thing class id not found" << info->thing()->thingClassId();
|
|
info->finish(Thing::ThingErrorSetupFailed);
|
|
}
|
|
}
|
|
|
|
void IntegrationPluginAqi::postSetupThing(Thing *thing)
|
|
{
|
|
if (thing->thingClassId() == airQualityIndexThingClassId) {
|
|
|
|
if (!m_aqiConnection) {
|
|
qCWarning(dcAirQualityIndex()) << "Air quality connection not initialized";
|
|
return;
|
|
}
|
|
|
|
double longitude = thing->paramValue(airQualityIndexThingLongitudeParamTypeId).toDouble();
|
|
double latitude = thing->paramValue(airQualityIndexThingLatitudeParamTypeId).toDouble();
|
|
QUuid requestId = m_aqiConnection->getDataByGeolocation(latitude, longitude);
|
|
m_asyncRequests.insert(requestId, thing->id());
|
|
}
|
|
|
|
if(!m_pluginTimer) {
|
|
m_pluginTimer = hardwareManager()->pluginTimerManager()->registerTimer(60);
|
|
connect(m_pluginTimer, &PluginTimer::timeout, this, &IntegrationPluginAqi::onPluginTimer);
|
|
}
|
|
}
|
|
|
|
bool IntegrationPluginAqi::createAqiConnection()
|
|
{
|
|
QString apiKey = configValue(airQualityIndexPluginApiKeyParamTypeId).toString();
|
|
|
|
if (apiKey.isEmpty()) {
|
|
apiKey = apiKeyStorage()->requestKey("aqi").data("apiKey");
|
|
}
|
|
if (apiKey.isEmpty()) {
|
|
qCWarning(dcAirQualityIndex()) << "Could not find any API key for AQI";
|
|
return false;
|
|
}
|
|
m_aqiConnection = new AirQualityIndex(hardwareManager()->networkManager(), apiKey, this);
|
|
connect(m_aqiConnection, &AirQualityIndex::requestExecuted, this, &IntegrationPluginAqi::onRequestExecuted);
|
|
connect(m_aqiConnection, &AirQualityIndex::dataReceived, this, &IntegrationPluginAqi::onAirQualityDataReceived);
|
|
connect(m_aqiConnection, &AirQualityIndex::stationsReceived, this, &IntegrationPluginAqi::onAirQualityStationsReceived);
|
|
return true;
|
|
}
|
|
|
|
void IntegrationPluginAqi::thingRemoved(Thing *thing)
|
|
{
|
|
Q_UNUSED(thing)
|
|
if (myThings().empty()) {
|
|
if (m_pluginTimer) {
|
|
hardwareManager()->pluginTimerManager()->unregisterTimer(m_pluginTimer);
|
|
m_pluginTimer = nullptr; }
|
|
if (m_aqiConnection) {
|
|
m_aqiConnection->deleteLater();
|
|
m_aqiConnection = nullptr;
|
|
}
|
|
}
|
|
}
|
|
|
|
void IntegrationPluginAqi::onAirQualityDataReceived(QUuid requestId, AirQualityIndex::AirQualityData data)
|
|
{
|
|
qCDebug(dcAirQualityIndex()) << "Air Quality data received, request id:" << requestId << "is an async request:" << m_asyncRequests.contains(requestId);
|
|
|
|
if (m_asyncSetups.contains(requestId)) {
|
|
ThingSetupInfo *info = m_asyncSetups.value(requestId);
|
|
return info->finish(Thing::ThingErrorNoError);
|
|
}
|
|
|
|
if (m_asyncRequests.contains(requestId)) {
|
|
Thing * thing = myThings().findById(m_asyncRequests.take(requestId));
|
|
if (!thing)
|
|
return;
|
|
|
|
thing->setStateValue(airQualityIndexConnectedStateTypeId, true);
|
|
thing->setStateValue(airQualityIndexCoStateTypeId, data.co);
|
|
thing->setStateValue(airQualityIndexHumidityStateTypeId, data.humidity);
|
|
thing->setStateValue(airQualityIndexTemperatureStateTypeId, data.temperature);
|
|
thing->setStateValue(airQualityIndexPressureStateTypeId, data.pressure);
|
|
thing->setStateValue(airQualityIndexO3StateTypeId, data.o3);
|
|
thing->setStateValue(airQualityIndexNo2StateTypeId, data.no2);
|
|
thing->setStateValue(airQualityIndexSo2StateTypeId, data.so2);
|
|
thing->setStateValue(airQualityIndexPm10StateTypeId, data.pm10);
|
|
thing->setStateValue(airQualityIndexPm25StateTypeId, data.pm25);
|
|
thing->setStateValue(airQualityIndexWindSpeedStateTypeId, data.windSpeed);
|
|
|
|
if (data.pm25 <= 50.00) {
|
|
thing->setStateValue(airQualityIndexAirQualityStateTypeId, "Good");
|
|
thing->setStateValue(airQualityIndexCautionaryStatementStateTypeId, tr("None"));
|
|
} else if ((data.pm25 > 50.00) && (data.pm25 <= 100.00)) {
|
|
thing->setStateValue(airQualityIndexAirQualityStateTypeId, "Moderate");
|
|
thing->setStateValue(airQualityIndexCautionaryStatementStateTypeId, tr("Active children and adults, and people with respiratory disease, such as asthma, should limit prolonged outdoor exertion."));
|
|
} else if ((data.pm25 > 100.00) && (data.pm25 <= 150.00)) {
|
|
thing->setStateValue(airQualityIndexAirQualityStateTypeId, "Unhealthy for Sensitive Groups");
|
|
thing->setStateValue(airQualityIndexCautionaryStatementStateTypeId, tr("Active children and adults, and people with respiratory disease, such as asthma, should limit prolonged outdoor exertion."));
|
|
} else if ((data.pm25 > 150.00) && (data.pm25 <= 200.00)) {
|
|
thing->setStateValue(airQualityIndexAirQualityStateTypeId, "Unhealthy");
|
|
thing->setStateValue(airQualityIndexCautionaryStatementStateTypeId, tr("Active children and adults, and people with respiratory disease, such as asthma, should avoid prolonged outdoor exertion; everyone else, especially children, should limit prolonged outdoor exertion"));
|
|
} else if ((data.pm25 > 200.00) && (data.pm25 <= 300.00)) {
|
|
thing->setStateValue(airQualityIndexAirQualityStateTypeId, "Very Unhealthy");
|
|
thing->setStateValue(airQualityIndexCautionaryStatementStateTypeId, tr("Active children and adults, and people with respiratory disease, such as asthma, should avoid all outdoor exertion; everyone else, especially children, should limit outdoor exertion."));
|
|
} else {
|
|
thing->setStateValue(airQualityIndexAirQualityStateTypeId, "Hazardous");
|
|
thing->setStateValue(airQualityIndexCautionaryStatementStateTypeId, tr("Everyone should avoid all outdoor exertion"));
|
|
}
|
|
}
|
|
}
|
|
|
|
void IntegrationPluginAqi::onAirQualityStationsReceived(QUuid requestId, QList<AirQualityIndex::Station> stations)
|
|
{
|
|
qCDebug(dcAirQualityIndex()) << "Air Quality Stations received, request id:" << requestId << "is an async request:" << m_asyncRequests.contains(requestId);
|
|
if (m_asyncDiscovery.contains(requestId)) {
|
|
ThingDiscoveryInfo *info = m_asyncDiscovery.take(requestId);
|
|
foreach(AirQualityIndex::Station station, stations) {
|
|
ThingDescriptor descriptor(airQualityIndexThingClassId, station.name, "Air Quality Index Station");
|
|
ParamList params;
|
|
params << Param(airQualityIndexThingLatitudeParamTypeId, station.location.latitude);
|
|
params << Param(airQualityIndexThingLongitudeParamTypeId, station.location.longitude);
|
|
descriptor.setParams(params);
|
|
info->addThingDescriptor(descriptor);
|
|
}
|
|
info->finish(Thing::ThingErrorNoError);
|
|
}
|
|
|
|
|
|
if (m_asyncRequests.contains(requestId)) {
|
|
Thing * thing = myThings().findById(m_asyncRequests.value(requestId));
|
|
if (!thing) {
|
|
qCWarning(dcAirQualityIndex()) << "Can't find thing, associated to this async request";
|
|
return;
|
|
}
|
|
if (stations.length() != 0) {
|
|
thing->setStateValue(airQualityIndexStationNameStateTypeId, stations.first().name);
|
|
}
|
|
}
|
|
}
|
|
|
|
void IntegrationPluginAqi::onPluginTimer()
|
|
{
|
|
if (!m_aqiConnection)
|
|
return;
|
|
|
|
foreach (Thing *thing, myThings().filterByThingClassId(airQualityIndexThingClassId)) {
|
|
double longitude = thing->paramValue(airQualityIndexThingLongitudeParamTypeId).toDouble();
|
|
double latitude = thing->paramValue(airQualityIndexThingLatitudeParamTypeId).toDouble();
|
|
QUuid requestId = m_aqiConnection->getDataByGeolocation(latitude, longitude);
|
|
m_asyncRequests.insert(requestId, thing->id());
|
|
}
|
|
}
|
|
|
|
void IntegrationPluginAqi::onRequestExecuted(QUuid requestId, bool success)
|
|
{
|
|
qCDebug(dcAirQualityIndex()) << "Request executed, requestId:" << requestId << "Success:" << success << "is an async request:" << m_asyncRequests.contains(requestId);
|
|
if (m_asyncDiscovery.contains(requestId) && !success) {
|
|
ThingDiscoveryInfo *info = m_asyncDiscovery.take(requestId);
|
|
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("Air quality index server not available, please check your internet connection."));
|
|
if (myThings().filterByThingClassId(airQualityIndexThingClassId).isEmpty() && m_aqiConnection) {
|
|
m_aqiConnection->deleteLater();
|
|
m_aqiConnection = nullptr;
|
|
}
|
|
}
|
|
|
|
if (m_asyncRequests.contains(requestId)) {
|
|
|
|
Thing *thing = myThings().findById(m_asyncRequests.value(requestId));
|
|
thing->setStateValue(airQualityIndexConnectedStateTypeId, success);
|
|
if (!success) {
|
|
qCWarning(dcAirQualityIndex()) << "Request failed, removing request from async request list";
|
|
}
|
|
m_asyncRequests.remove(requestId);
|
|
}
|
|
}
|