Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 4a3783d

Browse files
javalikescriptjavalikescript
committedJan 18, 2025
Add documentation to extensions
1 parent 3889a3c commit 4a3783d

File tree

24 files changed

+258
-2
lines changed

24 files changed

+258
-2
lines changed
 

‎extensions/calendrier-scolaire/readme.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This extension exposes a thing with properties indicating if the current day is an holiday.
2+
3+
You need to configure the zone accordingly to your location.

‎extensions/conbee-2/readme.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## Overview
2+
3+
This extension allows to connect to the Conbee II via the deCONZ application.
4+
5+
This extension only requires the REST API and WebSockets.
6+
7+
See the [Phoscon documentation](https://phoscon.de/en/conbee2/install#docker) and the [docker repository](https://github.com/deconz-community/deconz-docker#readme).
8+
9+
## Prerequisites
10+
11+
The deCONZ app must be available.
12+
13+
It is recommended to use Docker to run the deCONZ app.
14+
15+
### Docker
16+
17+
On Raspberry PI the setup of Docker can be painfull, please consult the [Docker documentation](https://docs.docker.com/engine/install/debian/).
18+
19+
Optionally retrieve the Docker image.
20+
```sh
21+
docker pull deconzcommunity/deconz:stable
22+
lsusb
23+
```
24+
25+
Start deCONZ in background.
26+
```sh
27+
mkdir $HOME/deconz
28+
docker run -d --name=deconz --restart=unless-stopped -p 8080:8080 -p 8088:8088 \
29+
-e DECONZ_WEB_PORT=8080 -e DECONZ_WS_PORT=8088 \
30+
-v /etc/localtime:/etc/localtime:ro -v $HOME/deconz:/opt/deCONZ \
31+
-e DECONZ_DEVICE=/dev/ttyACM0 --device=/dev/serial/by-id/usb-dresden_elektronik_ingenieurtechnik_GmbH_ConBee_II-if00:/dev/ttyACM0 \
32+
deconzcommunity/deconz:stable
33+
```
34+
35+
## Setup
36+
37+
You will need to acquire an API key.
38+
39+
You could use `curl` with the gateway credentials:
40+
```sh
41+
curl --user "login:password" -X POST http://localhost:8080/api
42+
```
43+
44+
45+
## Usage
46+
47+
You need to add your device in the Phoscon app prior adding it through this extension.
48+
49+
The JSON mapping defines the how the Conbee devices are mapped to things.

‎extensions/ecowatt/readme.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Overview
2+
3+
This extension exposes the EcoWatt signals
4+
5+
## Setup
6+
7+
You will need to create an application on RTE in order to configure this extension.
8+
9+
## Usage
10+
11+
The signal values are
12+
* 0 vert + production décarbonée
13+
* 1 vert
14+
* 2 orange
15+
* 3 rouge

‎extensions/execute/readme.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Overview
2+
3+
This extension simplifies the execution of OS command in other extensions.
4+
5+
## Usage
6+
7+
The extension exposes a Lua function `execute` with a command string argument which returns a Promise.
8+
9+
This feature is shared with and reused by other extensions such as `ping`.

‎extensions/free-mobile-sms/readme.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Overview
2+
3+
This extension allows to send SMS on your mobile phone.
4+
5+
## Setup
6+
7+
You need to activate the option on your Free mobile account.
8+
9+
## Usage
10+
11+
The thing exposes a `message` writable property, a SMS is sent when setting this property.

‎extensions/generic/readme.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This extension allows to define virtual things.
2+
3+
You configure each virtual things and its properties.
4+
5+
These virtual things can be reused in multiple scripts.

‎extensions/https/readme.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
This extension exposes the default engine HTTP server on a specific port using HTTPS.
2+
3+
You need to provide the certificate and the associated private key.
4+
5+
You could restrict the acces to logged users.

‎extensions/hue-v2/readme.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Overview
2+
3+
This extension allows to connect to the Hue bridge.
4+
5+
## Setup
6+
7+
You will need to acquire an application key.
8+
9+
## Usage
10+
11+
You need to add your device in the Hue bridge prior adding it through this extension.
12+
13+
The JSON mapping defines the how the Hue devices are mapped to things.

‎extensions/mqtt-broker/readme.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
This extension provides a light MQTT server.

‎extensions/mqtt/readme.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
This extension propagates the thing properties data changes to an MQTT server.
3+
4+
The change is published on the data path prefixed by the configured topic.
5+
6+
The message received on the same topic are applied on the engine data.

‎extensions/owm/manifest.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "Open Weather Map",
3-
"description": "Open Weather Map",
3+
"description": "Provides weather and forecast data",
44
"version": "2.0",
55
"dependencies": ["web-base"],
66
"script": "owm.lua",

‎extensions/owm/readme.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Overview
2+
3+
This extension provides weather and forecast data from Open Weather Map
4+
5+
## Setup
6+
7+
You will need to get and configure an API key

‎extensions/self/readme.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
This extension exposes information from the engine and the underlying OS.

‎extensions/serial/readme.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
2+
This extension exposes things from a serial connection.
3+
4+
You could use an Arduino board to retrieve sensor data and expose the data through the serial port.
5+
6+
The messages are sent in JSON format in a single line.
7+
8+
```JSON
9+
[commandId, thingId, value, propertyId]
10+
```
11+
12+
The available commands are:
13+
14+
* 0: WELCOME - To initiate the connexion
15+
* 1: INFO - To discover things
16+
* 2: READ - To read thing property values
17+
* 3: WRITE - To write a thing property value (not implemented)
18+
19+
The messages are received in JSON format in a single line.
20+
21+
```JSON
22+
{
23+
success: true,
24+
id: thingId,
25+
cmd: commandId,
26+
values: ['humidity', 'temperature', 'pressure', 'custom property name']
27+
}
28+
```

‎extensions/share/readme.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
This extension exposes files on the engine server.
3+
4+
You could then upload then download files on this path.
5+
6+
You could also exposes URLs on the engine server using a light reverse proxy.

‎extensions/tic-serial/readme.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
Cette extension expose les informations du compteur électrique utilisé en France.
3+
4+
Les données vous permettent notamment de suivre votre consommation et de faire le délestage de vos chauffages électriques.
5+
6+
Les données exposées sont:
7+
* Dépassement de puissance souscrite
8+
* Puissance apparente et souscrite
9+
* Index heures pleines et creuses
10+
11+
Pour accéder à ces données vous pouvez brancher un module TIC USB.

‎extensions/tic-serial/tic-serial.lua‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ extension:subscribeEvent('things', function()
119119
['@type'] = Thing.PROPERTY_TYPES.ApparentPowerProperty,
120120
type = 'number',
121121
title = 'Apparent power',
122-
description = 'The apparent power',
122+
description = 'Puissance apparente',
123123
readOnly = true,
124124
unit = 'voltampere'
125125
})

‎extensions/users/readme.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
This extension allows you to manage the access rights.
3+
4+
By default the engine can be used by anyone without any credentials.
5+
6+
You could add users and associated access rights.
7+
8+
The available access rights are:
9+
* `read`: read things
10+
* `write`: modify thing property values
11+
* `configure`: add or modify things or extensions
12+
* `administer`: start or stop the engine
13+
14+
Note: Take care to have at least one user with the `administer` or `configure` right.
15+
16+
You could restrict the access to logged users, users are redirected to a login page.

‎extensions/web-base/readme.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
This extension is enabled by default and provides a web interface to manage the engine.
3+
4+
The web interface allows to manage things and extensions.
5+
6+
The web interface can be enriched by other extensions.
7+
8+
```Lua
9+
extension:require('web-base.addons', true).register(extension)
10+
```

‎extensions/web-chart/readme.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
This extension provides a web page to visualize historical data via a time chart.
3+
4+
The thing should have been flagged to historize their data.

‎extensions/web-notes/readme.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
This extension provides a web page to create, view and edit notes containing plain text.
3+
4+
A user folder contains notes only accessible by the logged user.

‎extensions/web-scripts/readme.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
This extension provides a web page to create scripts.
3+
4+
There are 3 types of scripts, `blocks`, `view` and `lua` each having a dedicated editor.
5+
6+
A blocks extension is a server side extension composed with basic blocks to react to thing property value modifications.
7+
A view extension is a front-end extension composed with HTML to show thing property values.

‎extensions/web-tools/readme.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
This extension provides a web page with various advanced tools.
3+
4+
You could change the log level, run Lua script or OS command on the engine.

‎extensions/zwave-js-ws/readme.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Overview
2+
3+
This extension exposes ZWave devices through ZWave-JS.
4+
5+
## Prerequisites
6+
7+
ZWave-JS-UI must be available.
8+
9+
It is recommended to use Docker to run the ZWave-JS-UI server.
10+
11+
### Docker
12+
13+
On Raspberry PI the setup of Docker can be painfull, please consult the [Docker documentation](https://docs.docker.com/engine/install/debian/).
14+
15+
Bookworm may hang requiring to use Bullseye.
16+
17+
Optionally retrieve the Docker image.
18+
```sh
19+
docker pull zwavejs/zwave-js-ui:latest
20+
lsusb
21+
```
22+
23+
Start ZWave-JS-UI in background.
24+
```sh
25+
mkdir $HOME/zwave-js-ui
26+
docker run -d --name zwavejs --restart unless-stopped -p 8091:8091 -p 3000:3000 -e TZ=Europe/Paris \
27+
--device=/dev/serial/by-id/usb-0000_0000-if00:/dev/zwave \
28+
-v $HOME/zwave-js-ui:/usr/src/app/store zwavejs/zwave-js-ui:latest
29+
```
30+
31+
## Setup
32+
33+
You need to activate the WebSockets feature on your ZWave-JS server.
34+
35+
## Usage
36+
37+
You need to include your device in ZWave-JS prior adding it through this extension.
38+
39+
The JSON mapping defines the how the ZWave devices are mapped to things.

0 commit comments

Comments
 (0)
Please sign in to comment.