Added source docu, license and changelog files.

Sun, 02 Sep 2018 18:36:22 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 02 Sep 2018 18:36:22 +0200
changeset 12
e0175cb7c5d5
parent 11
90d3ebed4cc0
child 13
0f819898a1c8

Added source docu, license and changelog files.

ChangeLog file | annotate | diff | comparison | revisions
MqttMonitor/Documentation/LICENSE.GPL3 file | annotate | diff | comparison | revisions
MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html file | annotate | diff | comparison | revisions
MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html file | annotate | diff | comparison | revisions
MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html file | annotate | diff | comparison | revisions
MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html file | annotate | diff | comparison | revisions
MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.MqttMonitor.html file | annotate | diff | comparison | revisions
MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.html file | annotate | diff | comparison | revisions
MqttMonitor/Documentation/source/index.html file | annotate | diff | comparison | revisions
PluginMqttMonitor.e4p file | annotate | diff | comparison | revisions
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ChangeLog	Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,4 @@
+ChangeLog
+---------
+Version 1.0.0
+- first stable release
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MqttMonitor/Documentation/LICENSE.GPL3	Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,621 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html	Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,470 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Mqtt_Monitor.MqttMonitor.MqttClient</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttClient</h1>
+<p>
+Module implementing a PyQt wrapper around the paho MQTT client.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#MqttClient">MqttClient</a></td>
+<td>Class implementing a PyQt wrapper around the paho MQTT client.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#mqttConnackMessage">mqttConnackMessage</a></td>
+<td>Public method to get the string associated with a CONNACK result.</td>
+</tr><tr>
+<td><a href="#mqttErrorMessage">mqttErrorMessage</a></td>
+<td>Public method to get the error string associated with an MQTT error number.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="MqttClient" ID="MqttClient"></a>
+<h2>MqttClient</h2>
+<p>
+    Class implementing a PyQt wrapper around the paho MQTT client.
+</p><h3>Signals</h3>
+<dl>
+<dt>onConnect(flags, rc)</dt>
+<dd>
+emitted after the client has connected to the
+        broker
+</dd><dt>onDisconnected(rc)</dt>
+<dd>
+emitted after the client has disconnected from
+        the broker
+</dd><dt>onMessage(topic, payload, qos, retain)</dt>
+<dd>
+emitted after a message has
+        been received by the client
+</dd><dt>onPublish(mid)</dt>
+<dd>
+emitted after a message has been published
+</dd><dt>onSubscribe(mid, grantedQos)</dt>
+<dd>
+emitted after the client has
+        subscribed to some topics
+</dd><dt>onUnsubscribe(mid)</dt>
+<dd>
+emitted after the client has unsubscribed from
+        some topics
+</dd>
+</dl>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#MqttClient.__init__">MqttClient</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#MqttClient.__initCallbacks">__initCallbacks</a></td>
+<td>Private method to initialize the MQTT callback methods.</td>
+</tr><tr>
+<td><a href="#MqttClient.connectToServer">connectToServer</a></td>
+<td>Public method to connect to a remote MQTT broker.</td>
+</tr><tr>
+<td><a href="#MqttClient.connectToServerWithOptions">connectToServerWithOptions</a></td>
+<td>Public method to connect to a remote MQTT broker.</td>
+</tr><tr>
+<td><a href="#MqttClient.defaultConnectionOptions">defaultConnectionOptions</a></td>
+<td>Public method to get a connection options dictionary with default values.</td>
+</tr><tr>
+<td><a href="#MqttClient.disconnectFromServer">disconnectFromServer</a></td>
+<td>Public method to disconnect the client from the remote broker.</td>
+</tr><tr>
+<td><a href="#MqttClient.publish">publish</a></td>
+<td>Public method to publish to a topic.</td>
+</tr><tr>
+<td><a href="#MqttClient.reconnectToServer">reconnectToServer</a></td>
+<td>Public method to reconnect the client with the same parameters.</td>
+</tr><tr>
+<td><a href="#MqttClient.reinitialise">reinitialise</a></td>
+<td>Public method to reinitialize the client with given data.</td>
+</tr><tr>
+<td><a href="#MqttClient.setLastWill">setLastWill</a></td>
+<td>Public method to set the last will of the client.</td>
+</tr><tr>
+<td><a href="#MqttClient.setMaxInflightMessages">setMaxInflightMessages</a></td>
+<td>Public method to set the maximum number of messages with QoS > 0 that can be part way through their network flow at once.</td>
+</tr><tr>
+<td><a href="#MqttClient.setMaxQueuedMessages">setMaxQueuedMessages</a></td>
+<td>Public method to set the maximum number of messages with QoS > 0 that can be pending in the outgoing message queue.</td>
+</tr><tr>
+<td><a href="#MqttClient.setUserCredentials">setUserCredentials</a></td>
+<td>Public method to set the user name and optionally the password.</td>
+</tr><tr>
+<td><a href="#MqttClient.setUserData">setUserData</a></td>
+<td>Public method to set the user data.</td>
+</tr><tr>
+<td><a href="#MqttClient.startLoop">startLoop</a></td>
+<td>Public method to start the MQTT client loop.</td>
+</tr><tr>
+<td><a href="#MqttClient.stopLoop">stopLoop</a></td>
+<td>Public method to stop the MQTT client loop.</td>
+</tr><tr>
+<td><a href="#MqttClient.subscribe">subscribe</a></td>
+<td>Public method to subscribe to topics with quality of service.</td>
+</tr><tr>
+<td><a href="#MqttClient.unsubscribe">unsubscribe</a></td>
+<td>Public method to unsubscribe topics.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="MqttClient.__init__" ID="MqttClient.__init__"></a>
+<h4>MqttClient (Constructor)</h4>
+<b>MqttClient</b>(<i>clientId="", cleanSession=True, userdata=None, protocol=mqtt.MQTTv311, transport="tcp", parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>clientId</i> (str)</dt>
+<dd>
+ID to be used for the client
+</dd><dt><i>cleanSession</i> (bool)</dt>
+<dd>
+flag indicating to start a clean session
+</dd><dt><i>userdata</i> (any)</dt>
+<dd>
+user data
+</dd><dt><i>protocol</i> (int, one of mqtt.MQTTv31 or mqtt.MQTTv311)</dt>
+<dd>
+version of the MQTT protocol to use
+</dd><dt><i>transport</i> (str, one of "tcp" or "websockets")</dt>
+<dd>
+transport to be used
+</dd><dt><i>parent</i> (QObject)</dt>
+<dd>
+reference to the parent object
+</dd>
+</dl><a NAME="MqttClient.__initCallbacks" ID="MqttClient.__initCallbacks"></a>
+<h4>MqttClient.__initCallbacks</h4>
+<b>__initCallbacks</b>(<i></i>)
+<p>
+        Private method to initialize the MQTT callback methods.
+</p><a NAME="MqttClient.connectToServer" ID="MqttClient.connectToServer"></a>
+<h4>MqttClient.connectToServer</h4>
+<b>connectToServer</b>(<i>host, port=1883, keepalive=60, bindAddress=""</i>)
+<p>
+        Public method to connect to a remote MQTT broker.
+</p><dl>
+<dt><i>host</i> (str)</dt>
+<dd>
+host name or IP address of the remote broker
+</dd><dt><i>port</i> (int)</dt>
+<dd>
+network port of the server host to connect to (default:
+            1883, using TLS: 8883)
+</dd><dt><i>keepalive</i> (int)</dt>
+<dd>
+maximum period in seconds allowed between
+            communications with the broker
+</dd><dt><i>bindAddress</i> (str)</dt>
+<dd>
+IP address of a local network interface to bind
+            this client to
+</dd>
+</dl><a NAME="MqttClient.connectToServerWithOptions" ID="MqttClient.connectToServerWithOptions"></a>
+<h4>MqttClient.connectToServerWithOptions</h4>
+<b>connectToServerWithOptions</b>(<i>host, port=1883, bindAddress="", options=None</i>)
+<p>
+        Public method to connect to a remote MQTT broker.
+</p><dl>
+<dt><i>host</i> (str)</dt>
+<dd>
+host name or IP address of the remote broker
+</dd><dt><i>port</i> (int)</dt>
+<dd>
+network port of the server host to connect to (default:
+            1883, using TLS: 8883)
+</dd><dt><i>bindAddress</i> (str)</dt>
+<dd>
+IP address of a local network interface to bind
+            this client to
+</dd><dt><i>options</i> (dict)</dt>
+<dd>
+dictionary containing the connection options. This
+            dictionary should contain the keys "ClientId", "Keepalive",
+            "CleanSession", "Username", "Password", "WillTopic", "WillMessage",
+            "WillQos", "WillRetain"
+</dd>
+</dl><a NAME="MqttClient.defaultConnectionOptions" ID="MqttClient.defaultConnectionOptions"></a>
+<h4>MqttClient.defaultConnectionOptions</h4>
+<b>defaultConnectionOptions</b>(<i></i>)
+<p>
+        Public method to get a connection options dictionary with default
+        values.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary containing the default connection options. It has
+            the keys "ClientId", "Keepalive", "CleanSession", "Username",
+            "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain"
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl><a NAME="MqttClient.disconnectFromServer" ID="MqttClient.disconnectFromServer"></a>
+<h4>MqttClient.disconnectFromServer</h4>
+<b>disconnectFromServer</b>(<i></i>)
+<p>
+        Public method to disconnect the client from the remote broker.
+</p><a NAME="MqttClient.publish" ID="MqttClient.publish"></a>
+<h4>MqttClient.publish</h4>
+<b>publish</b>(<i>topic, payload=None, qos=0, retain=False</i>)
+<p>
+        Public method to publish to a topic.
+</p><dl>
+<dt><i>topic</i> (str)</dt>
+<dd>
+topic to publish to
+</dd><dt><i>payload</i> (str, bytes, int or float)</dt>
+<dd>
+data to be published
+</dd><dt><i>qos</i> (int, one of 0, 1 or 2)</dt>
+<dd>
+quality of service
+</dd><dt><i>retain</i> (bool)</dt>
+<dd>
+flag indicating to set as the "last known good"/retained
+            message for the topic
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+message info object
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+mqtt.MQTTMessageInfo
+</dd>
+</dl><a NAME="MqttClient.reconnectToServer" ID="MqttClient.reconnectToServer"></a>
+<h4>MqttClient.reconnectToServer</h4>
+<b>reconnectToServer</b>(<i></i>)
+<p>
+        Public method to reconnect the client with the same parameters.
+</p><a NAME="MqttClient.reinitialise" ID="MqttClient.reinitialise"></a>
+<h4>MqttClient.reinitialise</h4>
+<b>reinitialise</b>(<i>clientId="", cleanSession=True, userdata=None</i>)
+<p>
+        Public method to reinitialize the client with given data.
+</p><dl>
+<dt><i>clientId</i> (str)</dt>
+<dd>
+ID to be used for the client
+</dd><dt><i>cleanSession</i> (bool)</dt>
+<dd>
+flag indicating to start a clean session
+</dd><dt><i>userdata</i> (any)</dt>
+<dd>
+user data
+</dd>
+</dl><a NAME="MqttClient.setLastWill" ID="MqttClient.setLastWill"></a>
+<h4>MqttClient.setLastWill</h4>
+<b>setLastWill</b>(<i>topic, payload=None, qos=0, retain=False</i>)
+<p>
+        Public method to set the last will of the client.
+</p><dl>
+<dt><i>topic</i> (str)</dt>
+<dd>
+topic the will message should be published on
+</dd><dt><i>payload</i> (str, bytes, int or float)</dt>
+<dd>
+message to send as a will
+</dd><dt><i>qos</i> (int, one of 0, 1 or 2)</dt>
+<dd>
+quality of service level to use for the will
+</dd><dt><i>retain</i> (bool)</dt>
+<dd>
+flag indicating to set as the "last known good"/retained
+            message for the will topic
+</dd>
+</dl><a NAME="MqttClient.setMaxInflightMessages" ID="MqttClient.setMaxInflightMessages"></a>
+<h4>MqttClient.setMaxInflightMessages</h4>
+<b>setMaxInflightMessages</b>(<i>inflight=20</i>)
+<p>
+        Public method to set the maximum number of messages with QoS > 0 that
+        can be part way through their network flow at once.
+</p><dl>
+<dt><i>inflight</i> (int)</dt>
+<dd>
+maximum number of messages in flight
+</dd>
+</dl><a NAME="MqttClient.setMaxQueuedMessages" ID="MqttClient.setMaxQueuedMessages"></a>
+<h4>MqttClient.setMaxQueuedMessages</h4>
+<b>setMaxQueuedMessages</b>(<i>queueSize=0</i>)
+<p>
+        Public method to set the maximum number of messages with QoS > 0 that
+        can be pending in the outgoing message queue.
+</p><dl>
+<dt><i>queueSize</i> (int)</dt>
+<dd>
+maximum number of queued messages (0 = unlimited)
+</dd>
+</dl><a NAME="MqttClient.setUserCredentials" ID="MqttClient.setUserCredentials"></a>
+<h4>MqttClient.setUserCredentials</h4>
+<b>setUserCredentials</b>(<i>username, password=None</i>)
+<p>
+        Public method to set the user name and optionally the password.
+</p><dl>
+<dt><i>username</i> (str)</dt>
+<dd>
+user name to be set
+</dd><dt><i>password</i> (str)</dt>
+<dd>
+optional password
+</dd>
+</dl><a NAME="MqttClient.setUserData" ID="MqttClient.setUserData"></a>
+<h4>MqttClient.setUserData</h4>
+<b>setUserData</b>(<i>userdata</i>)
+<p>
+        Public method to set the user data.
+</p><dl>
+<dt><i>userdata</i> (any)</dt>
+<dd>
+user data
+</dd>
+</dl><a NAME="MqttClient.startLoop" ID="MqttClient.startLoop"></a>
+<h4>MqttClient.startLoop</h4>
+<b>startLoop</b>(<i></i>)
+<p>
+        Public method to start the MQTT client loop.
+</p><a NAME="MqttClient.stopLoop" ID="MqttClient.stopLoop"></a>
+<h4>MqttClient.stopLoop</h4>
+<b>stopLoop</b>(<i></i>)
+<p>
+        Public method to stop the MQTT client loop.
+</p><a NAME="MqttClient.subscribe" ID="MqttClient.subscribe"></a>
+<h4>MqttClient.subscribe</h4>
+<b>subscribe</b>(<i>topic, qos=0</i>)
+<p>
+        Public method to subscribe to topics with quality of service.
+</p><dl>
+<dt><i>topic</i> (str or tuple of (str, int) or list of tuple of (str, int))</dt>
+<dd>
+single topic to subscribe to or a tuple with a topic
+            and a QoS or a list of tuples with a topic and a QoS each
+</dd><dt><i>qos</i> (int, one of 0, 1 or 2)</dt>
+<dd>
+quality of service
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing the result code and the message ID
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int)
+</dd>
+</dl><a NAME="MqttClient.unsubscribe" ID="MqttClient.unsubscribe"></a>
+<h4>MqttClient.unsubscribe</h4>
+<b>unsubscribe</b>(<i>topic</i>)
+<p>
+        Public method to unsubscribe topics.
+</p><dl>
+<dt><i>topic</i> (str or list of str)</dt>
+<dd>
+topic or list of topics to unsubscribe
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+tuple containing the result code and the message ID
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="mqttConnackMessage" ID="mqttConnackMessage"></a>
+<h2>mqttConnackMessage</h2>
+<b>mqttConnackMessage</b>(<i>connackCode</i>)
+<p>
+    Public method to get the string associated with a CONNACK result.
+</p><dl>
+<dt><i>connackCode</i> (int)</dt>
+<dd>
+result code of the connection request
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+textual representation for the result code
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="mqttErrorMessage" ID="mqttErrorMessage"></a>
+<h2>mqttErrorMessage</h2>
+<b>mqttErrorMessage</b>(<i>mqttErrno</i>)
+<p>
+    Public method to get the error string associated with an MQTT error
+    number.
+</p><dl>
+<dt><i>mqttErrno</i> (int)</dt>
+<dd>
+result code of a MQTT request
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+textual representation of the result code
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html	Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,151 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog</h1>
+<p>
+Module implementing a dialog to enter MQTT connection options.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#MqttConnectionOptionsDialog">MqttConnectionOptionsDialog</a></td>
+<td>Class implementing a dialog to enter MQTT connection options.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="MqttConnectionOptionsDialog" ID="MqttConnectionOptionsDialog"></a>
+<h2>MqttConnectionOptionsDialog</h2>
+<p>
+    Class implementing a dialog to enter MQTT connection options.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_MqttConnectionOptionsDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#MqttConnectionOptionsDialog.__init__">MqttConnectionOptionsDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#MqttConnectionOptionsDialog.__populateDefaults">__populateDefaults</a></td>
+<td>Private method to populate the dialog.</td>
+</tr><tr>
+<td><a href="#MqttConnectionOptionsDialog.getConnectionOptions">getConnectionOptions</a></td>
+<td>Public method get the entered connection options.</td>
+</tr><tr>
+<td><a href="#MqttConnectionOptionsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
+<td>Private slot to handle the press of a button box button.</td>
+</tr><tr>
+<td><a href="#MqttConnectionOptionsDialog.on_generateIdButton_clicked">on_generateIdButton_clicked</a></td>
+<td>Private slot to generate a client ID.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="MqttConnectionOptionsDialog.__init__" ID="MqttConnectionOptionsDialog.__init__"></a>
+<h4>MqttConnectionOptionsDialog (Constructor)</h4>
+<b>MqttConnectionOptionsDialog</b>(<i>client, options=None, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>client</i> (MqttClient)</dt>
+<dd>
+reference to the MQTT client object
+</dd><dt><i>options</i></dt>
+<dd>
+dictionary containing the connection options to
+            populate the dialog with. It must have the keys "ClientId",
+            "Keepalive", "CleanSession", "Username", "Password", "WillTopic",
+            "WillMessage", "WillQos", "WillRetain".
+@type dict
+</dd><dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl><a NAME="MqttConnectionOptionsDialog.__populateDefaults" ID="MqttConnectionOptionsDialog.__populateDefaults"></a>
+<h4>MqttConnectionOptionsDialog.__populateDefaults</h4>
+<b>__populateDefaults</b>(<i>options=None</i>)
+<p>
+        Private method to populate the dialog.
+</p><p>
+        If no options dictionary is given, the dialog will be populated with
+        default values.
+</p><dl>
+<dt><i>options</i> (dict)</dt>
+<dd>
+dictionary containing the connection options to populate
+            the dialog with. It must have the keys "ClientId", "Keepalive",
+            "CleanSession", "Username", "Password", "WillTopic", "WillMessage",
+            "WillQos", "WillRetain".
+</dd>
+</dl><a NAME="MqttConnectionOptionsDialog.getConnectionOptions" ID="MqttConnectionOptionsDialog.getConnectionOptions"></a>
+<h4>MqttConnectionOptionsDialog.getConnectionOptions</h4>
+<b>getConnectionOptions</b>(<i></i>)
+<p>
+        Public method get the entered connection options.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary containing the connection options. It has the keys
+            "ClientId", "Keepalive", "CleanSession", "Username", "Password",
+            "WillTopic", "WillMessage", "WillQos", "WillRetain".
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, dict)
+</dd>
+</dl><a NAME="MqttConnectionOptionsDialog.on_buttonBox_clicked" ID="MqttConnectionOptionsDialog.on_buttonBox_clicked"></a>
+<h4>MqttConnectionOptionsDialog.on_buttonBox_clicked</h4>
+<b>on_buttonBox_clicked</b>(<i>button</i>)
+<p>
+        Private slot to handle the press of a button box button.
+</p><dl>
+<dt><i>button</i> (QAbstractButton)</dt>
+<dd>
+button that has been pressed
+</dd>
+</dl><a NAME="MqttConnectionOptionsDialog.on_generateIdButton_clicked" ID="MqttConnectionOptionsDialog.on_generateIdButton_clicked"></a>
+<h4>MqttConnectionOptionsDialog.on_generateIdButton_clicked</h4>
+<b>on_generateIdButton_clicked</b>(<i></i>)
+<p>
+        Private slot to generate a client ID.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html	Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,429 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget</h1>
+<p>
+Module implementing the MQTT Monitor widget.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#MqttMonitorWidget">MqttMonitorWidget</a></td>
+<td>Class implementing the MQTT Monitor widget.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="MqttMonitorWidget" ID="MqttMonitorWidget"></a>
+<h2>MqttMonitorWidget</h2>
+<p>
+    Class implementing the MQTT Monitor widget.
+</p>
+<h3>Derived from</h3>
+QWidget, Ui_MqttMonitorWidget
+<h3>Class Attributes</h3>
+<table>
+<tr><td>BrokerStatusTopic</td></tr><tr><td>BrokerStatusTopicLoadPrefix</td></tr><tr><td>BrokerStatusTopicPrefix</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#MqttMonitorWidget.__init__">MqttMonitorWidget</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__addBrokerToRecent">__addBrokerToRecent</a></td>
+<td>Private method to add a host name to the list of recently connected brokers.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__appendMessage">__appendMessage</a></td>
+<td>Private method to append a received message to the output.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__brokerConnected">__brokerConnected</a></td>
+<td>Private slot to handle being connected to a broker.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__brokerDisconnected">__brokerDisconnected</a></td>
+<td>Private slot to handle a disconnection from the broker.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__clearBrokerStatusLabels">__clearBrokerStatusLabels</a></td>
+<td>Private method to clear the broker status labels.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__flashBrokerStatusLabel">__flashBrokerStatusLabel</a></td>
+<td>Private slot to show the broker status label with some text for 5 seconds.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__handleBrokerLoadStatusMessage">__handleBrokerLoadStatusMessage</a></td>
+<td>Private method to append a received message to the output.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__handleBrokerStatusMessage">__handleBrokerStatusMessage</a></td>
+<td>Private method to append a received message to the output.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__loadDefaultDictFactory">__loadDefaultDictFactory</a></td>
+<td>Private method to populate non-existing load items.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__messagePublished">__messagePublished</a></td>
+<td>Private slot to handle a message being published.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__messageReceived">__messageReceived</a></td>
+<td>Private slot to handle the receipt of a message.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__populateBrokerComboBoxes">__populateBrokerComboBoxes</a></td>
+<td>Private method to populate the broker name and port combo boxes.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__setBrokerStatusSubscribed">__setBrokerStatusSubscribed</a></td>
+<td>Private method to set the subscription status for the broker status topics.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__topicSubscribed">__topicSubscribed</a></td>
+<td>Private slot to handle being subscribed to topics.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__topicUnsubscribed">__topicUnsubscribed</a></td>
+<td>Private slot to handle being unsubcribed from a topic.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__updatePublishTopicComboBox">__updatePublishTopicComboBox</a></td>
+<td>Private method to update the publish topic combo box.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.__updateUnsubscribeTopicComboBox">__updateUnsubscribeTopicComboBox</a></td>
+<td>Private method to update the unsubcribe topic combo box.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_brokerComboBox_editTextChanged">on_brokerComboBox_editTextChanged</a></td>
+<td>Private slot to handling entering or selecting a broker host name.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_brokerConnectionOptionsButton_clicked">on_brokerConnectionOptionsButton_clicked</a></td>
+<td>Private slot to show a dialog to modify connection options.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_brokerStatusButton_clicked">on_brokerStatusButton_clicked</a></td>
+<td>Private slot to subscribe or unsubscribe the broker status topic.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_connectButton_clicked">on_connectButton_clicked</a></td>
+<td>Private slot to handle a connect or disconnect request.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_publishButton_clicked">on_publishButton_clicked</a></td>
+<td>Private slot to publish the entered message.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_publishClearButton_clicked">on_publishClearButton_clicked</a></td>
+<td>Private slot to clear the publish data fields.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_publishTopicComboBox_editTextChanged">on_publishTopicComboBox_editTextChanged</a></td>
+<td>Private slot to handle changes of the publish topic name.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_subscribeButton_clicked">on_subscribeButton_clicked</a></td>
+<td>Private slot to subscribe to the entered topic.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_subscribeTopicEdit_textChanged">on_subscribeTopicEdit_textChanged</a></td>
+<td>Private slot to handle a change of the entered topic.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_unsubscribeButton_clicked">on_unsubscribeButton_clicked</a></td>
+<td>Private slot to unsubscribe from the selected topic.</td>
+</tr><tr>
+<td><a href="#MqttMonitorWidget.on_unsubscribeTopicComboBox_currentIndexChanged">on_unsubscribeTopicComboBox_currentIndexChanged</a></td>
+<td>Private slot to handle the selection of a topic to unsubscribe from.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="MqttMonitorWidget.__init__" ID="MqttMonitorWidget.__init__"></a>
+<h4>MqttMonitorWidget (Constructor)</h4>
+<b>MqttMonitorWidget</b>(<i>plugin, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>plugin</i> (MqttMonitorPlugin)</dt>
+<dd>
+reference to the plug-in object
+</dd><dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl><a NAME="MqttMonitorWidget.__addBrokerToRecent" ID="MqttMonitorWidget.__addBrokerToRecent"></a>
+<h4>MqttMonitorWidget.__addBrokerToRecent</h4>
+<b>__addBrokerToRecent</b>(<i>host, port</i>)
+<p>
+        Private method to add a host name to the list of recently connected
+        brokers.
+</p><dl>
+<dt><i>host</i> (str)</dt>
+<dd>
+host name of broker
+</dd><dt><i>port</i> (int)</dt>
+<dd>
+port number of the connection
+</dd>
+</dl><a NAME="MqttMonitorWidget.__appendMessage" ID="MqttMonitorWidget.__appendMessage"></a>
+<h4>MqttMonitorWidget.__appendMessage</h4>
+<b>__appendMessage</b>(<i>topic, payload</i>)
+<p>
+        Private method to append a received message to the output.
+</p><dl>
+<dt><i>topic</i> (str)</dt>
+<dd>
+topic of the received message
+</dd><dt><i>payload</i> (bytes)</dt>
+<dd>
+payload of the received message
+</dd>
+</dl><a NAME="MqttMonitorWidget.__brokerConnected" ID="MqttMonitorWidget.__brokerConnected"></a>
+<h4>MqttMonitorWidget.__brokerConnected</h4>
+<b>__brokerConnected</b>(<i>flags, rc</i>)
+<p>
+        Private slot to handle being connected to a broker.
+</p><dl>
+<dt><i>flags</i> (dict)</dt>
+<dd>
+flags set for the connection
+</dd><dt><i>rc</i> (int)</dt>
+<dd>
+CONNACK result code
+</dd>
+</dl><a NAME="MqttMonitorWidget.__brokerDisconnected" ID="MqttMonitorWidget.__brokerDisconnected"></a>
+<h4>MqttMonitorWidget.__brokerDisconnected</h4>
+<b>__brokerDisconnected</b>(<i>rc</i>)
+<p>
+        Private slot to handle a disconnection from the broker.
+</p><dl>
+<dt><i>rc</i> (int)</dt>
+<dd>
+MQTT error result code
+</dd>
+</dl><a NAME="MqttMonitorWidget.__clearBrokerStatusLabels" ID="MqttMonitorWidget.__clearBrokerStatusLabels"></a>
+<h4>MqttMonitorWidget.__clearBrokerStatusLabels</h4>
+<b>__clearBrokerStatusLabels</b>(<i></i>)
+<p>
+        Private method to clear the broker status labels.
+</p><a NAME="MqttMonitorWidget.__flashBrokerStatusLabel" ID="MqttMonitorWidget.__flashBrokerStatusLabel"></a>
+<h4>MqttMonitorWidget.__flashBrokerStatusLabel</h4>
+<b>__flashBrokerStatusLabel</b>(<i>message</i>)
+<p>
+        Private slot to show the broker status label with some text for
+        5 seconds.
+</p><dl>
+<dt><i>message</i> (str)</dt>
+<dd>
+message to be shown
+</dd>
+</dl><a NAME="MqttMonitorWidget.__handleBrokerLoadStatusMessage" ID="MqttMonitorWidget.__handleBrokerLoadStatusMessage"></a>
+<h4>MqttMonitorWidget.__handleBrokerLoadStatusMessage</h4>
+<b>__handleBrokerLoadStatusMessage</b>(<i>topic, payloadStr</i>)
+<p>
+        Private method to append a received message to the output.
+</p><dl>
+<dt><i>topic</i> (str)</dt>
+<dd>
+topic of the received message
+</dd><dt><i>payloadStr</i> (str)</dt>
+<dd>
+string representation of the payload of the
+            received message
+</dd>
+</dl><a NAME="MqttMonitorWidget.__handleBrokerStatusMessage" ID="MqttMonitorWidget.__handleBrokerStatusMessage"></a>
+<h4>MqttMonitorWidget.__handleBrokerStatusMessage</h4>
+<b>__handleBrokerStatusMessage</b>(<i>topic, payload</i>)
+<p>
+        Private method to append a received message to the output.
+</p><dl>
+<dt><i>topic</i> (str)</dt>
+<dd>
+topic of the received message
+</dd><dt><i>payload</i> (bytes)</dt>
+<dd>
+payload of the received message
+</dd>
+</dl><a NAME="MqttMonitorWidget.__loadDefaultDictFactory" ID="MqttMonitorWidget.__loadDefaultDictFactory"></a>
+<h4>MqttMonitorWidget.__loadDefaultDictFactory</h4>
+<b>__loadDefaultDictFactory</b>(<i></i>)
+<p>
+        Private method to populate non-existing load items.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+default dictionary entry
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl><a NAME="MqttMonitorWidget.__messagePublished" ID="MqttMonitorWidget.__messagePublished"></a>
+<h4>MqttMonitorWidget.__messagePublished</h4>
+<b>__messagePublished</b>(<i>mid</i>)
+<p>
+        Private slot to handle a message being published.
+</p><dl>
+<dt><i>mid</i> (int)</dt>
+<dd>
+ID of the published message
+</dd>
+</dl><a NAME="MqttMonitorWidget.__messageReceived" ID="MqttMonitorWidget.__messageReceived"></a>
+<h4>MqttMonitorWidget.__messageReceived</h4>
+<b>__messageReceived</b>(<i>topic, payload, qos, retain</i>)
+<p>
+        Private slot to handle the receipt of a message.
+</p><dl>
+<dt><i>topic</i> (str)</dt>
+<dd>
+topic of the message
+</dd><dt><i>payload</i> (bytes)</dt>
+<dd>
+payload (i.e. data) of the message
+</dd><dt><i>qos</i> (int)</dt>
+<dd>
+quality of service indicator
+</dd><dt><i>retain</i> (bool)</dt>
+<dd>
+flag indicating a retained message
+</dd>
+</dl><a NAME="MqttMonitorWidget.__populateBrokerComboBoxes" ID="MqttMonitorWidget.__populateBrokerComboBoxes"></a>
+<h4>MqttMonitorWidget.__populateBrokerComboBoxes</h4>
+<b>__populateBrokerComboBoxes</b>(<i></i>)
+<p>
+        Private method to populate the broker name and port combo boxes.
+</p><a NAME="MqttMonitorWidget.__setBrokerStatusSubscribed" ID="MqttMonitorWidget.__setBrokerStatusSubscribed"></a>
+<h4>MqttMonitorWidget.__setBrokerStatusSubscribed</h4>
+<b>__setBrokerStatusSubscribed</b>(<i>subscribed</i>)
+<p>
+        Private method to set the subscription status for the broker status
+        topics.
+</p><dl>
+<dt><i>subscribed</i> (bool)</dt>
+<dd>
+subscription status for the broker status topics
+</dd>
+</dl><a NAME="MqttMonitorWidget.__topicSubscribed" ID="MqttMonitorWidget.__topicSubscribed"></a>
+<h4>MqttMonitorWidget.__topicSubscribed</h4>
+<b>__topicSubscribed</b>(<i>mid, grantedQos</i>)
+<p>
+        Private slot to handle being subscribed to topics.
+</p><dl>
+<dt><i>mid</i> (int)</dt>
+<dd>
+ID of the subscribe request
+</dd><dt><i>grantedQos</i> (tuple of int)</dt>
+<dd>
+tuple of granted quality of service
+</dd>
+</dl><a NAME="MqttMonitorWidget.__topicUnsubscribed" ID="MqttMonitorWidget.__topicUnsubscribed"></a>
+<h4>MqttMonitorWidget.__topicUnsubscribed</h4>
+<b>__topicUnsubscribed</b>(<i>mid</i>)
+<p>
+        Private slot to handle being unsubcribed from a topic.
+</p><dl>
+<dt><i>mid</i> (int)</dt>
+<dd>
+ID of the unsubscribe request
+</dd>
+</dl><a NAME="MqttMonitorWidget.__updatePublishTopicComboBox" ID="MqttMonitorWidget.__updatePublishTopicComboBox"></a>
+<h4>MqttMonitorWidget.__updatePublishTopicComboBox</h4>
+<b>__updatePublishTopicComboBox</b>(<i></i>)
+<p>
+        Private method to update the publish topic combo box.
+</p><a NAME="MqttMonitorWidget.__updateUnsubscribeTopicComboBox" ID="MqttMonitorWidget.__updateUnsubscribeTopicComboBox"></a>
+<h4>MqttMonitorWidget.__updateUnsubscribeTopicComboBox</h4>
+<b>__updateUnsubscribeTopicComboBox</b>(<i></i>)
+<p>
+        Private method to update the unsubcribe topic combo box.
+</p><a NAME="MqttMonitorWidget.on_brokerComboBox_editTextChanged" ID="MqttMonitorWidget.on_brokerComboBox_editTextChanged"></a>
+<h4>MqttMonitorWidget.on_brokerComboBox_editTextChanged</h4>
+<b>on_brokerComboBox_editTextChanged</b>(<i>host</i>)
+<p>
+        Private slot to handling entering or selecting a broker host name.
+</p><dl>
+<dt><i>host</i> (str)</dt>
+<dd>
+host name of the broker
+</dd>
+</dl><a NAME="MqttMonitorWidget.on_brokerConnectionOptionsButton_clicked" ID="MqttMonitorWidget.on_brokerConnectionOptionsButton_clicked"></a>
+<h4>MqttMonitorWidget.on_brokerConnectionOptionsButton_clicked</h4>
+<b>on_brokerConnectionOptionsButton_clicked</b>(<i></i>)
+<p>
+        Private slot to show a dialog to modify connection options.
+</p><a NAME="MqttMonitorWidget.on_brokerStatusButton_clicked" ID="MqttMonitorWidget.on_brokerStatusButton_clicked"></a>
+<h4>MqttMonitorWidget.on_brokerStatusButton_clicked</h4>
+<b>on_brokerStatusButton_clicked</b>(<i></i>)
+<p>
+        Private slot to subscribe or unsubscribe the broker status topic.
+</p><a NAME="MqttMonitorWidget.on_connectButton_clicked" ID="MqttMonitorWidget.on_connectButton_clicked"></a>
+<h4>MqttMonitorWidget.on_connectButton_clicked</h4>
+<b>on_connectButton_clicked</b>(<i></i>)
+<p>
+        Private slot to handle a connect or disconnect request.
+</p><a NAME="MqttMonitorWidget.on_publishButton_clicked" ID="MqttMonitorWidget.on_publishButton_clicked"></a>
+<h4>MqttMonitorWidget.on_publishButton_clicked</h4>
+<b>on_publishButton_clicked</b>(<i></i>)
+<p>
+        Private slot to publish the entered message.
+</p><a NAME="MqttMonitorWidget.on_publishClearButton_clicked" ID="MqttMonitorWidget.on_publishClearButton_clicked"></a>
+<h4>MqttMonitorWidget.on_publishClearButton_clicked</h4>
+<b>on_publishClearButton_clicked</b>(<i></i>)
+<p>
+        Private slot to clear the publish data fields.
+</p><a NAME="MqttMonitorWidget.on_publishTopicComboBox_editTextChanged" ID="MqttMonitorWidget.on_publishTopicComboBox_editTextChanged"></a>
+<h4>MqttMonitorWidget.on_publishTopicComboBox_editTextChanged</h4>
+<b>on_publishTopicComboBox_editTextChanged</b>(<i>topic</i>)
+<p>
+        Private slot to handle changes of the publish topic name.
+</p><dl>
+<dt><i>topic</i> (str)</dt>
+<dd>
+topic text
+</dd>
+</dl><a NAME="MqttMonitorWidget.on_subscribeButton_clicked" ID="MqttMonitorWidget.on_subscribeButton_clicked"></a>
+<h4>MqttMonitorWidget.on_subscribeButton_clicked</h4>
+<b>on_subscribeButton_clicked</b>(<i></i>)
+<p>
+        Private slot to subscribe to the entered topic.
+</p><a NAME="MqttMonitorWidget.on_subscribeTopicEdit_textChanged" ID="MqttMonitorWidget.on_subscribeTopicEdit_textChanged"></a>
+<h4>MqttMonitorWidget.on_subscribeTopicEdit_textChanged</h4>
+<b>on_subscribeTopicEdit_textChanged</b>(<i>topic</i>)
+<p>
+        Private slot to handle a change of the entered topic.
+</p><dl>
+<dt><i>topic</i> (str)</dt>
+<dd>
+entered topic text
+</dd>
+</dl><a NAME="MqttMonitorWidget.on_unsubscribeButton_clicked" ID="MqttMonitorWidget.on_unsubscribeButton_clicked"></a>
+<h4>MqttMonitorWidget.on_unsubscribeButton_clicked</h4>
+<b>on_unsubscribeButton_clicked</b>(<i></i>)
+<p>
+        Private slot to unsubscribe from the selected topic.
+</p><a NAME="MqttMonitorWidget.on_unsubscribeTopicComboBox_currentIndexChanged" ID="MqttMonitorWidget.on_unsubscribeTopicComboBox_currentIndexChanged"></a>
+<h4>MqttMonitorWidget.on_unsubscribeTopicComboBox_currentIndexChanged</h4>
+<b>on_unsubscribeTopicComboBox_currentIndexChanged</b>(<i>topic</i>)
+<p>
+        Private slot to handle the selection of a topic to unsubscribe from.
+</p><dl>
+<dt><i>topic</i> (str)</dt>
+<dd>
+topic text
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.PluginMqttMonitor.html	Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,198 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Mqtt_Monitor.PluginMqttMonitor</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>Plugin_Mqtt_Monitor.PluginMqttMonitor</h1>
+<p>
+Module implementing the MQTT Monitor plug-in.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#MqttMonitorPlugin">MqttMonitorPlugin</a></td>
+<td>Class implementing the MQTT Monitor plug-in.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#exeDisplayData">exeDisplayData</a></td>
+<td>Module function to support the display of some executable info.</td>
+</tr><tr>
+<td><a href="#prepareUninstall">prepareUninstall</a></td>
+<td>Module function to prepare for an uninstallation.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="MqttMonitorPlugin" ID="MqttMonitorPlugin"></a>
+<h2>MqttMonitorPlugin</h2>
+<p>
+    Class implementing the MQTT Monitor plug-in.
+</p>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>PreferencesKey</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#MqttMonitorPlugin.__init__">MqttMonitorPlugin</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#MqttMonitorPlugin.__activateWidget">__activateWidget</a></td>
+<td>Private slot to handle the activation of the MQTT Monitor.</td>
+</tr><tr>
+<td><a href="#MqttMonitorPlugin.__initialize">__initialize</a></td>
+<td>Private slot to (re)initialize the plugin.</td>
+</tr><tr>
+<td><a href="#MqttMonitorPlugin.__loadTranslator">__loadTranslator</a></td>
+<td>Private method to load the translation file.</td>
+</tr><tr>
+<td><a href="#MqttMonitorPlugin.activate">activate</a></td>
+<td>Public method to activate this plug-in.</td>
+</tr><tr>
+<td><a href="#MqttMonitorPlugin.deactivate">deactivate</a></td>
+<td>Public method to deactivate this plug-in.</td>
+</tr><tr>
+<td><a href="#MqttMonitorPlugin.getPreferences">getPreferences</a></td>
+<td>Public method to retrieve the various settings.</td>
+</tr><tr>
+<td><a href="#MqttMonitorPlugin.setPreferences">setPreferences</a></td>
+<td>Public method to store the various settings.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="MqttMonitorPlugin.__init__" ID="MqttMonitorPlugin.__init__"></a>
+<h4>MqttMonitorPlugin (Constructor)</h4>
+<b>MqttMonitorPlugin</b>(<i>ui</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>ui</i> (UI.UserInterface)</dt>
+<dd>
+reference to the user interface object
+</dd>
+</dl><a NAME="MqttMonitorPlugin.__activateWidget" ID="MqttMonitorPlugin.__activateWidget"></a>
+<h4>MqttMonitorPlugin.__activateWidget</h4>
+<b>__activateWidget</b>(<i></i>)
+<p>
+        Private slot to handle the activation of the MQTT Monitor.
+</p><a NAME="MqttMonitorPlugin.__initialize" ID="MqttMonitorPlugin.__initialize"></a>
+<h4>MqttMonitorPlugin.__initialize</h4>
+<b>__initialize</b>(<i></i>)
+<p>
+        Private slot to (re)initialize the plugin.
+</p><a NAME="MqttMonitorPlugin.__loadTranslator" ID="MqttMonitorPlugin.__loadTranslator"></a>
+<h4>MqttMonitorPlugin.__loadTranslator</h4>
+<b>__loadTranslator</b>(<i></i>)
+<p>
+        Private method to load the translation file.
+</p><a NAME="MqttMonitorPlugin.activate" ID="MqttMonitorPlugin.activate"></a>
+<h4>MqttMonitorPlugin.activate</h4>
+<b>activate</b>(<i></i>)
+<p>
+        Public method to activate this plug-in.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+tuple of None and activation status
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="MqttMonitorPlugin.deactivate" ID="MqttMonitorPlugin.deactivate"></a>
+<h4>MqttMonitorPlugin.deactivate</h4>
+<b>deactivate</b>(<i></i>)
+<p>
+        Public method to deactivate this plug-in.
+</p><a NAME="MqttMonitorPlugin.getPreferences" ID="MqttMonitorPlugin.getPreferences"></a>
+<h4>MqttMonitorPlugin.getPreferences</h4>
+<b>getPreferences</b>(<i>key</i>)
+<p>
+        Public method to retrieve the various settings.
+</p><dl>
+<dt><i>key</i></dt>
+<dd>
+the key of the value to get
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the requested setting
+</dd>
+</dl><a NAME="MqttMonitorPlugin.setPreferences" ID="MqttMonitorPlugin.setPreferences"></a>
+<h4>MqttMonitorPlugin.setPreferences</h4>
+<b>setPreferences</b>(<i>key, value</i>)
+<p>
+        Public method to store the various settings.
+</p><dl>
+<dt><i>key</i></dt>
+<dd>
+the key of the setting to be set (string)
+</dd><dt><i>value</i></dt>
+<dd>
+the value to be set
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="exeDisplayData" ID="exeDisplayData"></a>
+<h2>exeDisplayData</h2>
+<b>exeDisplayData</b>(<i></i>)
+<p>
+    Module function to support the display of some executable info.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary containing the data to query the presence of
+        the executable
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="prepareUninstall" ID="prepareUninstall"></a>
+<h2>prepareUninstall</h2>
+<b>prepareUninstall</b>(<i></i>)
+<p>
+    Module function to prepare for an uninstallation.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.MqttMonitor.html	Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Mqtt_Monitor.MqttMonitor</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<h1>Plugin_Mqtt_Monitor.MqttMonitor</h1>
+<p>
+Package containing the MQTT Monitor modules and data files.
+</p>
+
+
+<h3>Modules</h3>
+<table>
+<tr>
+<td><a href="Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html">MqttClient</a></td>
+<td>Module implementing a PyQt wrapper around the paho MQTT client.</td>
+</tr><tr>
+<td><a href="Plugin_Mqtt_Monitor.MqttMonitor.MqttConnectionOptionsDialog.html">MqttConnectionOptionsDialog</a></td>
+<td>Module implementing a dialog to enter MQTT connection options.</td>
+</tr><tr>
+<td><a href="Plugin_Mqtt_Monitor.MqttMonitor.MqttMonitorWidget.html">MqttMonitorWidget</a></td>
+<td>Module implementing the MQTT Monitor widget.</td>
+</tr>
+</table>
+</body></html>
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MqttMonitor/Documentation/source/index-Plugin_Mqtt_Monitor.html	Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Mqtt_Monitor</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<h1>Plugin_Mqtt_Monitor</h1>
+<p>
+Package implementing the MQTT Monitor plug-in.
+</p>
+
+<h3>Packages</h3>
+<table>
+<tr>
+<td><a href="index-Plugin_Mqtt_Monitor.MqttMonitor.html">MqttMonitor</a></td>
+<td>Package containing the MQTT Monitor modules and data files.</td>
+</tr>
+</table>
+
+<h3>Modules</h3>
+<table>
+<tr>
+<td><a href="Plugin_Mqtt_Monitor.PluginMqttMonitor.html">PluginMqttMonitor</a></td>
+<td>Module implementing the MQTT Monitor plug-in.</td>
+</tr>
+</table>
+</body></html>
\ No newline at end of file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MqttMonitor/Documentation/source/index.html	Sun Sep 02 18:36:22 2018 +0200
@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html><head>
+<title>Table of contents</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body>
+<h1>Table of contents</h1>
+
+
+<h3>Packages</h3>
+<table>
+<tr>
+<td><a href="index-Plugin_Mqtt_Monitor.html">Plugin_Mqtt_Monitor</a></td>
+<td>Package implementing the MQTT Monitor plug-in.</td>
+</tr>
+</table>
+
+</body></html>
\ No newline at end of file
--- a/PluginMqttMonitor.e4p	Sun Sep 02 18:29:35 2018 +0200
+++ b/PluginMqttMonitor.e4p	Sun Sep 02 18:36:22 2018 +0200
@@ -29,6 +29,9 @@
   </Forms>
   <Others>
     <Other>.hgignore</Other>
+    <Other>ChangeLog</Other>
+    <Other>MqttMonitor/Documentation/LICENSE.GPL3</Other>
+    <Other>MqttMonitor/Documentation/source</Other>
     <Other>MqttMonitor/icons/mqtt22.png</Other>
     <Other>MqttMonitor/icons/mqtt48.png</Other>
     <Other>PluginMqttMonitor.e4p</Other>
@@ -159,6 +162,61 @@
     <FiletypeAssociation pattern="Ui_*.py" type="__IGNORE__"/>
     <FiletypeAssociation pattern="makefile" type="OTHERS"/>
   </FiletypeAssociations>
+  <Documentation>
+    <DocumentationParams>
+      <dict>
+        <key>
+          <string>ERIC4DOC</string>
+        </key>
+        <value>
+          <dict>
+            <key>
+              <string>cssFile</string>
+            </key>
+            <value>
+              <string>%PYTHON%/eric6/CSSs/default.css</string>
+            </value>
+            <key>
+              <string>ignoreDirectories</string>
+            </key>
+            <value>
+              <list>
+                <string>.hg</string>
+                <string>.eric6project</string>
+                <string>.ropeproject</string>
+              </list>
+            </value>
+            <key>
+              <string>ignoreFilePatterns</string>
+            </key>
+            <value>
+              <list>
+                <string>Ui_*.py</string>
+              </list>
+            </value>
+            <key>
+              <string>outputDirectory</string>
+            </key>
+            <value>
+              <string>MqttMonitor/Documentation/source</string>
+            </value>
+            <key>
+              <string>qtHelpEnabled</string>
+            </key>
+            <value>
+              <bool>False</bool>
+            </value>
+            <key>
+              <string>useRecursion</string>
+            </key>
+            <value>
+              <bool>True</bool>
+            </value>
+          </dict>
+        </value>
+      </dict>
+    </DocumentationParams>
+  </Documentation>
   <Checkers>
     <CheckersParams>
       <dict>

eric ide

mercurial