I2C
This is a class to control M5Stack's Grove-A port (I2C). I2C communication needs to be initialized in advance by M5.Begin().
writeCommand()
Syntax:
bool writeCommand(uint8_t address, uint8_t subAddress)
Description:
Write to the specified address. Used when there are no parameters.
Function argument
| Function argument | Type | Description |
|---|---|---|
| address | uint8_t |
Slave Address |
| subAddress | uint8_t |
function address |
Function return value
| Value | Description |
|---|---|
| true | Write success |
| false | Write failure |
writeByte()
Syntax:
bool writeByte(uint8_t address, uint8_t subAddress, uint8_t data)
Description:
Write to the specified address. Used when there is one parameter.
Function argument
| Function argument | Type | Description |
|---|---|---|
| address | uint8_t |
Slave Address |
| subAddress | uint8_t |
function address |
| data | uint8_t |
parameter |
Function return value
| Value | Description |
|---|---|
| true | Write success |
| false | Write failure |
writeBytes()
Syntax:
bool writeBytes(uint8_t address, uint8_t subAddress, uint8_t *data,uint8_t length)
Description:
Write to the specified address. Use when there are multiple parameters.
Function argument
| Function argument | Type | Description |
|---|---|---|
| address | uint8_t |
Slave Address |
| subAddress | uint8_t |
function address |
| data | uint8_t * |
top of data memory |
| length | uint8_t |
length of data |
Function return value
| Value | Description |
|---|---|
| true | Write success |
| false | Write failure |
readByte()
Syntax:
bool readByte(uint8_t address, uint8_t *result)
Description:
Read from the specified address. It is used when there is no data to send before reading and the response is 1 byte.
Function argument
| Function argument | Type | Description |
|---|---|---|
| address | uint8_t |
Slave Address |
| result | uint8_t * |
stored memory |
Function return value
| Value | Description |
|---|---|
| true | Read success |
| false | Read failure |
readByte()
Syntax:
bool readByte(uint8_t address, uint8_t subAddress,uint8_t *result)
Description:
Read from the specified address. It is used when the data to be sent before reading is only the functional address and the response is 1 byte.
Function argument
| Function argument | Type | Description |
|---|---|---|
| address | uint8_t |
Slave Address |
| subAddress | uint8_t |
function address |
| result | uint8_t * |
stored memory |
Function return value
| Value | Description |
|---|---|
| true | Read success |
| false | Read failure |
readBytes()
Syntax:
bool readBytes(uint8_t address, uint8_t count,uint8_t * dest)
Description:
Read from the specified address. Use when there is no data to send before reading and there are multiple responses.
Function argument
| Function argument | Type | Description |
|---|---|---|
| address | uint8_t |
Slave Address |
| count | uint8_t |
Length of request bytes |
| result | uint8_t * |
stored memory |
Function return value
| Value | Description |
|---|---|
| true | Read success |
| false | Read failure |
readBytes()
Syntax:
bool readBytes(uint8_t address, uint8_t subAddress, uint8_t count, uint8_t * dest)
Description:
Read from the specified address. It is used when the data to be sent before reading is only the functional address and there are multiple responses.
Function argument
| argument | Typer | Description |
|---|---|---|
| address | uint8_t |
Slave Address |
| subAddress | uint8_t |
Addresress |
| count | uint8_t |
Length of request bytes |
| result | uint8_t * |
stored memory |
Function return value
| Value | Description |
|---|---|
| true | Read success |
| false | Read failure |
scanID()
Syntax:
bool readBytes(bool *result)
Description:
Perform device presence check on I2C bus.
Function argument
| Function argument | Type | Description |
|---|---|---|
| result | bool * |
stored memory(128bytes) |
Function return value
| Value | Description |
|---|---|
| true | Read success |
| false | Read failure |
Example of use;
bool result[0x80];
M5.I2C.scanID(&result[0]);