Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.73 KB

CoapBroker.md

File metadata and controls

67 lines (42 loc) · 2.73 KB

Coap Broker Servers

Join the chat at https://gitter.im/wotcity/wotcity-wot-framework

A Coap broker server is not running on IoT devices. The main use case is for constrained devices (eg. microcontrollers) to send data streams over the web.

  1. Install
  2. Usage
  3. Discussion
  4. How To Report Bugs

Install

  1. Download dotcity-wot-framework.
  2. Run $ cd dotcity-wot-framework to change the directory.
  3. Run $ npm install to install the dependencies if you don't already have them.
  4. Run $ node servers/coap-broker.js to start the WoT Coap server.

By default, the server is running at coap://localhost:8000. You could override the default settings by Linux shell environment varialbes HOST and PORT. To start Coap broker server at wotcity.com and port 8080, run $ export HOST=wotcity.com; export PORT=8080; node servers/coap-broker.js .

Prerequisites

  1. Node.js. Note: Node should be with a version above 0.10.x.

Usage

To send the data over the Internet, IoT devices should use the url below to establish a connection with the server.

coap://[hostname]/object/[name]/send

You must specify an object name and your hostname. For example:

coap://localhost:8000/object/frontdoor/send

To receive data from the server, the frontend should use the url below to establish a connection with the server.

coap://localhost:8000/object/[name]/viewer

Also, you need to specify the object name and hostname. For example:

coap://localhost:8000/object/frontdoor/viewer

An physical object has two significant resources, send and viewer. send is to send device data to the server over Coap connection. viewer could be used by web frontend to receive real-time data over the connection.

Tests

  1. Open a new terminal and run $ cd tests to enter the directory of test scripts.
  2. Run $ node coap-send-data.js to start sending streaming data to WoT coap server.
  3. Open a new terminal and run $ node coap-view-data.js to start receiving streaming data over coap.

Discussion

There are various ways to get involved with .CITY Web of Things Framework. We're looking for help identifying bugs, writing documentation and contributing codes.

You can also find us in the #wotcity IRC channel on irc.freenode.net.

How to Report Bugs

Bugs are reported via https://github.com/wotcity/wotcity-wot-framework.