Macros | Functions
SensorNodeMapping.h File Reference
#include "BCDS_Basics.h"
+ Include dependency graph for SensorNodeMapping.h:
+ This graph shows which files directly or indirectly include this file:

Macros

#define I2C_FAILURE   INT8_C(-1)
 
#define I2C_SUCCESS   INT8_C(0)
 

Functions

int8_t SensorNodeMapping_BurstRead (unsigned char I2Caddr, unsigned char Reg, unsigned char *RegData, unsigned int NbrBytesToRead)
 Function to read a register of a device connected to I2C. More...
 
Retcode_T SensorNodeMapping_DeInit (void)
 de-Initializes I2C and disables the power to sensors. More...
 
Retcode_T SensorNodeMapping_Init (void)
 Initializes I2C and enables the power to sensors. More...
 
int8_t SensorNodeMapping_Read (unsigned char I2Caddr, unsigned char Reg, unsigned char *RegData, unsigned char NbrBytesToRead)
 Function to read a register of a device connected to I2C. More...
 
int8_t SensorNodeMapping_Write (unsigned char I2Caddr, unsigned char Reg, unsigned char *RegData, unsigned char NbrBytesToWrite)
 Function to write a register of a device connected to I2C. More...
 

Macro Definition Documentation

#define I2C_FAILURE   INT8_C(-1)
#define I2C_SUCCESS   INT8_C(0)

Function Documentation

int8_t SensorNodeMapping_BurstRead ( unsigned char  I2Caddr,
unsigned char  Reg,
unsigned char *  RegData,
unsigned int  NbrBytesToRead 
)
Parameters
[in]I2CaddrI2C address of the connected device from which to read the register.
[in]RegRegister address of the device to read.
[out]RegDataPointer on a buffer into which the read values will be stored.
[in]NbrBytesToReadNumber of data elements expected to be received.
Return values
I2C_SUCCESSon success.
I2C_FAILUREif an error occurred.
Retcode_T SensorNodeMapping_DeInit ( void  )
Return values
RETCODE_OKon success or an error code otherwise.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T SensorNodeMapping_Init ( void  )
Return values
RETCODE_OKon success or an error code otherwise.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int8_t SensorNodeMapping_Read ( unsigned char  I2Caddr,
unsigned char  Reg,
unsigned char *  RegData,
unsigned char  NbrBytesToRead 
)
Parameters
[in]I2CaddrI2C address of the connected device from which to read the register.
[in]RegRegister address of the device to read.
[out]RegDataPointer on a buffer into which the read values will be stored.
[in]NbrBytesToReadNumber of data elements expected to be received.
Return values
I2C_SUCCESSon success.
I2C_FAILUREif an error occurred.

+ Here is the caller graph for this function:

int8_t SensorNodeMapping_Write ( unsigned char  I2Caddr,
unsigned char  Reg,
unsigned char *  RegData,
unsigned char  NbrBytesToWrite 
)
Parameters
[in]I2CaddrI2C address of the connected device from which to read the register.
[in]RegRegister address of the device to read.
[in]RegDataPointer on a buffer into which the read values will be stored.
[in]NbrBytesToReadNumber of data elements expected to be received.
Return values
I2C_SUCCESSon success.
I2C_FAILUREif an error occurred.

+ Here is the caller graph for this function:


This documentation file has been automatically generated on Fri Oct 4 2019 03:47:30 by doxygen 1.8.8