Skip to content

Commit 585b798

Browse files
committed
* Docu update
1 parent 9812718 commit 585b798

2 files changed

Lines changed: 7 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ All notable changes to this project will be documented in this file.
33

44
## Release 0.4.1
55

6+
### Improvements
7+
- Updated docu and added "Known issues" in README that data of registered events to be forwarded via MQTT are always published as converted data type "string".
8+
69
### Bugfix
710
- Did not convert data of registered events to strings before trying to publish them via MQTT
811

docu/CSK_Module_MQTTClient.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -830,7 +830,7 @@ <h4 id="_short_description_2">Short description</h4>
830830
<strong>4) Publish</strong><br>
831831
It is possible to publish MQTT messages via "publish" (via script) or "publishViaUI (via UI) to use preset values (check "presetPublish&#8230;&#8203;"-functions)<br>
832832
Additionally it is possible to configure the module to listen / wait for specific events of other modules/apps and to forward their content to predefined topics with predefined QoS/Retain.<br>
833-
This can be used e.g. to listen to "OtherModule.OnNewResult"-events and to forward the results via MQTT.<br>
833+
This can be used e.g. to listen to "OtherModule.OnNewResult"-events and to forward the results via MQTT (data will be forwarded to data type 'string').<br>
834834
To do so make use of "addPublishEvent" (via script) or the "presetPublish"-functions (incl. "presetPublishEvent") and "addPublishEventViaUI".<br>
835835
<br>
836836
<strong>5) WillMessage</strong><br>
@@ -1124,7 +1124,7 @@ <h5 id="API:Function:CSK_MQTTClient.addPublishEvent"><span class="breadcrumb">CS
11241124
<div class="sect5">
11251125
<h6 id="_short_description_3">Short description</h6>
11261126
<div class="paragraph">
1127-
<p>Function to add an event to listen to and forward content if notified with configured MQTT publish message.</p>
1127+
<p>Function to add an event to listen to and forward content (as string) if notified with configured MQTT publish message.</p>
11281128
</div>
11291129
</div>
11301130
<div class="sect5">
@@ -1188,7 +1188,7 @@ <h5 id="API:Function:CSK_MQTTClient.addPublishEventViaUI"><span class="breadcrum
11881188
<div class="sect5">
11891189
<h6 id="_short_description_4">Short description</h6>
11901190
<div class="paragraph">
1191-
<p>Function to add a preset event with preset configuration (topic, QoS, Retain) to listen to and to forward content via MQTT publish.</p>
1191+
<p>Function to add a preset event with preset configuration (topic, QoS, Retain) to listen to and to forward content (as string) via MQTT publish.</p>
11921192
</div>
11931193
</div>
11941194
<div class="sect5">
@@ -5287,7 +5287,7 @@ <h3 id="API:Enum:CSK_MQTTClient.TLSVersion"><span class="api-enum">CSK_MQTTClien
52875287
<div id="footer">
52885288
<div id="footer-text">
52895289
Version 0.4.1<br>
5290-
Last updated 2023-09-19 10:40:06 +0200
5290+
Last updated 2023-09-19 11:19:46 +0200
52915291
</div>
52925292
</div>
52935293
<script type="text/javascript">

0 commit comments

Comments
 (0)