Merge PR #702: Fix some typos in the code base

This commit is contained in:
jenkins 2025-09-23 14:12:43 +02:00
commit 0d85868465
22 changed files with 26 additions and 26 deletions

View File

@ -6,7 +6,7 @@
</a>
</p>
nymea (/[n'aiːmea:]/ - is an open source IoT edge server. The plug-in based architecture allows to integrate protocols and APIs. With the build-in rule engine you are able to interconnect devices or services available in the system and create individual scenes and behaviours for your environment.
nymea (/[n'aiːmea:]/ - is an open source IoT edge server. The plug-in based architecture allows to integrate protocols and APIs. With the built-in rule engine you are able to interconnect devices or services available in the system and create individual scenes and behaviours for your environment.
## Quick start

View File

@ -145,7 +145,7 @@ nymea (1.8.0) jammy; urgency=medium
* Add location setting
* Add desiredPhaseCount state to evcharger interface
* Add windowOpen and windowOpenDetected states to the thermostat
* Fix multiple ragisterTransport calls on reconfiguring interfaces
* Fix multiple registerTransport calls on reconfiguring interfaces
* Enforce unit on closable interface
* Rework the log engine to use influxdb instead of sql

View File

@ -20,8 +20,8 @@
the description of an actual \l{Param}. Params will be set when a device is configured initially and can only be changed by
a complete reconfiguration of the given device.
\li \l{ParamType}{SettingsTypes} \unicode{0x2192} A \l{Device} can have settings. They are like params, with the exception that the
user (and also the plugin developer) can change them at runtime. Settings should be used to change the behabior of a device at runtime.
An example would the the refresh interval when polling a web server.
user (and also the plugin developer) can change them at runtime. Settings should be used to change the behavior of a device at runtime.
An example would be the refresh interval when polling a web server.
\li \l{StateType}{StateTypes} \unicode{0x2192} A \l{Device} can have \l{State}{States}, which basically represent a value of a \l{Device}
like \e {current temperature} or \e ON/OFF. The \l{StateType} represents the description of an actual \l{State}.
\li \l{EventType}{EventTypes} \unicode{0x2192} A \l{Device} can emit \l{Event}{Events}, which basically represent a signal.

View File

@ -487,7 +487,7 @@ A \l{StateType} has following parameters:
\li \b O
\li bool
\li Indicates if a state value should be cached over reboot of the server. The value will be initialized with the last known value.
By default all states get chached. If you want to disable that behaviour you can set this property to \tt{false}. In that case the
By default all states get cached. If you want to disable that behaviour you can set this property to \tt{false}. In that case the
value will be initialized with the default value of the State.
\row
\li \tt unit

View File

@ -78,7 +78,7 @@
Once you finished the plugin wizard, you can start with the development of you plugin.
\image plugin-template-7.png Project tree
\section1 Walk trough
\section1 Walk through
Starting with the new created project you can find following files in you project:

View File

@ -331,7 +331,7 @@ void NetworkDeviceDiscoveryImpl::unregisterMonitor(NetworkDeviceMonitor *network
PingReply *NetworkDeviceDiscoveryImpl::ping(const QHostAddress &address, uint retries)
{
PingReply *reply = m_ping->ping(address, retries);
// Note: we use any ping used trough this method also for the monitor evaluation
// Note: we use any ping used through this method also for the monitor evaluation
watchPingReply(reply);
return reply;
}
@ -339,7 +339,7 @@ PingReply *NetworkDeviceDiscoveryImpl::ping(const QHostAddress &address, uint re
PingReply *NetworkDeviceDiscoveryImpl::ping(const QString &hostName, uint retries)
{
PingReply *reply = m_ping->ping(hostName, retries);
// Note: we use any ping used trough this method also for the monitor evaluation
// Note: we use any ping used through this method also for the monitor evaluation
watchPingReply(reply);
return reply;
}
@ -347,7 +347,7 @@ PingReply *NetworkDeviceDiscoveryImpl::ping(const QString &hostName, uint retrie
PingReply *NetworkDeviceDiscoveryImpl::ping(const QHostAddress &address, bool lookupHost, uint retries)
{
PingReply *reply = m_ping->ping(address, lookupHost, retries);
// Note: we use any ping used trough this method also for the monitor evaluation
// Note: we use any ping used through this method also for the monitor evaluation
watchPingReply(reply);
return reply;
}

View File

@ -54,7 +54,7 @@ BrowserActionInfo::BrowserActionInfo(Thing *thing, ThingManager *thingManager, c
// expect this to happen. So we'll have to verify here that the plugin did not finish() by now before aborting.
if (!m_finished) {
emit aborted();
// Also it could happen the the plugin calls finish() *in* the aborted() signal, in which case
// Also it could happen the plugin calls finish() *in* the aborted() signal, in which case
// we don't want to call finish() here now to not print a warning about duplicate finished calls
if (!m_finished) {
finish(Thing::ThingErrorTimeout);

View File

@ -55,7 +55,7 @@ BrowseResult::BrowseResult(Thing *thing, ThingManager *thingManager, const QStri
// expect this to happen. So we'll have to verify here that the plugin did not finish() by now before aborting.
if (!m_finished) {
emit aborted();
// Also it could happen the the plugin calls finish() *in* the aborted() signal, in which case
// Also it could happen the plugin calls finish() *in* the aborted() signal, in which case
// we don't want to call finish() here now to not print a warning about duplicate finished calls
if (!m_finished) {
finish(Thing::ThingErrorTimeout);

View File

@ -54,7 +54,7 @@ BrowserItemActionInfo::BrowserItemActionInfo(Thing *thing, ThingManager *thingMa
// expect this to happen. So we'll have to verify here that the plugin did not finish() by now before aborting.
if (!m_finished) {
emit aborted();
// Also it could happen the the plugin calls finish() *in* the aborted() signal, in which case
// Also it could happen the plugin calls finish() *in* the aborted() signal, in which case
// we don't want to call finish() here now to not print a warning about duplicate finished calls
if (!m_finished) {
finish(Thing::ThingErrorTimeout);

View File

@ -55,7 +55,7 @@ BrowserItemResult::BrowserItemResult(Thing *thing, ThingManager *thingManager, c
// expect this to happen. So we'll have to verify here that the plugin did not finish() by now before aborting.
if (!m_finished) {
emit aborted();
// Also it could happen the the plugin calls finish() *in* the aborted() signal, in which case
// Also it could happen the plugin calls finish() *in* the aborted() signal, in which case
// we don't want to call finish() here now to not print a warning about duplicate finished calls
if (!m_finished) {
finish(Thing::ThingErrorTimeout);

View File

@ -113,7 +113,7 @@ void StateValueFilterAdaptive::update()
// Add up the deviation from the current actual value to the currently filtered value
m_totalDeviation += changeRatioToCurrentOutput;
// If the filtered value changed for more than the the standard deviation, follow slowly
// If the filtered value changed for more than the standard deviation, follow slowly
// In order to not get stuck on being off for the standard deviation forever, also move closer
// to the new value when the summed up deviation exceeds the maximum allowed total deviation
if (qAbs(changeRatioFiltered) > m_standardDeviation || qAbs(m_totalDeviation) > m_maxTotalDeviation) {

View File

@ -122,7 +122,7 @@
This signal is emitted when the device name is changed.
Note that the name can be changed by the plugin, as well as the user. Integration plugins
should connect to this signal for their things if it possible to set the name on the actual device
or service. If the the device or service does not support changing the name, this will only be used
or service. If the device or service does not support changing the name, this will only be used
for nymea's internal representation and is not required to be handled by the plugin.
*/

View File

@ -55,7 +55,7 @@ ThingActionInfo::ThingActionInfo(Thing *thing, const Action &action, ThingManage
// expect this to happen. So we'll have to verify here that the plugin did not finish() by now before aborting.
if (!m_finished) {
emit aborted();
// Also it could happen the the plugin calls finish() *in* the aborted() signal, in which case
// Also it could happen the plugin calls finish() *in* the aborted() signal, in which case
// we don't want to call finish() here now to not print a warning about duplicate finished calls
if (!m_finished) {
finish(Thing::ThingErrorTimeout);

View File

@ -54,7 +54,7 @@ ThingDiscoveryInfo::ThingDiscoveryInfo(const ThingClassId &thingClassId, const P
// expect this to happen. So we'll have to verify here that the plugin did not finish() by now before aborting.
if (!m_finished) {
emit aborted();
// Also it could happen the the plugin calls finish() *in* the aborted() signal, in which case
// Also it could happen the plugin calls finish() *in* the aborted() signal, in which case
// we don't want to call finish() here now to not print a warning about duplicate finished calls
if (!m_finished) {
finish(Thing::ThingErrorTimeout);

View File

@ -58,7 +58,7 @@ ThingPairingInfo::ThingPairingInfo(const PairingTransactionId &pairingTransactio
// expect this to happen. So we'll have to verify here that the plugin did not finish() by now before aborting.
if (!m_finished) {
emit aborted();
// Also it could happen the the plugin calls finish() *in* the aborted() signal, in which case
// Also it could happen the plugin calls finish() *in* the aborted() signal, in which case
// we don't want to call finish() here now to not print a warning about duplicate finished calls
if (!m_finished) {
finish(Thing::ThingErrorTimeout);

View File

@ -63,7 +63,7 @@ ThingSetupInfo::ThingSetupInfo(Thing *thing, ThingManager *thingManager, bool in
// expect this to happen. So we'll have to verify here that the plugin did not finish() by now before aborting.
if (!m_finished) {
emit aborted();
// Also it could happen the the plugin calls finish() *in* the aborted() signal, in which case
// Also it could happen the plugin calls finish() *in* the aborted() signal, in which case
// we don't want to call finish() here now to not print a warning about duplicate finished calls
if (!m_finished) {
finish(Thing::ThingErrorTimeout);

View File

@ -1,5 +1,5 @@
{
"description": "This interface can be used for heat pumps offering the smart grid label \"SG-Ready\". The modes can be set to the heatpump either trough 2 digital outputs or directly using modbus registers. These modes should be used by an energy manager and are not intended to be set by an user since there are certain rules to consider when switchen the SG mode.",
"description": "This interface can be used for heat pumps offering the smart grid label \"SG-Ready\". The modes can be set to the heatpump either through 2 digital outputs or directly using modbus registers. These modes should be used by an energy manager and are not intended to be set by a user since there are certain rules to consider when switching the SG mode.",
"extends": "heatpump",
"states": [
{

View File

@ -71,7 +71,7 @@ bool ArpSocket::sendRequest()
if (!m_isOpen)
return false;
// Send the ARP request trough each network interface
// Send the ARP request through each network interface
qCDebug(dcArpSocket()) << "Sending ARP request to all local network interfaces...";
foreach (const QNetworkInterface &networkInterface, QNetworkInterface::allInterfaces()) {
sendRequest(networkInterface);

View File

@ -80,7 +80,7 @@ public:
QString incompleteProperties() const;
// Helper methods for the networkdevice interface
// The fill in automaticlally the correct paramters for the
// They fill in automatically the correct parameters for the
// right monitor
QString thingParamValueMacAddress() const;
QString thingParamValueHostName() const;

View File

@ -397,7 +397,7 @@ void Ping::finishReply(PingReply *reply, PingReply::Error error)
}
emit reply->retry(error, reply->retryCount());
// Note: will be restarted once actually sent trough the network
// Note: will be restarted once actually sent through the network
reply->m_timer->stop();
// Re-Enqueu the reply
@ -560,7 +560,7 @@ void Ping::onHostLookupFinished(const QHostInfo &info)
PingReply::Error pingError = PingReply::ErrorNoError;
switch(info.error()) {
case QHostInfo::NoError:
qCDebug(dcPing()) << "Looked up hostname after successfull ping" << reply->targetHostAddress().toString() << info.hostName();
qCDebug(dcPing()) << "Looked up hostname after successful ping" << reply->targetHostAddress().toString() << info.hostName();
if (info.hostName() != reply->targetHostAddress().toString())
reply->m_hostName = info.hostName();
@ -590,7 +590,7 @@ void Ping::onHostLookupFinished(const QHostInfo &info)
case QHostInfo::NoError:
qCDebug(dcPing()) << "Looked up address for hostname finished successfully" << info.hostName() << info.addresses();
if (info.addresses().isEmpty()) {
qCWarning(dcPing()) << "Looked up address finished succesfully but there are no addresses available for" << info.hostName();
qCWarning(dcPing()) << "Looked up address finished successfully but there are no addresses available for" << info.hostName();
pingError = PingReply::ErrorHostNameNotFound;
} else {
QHostAddress targetHostAddress;

View File

@ -2899,7 +2899,7 @@ void TestRules::testThingBasedAndThingValueStateDescriptor()
QCOMPARE(spy.count(), 1);
reply->deleteLater();
// set power to false intially
// set power to false initially
spy.clear();
request = QNetworkRequest(QUrl(QString("http://localhost:%1/setstate?%2=%3").arg(m_mockThing1Port).arg(mockPowerStateTypeId.toString()).arg(false)));
reply = nam.get(request);