Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP Developer Journey #263

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

WIP Developer Journey #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
976a0e2
add simple list of things to learn for WoT
egekorkan Feb 16, 2022
9fefcc1
add tags, nodejs and embedded dev to the dev journey
egekorkan Mar 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/developers/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@
title: Developers
group: "navigation"
---
<div>
<h2>Guide for WoT Developers</h2>
<!-- might be better to use new developers? -->

<p>
If you are new to the Web of Things, there are different ways to be knowledgeable and start using Web of Things
in your applications.
In our <a href="{{'developers/journey' | relative_url }}">developer journey document</a>, you can find one such way.
</p>

</div>
<div>
<h2>Developer Tools</h2>

Expand Down
111 changes: 111 additions & 0 deletions docs/developers/journey.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
layout: default
title: Developer Journey
group: "navigation"
---
<div>
<h2>Guide for WoT Developers</h2>

<p>
There are many ways to be an expert in the Web of Things and below is our proposal on how to get there.
This assumes no prior knowledge on any of the technologies the Web of Things builds upon.
Since Web of Things bridges many fields such as Web development, embedded system development and Internet protocols,
the preliminary sections below are tagged with the corresponding field and can be unfolded depending on your prior knowledge.
</p>

<ol>
<li>JSON:
<!-- TAGS: Web, Internet -->
<ol>
<li>Learning Sources</li>
<li>Configuration files</li>
<li>Exchanging data between devices (APIs)</li>
<li>Metadata (e.g. API Descriptions)</li>
</ol>
</li>

<li>JSON Schema:
<!-- TAGS: Web, Internet -->
<ol>
<li>Learning Sources</li>
<li>Validation of JSON instances</li>
<li>Generation of documentation, types for programming languages, UIs</li>
</ol>
</li>

<li>Node.js (optional)
<!-- TAGS: Web, Internet -->
<ol>
<li>Explaining why (reference implementation)</li>
<li>Node.js Tutorials</li>
</ol>
</li>

<li>JSON-LD:
<!-- TAGS: Web-->
<ol>
<li>Learning Sources</li>
<li>Bringing context to data, specifying the meaning (semantics) of the data</li>
</ol>
</li>

<li>A protocol, HTTP/REST is recommended:
<!-- TAGS: Web, Internet -->
<ol>
<li>Learning Sources for the HTTP protocol</li>
<li>How one programs a server (Thing)</li>
<li>How one uses a REST Client and how one programs one</li>
</ol>
</li>

<li> Working with (constrained) Physical Things
<!-- TAGS: embedded -->
<ol>
<li>Understanding Device Categories</li>
<li>Understanding lower level protocols (wireless and wired)</li>
<li>Understanding how to work with sensors/li>
<li>Understanding how to work with actuators</li>
<li>Example Thing development with Raspberry Pi</li>
<li>Example Thing development with ESP32</li>
</ol>
</li>

<li>TD:
<ol>
<li>Reading the spec</li>
<li>Use a TD for a UI</li>
<li>Interact with a Thing</li>
<li>Existing Tooling</li>
</ol>
</li>

<li>Discovery:
<ol>
<li>Introduction mechanisms</li>
<li>Register TDs</li>
<li>Find/Fetch TDs</li>
<li>Existing implementations</li>
</ol>
</li>

<li>Scripting API:
<ol>
<li>Idea behind how to program interactions with devices, the WoT way!</li>
<li>Reading the specification</li>
<li>node-wot</li>
</ol>
</li>

<li>Binding Templates:
<ol>
<li>See how your knowledge in one protocol can apply to others</li>
<li>See how other protocols work in WoT</li>
</ol>
</li>

<li>Profiles:
<ol>
<li>Reduce implementation effort for your Consumers by implementing a profile</li>
</ol></li>
</ol>
</div>