{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Meshblu Utility","type":"basic","slug":"meshblu-utility","excerpt":"Meshblu also offers a command line utility!","body":"Start by:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"npm install -g meshblu-util\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nTo generate a public/private keypair, update meshblu.json with the private key, and publish the public key, run:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ meshblu-util keygen meshblu.json\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nTo learn more about the functionality of the meshblu-util tool, use:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ meshblu-util --help\\n\\n  Usage: meshblu-util [options] [command]\\n\\n\\n  Commands:\\n\\n    claim                 claim Meshblu device in Octoblu\\n    subscription-create   Create a device subscription\\n    subscription-delete   Delete a device subscription\\n    subscription-list     List a device's subscription\\n    create-hook           Create a message hook\\n    firehose              Connect to the firehose!\\n    generate-token        generate and store token\\n    get                   retrieve a device using a meshblu.json\\n    keygen                generate public/private keypair, update\\n                meshblu.json with the private key,\\n                and publish the public key\\n    message               send a message with Meshblu\\n    online                check if Meshblu device is online\\n    register              register a new device with Meshblu\\n    revoke-token          revoke token from device\\n    server-check          check if Meshblu server is available\\n    search                search for devices\\n    subscribe             subscribe to messages to a Meshblu Device\\n    update                update an existing device in Meshblu\\n    gateblu-shadow-sync   synchronize a gateblu and it's shadows\\n    help [cmd]            display help for [cmd]\\n\\n  Options:\\n\\n    -h, --help     output usage information\\n    -V, --version  output the version number\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55663bc9979a3c2500bbafbf","user":"5564f227f0f70f0d00a9ab20","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5564f26b1fd04c0d00dc9aae","556741d17acd550d0075eaca","556741d87acd550d0075eacb","556742f87acd550d0075ead1","556781cd6976ef0d0099c545","5568d666d33aad0d00ec8d2e","557f6b2d38249b0d00d0d12b","55b67be9c2e909190073ed38","564e56c601e80e0d00396684","56731b714b2a680d00524daf","573612ac652bd80e00a90027","57365e2cf8ebd31700769f50","57366131f8ebd31700769f58","573b93514e029d19000b8669","573bbfdb7ac6f6170033bd35"],"_id":"5564f26a1fd04c0d00dc9aad","createdAt":"2015-05-26T22:23:38.671Z","project":"5564f26a1fd04c0d00dc9aaa","releaseDate":"2015-05-26T22:23:38.671Z","__v":15},"__v":1,"category":{"sync":{"isSync":false,"url":""},"pages":["5564f26b1fd04c0d00dc9ab0","55663bc9979a3c2500bbafbf"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5564f26b1fd04c0d00dc9aae","__v":2,"createdAt":"2015-05-26T22:23:39.234Z","project":"5564f26a1fd04c0d00dc9aaa","version":"5564f26a1fd04c0d00dc9aad"},"createdAt":"2015-05-27T21:48:57.210Z","githubsync":"","parentDoc":null,"project":"5564f26a1fd04c0d00dc9aaa"}

Documentation

Security

Messages

Subscriptions

Message Forwarders

Authentication

Examples

Demos

Config Events

Meshblu Utility

Meshblu also offers a command line utility!
Start by: [block:code] { "codes": [ { "code": "npm install -g meshblu-util", "language": "text" } ] } [/block] To generate a public/private keypair, update meshblu.json with the private key, and publish the public key, run: [block:code] { "codes": [ { "code": "$ meshblu-util keygen meshblu.json", "language": "text" } ] } [/block] To learn more about the functionality of the meshblu-util tool, use: [block:code] { "codes": [ { "code": "$ meshblu-util --help\n\n Usage: meshblu-util [options] [command]\n\n\n Commands:\n\n claim claim Meshblu device in Octoblu\n subscription-create Create a device subscription\n subscription-delete Delete a device subscription\n subscription-list List a device's subscription\n create-hook Create a message hook\n firehose Connect to the firehose!\n generate-token generate and store token\n get retrieve a device using a meshblu.json\n keygen generate public/private keypair, update\n meshblu.json with the private key,\n and publish the public key\n message send a message with Meshblu\n online check if Meshblu device is online\n register register a new device with Meshblu\n revoke-token revoke token from device\n server-check check if Meshblu server is available\n search search for devices\n subscribe subscribe to messages to a Meshblu Device\n update update an existing device in Meshblu\n gateblu-shadow-sync synchronize a gateblu and it's shadows\n help [cmd] display help for [cmd]\n\n Options:\n\n -h, --help output usage information\n -V, --version output the version number", "language": "text" } ] } [/block]