Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lwmqn/shepherd

Server & manager for the LwM2M-like Lightweight Message Queuing Network (LwMQN)
https://github.com/lwmqn/shepherd

lwm2m lwm2m-server lwmqn mqtt

Last synced: 24 days ago
JSON representation

Server & manager for the LwM2M-like Lightweight Message Queuing Network (LwMQN)

Host: GitHub
URL: https://github.com/lwmqn/shepherd
Owner: lwmqn
License: mit
Created: 2015-11-03T03:02:02.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2020-06-01T01:12:02.000Z (over 4 years ago)
Last Synced: 2024-09-29T08:41:03.489Z (about 1 month ago)
Topics: lwm2m, lwm2m-server, lwmqn, mqtt
Language: JavaScript
Homepage: http://lwmqn.github.io/
Size: 653 KB
Stars: 41
Watchers: 13
Forks: 4
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        ![LWMQN Network](https://raw.githubusercontent.com/lwmqn/shepherd/master/docs/images/lwmqn.png)



**@lwmqn/shepherd** is a network server and manager for the Lightweight Message Queuing Network (LwMQN)

[![NPM version](https://img.shields.io/npm/v/shepherd.svg?style=flat-square)](https://www.npmjs.com/package/shepherd)

[![NPM downloads](https://img.shields.io/npm/dm/shepherd.svg?style=flat-square)](https://www.npmjs.com/package/shepherd)

[![Travis branch](https://img.shields.io/travis/lwmqn/shepherd/master.svg?maxAge=2592000&style=flat-square)](https://travis-ci.org/lwmqn/shepherd)

[![Gitter](https://img.shields.io/gitter/room/lwmqn/Lobby.svg?style=flat-square)](https://gitter.im/lwmqn/Lobby)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)

![pr-welcoming-image](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)



-------

## What is LwMQN

Lightweight Message Queuing Network ([**LwMQN**](http://lwmqn.github.io)) is an open source project that follows part of [**OMA LwM2M v1.0**](http://technical.openmobilealliance.org/Technical/technical-information/release-program/current-releases/oma-lightweightm2m-v1-0) specification to meet the minimum requirements of machine network management.

### Server-side and Client-side Libraries:

   - LwMQN project provides you with this machine-side **@lwmqn/qnode** library and a server-side [**@lwmqn/shepherd**](https://github.com/lwmqn/shepherd) library to build your machine network with JavaScript and Node.js easily.

* Server-side library: **@lwmqn/shepherd** (this module)

* Client-side library: [**@lwmqn/qnode**](https://github.com/lwmqn/qnode)

* [**A simple demo webapp**](https://github.com/lwmqn/demo)

### Features

* Communication based on MQTT protocol and [Mosca](https://github.com/mcollina/mosca/wiki) broker.

* Embedded persistence ([NeDB](https://github.com/louischatriot/nedb)) and auto-reloads Client Devices at boot-up.

* Build your IoT network with or without cloud services.

* LwM2M-like interfaces for Client/Server interaction.

* Hierarchical Smart Object data model ([IPSO](http://www.ipso-alliance.org/)), which leads to a comprehensive and consistent way in describing real-world gadgets.

* Easy to query resources on a Client Device with the URI-style path, and everything has been well-organized to ease the pain for you to create RPC interfaces for your webapps, such as RESTful and websocket-based APIs.

* LwMQN Server is your local machine gateway and application runner. But if you like to let your machines go up cloud, why not? It's Node.js!

### Understanding Smart Objects and the IPSO Model

![IPSO Model](https://raw.githubusercontent.com/lwmqn/shepherd/master/docs/images/ipso_model.png)

#### Acronyms and Abbreviations

* **Server**: LwMQN server

* **Client** or **Client Device**: LwMQN client (machine)

* **Shepherd**: Class exposed by `require('@lwmqn/shepherd')`

* **Qnode**: Class to create a software endpoint(proxy) of a remote Client Device on the server

* **qserver**: Instance of Shepherd Class

* **qnode**: Instance of Qnode Class

-------

## Installation

Currently [Node.js 8.x LTS](https://nodejs.org/en/about/releases/) or higher is required.

```bash

$ npm install @lwmqn/shepherd

```

### Compabitility table

| Shepherd versions /
Node.js versions | 8.x
LTS | 10.x
LTS | 11.x | 12.x
LTS | 13.x |

|--------------------------------------|------------|-------------|------|-------------|------|

| v0.8.0 | ✔ | ✘ | ✘ | ✘ | ✘ |

-------

## Basic Usage

```js

const Shepherd = require('@lwmqn/shepherd')

const qserver = new Shepherd() // create a LWMQN server

qserver.on('ready', function () {

  console.log('Server is ready.')

  // when server is ready, allow devices to join the network within 180 secs

  qserver.permitJoin(180)

})

qserver.start(function (err) { // start the sever

  if (err) console.log(err)

})

// That's all to start a LwMQN server.

// Now qserver is going to automatically tackle most of the network managing things.

```

-------

## Documentation

* Basic APIs

* Events

* Message Encryption

* Auth Policies

* Status Codes

* Debug Messages

-------

## License

Licensed under [MIT](https://github.com/lwmqn/shepherd/blob/master/LICENSE).