Skip to content

Commit d7c36ba

Browse files
committed
Update readme
1 parent 2568ccd commit d7c36ba

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
# Description
2-
This library permits to control Bosch-Sensortec's BNO055 with an ESP32 SoC (esp-idf)
1+
# BNO055ESP32
2+
This idf-component permits to control [Bosch-Sensortec's BNO055](https://www.bosch-sensortec.com/bst/products/all_products/bno055) using an [Espressif's ESP32 SoC](https://www.espressif.com/en/products/hardware/esp32/overview) (running [esp-idf](https://github.com/espressif/esp-idf)).
33

44
# Compatibility
55
Tested on ESP32D0WDQ6 (DevKitC) with [Adafruit's BNO055 Breakout Board](https://www.adafruit.com/product/2472) using UART protocol.
66

7-
<b>I²C</b> is not supported due to issues probably caused by clock stretching.
8-
when this issues will be fixed I²C will be supported.
7+
#### Supported Interfaces
8+
- <b>UART</b> - fully Supported.
9+
- <b>I²C</b> - <b>not supported*</b>
10+
11+
*I²C is not supported due to several ESP32's I²C issues probably caused by clock stretching.
12+
when espressif team will solve this issues, I²C will be supported.
913

1014
# Getting Started
1115
***NOTE: this code is not (yet) Production Ready.***
@@ -17,11 +21,10 @@ git clone https://github.com/ShellAddicted/BNO055ESP32.git
1721
```
1822
Remember to enable ```Compiler Options -> Enable C++ Exceptions``` using ```make menuconfig```
1923

20-
and see [examples/](https://github.com/ShellAddicted/BNO055ESP32/tree/master/examples)
24+
for more details see [examples/](https://github.com/ShellAddicted/BNO055ESP32/tree/master/examples)
2125

2226
## Wiring
2327

2428
PS1 -> 3.3v (HIGH) -> Enables UART protocol instead of I²C
25-
SDA -> UART RX
26-
SCL -> UART TX
27-
obviously, BNO055 and ESP32 SoC <b>must</b> have a common ground.
29+
SDA -> UART RX (Default: GPIO_NUM_17)
30+
SCL -> UART TX (Default: GPIO_NUM_16)

0 commit comments

Comments
 (0)