Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nopnop2002/esp-idf-hmc5883l
Display the orientation of HMC5883L with ESP32
https://github.com/nopnop2002/esp-idf-hmc5883l
compass esp-idf esp32 hmc5883l
Last synced: 16 days ago
JSON representation
Display the orientation of HMC5883L with ESP32
- Host: GitHub
- URL: https://github.com/nopnop2002/esp-idf-hmc5883l
- Owner: nopnop2002
- License: mit
- Created: 2023-04-15T04:04:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-14T02:13:24.000Z (10 months ago)
- Last Synced: 2024-10-11T13:44:47.523Z (about 1 month ago)
- Topics: compass, esp-idf, esp32, hmc5883l
- Language: C
- Homepage:
- Size: 63.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# esp-idf-hmc5883l
Display the orientation of HMC5883L with ESP32.
I used [this](https://github.com/jrowberg/i2cdevlib/tree/master/Arduino) I2Cdev library collection by Jeff Rowberg.
First, find the offset value for each axis.
As you can see, each axis is quite off-center.
And display the orientation.
# Software requiment
ESP-IDF V4.4/V5.x.
ESP-IDF V5.0 is required when using ESP32-C2.
ESP-IDF V5.1 is required when using ESP32-C6.
# Hardware requirements
HMC5883L 3-axis Electronic Compass
__Note__
HMC5883L and QMC5883L are completely incompatible chips.
# Wireing
|HMC5883L||ESP32|ESP32-S2/S3|ESP32-C2/C3/C6||
|:-:|:-:|:-:|:-:|:-:|:-:|
|VCC|--|3.3V|3.3V|3.3V||
|GND|--|GND|GND|GND||
|SCL|--|GPIO22|GPIO12|GPIO5|(*1)|
|SDA|--|GPIO21|GPIO11|GPIO4|(*1)|
|DRDY|--|N/C|N/C|N/C||
(*1)You can change it to any pin using menuconfig.
# Caribration
```
git clone https://github.com/nopnop2002/esp-idf-hmc5883l
cd esp-idf-hmc5883l/calibrate
idf.py set-target {esp32/esp32s2/esp32s3/esp32c2/esp32c3/esp32c6}
idf.py menuconfig
idf.py flash
```
### Configuration
To find the offset value, set the compass offset to 0.
### Execute calibration
ESP32 acts as a web server.
I used [this](https://github.com/Molorius/esp32-websocket) component.
This component can communicate directly with the browser.
Enter the following in the address bar of your web browser.
```
http:://{IP of ESP32}/
or
http://esp32.local/
```
As you move the compass it plots the X, Y and Z values.
X, Y, Z offset are displayed.
### Execute calibration again
If you set the offset you got from the calibration and run it again, the circle position will change.
# Display the orientation
```
git clone https://github.com/nopnop2002/esp-idf-hmc5883l
cd esp-idf-hmc5883l/heading
idf.py set-target {esp32/esp32s2/esp32s3/esp32c2/esp32c3/esp32c6}
idf.py menuconfig
idf.py flash
```
### Configuration
Sets the compass offset obtained by calibration.
### View orientation
ESP32 acts as a web server.
I used [this](https://github.com/Molorius/esp32-websocket) component.
This component can communicate directly with the browser.
Enter the following in the address bar of your web browser.
```
http:://{IP of ESP32}/
or
http://esp32.local/
```
Click the mouse to change the display.
WEB pages are stored in the html folder.
I used [this](https://canvas-gauges.com/) for gauge display.
You can change the design and color according to your preference.