LibDriver INA226
Loading...
Searching...
No Matches
ina226 example driver function
ina226 driver function

ina226 example driver modules More...

Collaboration diagram for ina226 example driver function:

Macros

#define INA226_ALERT_DEFAULT_AVG_MODE   INA226_AVG_16
 ina226 alert example default definition
#define INA226_ALERT_DEFAULT_BUS_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS
#define INA226_ALERT_DEFAULT_SHUNT_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS
#define INA226_ALERT_DEFAULT_READY_ALERT_PIN   INA226_BOOL_FALSE
#define INA226_ALERT_DEFAULT_ALERT_POLARITY_NORMAL   INA226_ALERT_POLARITY_NORMAL
#define INA226_ALERT_DEFAULT_ALERT_LATCH   INA226_BOOL_FALSE
#define INA226_BASIC_DEFAULT_AVG_MODE   INA226_AVG_16
 ina226 basic example default definition
#define INA226_BASIC_DEFAULT_BUS_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS
#define INA226_BASIC_DEFAULT_SHUNT_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS
#define INA226_SHOT_DEFAULT_AVG_MODE   INA226_AVG_16
 ina226 shot example default definition
#define INA226_SHOT_DEFAULT_BUS_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS
#define INA226_SHOT_DEFAULT_SHUNT_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS

Functions

uint8_t ina226_alert_irq_handler (void)
 alert irq handler
uint8_t ina226_alert_init (ina226_address_t addr_pin, double r, ina226_mask_t mask, float threshold, void(*callback)(uint8_t type))
 alert example init
uint8_t ina226_alert_deinit (void)
 alert example deinit
uint8_t ina226_alert_read (float *mV, float *mA, float *mW)
 alert example read
uint8_t ina226_basic_init (ina226_address_t addr_pin, double r)
 basic example init
uint8_t ina226_basic_deinit (void)
 basic example deinit
uint8_t ina226_basic_read (float *mV, float *mA, float *mW)
 basic example read
uint8_t ina226_shot_init (ina226_address_t addr_pin, double r)
 shot example init
uint8_t ina226_shot_deinit (void)
 shot example deinit
uint8_t ina226_shot_read (float *mV, float *mA, float *mW)
 shot example read

Detailed Description

ina226 example driver modules

Macro Definition Documentation

◆ INA226_ALERT_DEFAULT_ALERT_LATCH

#define INA226_ALERT_DEFAULT_ALERT_LATCH   INA226_BOOL_FALSE

disable alert latch

Definition at line 59 of file driver_ina226_alert.h.

◆ INA226_ALERT_DEFAULT_ALERT_POLARITY_NORMAL

#define INA226_ALERT_DEFAULT_ALERT_POLARITY_NORMAL   INA226_ALERT_POLARITY_NORMAL

alert polarity normal

Definition at line 58 of file driver_ina226_alert.h.

◆ INA226_ALERT_DEFAULT_AVG_MODE

#define INA226_ALERT_DEFAULT_AVG_MODE   INA226_AVG_16

ina226 alert example default definition

16 averages

Definition at line 54 of file driver_ina226_alert.h.

◆ INA226_ALERT_DEFAULT_BUS_VOLTAGE_CONVERSION_TIME

#define INA226_ALERT_DEFAULT_BUS_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS

bus voltage conversion time 1.1 ms

Definition at line 55 of file driver_ina226_alert.h.

◆ INA226_ALERT_DEFAULT_READY_ALERT_PIN

#define INA226_ALERT_DEFAULT_READY_ALERT_PIN   INA226_BOOL_FALSE

disable ready alert pin

Definition at line 57 of file driver_ina226_alert.h.

◆ INA226_ALERT_DEFAULT_SHUNT_VOLTAGE_CONVERSION_TIME

#define INA226_ALERT_DEFAULT_SHUNT_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS

shunt voltage conversion time 1.1 ms

Definition at line 56 of file driver_ina226_alert.h.

◆ INA226_BASIC_DEFAULT_AVG_MODE

#define INA226_BASIC_DEFAULT_AVG_MODE   INA226_AVG_16

ina226 basic example default definition

16 averages

Definition at line 56 of file driver_ina226_basic.h.

◆ INA226_BASIC_DEFAULT_BUS_VOLTAGE_CONVERSION_TIME

