Web of Things implementation on Node.js
Build:
W3C Software License
On Linux, install lerna
npm install -g lerna
On Windows, install the build tools and lerna (CMD shell as administrator)
npm install -g --production windows-build-tools
# Clone the repository
git clone https://github.com/thingweb/node-wot
# Go into the repository
cd node-wot
# install root dependencies (locally installs tools like typescript and lerna)
npm install
# bootstrap the packages (installs dependencies and links the inter-dependencies)
# Note: This step is automatically done on building or testing
npm run bootstrap
# use tsc to transcompile TS code to JS in dist directory for each package
npm run build
# run test suites of all packets
npm run test
# (OPTIONAL!)
# make all packages available on your local machine (as symlinks)
# you can then use each paket in its local version via "npm link" instead of "npm install"
# see also https://docs.npmjs.com/cli/link
sudo npm run link
Run all the steps above and then run this:
cd examples/scripts
wot-servient
# e.g., Windows CMD shell (Counter Example)
# expose
# node packages\cli\dist\cli.js examples\scripts\counter.js
# consume
# node packages\cli\dist\cli.js examples\scripts\counterClient.js
- go to http://localhost:8080/counter and you'll find a thing description.
- you can query the count by http://localhost:8080/counter/properties/count
- you can modify the count via POST on http://localhost:8080/counter/actions/increment and http://localhost:8080/counter/actions/decrement
- application logic is in
examples/scripts/counter.js
This library implements the WoT Scripting API
- First Public Working Draft in release v0.3.0
- Note: There are known differences between node-wot and FPWD (see Issue72).
- Editors Draft in master
You can also see examples/scripts to have a feeling of how to script a Thing.
- HTTP ✔️
- HTTPS ❓ ?fix needed?
- CoAP ✔️
- CoAPS ✖️
- Websocket ✖️
Note: More protocols can be easily added by implementing ProtocolClient, ProtocolClientFactory and ProtocolServer interface.
- JSON ✔️
- plainText ✔️
Note: More mediaTyes can be easily added by implementing ContentCodec interface.
We used to have a node-wot-logger package to allow fine-grained logging (by means of Winston). It turned out though that depending on the actual use-case other logging libraries might be better suited. Hence we do not want to prescribe which logging library to use. Having said that, we use console statements which can be easily overriden to use the prefered logging library if needed (see here).