README

Meshblu-CoAP-CLI

CoAP-CLI is a command line interface for CoAP, built on node.js and node-coap.

What is CoAP?

Constrained Application Protocol (CoAP) is a software protocol intended to be used in very simple electronics devices that allows them to communicate interactively over the Internet. - Wikipedia

Install

Install node.js, and then from a terminal:

npm install meshblu-coap-cli -g

Usage

  Usage: meshblu-coap [command] [options] url

  Commands:

    get                    performs a GET request
    put                    performs a PUT request
    post                   performs a POST request
    delete                 performs a DELETE request

  Options:

    -h, --help               output usage information
    -H, --headers <headers>  The headers string for requests
    -V, --version            output the version number
    -o, --observe            Observe the given resource
    -n, --no-new-line        No new line at the end of the stream
    -p, --payload <payload>  The payload for POST and PUT requests
    -q, --quiet              Do not print status codes of received packets
    -H "meshblu_auth_uuid={UUID}&meshblu_auth_token={TOKEN}"

PUT and POST

PUT and POST requests body are sent from the standard input by default. E.g.

echo -n 'hello world' | coap post coap://localhost/message

If you want to type it you can end the standard input by pressing CTRL-D.

Sending authentication headers for Meshblu (formerly SkyNet.im)

Meshblu uses skynet_auth_uuid/meshblu_auth_uuid and skynet_auth_token/meshblu_auth_token authentication headers in all HTTP and CoAP API calls. You can test Meshblu CoAP API calls by adding:

-H "skynet_auth_uuid={:UUID}&skynet_auth_token={:TOKEN}" to your CoAP CLI call like this:

coap post -p "payload=hi&devices=9314f1d1-2404-11e4-a3a9-9b953437ccb1" -H "skynet_auth_uuid=9fb3cb71-23e9-11e4-a870-9f04ce09bb6b&skynet_auth_token=9fv55f6hi0iicnmii8k4rrs4t4g9cnmi" coap://coap.meshblu.com/messages

or:

-H "meshblu_auth_uuid={:UUID}&meshblu_auth_token={:TOKEN}" to your CoAP CLI call like this:

coap post -p "payload=hi&devices=9314f1d1-2404-11e4-a3a9-9b953437ccb1" -H "meshblu_auth_uuid=9fb3cb71-23e9-11e4-a870-9f04ce09bb6b&meshblu_auth_token=9fv55f6hi0iicnmii8k4rrs4t4g9cnmi" coap://coap.meshblu.com/messages

License

node-coap 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.

Usage no npm install needed!