#define INA226_BASIC_DEFAULT_BUS_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS

bus voltage conversion time 1.1 ms

Definition at line 57 of file driver_ina226_basic.h.

◆ INA226_BASIC_DEFAULT_SHUNT_VOLTAGE_CONVERSION_TIME

#define INA226_BASIC_DEFAULT_SHUNT_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS

shunt voltage conversion time 1.1 ms

Definition at line 58 of file driver_ina226_basic.h.

◆ INA226_SHOT_DEFAULT_AVG_MODE

#define INA226_SHOT_DEFAULT_AVG_MODE   INA226_AVG_16

ina226 shot example default definition

16 averages

Definition at line 54 of file driver_ina226_shot.h.

◆ INA226_SHOT_DEFAULT_BUS_VOLTAGE_CONVERSION_TIME

#define INA226_SHOT_DEFAULT_BUS_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS

bus voltage conversion time 1.1 ms

Definition at line 55 of file driver_ina226_shot.h.

◆ INA226_SHOT_DEFAULT_SHUNT_VOLTAGE_CONVERSION_TIME

#define INA226_SHOT_DEFAULT_SHUNT_VOLTAGE_CONVERSION_TIME   INA226_CONVERSION_TIME_1P1_MS

shunt voltage conversion time 1.1 ms

Definition at line 56 of file driver_ina226_shot.h.

Function Documentation

◆ ina226_alert_deinit()

uint8_t ina226_alert_deinit ( void )

alert example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 613 of file driver_ina226_alert.c.

Here is the call graph for this function:

◆ ina226_alert_init()

uint8_t ina226_alert_init ( ina226_address_t addr_pin,
double r,
ina226_mask_t mask,
float threshold,
void(* callback )(uint8_t type) )

alert example init

Parameters
[in]addr_piniic address pin
[in]rreference resistor value
[in]maskset mask
[in]thresholdset threshold
[in]*callbackpointer to a function address
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 70 of file driver_ina226_alert.c.

Here is the call graph for this function:

◆ ina226_alert_irq_handler()

uint8_t ina226_alert_irq_handler ( void )

alert irq handler

Returns
status code
  • 0 success
  • 1 run failed
Note
none

Definition at line 48 of file driver_ina226_alert.c.

Here is the call graph for this function:

◆ ina226_alert_read()

uint8_t ina226_alert_read ( float * mV,
float * mA,
float * mW )

alert example read

Parameters
[out]*mVpointer to a mV buffer
[out]*mApointer to a mA buffer
[out]*mWpointer to a mW buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 576 of file driver_ina226_alert.c.

Here is the call graph for this function:

◆ ina226_basic_deinit()

uint8_t ina226_basic_deinit ( void )

basic example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 200 of file driver_ina226_basic.c.

Here is the call graph for this function:

◆ ina226_basic_init()

uint8_t ina226_basic_init ( ina226_address_t addr_pin,
double r )

basic example init

Parameters
[in]addr_piniic address pin
[in]rreference resistor value
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 50 of file driver_ina226_basic.c.

Here is the call graph for this function:

◆ ina226_basic_read()

uint8_t ina226_basic_read ( float * mV,
float * mA,
float * mW )

basic example read

Parameters
[out]*mVpointer to a mV buffer
[out]*mApointer to a mA buffer
[out]*mWpointer to a mW buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 163 of file driver_ina226_basic.c.

Here is the call graph for this function:

◆ ina226_shot_deinit()

uint8_t ina226_shot_deinit ( void )

shot example deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 207 of file driver_ina226_shot.c.

Here is the call graph for this function:

◆ ina226_shot_init()

uint8_t ina226_shot_init ( ina226_address_t addr_pin,
double r )

shot example init

Parameters
[in]addr_piniic address pin
[in]rreference resistor value
Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 50 of file driver_ina226_shot.c.

Here is the call graph for this function:

◆ ina226_shot_read()

uint8_t ina226_shot_read ( float * mV,
float * mA,
float * mW )

shot example read

Parameters
[out]*mVpointer to a mV buffer
[out]*mApointer to a mA buffer
[out]*mWpointer to a mW buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 163 of file driver_ina226_shot.c.

Here is the call graph for this function: