@@ -6,7 +6,7 @@ It provides low-level register access, automatic calibration, heading computatio
66
77---
88
9- ## 🧭 Features
9+ ## Features
1010
1111* ✅ Full ** I²C driver** for LIS2MDL
1212* ✅ Supports ** 10 / 20 / 50 / 100 Hz** output data rates
@@ -24,7 +24,7 @@ It provides low-level register access, automatic calibration, heading computatio
2424
2525---
2626
27- ## ⚙️ Hardware Requirements
27+ ## Hardware Requirements
2828
2929* ** LIS2MDL** 3-axis magnetometer (STMicroelectronics)
3030* ** MicroPython/CircuitPython board** , e.g.:
@@ -37,7 +37,7 @@ It provides low-level register access, automatic calibration, heading computatio
3737
3838---
3939
40- ## 🔌 Wiring Example (ESP32)
40+ ## Wiring Example (ESP32)
4141
4242| LIS2MDL Pin | ESP32 Pin | Description |
4343| ----------- | --------- | ------------ |
@@ -58,7 +58,7 @@ mag = LIS2MDL(i2c)
5858
5959---
6060
61- ## 🚀 Quick Start
61+ ## Quick Start
6262
6363### Read magnetic field
6464
@@ -87,7 +87,7 @@ heading = mag.heading_with_tilt_compensation(read_accel)
8787
8888---
8989
90- ## ⚖️ Calibration
90+ ## Calibration
9191
9292Calibration is essential to obtain accurate compass readings.
9393The driver provides ** automated routines** for both 2D (flat) and 3D calibration.
@@ -124,7 +124,7 @@ mag.calibrate_reset()
124124
125125---
126126
127- ## 🧰 Configuration Examples
127+ ## Configuration Examples
128128
129129### Output rate and power
130130
@@ -154,7 +154,7 @@ mag.set_bdu(True)
154154
155155---
156156
157- ## 🧮 Heading Filtering
157+ ## Heading Filtering
158158
159159You can apply a ** smoothing filter** on the heading angle to stabilize the readings:
160160
@@ -168,7 +168,7 @@ mag.set_heading_filter(alpha=0.2) # Light smoothing
168168
169169---
170170
171- ## 🔍 Diagnostics & Debug
171+ ## Diagnostics & Debug
172172
173173### Read sensor ID
174174
@@ -200,7 +200,7 @@ print("Register dump:", regs)
200200
201201---
202202
203- ## 🧠 Internal Methods Overview
203+ ## Internal Methods Overview
204204
205205| Method | Description |
206206| ---------------------------------- | ------------------------------ |
@@ -215,7 +215,7 @@ print("Register dump:", regs)
215215
216216---
217217
218- ## 🧪 Example: Continuous Compass Loop
218+ ## Example: Continuous Compass Loop
219219
220220``` python
221221from machine import I2C , Pin
@@ -234,7 +234,7 @@ while True:
234234
235235---
236236
237- ## 📚 References
237+ ## References
238238
239239* [ STMicroelectronics LIS2MDL Datasheet] ( https://www.st.com/resource/en/datasheet/lis2mdl.pdf )
240240* [ MicroPython Documentation] ( https://docs.micropython.org/en/latest/library/machine.I2C.html )
0 commit comments