Skip to content

Commit f3cebb1

Browse files
committed
add build instruction and description
1 parent 5c79fd8 commit f3cebb1

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,40 @@
11
# Libelium Calibration App
22

3-
## Run
3+
The Libelium Calibration App can be used for Libelium [Smart Water Sensors Kit](https://development.libelium.com/smart_water_sensor_guide) and [Smart Water ions Sensors kit](https://development.libelium.com/smart-water-ions-sensor-guide). App will work only with the [firmware](firmware) from this repository.
4+
5+
The Libelium Calibration App allows to see the current measurements and calibrate sensors.
6+
7+
The Libelium Calibration App is designed to be compatible with both the [Smart Water Sensors Kit](https://development.libelium.com/smart_water_sensor_guide) and the [Smart Water ions Sensors kit](https://development.libelium.com/smart-water-ions-sensor-guide) from Libelium. It is essential to note that the app is exclusively compatible with the [firmware](firmware) provided within this repository.
8+
9+
This application enables users to view real-time measurements and conduct sensor calibration effortlessly.
10+
11+
The latest executable files can be found in the latest release.
12+
13+
## Build from source
14+
To build the application, Python version no older than 3.9 is required!
15+
16+
Clone the repo:
17+
```bash
18+
git clone https://github.com/Multi-Agent-io/libelium-calibration-app.git
19+
cd libelium-calibration-app
20+
```
21+
Install dependencies:
22+
```bash
23+
pip3 install requirements.txt
24+
```
25+
Build GUI files:
26+
```bash
27+
pyuic5 app/gui/mainwindow.ui -o app/gui/mainwindow.py
28+
```
29+
And build executables:
30+
```bash
31+
pyinstaller app/main.py --onefile --windowed --name SmartWaterGUI
32+
```
33+
Executables will be in the `dist` folder.
34+
35+
## Run Python Script
436
```bash
37+
pip3 install -r requirements.txt
538
pyuic5 app/gui/mainwindow.ui -o app/gui/mainwindow.py
639
python3 app/main.py
740
```

0 commit comments

Comments
 (0)