coap-packet

CoAP-Packet

CoAP-Packet is an highly experimental generator and parser of CoAP packets.

It does not provide any CoAP semantics, it just parses the protocol.

This has been tested only on node v0.8.

Installation

$: npm install coap-packet --save

Basic Example

The following example opens an UDP client and UDP server and sends a CoAP message between them:

const dgram       = require('dgram')
    , coapPacket  = require('coap-packet')
    , parse       = packet.parse
    , generate    = packet.generate
    , payload     = new Buffer('Hello World')
    , message     = generate({ payload: payload })
    , port        = 41234
    , client      = dgram.createSocket("udp4")
    , server      = dgram.createSocket("udp4")

server.bind(port, function() {
  client.send(message, 0, message.length, 41234, "localhost", function(err, bytes) {
    client.close()
  })
})

server.on('message', function(data) {
  console.log(parse(data).payload.toString())
  server.close()
})

API

• JS packet format
• coapPacket.parse()
• coapPacket.generate()

parse(buffer)

The parse function takes a buffer and returns a JS object that follows a particular format.

generate()

The generate function takes a JS object that follows a particular format and transform it into a CoAP packet.

JS packet format

The JS representation of a CoAP packet is:

{
    token: new Buffer(4)
  , code: '0.01'
  , messageId: 42
  , options: [{
        name: 'If-Match'
      , value: new Buffer(5)
    }, {
        name: 'Uri-Path' 
      , value: new Buffer('hello')
    }]
}

Instead of numerical codes, it also supports humanized names, e.g. GET, POST, PUT, DELETE.

Contributors

Coap-Packet is only possible due to the excellent work of the following contributors:

Matteo Collina	GitHub/mcollina	Twitter/@matteocollina

LICENSE

Copyright (c) 2013 CoAP-Packet contributors (listed above).

Coap-Packet is licensed under an MIT +no-false-attribs license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.