ETM-Schurig/powersync-core
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

close #324

Browse Source
This commit is contained in:
Simon Stürz 2016-05-16 11:53:58 +02:00 committed by Michael Zanetti
parent ed358c7d38
commit c0c2f4dbbb
3 changed files with 76 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
debian/changelog vendored
View File

@ -1,3 +1,9 @@
guh (0.7.3) xenial; urgency=medium
* Add plugin property recommendations for client applications
-- Simon Stürz <simon.stuerz@guh.guru> Thu, 16 May 2016 11:24:06 +0200
guh (0.7.2) xenial; urgency=medium guh (0.7.2) xenial; urgency=medium
* Add Avahi support * Add Avahi support

94
libguh/plugin/deviceplugin.cpp
View File

@ -211,7 +211,13 @@ QList<DeviceClass> DevicePlugin::supportedDevices() const
} }
} }
deviceClass.setCreateMethods(createMethods); deviceClass.setCreateMethods(createMethods);
deviceClass.setDeviceIcon(loadAndVerifyDeviceIcon(jo.value("deviceIcon").toString())); QPair<bool, DeviceClass::DeviceIcon> deviceIconVerification = loadAndVerifyDeviceIcon(jo.value("deviceIcon").toString());
if (!deviceIconVerification.first) {
broken = true;
} else {
deviceClass.setDeviceIcon(deviceIconVerification.second);
}
QPair<bool, QList<ParamType> > discoveryParamVerification = parseParamTypes(jo.value("discoveryParamTypes").toArray()); QPair<bool, QList<ParamType> > discoveryParamVerification = parseParamTypes(jo.value("discoveryParamTypes").toArray());
if (!discoveryParamVerification.first) { if (!discoveryParamVerification.first) {
broken = true; broken = true;
@ -241,7 +247,13 @@ QList<DeviceClass> DevicePlugin::supportedDevices() const
QList<DeviceClass::BasicTag> basicTags; QList<DeviceClass::BasicTag> basicTags;
foreach (const QJsonValue &basicTagJson, jo.value("basicTags").toArray()) { foreach (const QJsonValue &basicTagJson, jo.value("basicTags").toArray()) {
basicTags.append(loadAndVerifyBasicTag(basicTagJson.toString())); QPair<bool, DeviceClass::BasicTag> basicTagVerification = loadAndVerifyBasicTag(basicTagJson.toString());
if (!basicTagVerification.first) {
broken = true;
break;
} else {
basicTags.append(basicTagVerification.second);
}
} }
deviceClass.setBasicTags(basicTags); deviceClass.setBasicTags(basicTags);
@ -261,7 +273,12 @@ QList<DeviceClass> DevicePlugin::supportedDevices() const
stateType.setName(st.value("name").toString()); stateType.setName(st.value("name").toString());
stateType.setIndex(st.value("index").toInt()); stateType.setIndex(st.value("index").toInt());
stateType.setType(t); stateType.setType(t);
stateType.setUnit(loadAndVerifyUnit(st.value("unit").toString())); QPair<bool, Types::Unit> unitVerification = loadAndVerifyUnit(st.value("unit").toString());
if (!unitVerification.first) {
broken = true;
} else {
stateType.setUnit(unitVerification.second);
}
stateType.setDefaultValue(st.value("defaultValue").toVariant()); stateType.setDefaultValue(st.value("defaultValue").toVariant());
if (st.contains("minValue")) if (st.contains("minValue"))
stateType.setMinValue(st.value("minValue").toVariant()); stateType.setMinValue(st.value("minValue").toVariant());
@ -540,12 +557,24 @@ QPair<bool, QList<ParamType> > DevicePlugin::parseParamTypes(const QJsonArray &a
// set the input type if there is any // set the input type if there is any
if (pt.contains("inputType")) { if (pt.contains("inputType")) {
paramType.setInputType(loadAndVerifyInputType(pt.value("inputType").toString())); QPair<bool, Types::InputType> inputTypeVerification = loadAndVerifyInputType(pt.value("inputType").toString());
if (!inputTypeVerification.first) {
qCWarning(dcDeviceManager()) << pluginName() << QString("Invalid inputType for paramType") << pt;
return QPair<bool, QList<ParamType> >(false, QList<ParamType>());
} else {
paramType.setInputType(inputTypeVerification.second);
}
} }
// set the unit if there is any // set the unit if there is any
if (pt.contains("unit")) { if (pt.contains("unit")) {
paramType.setUnit(loadAndVerifyUnit(pt.value("unit").toString())); QPair<bool, Types::Unit> unitVerification = loadAndVerifyUnit(pt.value("unit").toString());
if (!unitVerification.first) {
qCWarning(dcDeviceManager()) << pluginName() << QString("Invalid unit type for paramType") << pt;
return QPair<bool, QList<ParamType> >(false, QList<ParamType>());
} else {
paramType.setUnit(unitVerification.second);
}
} }
// set readOnly if given (default false) // set readOnly if given (default false)
@ -603,7 +632,6 @@ DeviceManager::DeviceError DevicePlugin::setConfiguration(const ParamList &confi
/*! Can be called in the DevicePlugin to set a plugin's \l{Param} with the given \a paramName and \a value. */ /*! Can be called in the DevicePlugin to set a plugin's \l{Param} with the given \a paramName and \a value. */
DeviceManager::DeviceError DevicePlugin::setConfigValue(const QString &paramName, const QVariant &value) DeviceManager::DeviceError DevicePlugin::setConfigValue(const QString &paramName, const QVariant &value)
{ {
bool found = false; bool found = false;
foreach (const ParamType &paramType, configurationDescription()) { foreach (const ParamType &paramType, configurationDescription()) {
if (paramType.name() == paramName) { if (paramType.name() == paramName) {
@ -790,10 +818,10 @@ QStringList DevicePlugin::verifyFields(const QStringList &fields, const QJsonObj
return ret; return ret;
} }
Types::Unit DevicePlugin::loadAndVerifyUnit(const QString &unitString) const QPair<bool, Types::Unit> DevicePlugin::loadAndVerifyUnit(const QString &unitString) const
{ {
if (unitString.isEmpty()) if (unitString.isEmpty())
return Types::UnitNone; return QPair<bool, Types::Unit>(true, Types::UnitNone);
QMetaObject metaObject = Types::staticMetaObject; QMetaObject metaObject = Types::staticMetaObject;
int enumIndex = metaObject.indexOfEnumerator(QString("Unit").toLatin1().data()); int enumIndex = metaObject.indexOfEnumerator(QString("Unit").toLatin1().data());
@ -808,15 +836,19 @@ Types::Unit DevicePlugin::loadAndVerifyUnit(const QString &unitString) const
} }
// inform the plugin developer about the error in the plugin json file // inform the plugin developer about the error in the plugin json file
Q_ASSERT_X(enumValue != -1, if (enumValue == -1) {
QString("\"%1\" plugin").arg(pluginName()).toLatin1().data(), qCWarning(dcDeviceManager()) << QString("\"%1\" plugin").arg(pluginName()).toLatin1().data() << QString("Invalid unit type \"%1\" in json file.").arg(unitString).toLatin1().data();
QString("Invalid unit type \"%1\" in json file.").arg(unitString).toLatin1().data()); return QPair<bool, Types::Unit>(false, Types::UnitNone);
}
return (Types::Unit)enumValue; return QPair<bool, Types::Unit>(true, (Types::Unit)enumValue);
} }
Types::InputType DevicePlugin::loadAndVerifyInputType(const QString &inputType) const QPair<bool, Types::InputType> DevicePlugin::loadAndVerifyInputType(const QString &inputType) const
{ {
if (inputType.isEmpty())
return QPair<bool, Types::InputType>(true, Types::InputTypeNone);
QMetaObject metaObject = Types::staticMetaObject; QMetaObject metaObject = Types::staticMetaObject;
int enumIndex = metaObject.indexOfEnumerator(QString("InputType").toLatin1().data()); int enumIndex = metaObject.indexOfEnumerator(QString("InputType").toLatin1().data());
QMetaEnum metaEnum = metaObject.enumerator(enumIndex); QMetaEnum metaEnum = metaObject.enumerator(enumIndex);
@ -830,15 +862,19 @@ Types::InputType DevicePlugin::loadAndVerifyInputType(const QString &inputType)
} }
// inform the plugin developer about the error in the plugin json file // inform the plugin developer about the error in the plugin json file
Q_ASSERT_X(enumValue != -1, if (enumValue == -1) {
QString("\"%1\" plugin").arg(pluginName()).toLatin1().data(), qCWarning(dcDeviceManager()) << QString("\"%1\" plugin").arg(pluginName()).toLatin1().data() << QString("Invalid inputType \"%1\" in json file.").arg(inputType).toLatin1().data();
QString("Invalid inputType \"%1\" in json file.").arg(inputType).toLatin1().data()); return QPair<bool, Types::InputType>(false, Types::InputTypeNone);
}
return (Types::InputType)enumValue; return QPair<bool, Types::InputType>(true, (Types::InputType)enumValue);
} }
DeviceClass::BasicTag DevicePlugin::loadAndVerifyBasicTag(const QString &basicTag) const QPair<bool, DeviceClass::BasicTag> DevicePlugin::loadAndVerifyBasicTag(const QString &basicTag) const
{ {
if (basicTag.isEmpty())
return QPair<bool, DeviceClass::BasicTag>(true, DeviceClass::BasicTagDevice);
QMetaObject metaObject = DeviceClass::staticMetaObject; QMetaObject metaObject = DeviceClass::staticMetaObject;
int enumIndex = metaObject.indexOfEnumerator(QString("BasicTag").toLatin1().data()); int enumIndex = metaObject.indexOfEnumerator(QString("BasicTag").toLatin1().data());
QMetaEnum metaEnum = metaObject.enumerator(enumIndex); QMetaEnum metaEnum = metaObject.enumerator(enumIndex);
@ -852,17 +888,18 @@ DeviceClass::BasicTag DevicePlugin::loadAndVerifyBasicTag(const QString &basicTa
} }
// inform the plugin developer about the error in the plugin json file // inform the plugin developer about the error in the plugin json file
Q_ASSERT_X(enumValue != -1, if (enumValue == -1) {
QString("\"%1\" plugin").arg(pluginName()).toLatin1().data(), qCWarning(dcDeviceManager()) << QString("\"%1\" plugin").arg(pluginName()).toLatin1().data() << QString("Invalid basicTag \"%1\" in json file.").arg(basicTag).toLatin1().data();
QString("Invalid basicTag type \"%1\" in json file.").arg(basicTag).toLatin1().data()); return QPair<bool, DeviceClass::BasicTag>(false, DeviceClass::BasicTagDevice);
}
return (DeviceClass::BasicTag)enumValue; return QPair<bool, DeviceClass::BasicTag>(true, (DeviceClass::BasicTag)enumValue);
} }
DeviceClass::DeviceIcon DevicePlugin::loadAndVerifyDeviceIcon(const QString &deviceIcon) const QPair<bool, DeviceClass::DeviceIcon> DevicePlugin::loadAndVerifyDeviceIcon(const QString &deviceIcon) const
{ {
if (deviceIcon.isEmpty()) if (deviceIcon.isEmpty())
return DeviceClass::DeviceIconNone; return QPair<bool, DeviceClass::DeviceIcon>(true, DeviceClass::DeviceIconNone);
QMetaObject metaObject = DeviceClass::staticMetaObject; QMetaObject metaObject = DeviceClass::staticMetaObject;
int enumIndex = metaObject.indexOfEnumerator(QString("DeviceIcon").toLatin1().data()); int enumIndex = metaObject.indexOfEnumerator(QString("DeviceIcon").toLatin1().data());
@ -877,9 +914,10 @@ DeviceClass::DeviceIcon DevicePlugin::loadAndVerifyDeviceIcon(const QString &dev
} }
// inform the plugin developer about the error in the plugin json file // inform the plugin developer about the error in the plugin json file
Q_ASSERT_X(enumValue != -1, if (enumValue == -1) {
QString("\"%1\" plugin").arg(pluginName()).toLatin1().data(), qCWarning(dcDeviceManager()) << QString("\"%1\" plugin").arg(pluginName()).toLatin1().data() << QString("Invalid deviceIcon \"%1\" in json file.").arg(deviceIcon).toLatin1().data();
QString("Invalid icon type \"%1\" in json file.").arg(deviceIcon).toLatin1().data()); return QPair<bool, DeviceClass::DeviceIcon>(false, DeviceClass::DeviceIconNone);
}
return (DeviceClass::DeviceIcon)enumValue; return QPair<bool, DeviceClass::DeviceIcon>(true, (DeviceClass::DeviceIcon)enumValue);
} }

8
libguh/plugin/deviceplugin.h
View File

@ -132,10 +132,10 @@ private:
QStringList verifyFields(const QStringList &fields, const QJsonObject &value) const; QStringList verifyFields(const QStringList &fields, const QJsonObject &value) const;
// load and verify enum values // load and verify enum values
Types::Unit loadAndVerifyUnit(const QString &unitString) const; QPair<bool, Types::Unit> loadAndVerifyUnit(const QString &unitString) const;
Types::InputType loadAndVerifyInputType(const QString &inputType) const; QPair<bool, Types::InputType> loadAndVerifyInputType(const QString &inputType) const;
DeviceClass::BasicTag loadAndVerifyBasicTag(const QString &basicTag) const; QPair<bool, DeviceClass::BasicTag> loadAndVerifyBasicTag(const QString &basicTag) const;
DeviceClass::DeviceIcon loadAndVerifyDeviceIcon(const QString &deviceIcon) const; QPair<bool, DeviceClass::DeviceIcon> loadAndVerifyDeviceIcon(const QString &deviceIcon) const;
DeviceManager *m_deviceManager; DeviceManager *m_deviceManager;