KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #codex #claude-code #mcp #rust #deepseek-harness #typescript #ai-agent #cli

shepherd

★ 41 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![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)

</div>

-------

## 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
* <a href="https://github.com/lwmqn/shepherd/blob/master/docs/Basic-APIs.md"><code>Basic APIs</code></a>
* <a href="https://github.com/lwmqn/shepherd/blob/master/docs/Events.md"><code>Events</code></a>
* <a href="https://github.com/lwmqn/shepherd/blob/master/docs/Message-Encryption.md"><code>Message Encryption</code></a>
* <a href="https://github.com/lwmqn/shepherd/blob/master/docs/Auth-Policies.md"><code>Auth Policies</code></a>
* <a href="https://github.com/lwmqn/shepherd/blob/master/docs/Status-Codes.md"><code>Status Codes</code></a>
* <a href="https://github.com/lwmqn/shepherd/blob/master/docs/Debug-Messages.md"><code>Debug Messages</code></a>

-------

## License

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

shepherd

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README