C++ DevKit
C++ set of OOP library
Loading...
Searching...
No Matches
struct_I2CXferResult Struct Reference

this data structure collects result when an I2C transfer is done. It gives a more verbose error description : a context and the number of transfered byte. More...

#include <hw_i2c.h>

Collaboration diagram for struct_I2CXferResult:
Collaboration graph

Public Attributes

bool error = false
 flag that indicates if an error occurred.
 
std::string context = ""
 a clear indication of where the error occurred:
 
int xfer_size = 0
 the number of byte transfered.
 

Detailed Description

this data structure collects result when an I2C transfer is done. It gives a more verbose error description : a context and the number of transfered byte.

Member Data Documentation

◆ context

std::string struct_I2CXferResult::context = ""

a clear indication of where the error occurred:

  • "burst_byte_write [write cmd][data*]"
  • "single_byte_write [write cmd][byte]"
  • "single_byte_read [write cmd]"
  • "single_byte_read [read byte]"
  • "burst_byte_read [write cmd]"
  • "burst_byte_read [read data*]"

The documentation for this struct was generated from the following file: