j3d1/esp-open-rtos
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

I2C code formatting, README fix

Browse source
This commit is contained in:
UncleRus 2017-10-11 13:14:55 +05:00
parent cb4ea206fa
commit 080974ccfd
3 changed files with 80 additions and 71 deletions
Download patch file Download diff file Expand all files Collapse all files

13
extras/i2c/README.md
View file

@ -2,11 +2,12 @@
This time a driver for the excellent esp-open-rtos. This is a bit banging I2C driver based on the Wikipedia pesudo C code [1].
### Usage
### Basic usage
````
```C
#include <i2c.h>
#define BUS (0)
#define SCL_PIN (0)
#define SDA_PIN (2)
@ -14,19 +15,19 @@ uint8_t slave_addr = 0x20;
uint8_t reg_addr = 0x1f;
uint8_t reg_data;
i2c_init(SCL_PIN, SDA_PIN);
i2c_init(BUS, SCL_PIN, SDA_PIN);
// Write 1 byte to slave register
int err = i2c_slave_write(slave_addr, &reg_addr, &data, 1);
int err = i2c_slave_write(BUS, slave_addr, &reg_addr, &data, 1);
if (err != 0)
{
// do something with error
}
// Issue write to slave, sending reg_addr, followed by reading 1 byte
err = i2c_slave_read(slave_addr, &reg_addr, &reg_data, 1);
err = i2c_slave_read(BUS, slave_addr, &reg_addr, &reg_data, 1);
````
```
For details please see `extras/i2c/i2c.h`.