https://github.com/misterpemodder/sensorsensei
https://github.com/misterpemodder/sensorsensei
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/misterpemodder/sensorsensei
- Owner: MisterPeModder
- Archived: true
- Created: 2025-02-27T13:37:39.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-19T07:58:05.000Z (12 months ago)
- Last Synced: 2025-10-27T09:27:16.433Z (7 months ago)
- Language: Rust
- Size: 2.25 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sensor Sensei
[Link to Working repository](https://github.com/MisterPeModder/SensorSensei)
[Link to Epitech repository](https://github.com/EpitechMscProPromo2025/T-IOT-902-NAN_10)
## Initial Setup
1. **Install PlatformIO**: [installation steps](https://platformio.org/install)
2. **Install Rust and Cargo**: Make sure you have Rust and Cargo installed on your machine. You can install them by following the instructions at [rust-lang.org](https://www.rust-lang.org/tools/install).
3. **Install Rust flashing tools**:
```shell
cargo install espup cargo-espflash espflash
espup install
```
## Building
### Gateway and Sensor Boards
Both boards are using cargo and can be built/runned with the same commands. The only difference being in the appropriate directory.
Build:
```shell
source ~/export-esp.sh
cd gateway-board
# or cd sensor-board
cargo build --release
```
Build and flash:
```shell
source ~/export-esp.sh
cd gateway-board
# or cd sensor-board
cargo run --release
```
## Simulating (Gateway Board)
You may use Wokwi to simulate the Gateway Board. To do so, follow these steps:
1. Install the Wokwi VSCode extension.
2. (Re)-build the Gateway Board (see above).
3. Open the `gateway-board/diagram.json` file in VSCode.
4. Click on the "Start the simulation" button
## Conditional Compilation (Gateway Board)
### No OLED display
Flashing with wifi support only:
```shell
cargo run --no-default-features --features="board-heltec-lora32v3,wifi"
```
### ESP32 support
Flashing with wifi support only:
```shell
cargo run --target="xtensa-esp32-none-elf" --no-default-features --features="board-esp32dev"
```
### InfluxDB Dashboard
To enable the InfluxDB dashboard, you need to set the following environment variables while building.
- INFLUXDB_HOST
- INFLUXDB_API_TOKEN
- INFLUXDB_ORG
- INFLUXDB_BUCKET