https://github.com/meshtastic/i2c-sensor
Arduino boilerplate for defining your own custom I2C sensor for use with Meshtastic
https://github.com/meshtastic/i2c-sensor
Last synced: 6 months ago
JSON representation
Arduino boilerplate for defining your own custom I2C sensor for use with Meshtastic
- Host: GitHub
- URL: https://github.com/meshtastic/i2c-sensor
- Owner: meshtastic
- License: mit
- Created: 2024-08-30T12:28:56.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-10T00:57:35.000Z (almost 2 years ago)
- Last Synced: 2025-04-10T02:39:00.931Z (about 1 year ago)
- Language: C
- Size: 31.3 KB
- Stars: 5
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Meshtastic I2C Sensor
This readme provides instructions on how to build / use a Meshtastic I2C sensor in both host and client modes.
## Host Mode
To use the I2C sensor in host mode, follow these steps:
1. Use the boilerplate example code in `src/main.cpp` under, gaurded by the `MESHTASTIC_I2C_SENSOR_HOST=1` macro to create your custom Meshtastic I2C sensor sketch.
2. Upload to your board.
3. Connect your custom Meshtastic I2C sensor to the Meshtastic device over I2C.
4. Enable environment telemetry (`telemetry.environment_measurement_enabled`).
### Host MCU support
There are two PlatformIO environments available as examples to build off of: `kb2040_host` and `kb2040_client` which build the main example sketch in host and client mode respectively. You can add your own PlatformIO environments theoretically for pretty much any device capable of I2C. This may require modification to the host codebase, which serves as a boilerplate for your own custom implementation.
## Client Library
This is used in the Meshtastic firmware to consume any custom sensor data you supply from the Host boilerplate above.
Example code is in `src/main.cpp` under, gaurded by the `MESHTASTIC_I2C_SENSOR_HOST=0` macro:
```
void setup() {
while (!Serial) { delay(10); }
Serial.begin(115200);
Serial.println("Initializing Meshtastic I2C Sensor device (client)...");
Wire.begin(MT_I2C_ADDRESS);
Wire.onReceive(onReceiveMetrics);
}
void loop() {
// I2C slave does not need to do anything in the loop
// Unless you need custom business logic here
delay(1000);
}
```