Lightweight Constrained Application Protocol (CoAP) protocol server for IOT, based on Internet of Protocols Alliance (IOPA) specification
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
src
test
tools
typings
.gitignore
LICENSE
NOTICE
README.md
demo.js
index.js
jsconfig.json
package.json
shippable.yml

README.md

IOPA
iopa-coap

Build Status IOPA limerun

NPM

About

iopa-coap is a lightweight IOT Constrained Application Protocol (CoAP) protocol server, based on the Internet of Protocols Alliance (IOPA) specification

It servers CoAP messages in standard IOPA format and allows existing middleware for Connect, Express and limerun projects to consume/send each mesage.

It is an open-source, standards-based, drop-in replacement for CoAP servers such as node-coap.

It uses the standards based 'iopa-coap-packet' for protocol formatting, which in turn is based on the widely used library 'coap-packet'.

Written in plain javascript for maximum portability to constrained devices

Makes CoAP messages look to an application just like an HTTP message so little or no application changes required to support multiple REST protocols

Status

Fully working server and client.

Includes:

Server Functions

  • Layered protocol based on native UDP sockets
  • Translation from UDP Raw Message to CoAP Packet in standard IOPA format, compatible with all HTTP and COAP applications including those written for Express, Connect, etc!
  • Optional logging middleware for each inbound message
  • Server and Client Request caching middleware
  • Confirmable send middleware that keeps retrying until acknowledgements received
  • Auto-Acknowledge middleware that automatically takes care of sending acknowledgements to inbound confirmable requests/responses
  • Observable messages (publish/subscribe)

Client Functions

  • Layered protocol based on native UDP sockets
  • Translation from CoAP Packet in standard IOPA format to CoAP Raw Message
  • Optional logging middleware
  • Client Request caching middleware
  • Confirmable send middleware that keeps retrying until acknowledgements received
  • Auto-Acknowledge middleware that automatically takes care of sending acknowledgements to inbound confirmable responses
  • Observable messages (publish/subscribe)

Installation

npm install iopa-coap

Usage

Simple Hello World Server and Client with Pub/Sub

const iopa = require('iopa')
    , coap = require('iopa-coap')      

var app = new iopa.App();

app.use(function(context, next){
   context.log.info("[DEMO] CoAP APP USE " + context["iopa.Method"] + " " + context["iopa.Path"]);
  
   if (context["iopa.Method"] === "GET")
   {
     setTimeout(function() {
                server.publish("/projector", new Buffer("Hello World"));
            }, 23);
      }
       
   return next();
});
    
var server = coap.createServer(app.build());

if (!process.env.PORT)
  process.env.PORT = iopa.constants.IOPA.PORTS.COAP;

server.listen(process.env.PORT, process.env.IP)
  .then(function(){
    server.log.info("[DEMO] Server is on port " + server.port );
    return server.connect("coap://127.0.0.1", "CLIENTID-1", false);
  })
  .then(function(coapClient){
    server.log.info("[DEMO] Client is on port " + coapClient["server.LocalPort"]);
    coapClient.subscribe('/projector', function(pubsub){
           pubsub.log.info("[DEMO] CoAP /projector RESPONSE " + pubsub["iopa.Body"].toString());
           });
    setTimeout(function() {
          server.publish("/projector", new Buffer("Hello World 2"));
      }, 1000);
    setTimeout(function() {
          server.close().then(function(){server.log.info("[DEMO] CoAP DEMO Closed"); })
      }, 2000);
 });
    

Roadmap

Next steps are to build a reference framework to link together server, client, discovery and other protocol functions.

Adding additional features of the protocol such as Type 2 Blocks, is as simple as adding a new middleware function (10-30 lines of javascript)