node package manager

losant-mqtt

Losant JavaScript MQTT Client

Build Status npm version

The Losant MQTT client provides a simple way for custom things to communicate with the Losant platform over MQTT. You can authenticate as a device, publish device state, and listen for device commands.

This client works with Node.js v0.10 and newer. It uses the Node.js MQTT client for all underlying communication.

Installation

The Losant JavaScript MQTT Client is installed using npm.

$ npm install losant-mqtt

Example

Below is a high-level example of using the Losant JavaScript MQTT client to send the value of a temperature sensor to the Losant platform.

var Device = require('losant-mqtt').Device;
 
// Construct device. 
var device = new Device({
  id: 'my-device-id',
  key: 'my-app-access-key',
  secret: 'my-app-access-secret'
});
 
// Connect to Losant. 
device.connect();
 
// Listen for commands. 
device.on('command', function(command) {
  console.log('Command received.');
  console.log(command.name);
  console.log(command.payload);
});
 
// Send temperature once every second. 
setInterval(function() {
  device.sendState({ temperature: readAnalogIn() });
}, 1000);

API Documentation

## Device A device represents a single thing or widget that you'd like to connect to the Losant platform. A single device can contain many different sensors or other attached peripherals. Devices can either report state or respond to commands.

A device's state represents a snapshot of the device at some point in time. If the device has a temperature sensor, it might report state every few seconds with the temperature. If a device has a button, it might only report state when the button is pressed. Devices can report state as often as needed by your specific application.

Commands instruct a device to take a specific action. Commands are defined as a name and an optional payload. For example, if the device is a scrolling marquee, the command might be "update text" and the payload would include the text to update.

var Device = require('losant-mqtt').Device;
 
var device = new Device({
  id: 'my-device-id',
  key: 'my-app-access-key',
  secret: 'my-app-access-secret'
  transport: 'tls'
});
  • id: The device's ID. Obtained by first registering a device using the Losant platform.
  • key: The Losant access key.
  • secret: The Losant access secret.
  • transport: The underlying transport mechanism. Supports tcp, tls, ws (WebSocket), and wss (Secure WebSocket). Optional. Defaults to tls.

### device.connect()

Connects the device to the Losant platform. The device will automatically retry any lost connections. Hook the connect event to know when a connection has been successfully established.

device.connect();

### device.isConnected()

Returns a boolean indicating whether or not the device is currently connected to the Losant platform.

device.isConnected();

### device.sendState(state, [time], [callback])

Sends a device state to the Losant platform. In many scenarios, device states will change rapidly. For example a GPS device will report GPS coordinates once a second or more. Because of this, sendState is typically the most invoked function. Any state data sent to Losant is stored and made available in data visualization tools and workflow triggers.

// Send the device state to Losant. 
device.sendState({ voltage: readAnalogIn() });
  • state: The state to send as a JavaScript object.
  • time: The Date object that the state occurred. Optional. Defaults to new Date().
  • callback: Invoked when complete. err parameter will have details of any errors that occurred. Optional.

### Event: 'command'

device.on('command', function(command) { });

Emitted whenever a command is received from the Losant platform.

  • command.name: The name of the command received.
  • command.time: The Date of when the command was originally invoked.
  • command.payload: The optional payload as a JavaScript object for the command.

### Event: 'connect'

device.on('connect', function() { });

Emitted on the very first successful connection. All reconnects will emit the 'reconnect' event.

### Event: 'reconnect'

device.on('reconnect', function() { });

Emitted by the underlying MQTT client whenever a reconnect starts.

### Event: 'close'

device.on('close', function() { });

Emitted by the underlying MQTT client after a disconnection.

### Event: 'offline'

device.on('offline', function() { });

Emitted by the underlying MQTT client when it goes offline.

### Event: 'error'

device.on('error', function(err) { });

Emitted by the underlying MQTT client when it cannot connect.

  • err: The error that occurred.

## Gateway The Gateway object extends the Device object, therefore all device functions, properties, and events are available on the gateway.

A gateway works exactly like a device accept that it can also report state and receive commands on behalf of peripherals. Peripherals are things that are not directly connected to Losant. For example a Raspberry Pi could be a gateway that is reporting state for one or more Bluetooth peripherals.

var Gateway = require('losant-mqtt').Gateway;
 
var gateway = new Gateway({
  id: 'my-device-id',
  key: 'my-app-access-key',
  secret: 'my-app-access-secret'
});
 
gateway.connect();
 
// Add a peripheral to the gateway. 
var peripheral = gateway.addPeripheral('my-peripheral-id');
 
// Report the peripheral's state. 
// How the gateway communicates to the peripheral (e.g. Bluetooth) is up to 
// the specific environment and implementation. 
peripheral.sendState({ temperature: myReadPeripheralTemp() });
 
// Listen for commands sent to peripherals. 
peripheral.on('command', function(command) {
  console.log(command.name);
  console.log(command.payload);
  // The gateway can now communicate to the peripheral however needed 
  // to complete this command. 
});
 

### gateway.addPeripheral(id)

Adds a peripheral to the gateway and returns the peripheral instance. The id is a Losant device id that is created when the device is added to a Losant application. The device must be configured as a peripheral device type when created.

var peripheral = gateway.addPeripheral('my-peripheral-id');
  • id: The Losant peripheral device id.

## Peripheral Peripherals device types do not connect directly to Losant. Gateways report state and handle commands on their behalf. Peripheral instances are not directly constructed. They are created by calling addPeripheral on the gateway.

var Gateway = require('losant-mqtt').Gateway;
 
var gateway = new Gateway({
  id: 'my-device-id',
  key: 'my-app-access-key',
  secret: 'my-app-access-secret'
});
 
gateway.connect();
 
// Add a peripheral to the gateway. 
var peripheral = gateway.addPeripheral('my-peripheral-id');
 
// Report the peripheral's state. 
// How the gateway communicates to the peripheral (e.g. Bluetooth) is up to 
// the specific environment and implementation. 
peripheral.sendState({ temperature: myReadPeripheralTemp() });
 
// Listen for commands sent to peripherals. 
peripheral.on('command', function(command) {
  console.log(command.name);
  console.log(command.payload);
  // The gateway can now communicate to the peripheral however needed 
  // to complete this command. 
});
 

### peripheral.sendState(state, [time], [callback])

Sends a peripheral device's state to the Losant platform. In many scenarios, device states will change rapidly. For example a GPS device will report GPS coordinates once a second or more. Because of this, sendState is typically the most invoked function. Any state data sent to Losant is stored and made available in data visualization tools and workflow triggers.

// Send the device state to Losant. 
peripheral.sendState({ voltage: myReadPeripheralVoltage() });
  • state: The state to send as a JavaScript object.
  • time: The Date object that the state occurred. Optional. Defaults to new Date().
  • callback: Invoked when complete. err parameter will have details of any errors that occurred. Optional.

### Event: 'command'

peripheral.on('command', function(command) { });

Emitted whenever a command is received from the Losant platform.

  • command.name: The name of the command received.
  • command.time: The Date of when the command was originally invoked.
  • command.payload: The optional payload as a JavaScript object for the command.

Debugging

This library uses the Debug module for additional debug output. You can enable it by setting the DEBUG environment variable to losant*.

DEBUG=losant* node index.js


Copyright (c) 2017 Losant IoT, Inc

https://www.losant.com