Skip to content

Commit 45f37be

Browse files
updated readme
1 parent 52303f9 commit 45f37be

2 files changed

Lines changed: 44 additions & 2 deletions

File tree

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Table of contents
4343
- [Thingsboard server](#thingsboard-server)
4444
- [Launch locally](#launch-locally)
4545
- [Deploy](#deploy)
46+
- [Configure the Thingsboard server from scratch](#configure-the-thingsboard-server-from-scratch)
4647

4748

4849

@@ -124,11 +125,20 @@ The interface is compose of 3 tabs:
124125
![Temperature interface](https://i.ibb.co/N79Y55s/Screenshot-5.png)
125126
### Fluids
126127
![Fluids interface](https://i.ibb.co/tJ1LW4W/Screenshot-6.png)
128+
The fluids lets you control 3 fluid sensors:
129+
- an ink color sensor,
130+
- a flow sensor (in milliliters per second),
131+
- a fluid substance (=kind) sensor.
132+
133+
This page does not implement the Thingsboard telemetry dashboard for these sensors directly, so there are two ways of accessing it:
134+
- opening the dashboard directly in a web browser thanks to this [link](http://thingsboard.matthieu-rochette.fr/dashboard/a3618da0-4fe4-11ec-96b5-35454323bc15?publicId=e942da30-4dd8-11ec-a7fc-35454323bc15),
135+
- or going to one of the other two pages of the GUI ([Lights](#lights) or [Temperature](#temperature)) and change the dashboard displayed thanks to the menu in the top-right corner of the webview.
136+
127137

128138
---
129139
# Thingsboard server
130140
The thingsboard server is deployed using Docker Compose.
131-
By default, the project uses a web deployment with public dashboards, hosted [here](http://thingsboard.matthieu-rochette.fr) (the server might not be available at the moment you read those lines, presumably because the project has become quite old).
141+
By default, the project uses a web deployment with public dashboards, hosted **[here](http://thingsboard.matthieu-rochette.fr)** (the server might not be available at the moment you read those lines, presumably because the project has become quite old).
132142

133143
## Launch locally
134144
Make sure docker-compose is installed (instructions [here](https://docs.docker.com/compose/install/)).
@@ -141,4 +151,8 @@ docker-compose up
141151

142152
**Make sure to configure the Device Manager to use the correct URL (in `./DeviceManager/config.py` or via a `./.env` file. For a local deployment, that would be `http://localhost:8080`.**
143153
## Deploy
144-
You can either deploy directly on your server by forwarding the port you want to use in the `./docker-compose.yml` file, or put it behind a reverse proxy (example for NGINX in `./nginx.conf`).
154+
You can either deploy directly on your server by forwarding the port you want to use in the `./docker-compose.yml` file, or put it behind a reverse proxy (example for NGINX in `./nginx.conf`).
155+
156+
## Configure the Thingsboard server from scratch
157+
If you configure your own Thingsboard instance, you can use the files in `./Thingsboard/` to import dashboards and rules from this project.
158+
However, you will have to manually create the devices (a total of 9: 3 lights, 3 temperature sensors, 3 fluid sensors (1 of each kind)) and configure the GUI manually with the correct access tokens (cf. [this section](#configure-the-device-manager)).

Thingsboard/Devices/default.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"name": "default",
3+
"description": "Default device profile",
4+
"image": null,
5+
"type": "DEFAULT",
6+
"transportType": "DEFAULT",
7+
"provisionType": "DISABLED",
8+
"defaultRuleChainId": null,
9+
"defaultDashboardId": null,
10+
"defaultQueueName": null,
11+
"profileData": {
12+
"configuration": {
13+
"type": "DEFAULT"
14+
},
15+
"transportConfiguration": {
16+
"type": "DEFAULT"
17+
},
18+
"provisionConfiguration": {
19+
"type": "DISABLED",
20+
"provisionDeviceSecret": null
21+
},
22+
"alarms": null
23+
},
24+
"provisionDeviceKey": null,
25+
"firmwareId": null,
26+
"softwareId": null,
27+
"default": false
28+
}

0 commit comments

Comments
 (0)