First half of usermod readme updates

Describe the new usermod enable process, and update sample
platformio_override.ini stubs.
This commit is contained in:
Will Miles
2025-01-31 03:57:23 +00:00
parent 070b08a9e6
commit b3f9983f44
23 changed files with 51 additions and 185 deletions

View File

@@ -16,26 +16,6 @@ As a memento to a long trip I was on, I built an icosahedron globe. I put lights
I wanted to integrate an IMU to allow either on-board, or off-board effects that would
react to the globes orientation. See the blog post on building it <https://www.robopenguins.com/icosahedron-travel-globe/> or a video demo <https://youtu.be/zYjybxHBsHM> .
## Adding Dependencies
I2Cdev and MPU6050 must be installed.
To install them, add electroniccats/MPU6050@1.0.1 to lib_deps in the platformio.ini file.
For example:
```
lib_deps =
FastLED@3.3.2
NeoPixelBus@2.5.7
ESPAsyncTCP@1.2.0
ESPAsyncUDP@697c75a025
AsyncTCP@1.0.3
Esp Async WebServer@1.2.0
IRremoteESP8266@2.7.3
electroniccats/MPU6050@1.0.1
```
## Wiring
The connections needed to the MPU6050 are as follows:
@@ -74,18 +54,13 @@ to the info object
## Usermod installation
1. Copy the file `usermod_mpu6050_imu.h` to the `wled00` directory.
2. Register the usermod by adding `#include "usermod_mpu6050_imu.h"` in the top and `registerUsermod(new MPU6050Driver());` in the bottom of `usermods_list.cpp`.
Add `mpu6050_imu` to `custom_usermods` in your platformio_override.ini.
Example **usermods_list.cpp**:
Example **platformio_override.ini**:
```cpp
#include "wled.h"
#include "usermod_mpu6050_imu.h"
void registerUsermods()
{
UsermodManager::add(new MPU6050Driver());
}
```ini
[env:usermod_mpu6050_imu_esp32dev]
extends = env:esp32dev
custom_usermods = ${env:esp32dev.custom_usermods}
mpu6050_imu
```