mqtt.cool-web-client

2.0.0 • Public • Published

MQTT.Cool Web Client

Overview

The MQTT.Cool Web Client is a JavaScript library for the development of MQTT.Cool clients running inside the web browser.

The library enables any HTML page to act as an MQTT client; that is, ready to send and receive real-time MQTT messages to/from any MQTT broker connected to the MQTT.Cool server.

Installation

npm

The library is available as npm package, so you can download and install it through:

npm install mqtt.cool-web-client

Then load it from local node_modules:

<html>
<head>
  <script src="./node_modules/mqtt.cool-web-client/dist/mqtt.cool.js"></script>
  ...
</html>

cdn

The library is also available on unpkg, to which you can point directly in the script tag:

<script src="https://unpkg.com/mqtt.cool-web-client@2.0.0/dist/mqtt.cool.js"></script>

Development

Open a session against the MQTT.Cool server, create an MQTT client and connect to the MQTT broker:

mqttcool.openSession('http://my.MQTT.Cool.server:8080', 'my_user', 'my_password', {
  onConnectionSuccess: function(mqttCoolSession) {
    var client = mqttCoolSession.createClient('my_mqtt_broker', 'my_client_id');
    client.connect({
      onSuccess: function() {
        console.log("Connected!");
      }
    });
    ...
  }
});

Request a Subscription:

client.subscribe("my/cool/topic");

Listen for messages:

client.onMessageArrived = function(message) {
  console.log("onMessageArrived:" + message.payloadString);
}

Publish a Message to the server:

message = new mqttcool.Message("My Message!");
message.destinationName = "my/cool/topic";
client.send(message)

Compatibility

  • Compatible with MQTT.Cool since version 1.2.0.
  • Based on Lightstreamer SDK for Web Clients version 8.0.3 build 1800.
  • Compatible with code developed with the previous version.

Changelog

See detailed changes on https://mqtt.cool/download/changelog/?component=web&version=2.0.0

Documentation

For further details, visit the SDK section on the MQTT.Cool site.

Package Sidebar

Install

npm i mqtt.cool-web-client

Homepage

mqtt.cool

Weekly Downloads

235

Version

2.0.0

License

none

Unpacked Size

264 kB

Total Files

3

Last publish

Collaborators

  • lightstreamer
  • dario-ls
  • acarioni
  • giuseppe.corti