Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    barracks-messenger-sdkpublic

    Build Status Coverage Status npm version

    Barracks Messaging SDK for Javascript (Beta)

    The Javascript SDK to enable messaging on your devices

    Installation

    $ npm install barracks-messenger-sdk

    Usage

    Create a Barracks Messaging SDK instance :

    var BarracksMessenger = require('../src/index').BarracksMessenger;
     
    var barracksMessenger = new BarracksMessenger({
      apiKey: 'Your user API key',
      unitId: 'The unique device identifier'
    });

    Your user API key you can be found on the Account page of the Barracks application.

    Connect to the messaging service :

    barracksMessenger.connect({
        onConnect: function() {
          // Do something when your device connects to MQTT
        },
        onError: function(err) {
          // Do something when an error occurs
        },
        onClose: function() {
          // Do something when the connection is closed
        },
        onReconnect: function() {
          // Do somethings when the device attempts to reconnect
        }
    });

    Subscribe to a topic to enable message reception :

    barracksMessenger.subscribe(function (messageReceived) {
        // Do something with a message when you retrieve it
    }, { qos: 1 });

    A message object has 5 properties :

    • payload : String
    • retained : boolean
    • topic : String
    • length : int
    • qos : 0 or 1

    End the connection :

    barracksMessenger.end();

    Docs & Community

    Keywords

    none

    install

    npm i barracks-messenger-sdk

    Downloadsweekly downloads

    3

    version

    0.0.4

    license

    Apache-2.0

    repository

    githubgithub

    last publish

    collaborators

    • avatar
    • avatar