Update README for W3C WoT TD#143
Conversation
| ## Beginner Tutorials | ||
|
|
||
| If you need a more extensive explanation of the usage of this library, we have some step by step tutorials available with more context. | ||
|
|
||
| ### WebThings Arduino + Node-WoT | ||
|
|
||
| [Node-WoT](https://github.com/eclipse/thingweb.node-wot) is a Javascript client library to consume Web of Things devices. | ||
|
|
||
| - [Show number of Github forks and stars on Matrix display](https://bind.systems/blog/web-of-things-github-forks-stars/) | ||
| - [Run speedtest and show results on an OLED display](https://bind.systems/blog/web-of-things-speedtest/) | ||
|
|
||
| ### WebThings Arduino + Node-RED | ||
|
|
||
| [Node-RED](https://nodered.org/) is a drag and drop tool for connecting devices. It requires little Javascript programming knowledge. | ||
|
|
||
| - [Connect temperature sensor to OLED display](https://bind.systems/blog/web-of-things-node-red-temperature-oled/) | ||
|
|
||
| ### WebThings Arduino | ||
|
|
||
| - [Blinking LED](https://bind.systems/blog/web-of-things-led/) | ||
| - [Matrix display](https://bind.systems/blog/web-of-things-arduino-matrix-display/) | ||
| - [OLED display](https://bind.systems/blog/web-of-things-arduino-oled/) |
There was a problem hiding this comment.
A lot of these tutorials don't seem to have anything to do with the webthing-arduino library and "we" implies some kind of affiliation with the bind.systems website.
I don't think it's a bad thing to link to external tutorials for additional reading, but it would be better to provide some documentation for getting started with the webthing-arduino library directly inside this README, like the existing content of the README.
Contributions to the WebThings docs at https://webthings.io/docs are also welcome!
There was a problem hiding this comment.
Well, it's my website. I can change it to "there". That's fine. The tutorials cover how to use the Arduino library with other libraries together. It shows the possibilities of the W3C WoT TD 1.0 standard. You have to flash an app on the Arduino with the WebThings library in order to build these setups. So, it also covers the Arduino library as well.
The README still provides that, if you look to the rest of it. I just want to give new user some practical examples how to use the WoT standard in general and why people should use it.
| ### Continuing onwards | ||
|
|
||
| Make sure to install the current release of the ArduinoJson library (6) if you | ||
| don't have it installed already. | ||
|
|
||
|  | ||
|
|
||
| Next, download this library from the same library manager by searching for | ||
| `webthing`. | ||
|
|
||
|  | ||
|
|
||
| You should be able to upload the example sketch onto your board and use it as a | ||
| simple Web Thing. This Web Thing can be talked to using the WoT API or added to | ||
| the WebThings Gateway using the "Add Thing by URL" feature. Note that | ||
| right now, WiFi101-based Things must be manually added by typing the full URL | ||
| to the Web Thing, e.g. `http://192.168.0.103/things/led`. | ||
|
|
||
| If you want to create a Web Thing from scratch, make sure to include both | ||
| "Thing.h" and "WebThingAdapter.h" (or "EthernetWebThingAdapter.h", if using an | ||
| Ethernet board). You can then add Things and Properties to your board using our | ||
| proposed API. | ||
|
|
There was a problem hiding this comment.
Please update this text rather than just removing it. It includes important information.
|
Same reason as mentioned in #140 |
2 participants
Merge after #140