|
1 | | -**Project** Eclipse Paho MQTT Tester View |
2 | | - |
3 | | -**Version** 1.0.3 |
4 | | - |
5 | | -**Date** 24-04-2013 |
6 | | - |
7 | | -**Author** Eurotech Inc. |
8 | | - |
9 | | - |
10 | | -# Overview |
11 | | - |
12 | | -The Eclipse Paho MQTT Tester View is an Eclipse plugin that provides a user interface for performing MQTT-based messaging tasks within Eclipse. |
13 | | - |
14 | | - |
15 | | -# Installation |
16 | | - |
17 | | -(TODO this section is not yet valid) |
18 | | - |
19 | | -The plug-in can be installed using the included update site: |
20 | | - |
21 | | - update_site/update.site.zip |
22 | | - |
23 | | -1) Unzip the file onto your local machine. |
24 | | - |
25 | | -2) In Eclipse, browse to Help -> Install New Software. |
26 | | - |
27 | | -3) Add a new local repository by clicking on the "Add..." button and browsing to the directory that you unzipped above (should contain a site.xml file). Make sure to name the repository and then click "Ok". You should now be able to select the repository in the "Work with:" drop down menu and the plug-in should appear in the list. |
28 | | - |
29 | | -4) Select the plug-in: |
30 | | - |
31 | | - Paho Client Eclipse View Feature |
32 | | - |
33 | | -5) Click "Next" and follow the remaining instructions for installing the plug-in. |
34 | | - |
35 | | -# Usage |
36 | | - |
37 | | -The view can be accessed by navigating to Window -> Show View -> Other..., then expand the "M2M" folder and select "MQTT Tester View". This will open the interface for the MQTT view. The interface consists of three tabs: Connection, Publish, and Subscribe. |
38 | | - |
39 | | -**Connection Tab** |
40 | | - |
41 | | -This tab is used to connect the MQTT client to a broker. A connection must be established in order to publish and subscribe in the remaining tabs. Here is a brief description of the fields: |
42 | | - |
43 | | - * Broker Address: (Required) The IP address or URL of the broker |
44 | | - * Broker Port: (Required) The port number of the broker |
45 | | - * Client ID: (Required) A unique identifier to connect with. |
46 | | - * Username: A username, if required by the broker. |
47 | | - * Password: A password, if required by the broker. |
48 | | - * Keep Alive: (Required) The number of seconds between keep alive pings sent to the broker. |
49 | | - * Clean Start: Whether or not to maintain subscriptions across disconnects. |
50 | | - * LWT Enable: Whether to enable Last Will and Testament (LWT). |
51 | | - * LWT Topic: The topic that the broker will publish the LWT on. |
52 | | - * LWT Message: The message that the broker will publish for the LWT. |
53 | | - * LWT QoS: The quality of service that the LWT will be published on. |
54 | | - * LWT Retain: Whether to retain the LWT message. |
55 | | - |
56 | | -**Publish Tab** |
57 | | - |
58 | | -Used to publish messages to the broker. A message may be a string or a File. Here is a brief description of the fields: |
59 | | - |
60 | | - * Topic: The topic to publish on. |
61 | | - * QoS: The quality of service to publish on. |
62 | | - * Retain: Whether to retain the message on the broker. |
63 | | - * Payload: The payload to publish (if publishing a string). |
64 | | - * File: The file to publish (if publishing a file). |
65 | | - |
66 | | -**Subscribe Tab** |
67 | | - |
68 | | -Used to subscribe and unsubscribe on topics. Once the client is subscribed to a topic, all messages received will be displayed in the log below. Here is a brief description of the fields: |
69 | | - |
70 | | - * Topic: The topic to subscribe on (can include wildcards + and #) |
71 | | - * QoS: The quality of service to subscribe on. |
72 | | - |
73 | | - |
74 | | -# Building |
75 | | - |
76 | | -The project requires the Plug-in Development Environment (PDE) in order to build. Information about installing the PDE tools can be found at: |
77 | | - |
78 | | - [Eclipse PDE](www.eclipse.org/pde) |
79 | | - |
80 | | -The source for the project itself can be found at: |
81 | | - |
82 | | - [Eclipse Git](http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.esf.git/) |
83 | | - |
84 | | -Once the project is imported into Eclipse, it can be build by right clicking on the project and navigating to Export -> Plug-in Development -> Deployable plug-ins and fragments. |
85 | | - |
86 | | - |
87 | | -## Copyright |
88 | | - |
89 | | -Copyright (c) 2012 Eurotech Inc. All rights reserved. |
90 | | - |
91 | | - |
92 | | -## License |
93 | | - |
94 | | -This project is released under the Eclipse Public License (EPL) version 1.0 |
95 | | - |
96 | | - |
97 | | -## Additional Resources |
98 | | - |
99 | | -* [Eclipse Paho project](http://www.eclipse.org/paho/) |
100 | | - |
101 | | -* [MQTT Community](http://www.mqtt.org) |
102 | | - |
| 1 | +**Project** Eclipse Paho MQTT Tester View |
| 2 | + |
| 3 | +**Version** 1.0.3 |
| 4 | + |
| 5 | +**Date** 24-04-2013 |
| 6 | + |
| 7 | +**Author** Eurotech Inc. |
| 8 | + |
| 9 | + |
| 10 | +# Overview |
| 11 | + |
| 12 | +The Eclipse Paho MQTT Tester View is an Eclipse plugin that provides a user interface for performing MQTT-based messaging tasks within Eclipse. |
| 13 | + |
| 14 | + |
| 15 | +# Installation |
| 16 | + |
| 17 | +(TODO this section is not yet valid) |
| 18 | + |
| 19 | +The plug-in can be installed using the included update site: |
| 20 | + |
| 21 | + update_site/update.site.zip |
| 22 | + |
| 23 | +1) Unzip the file onto your local machine. |
| 24 | + |
| 25 | +2) In Eclipse, browse to Help -> Install New Software. |
| 26 | + |
| 27 | +3) Add a new local repository by clicking on the "Add..." button and browsing to the directory that you unzipped above (should contain a site.xml file). Make sure to name the repository and then click "Ok". You should now be able to select the repository in the "Work with:" drop down menu and the plug-in should appear in the list. |
| 28 | + |
| 29 | +4) Select the plug-in: |
| 30 | + |
| 31 | + Paho Client Eclipse View Feature |
| 32 | + |
| 33 | +5) Click "Next" and follow the remaining instructions for installing the plug-in. |
| 34 | + |
| 35 | +# Usage |
| 36 | + |
| 37 | +The view can be accessed by navigating to Window -> Show View -> Other..., then expand the "M2M" folder and select "MQTT Tester View". This will open the interface for the MQTT view. The interface consists of three tabs: Connection, Publish, and Subscribe. |
| 38 | + |
| 39 | +**Connection Tab** |
| 40 | + |
| 41 | +This tab is used to connect the MQTT client to a broker. A connection must be established in order to publish and subscribe in the remaining tabs. Here is a brief description of the fields: |
| 42 | + |
| 43 | + * Broker Address: (Required) The IP address or URL of the broker |
| 44 | + * Broker Port: (Required) The port number of the broker |
| 45 | + * Client ID: (Required) A unique identifier to connect with. |
| 46 | + * Username: A username, if required by the broker. |
| 47 | + * Password: A password, if required by the broker. |
| 48 | + * Keep Alive: (Required) The number of seconds between keep alive pings sent to the broker. |
| 49 | + * Clean Start: Whether or not to maintain subscriptions across disconnects. |
| 50 | + * LWT Enable: Whether to enable Last Will and Testament (LWT). |
| 51 | + * LWT Topic: The topic that the broker will publish the LWT on. |
| 52 | + * LWT Message: The message that the broker will publish for the LWT. |
| 53 | + * LWT QoS: The quality of service that the LWT will be published on. |
| 54 | + * LWT Retain: Whether to retain the LWT message. |
| 55 | + |
| 56 | +**Publish Tab** |
| 57 | + |
| 58 | +Used to publish messages to the broker. A message may be a string or a File. Here is a brief description of the fields: |
| 59 | + |
| 60 | + * Topic: The topic to publish on. |
| 61 | + * QoS: The quality of service to publish on. |
| 62 | + * Retain: Whether to retain the message on the broker. |
| 63 | + * Payload: The payload to publish (if publishing a string). |
| 64 | + * File: The file to publish (if publishing a file). |
| 65 | + |
| 66 | +**Subscribe Tab** |
| 67 | + |
| 68 | +Used to subscribe and unsubscribe on topics. Once the client is subscribed to a topic, all messages received will be displayed in the log below. Here is a brief description of the fields: |
| 69 | + |
| 70 | + * Topic: The topic to subscribe on (can include wildcards + and #) |
| 71 | + * QoS: The quality of service to subscribe on. |
| 72 | + |
| 73 | + |
| 74 | +# Building |
| 75 | + |
| 76 | +The project requires the Plug-in Development Environment (PDE) in order to build. Information about installing the PDE tools can be found at: |
| 77 | + |
| 78 | + [Eclipse PDE](www.eclipse.org/pde) |
| 79 | + |
| 80 | +The source for the project itself can be found at: |
| 81 | + |
| 82 | + [Eclipse Git](http://git.eclipse.org/c/paho/org.eclipse.paho.mqtt.esf.git/) |
| 83 | + |
| 84 | +Once the project is imported into Eclipse, it can be build by right clicking on the project and navigating to Export -> Plug-in Development -> Deployable plug-ins and fragments. |
| 85 | + |
| 86 | + |
| 87 | +## Copyright |
| 88 | + |
| 89 | +Copyright (c) 2012 Eurotech Inc. All rights reserved. |
| 90 | + |
| 91 | + |
| 92 | +## License |
| 93 | + |
| 94 | +This project is released under the Eclipse Public License (EPL) version 1.0 |
| 95 | + |
| 96 | + |
| 97 | +## Additional Resources |
| 98 | + |
| 99 | +* [Eclipse Paho project](http://www.eclipse.org/paho/) |
| 100 | + |
| 101 | +* [MQTT Community](http://www.mqtt.org) |
| 102 | + |
0 commit comments