Skip to content
This repository was archived by the owner on Jun 7, 2021. It is now read-only.

Commit 65d467c

Browse files
robyoungmrstegeman
authored andcommitted
Add links to WoT Capability Schema (#53)
When reading this README for the first time it was not clear exactly what the `Light` property was. Linking to the WoT Capability Schema is intended to make this connection clearer.
1 parent 2f4b34f commit 65d467c

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

README.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@ In this code-walkthrough we will set up a dimmable light and a humidity sensor (
3737
Dimmable Light
3838
--------------
3939

40-
Imagine you have a dimmable light that you want to expose via the web of things API. The light can be turned on/off and the brightness can be set from 0% to 100%. Besides the name, description, and type, a ``Light`` is required to expose two properties:
40+
Imagine you have a dimmable light that you want to expose via the web of things API. The light can be turned on/off and the brightness can be set from 0% to 100%. Besides the name, description, and type, a |Light|_ is required to expose two properties:
41+
42+
.. |Light| replace:: ``Light``
43+
.. _Light: https://iot.mozilla.org/schemas/#Light
4144

4245
* ``on``: the state of the light, whether it is turned on or off
4346

@@ -110,7 +113,10 @@ Sensor
110113

111114
Let's now also connect a humidity sensor to the server we set up for our light.
112115

113-
A ``MultiLevelSensor`` (a sensor that returns a level instead of just on/off) has one required property (besides the name, type, and optional description): ``level``. We want to monitor this property and get notified if the value changes.
116+
A |MultiLevelSensor|_ (a sensor that returns a level instead of just on/off) has one required property (besides the name, type, and optional description): ``level``. We want to monitor this property and get notified if the value changes.
117+
118+
.. |MultiLevelSensor| replace:: ``MultiLevelSensor``
119+
.. _MultiLevelSensor: https://iot.mozilla.org/schemas/#MultiLevelSensor
114120

115121
First we create a new Thing:
116122

0 commit comments

Comments
 (0)