Overview

The Eclipse Paho MQTT Tester View is an Eclipse plugin that provides a user interface for performing MQTT-based messaging tasks within Eclipse.

Installation

(TODO this section is not yet valid)

The plug-in can be installed using the included update site:

update_site/update.site.zip

Unzip the file onto your local machine.
In Eclipse, browse to Help -> Install New Software.
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.
Select the plug-in:

Paho Client Eclipse View Feature

Click “Next” and follow the remaining instructions for installing the plug-in.

Usage

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.

Connection Tab

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:

Broker Address: (Required) The IP address or URL of the broker
Broker Port: (Required) The port number of the broker
Client ID: (Required) A unique identifier to connect with.
Username: A username, if required by the broker.
Password: A password, if required by the broker.
Keep Alive: (Required) The number of seconds between keep alive pings sent to the broker.
Clean Start: Whether or not to maintain subscriptions across disconnects.
LWT Enable: Whether to enable Last Will and Testament (LWT).
LWT Topic: The topic that the broker will publish the LWT on.
LWT Message: The message that the broker will publish for the LWT.
LWT QoS: The quality of service that the LWT will be published on.
LWT Retain: Whether to retain the LWT message.

Publish Tab

Used to publish messages to the broker. A message may be a string or a File. Here is a brief description of the fields:

Topic: The topic to publish on.
QoS: The quality of service to publish on.
Retain: Whether to retain the message on the broker.
Payload: The payload to publish (if publishing a string).
File: The file to publish (if publishing a file).

Subscribe Tab

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:

Topic: The topic to subscribe on (can include wildcards + and #)
QoS: The quality of service to subscribe on.

Building

The project requires the Plug-in Development Environment (PDE) in order to build. Information about installing the PDE tools can be found at:

Eclipse PDE

The source for the project itself can be found at:

Eclipse Git

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.

Copyright

License