Skip to content

Commit 498ad77

Browse files
martinboersmartinboers
committed
Add docs directory and link from README
1 parent e6840b9 commit 498ad77

File tree

198 files changed

+13100
-8
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

198 files changed

+13100
-8
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
| Date | Version | Author |
1010
|------------|---------|--------------|
11-
| 29.03.2019 | 0.0.1 | Martin Boers |
11+
| 29.03.2019 | 1.0.0 | Martin Boers |
1212

1313

1414
## Description
@@ -21,7 +21,7 @@ Contributions to this project are welcome.
2121

2222
## Building from source
2323

24-
Building from source requires the PLCnext SDK for your target. It is strongly recommended that you use the PLCnext Command Line Interface (CLI) to install and manage PLCnext SDKs on your host. Assistance with this is available from the PLCnext Community.
24+
Building from source requires the PLCnext SDK for your target. It is strongly recommended that you use the PLCnext Command Line Interface (CLI) to install and manage PLCnext SDKs on your host. Assistance with this is available from the [PLCnext Community](https://www.plcnext-community.net).
2525

2626
An example of a build session is as follows:
2727

@@ -62,7 +62,7 @@ Basic steps for using the MQTT Client RSC service in a PLCnext C++ component:
6262
- In the component's `SubscribeServices` method, call `ServiceManager::GetService<IMqttClientService>("PxceTcs")`, and assign the result to the pointer variable.
6363
- Using the assigned pointer, call the `CreateClient` method to create an MQTT Client.
6464

65-
The complete set of available MQTT Client methods are documented ... (here).
65+
The complete API for the MQTT Client service is available [here](https://github.com/plcnext/MqttClient/docs/index.html).
6666

6767
The `CreateClient` method must always be called before any other MQTT operation. This method returns a unique ID that must be used in all other method calls. In this way, it is possible to create multiple MQTT Client instances.
6868

‎ReleaseNotes.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# ReleaseNotes
22

3-
## Release version 0.0.1
3+
## Current version
44

5-
| Datum | Version | Author |
6-
|------------|-------------|--------------|
7-
| 29.03.2019 | 0.0.1 | Martin Boers |
5+
| Date | Version |
6+
|------------|-------------|
7+
| 29.03.2019 | 1.0.0 |
88

9-
### Features
9+
### New Features
1010

1111
### Changes
1212

1313
### BugFixes
14+
15+
----------
16+
17+
## Previous versions
18+

‎docs/PLCnextStore_App_paho_03.png‎

3.42 KB
Loading

‎docs/_connect_options_8hpp_source.html‎

Lines changed: 90 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_i_mqtt_client_service_8hpp_source.html‎

Lines changed: 87 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_message_8hpp_source.html‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.15"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>MQTT Client: C:/Users/iebm01/Desktop/MqttClientService/Cpp/Eclipse/src/Services/Message.hpp Source File</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectlogo"><img alt="Logo" src="PLCnextStore_App_paho_03.png"/></td>
24+
<td id="projectalign" style="padding-left: 0.5em;">
25+
<div id="projectname">MQTT Client
26+
&#160;<span id="projectnumber">1.0.0</span>
27+
</div>
28+
</td>
29+
</tr>
30+
</tbody>
31+
</table>
32+
</div>
33+
<!-- end header part -->
34+
<!-- Generated by Doxygen 1.8.15 -->
35+
<script type="text/javascript">
36+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
37+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
38+
/* @license-end */
39+
</script>
40+
<script type="text/javascript" src="menudata.js"></script>
41+
<script type="text/javascript" src="menu.js"></script>
42+
<script type="text/javascript">
43+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
44+
$(function() {
45+
initMenu('',true,false,'search.php','Search');
46+
$(document).ready(function() { init_search(); });
47+
});
48+
/* @license-end */</script>
49+
<div id="main-nav"></div>
50+
<!-- window showing the filter options -->
51+
<div id="MSearchSelectWindow"
52+
onmouseover="return searchBox.OnSearchSelectShow()"
53+
onmouseout="return searchBox.OnSearchSelectHide()"
54+
onkeydown="return searchBox.OnSearchSelectKey(event)">
55+
</div>
56+
57+
<!-- iframe showing the search results (closed by default) -->
58+
<div id="MSearchResultsWindow">
59+
<iframe src="javascript:void(0)" frameborder="0"
60+
name="MSearchResults" id="MSearchResults">
61+
</iframe>
62+
</div>
63+
64+
<div id="nav-path" class="navpath">
65+
<ul>
66+
<li class="navelem"><a class="el" href="dir_e04ae2849dfa520b4ee2c9f7e9ff15de.html">Desktop</a></li><li class="navelem"><a class="el" href="dir_717eb9f61b51ce50f0de22cc26c6546d.html">MqttClientService</a></li><li class="navelem"><a class="el" href="dir_252ceb4d48781b975620d9d49b7036a4.html">Cpp</a></li><li class="navelem"><a class="el" href="dir_b7b9236d522a8cac8d553c2b290c70eb.html">Eclipse</a></li><li class="navelem"><a class="el" href="dir_2254d16c067442651d320d72de999bdd.html">src</a></li><li class="navelem"><a class="el" href="dir_4c02653dbbaa59c83658be8aa9eddaf3.html">Services</a></li> </ul>
67+
</div>
68+
</div><!-- top -->
69+
<div class="header">
70+
<div class="headertitle">
71+
<div class="title">Message.hpp</div> </div>
72+
</div><!--header-->
73+
<div class="contents">
74+
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Copyright PHOENIX CONTACT Electronics GmbH</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"></span><span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;Arp/System/Core/Arp.h&quot;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;Arp/System/Rsc/Services/IRscSerializable.hpp&quot;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &quot;Arp/System/Rsc/Services/RscReader.hpp&quot;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#include &quot;Arp/System/Rsc/Services/RscString.hxx&quot;</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;Arp/System/Rsc/Services/RscVariant.hxx&quot;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;Arp/System/Rsc/Services/RscWriter.hpp&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">namespace </span>PxceTcs { <span class="keyword">namespace </span>MqttClient { <span class="keyword">namespace </span>Services</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">using namespace </span>Arp;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">using namespace </span>Arp::System::Rsc::Services;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html"> 26</a></span>&#160;<span class="keyword">struct </span><a class="code" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html">Message</a> : <span class="keyword">public</span> IRscSerializable</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#a89e36bab9b2361f1347d1ed63c3526af"> 31</a></span>&#160; RscString&lt;512&gt; <a class="code" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#a89e36bab9b2361f1347d1ed63c3526af">topic</a>;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#a0f147795de68d08a1b0581396c4127e1"> 36</a></span>&#160; RscVariant&lt;512&gt; <a class="code" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#a0f147795de68d08a1b0581396c4127e1">payload</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#a87fcd0036ff645d4ab4f780b36b27af2"> 41</a></span>&#160; int32 len = 0;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#a27555c1c7c01efaccbcb31fcae34be2c"> 46</a></span>&#160; int32 qos = 0;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#a7c5692e2e13ab27f34f323c74d02317a"> 51</a></span>&#160; <span class="keywordtype">boolean</span> duplicate = <span class="keyword">false</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#ac1314720a38422eab49dd4542285c880"> 56</a></span>&#160; <span class="keywordtype">boolean</span> retained = <span class="keyword">false</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">void</span> Serialize(RscWriter&amp; writer)<span class="keyword">const override</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword"> </span>{</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; writer.Write(this-&gt;topic);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; writer.Write(this-&gt;payload);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; writer.Write(this-&gt;len);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; writer.Write(this-&gt;qos);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; writer.Write(this-&gt;duplicate);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; writer.Write(this-&gt;retained);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">void</span> Deserialize(RscReader&amp; reader)<span class="keyword">override</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="keyword"> </span>{</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; reader.Read(this-&gt;topic);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; reader.Read(this-&gt;payload);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; reader.Read(this-&gt;len);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; reader.Read(this-&gt;qos);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; reader.Read(this-&gt;duplicate);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; reader.Read(this-&gt;retained);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">static</span> <span class="keywordtype">size_t</span> GetFieldCount(<span class="keywordtype">void</span>)</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> 6;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;};</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;}}} <span class="comment">// end of namespace PxceTcs::MqttClient::Services</span></div><div class="ttc" id="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message_html_a0f147795de68d08a1b0581396c4127e1"><div class="ttname"><a href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#a0f147795de68d08a1b0581396c4127e1">PxceTcs::MqttClient::Services::Message::payload</a></div><div class="ttdeci">RscVariant&lt; 512 &gt; payload</div><div class="ttdoc">The message payload, truncated to 512 bytes if necessary.</div><div class="ttdef"><b>Definition:</b> Message.hpp:36</div></div>
75+
<div class="ttc" id="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message_html_a89e36bab9b2361f1347d1ed63c3526af"><div class="ttname"><a href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html#a89e36bab9b2361f1347d1ed63c3526af">PxceTcs::MqttClient::Services::Message::topic</a></div><div class="ttdeci">RscString&lt; 512 &gt; topic</div><div class="ttdoc">The message topic.</div><div class="ttdef"><b>Definition:</b> Message.hpp:31</div></div>
76+
<div class="ttc" id="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message_html"><div class="ttname"><a href="struct_pxce_tcs_1_1_mqtt_client_1_1_services_1_1_message.html">PxceTcs::MqttClient::Services::Message</a></div><div class="ttdoc">An MQTT message holds everything required for an MQTT PUBLISH message. This holds the message payload...</div><div class="ttdef"><b>Definition:</b> Message.hpp:26</div></div>
77+
</div><!-- fragment --></div><!-- contents -->
78+
<!-- start footer part -->
79+
<hr class="footer"/><address class="footer"><small>
80+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
81+
<img class="footer" src="doxygen.png" alt="doxygen"/>
82+
</a> 1.8.15
83+
</small></address>
84+
</body>
85+
</html>

0 commit comments

Comments
 (0)