From 10f45e4fb2826ed5507eb95953737860f07aaac7 Mon Sep 17 00:00:00 2001 From: SMotlaq Date: Tue, 10 Sep 2024 13:40:03 +0000 Subject: [PATCH] deploy: 6a77173c5b356efa36d66fb9d53f7d787f11a56a --- README_8md.html | 112 + annotated.html | 127 + annotated_dup.js | 4 + classes.html | 120 + doxygen_crawl.html | 323 +++ files.html | 117 + files_dup.js | 5 + functions.html | 222 ++ functions_vars.html | 222 ++ globals.html | 257 ++ globals_defs.html | 127 + globals_enum.html | 121 + globals_eval.html | 182 ++ globals_func.html | 142 ++ globals_type.html | 122 + ina234_8c.html | 1243 ++++++++++ ina234_8c.js | 29 + ina234_8h.html | 2059 +++++++++++++++++ ina234_8h.js | 138 ++ ina234_8h_source.html | 447 ++++ index.html | 21 +- index.js | 7 + md_README.html | 114 + menudata.js | 67 +- navtreedata.js | 26 +- navtreeindex0.js | 236 +- pages.html | 116 + search/all_0.js | 16 + search/all_1.js | 37 + search/all_10.js | 10 + search/all_2.js | 10 + search/all_3.js | 25 + search/all_4.js | 6 + search/all_5.js | 8 + search/all_6.js | 4 + search/all_7.js | 5 + search/all_8.js | 35 + search/all_9.js | 8 + search/all_a.js | 22 + search/all_b.js | 13 + search/all_c.js | 4 + search/all_d.js | 10 + search/all_e.js | 11 + search/all_f.js | 16 + search/classes_0.js | 14 + search/classes_1.js | 4 + search/defines_0.js | 4 + search/defines_1.js | 5 + search/defines_2.js | 8 + search/defines_3.js | 4 + search/defines_4.js | 6 + search/defines_5.js | 5 + search/defines_6.js | 6 + search/enums_0.js | 9 + search/enums_1.js | 4 + search/enums_2.js | 4 + search/enums_3.js | 4 + search/enums_4.js | 4 + search/enums_5.js | 4 + search/enumvalues_0.js | 17 + search/enumvalues_1.js | 11 + search/enumvalues_2.js | 7 + search/enumvalues_3.js | 11 + search/enumvalues_4.js | 11 + search/enumvalues_5.js | 5 + search/enumvalues_6.js | 5 + search/files_0.js | 5 + search/files_1.js | 4 + search/functions_0.js | 5 + search/functions_1.js | 27 + search/pages_0.js | 4 + search/pages_1.js | 4 + search/pages_2.js | 4 + search/pages_3.js | 5 + search/pages_4.js | 5 + search/pages_5.js | 4 + search/pages_6.js | 4 + search/pages_7.js | 4 + search/searchdata.js | 30 + search/typedefs_0.js | 9 + search/typedefs_1.js | 4 + search/typedefs_2.js | 4 + search/typedefs_3.js | 4 + search/typedefs_4.js | 4 + search/typedefs_5.js | 4 + search/typedefs_6.js | 4 + search/variables_0.js | 15 + search/variables_1.js | 7 + search/variables_2.js | 10 + search/variables_3.js | 5 + search/variables_4.js | 4 + search/variables_5.js | 4 + search/variables_6.js | 5 + search/variables_7.js | 9 + search/variables_8.js | 4 + search/variables_9.js | 4 + search/variables_a.js | 7 + search/variables_b.js | 8 + search/variables_c.js | 9 + search/variables_d.js | 9 + structina234.html | 440 ++++ structina234.js | 23 + ..._1_1__reg_1_1__alert__limit__register.html | 140 ++ ...34_1_1__reg_1_1__alert__limit__register.js | 4 + ..._1_1__reg_1_1__bus__voltage__register.html | 172 ++ ...34_1_1__reg_1_1__bus__voltage__register.js | 6 + ...4_1_1__reg_1_1__calibration__register.html | 156 ++ ...234_1_1__reg_1_1__calibration__register.js | 5 + ...ina234_1_1__reg_1_1__config__register.html | 236 ++ ...ctina234_1_1__reg_1_1__config__register.js | 10 + ...na234_1_1__reg_1_1__current__register.html | 156 ++ ...tina234_1_1__reg_1_1__current__register.js | 5 + ...34_1_1__reg_1_1__devide__id__register.html | 156 ++ ...a234_1_1__reg_1_1__devide__id__register.js | 5 + ...1__reg_1_1__manufacture__id__register.html | 140 ++ ...1_1__reg_1_1__manufacture__id__register.js | 4 + ..._1_1__reg_1_1__mask__enable__register.html | 332 +++ ...34_1_1__reg_1_1__mask__enable__register.js | 16 + ...tina234_1_1__reg_1_1__power__register.html | 140 ++ structina234_1_1__reg_1_1__power__register.js | 4 + ..._1__reg_1_1__shunt__voltage__register.html | 156 ++ ..._1_1__reg_1_1__shunt__voltage__register.js | 5 + unionina234_1_1__reg.html | 324 +++ unionina234_1_1__reg.js | 24 + 124 files changed, 9988 insertions(+), 7 deletions(-) create mode 100644 README_8md.html create mode 100644 annotated.html create mode 100644 annotated_dup.js create mode 100644 classes.html create mode 100644 files.html create mode 100644 files_dup.js create mode 100644 functions.html create mode 100644 functions_vars.html create mode 100644 globals.html create mode 100644 globals_defs.html create mode 100644 globals_enum.html create mode 100644 globals_eval.html create mode 100644 globals_func.html create mode 100644 globals_type.html create mode 100644 ina234_8c.html create mode 100644 ina234_8c.js create mode 100644 ina234_8h.html create mode 100644 ina234_8h.js create mode 100644 ina234_8h_source.html create mode 100644 index.js create mode 100644 md_README.html create mode 100644 pages.html create mode 100644 search/all_0.js create mode 100644 search/all_1.js create mode 100644 search/all_10.js create mode 100644 search/all_2.js create mode 100644 search/all_3.js create mode 100644 search/all_4.js create mode 100644 search/all_5.js create mode 100644 search/all_6.js create mode 100644 search/all_7.js create mode 100644 search/all_8.js create mode 100644 search/all_9.js create mode 100644 search/all_a.js create mode 100644 search/all_b.js create mode 100644 search/all_c.js create mode 100644 search/all_d.js create mode 100644 search/all_e.js create mode 100644 search/all_f.js create mode 100644 search/classes_0.js create mode 100644 search/classes_1.js create mode 100644 search/defines_0.js create mode 100644 search/defines_1.js create mode 100644 search/defines_2.js create mode 100644 search/defines_3.js create mode 100644 search/defines_4.js create mode 100644 search/defines_5.js create mode 100644 search/defines_6.js create mode 100644 search/enums_0.js create mode 100644 search/enums_1.js create mode 100644 search/enums_2.js create mode 100644 search/enums_3.js create mode 100644 search/enums_4.js create mode 100644 search/enums_5.js create mode 100644 search/enumvalues_0.js create mode 100644 search/enumvalues_1.js create mode 100644 search/enumvalues_2.js create mode 100644 search/enumvalues_3.js create mode 100644 search/enumvalues_4.js create mode 100644 search/enumvalues_5.js create mode 100644 search/enumvalues_6.js create mode 100644 search/files_0.js create mode 100644 search/files_1.js create mode 100644 search/functions_0.js create mode 100644 search/functions_1.js create mode 100644 search/pages_0.js create mode 100644 search/pages_1.js create mode 100644 search/pages_2.js create mode 100644 search/pages_3.js create mode 100644 search/pages_4.js create mode 100644 search/pages_5.js create mode 100644 search/pages_6.js create mode 100644 search/pages_7.js create mode 100644 search/typedefs_0.js create mode 100644 search/typedefs_1.js create mode 100644 search/typedefs_2.js create mode 100644 search/typedefs_3.js create mode 100644 search/typedefs_4.js create mode 100644 search/typedefs_5.js create mode 100644 search/typedefs_6.js create mode 100644 search/variables_0.js create mode 100644 search/variables_1.js create mode 100644 search/variables_2.js create mode 100644 search/variables_3.js create mode 100644 search/variables_4.js create mode 100644 search/variables_5.js create mode 100644 search/variables_6.js create mode 100644 search/variables_7.js create mode 100644 search/variables_8.js create mode 100644 search/variables_9.js create mode 100644 search/variables_a.js create mode 100644 search/variables_b.js create mode 100644 search/variables_c.js create mode 100644 search/variables_d.js create mode 100644 structina234.html create mode 100644 structina234.js create mode 100644 structina234_1_1__reg_1_1__alert__limit__register.html create mode 100644 structina234_1_1__reg_1_1__alert__limit__register.js create mode 100644 structina234_1_1__reg_1_1__bus__voltage__register.html create mode 100644 structina234_1_1__reg_1_1__bus__voltage__register.js create mode 100644 structina234_1_1__reg_1_1__calibration__register.html create mode 100644 structina234_1_1__reg_1_1__calibration__register.js create mode 100644 structina234_1_1__reg_1_1__config__register.html create mode 100644 structina234_1_1__reg_1_1__config__register.js create mode 100644 structina234_1_1__reg_1_1__current__register.html create mode 100644 structina234_1_1__reg_1_1__current__register.js create mode 100644 structina234_1_1__reg_1_1__devide__id__register.html create mode 100644 structina234_1_1__reg_1_1__devide__id__register.js create mode 100644 structina234_1_1__reg_1_1__manufacture__id__register.html create mode 100644 structina234_1_1__reg_1_1__manufacture__id__register.js create mode 100644 structina234_1_1__reg_1_1__mask__enable__register.html create mode 100644 structina234_1_1__reg_1_1__mask__enable__register.js create mode 100644 structina234_1_1__reg_1_1__power__register.html create mode 100644 structina234_1_1__reg_1_1__power__register.js create mode 100644 structina234_1_1__reg_1_1__shunt__voltage__register.html create mode 100644 structina234_1_1__reg_1_1__shunt__voltage__register.js create mode 100644 unionina234_1_1__reg.html create mode 100644 unionina234_1_1__reg.js diff --git a/README_8md.html b/README_8md.html new file mode 100644 index 0000000..da61487 --- /dev/null +++ b/README_8md.html @@ -0,0 +1,112 @@ + + + + + + + +INA234 HAL Based Library: README.md File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
README.md File Reference
+
+
+
+
+ + + + diff --git a/annotated.html b/annotated.html new file mode 100644 index 0000000..286857a --- /dev/null +++ b/annotated.html @@ -0,0 +1,127 @@ + + + + + + + +INA234 HAL Based Library: Data Structures + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Data Structures
+
+
+
Here are the data structures with brief descriptions:
+
[detail level 123]
+ + + + + + + + + + + + +
 ▼Cina234Class (struct) that stores variables for interacting with INA234
 ▼C_reg
 C_alert_limit_register
 C_bus_voltage_register
 C_calibration_register
 C_config_register
 C_current_register
 C_devide_id_register
 C_manufacture_id_register
 C_mask_enable_register
 C_power_register
 C_shunt_voltage_register
+
+
+
+ + + + diff --git a/annotated_dup.js b/annotated_dup.js new file mode 100644 index 0000000..5dbb976 --- /dev/null +++ b/annotated_dup.js @@ -0,0 +1,4 @@ +var annotated_dup = +[ + [ "ina234", "structina234.html", "structina234" ] +]; \ No newline at end of file diff --git a/classes.html b/classes.html new file mode 100644 index 0000000..642b19c --- /dev/null +++ b/classes.html @@ -0,0 +1,120 @@ + + + + + + + +INA234 HAL Based Library: Data Structure Index + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Data Structure Index
+
+
+
I | _
+
+
+
I
+
ina234
+
+
_
+
ina234::_reg::_alert_limit_register
ina234::_reg::_bus_voltage_register
ina234::_reg::_calibration_register
ina234::_reg::_config_register
ina234::_reg::_current_register
ina234::_reg::_devide_id_register
ina234::_reg::_manufacture_id_register
ina234::_reg::_mask_enable_register
ina234::_reg::_power_register
ina234::_reg
ina234::_reg::_shunt_voltage_register
+
+
+
+ + + + diff --git a/doxygen_crawl.html b/doxygen_crawl.html index 586811e..ca96aac 100644 --- a/doxygen_crawl.html +++ b/doxygen_crawl.html @@ -8,7 +8,330 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/files.html b/files.html new file mode 100644 index 0000000..3e680ae --- /dev/null +++ b/files.html @@ -0,0 +1,117 @@ + + + + + + + +INA234 HAL Based Library: File List + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
File List
+
+
+
Here is a list of all files with brief descriptions:
+ + + +
 ina234.c
 ina234.h
+
+
+
+ + + + diff --git a/files_dup.js b/files_dup.js new file mode 100644 index 0000000..689835e --- /dev/null +++ b/files_dup.js @@ -0,0 +1,5 @@ +var files_dup = +[ + [ "ina234.c", "ina234_8c.html", "ina234_8c" ], + [ "ina234.h", "ina234_8h.html", "ina234_8h" ] +]; \ No newline at end of file diff --git a/functions.html b/functions.html new file mode 100644 index 0000000..e390dd8 --- /dev/null +++ b/functions.html @@ -0,0 +1,222 @@ + + + + + + + +INA234 HAL Based Library: Data Fields + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all struct and union fields with links to the structures/unions they belong to:
+ +

- a -

+ + +

- b -

+ + +

- c -

+ + +

- d -

+ + +

- h -

+ + +

- i -

+ + +

- l -

+ + +

- m -

+ + +

- n -

    +
  • number_of_adc_samples : ina234
    • +
+ + +

- o -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+ + +

- v -

+
+
+ + + + diff --git a/functions_vars.html b/functions_vars.html new file mode 100644 index 0000000..cd3cdbd --- /dev/null +++ b/functions_vars.html @@ -0,0 +1,222 @@ + + + + + + + +INA234 HAL Based Library: Data Fields - Variables + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all variables with links to the structures/unions they belong to:
+ +

- a -

+ + +

- b -

+ + +

- c -

+ + +

- d -

+ + +

- h -

+ + +

- i -

+ + +

- l -

+ + +

- m -

+ + +

- n -

    +
  • number_of_adc_samples : ina234
    • +
+ + +

- o -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+ + +

- v -

+
+
+ + + + diff --git a/globals.html b/globals.html new file mode 100644 index 0000000..60768de --- /dev/null +++ b/globals.html @@ -0,0 +1,257 @@ + + + + + + + +INA234 HAL Based Library: Globals + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:
+ +

- _ -

+ + +

- a -

+ + +

- b -

+ + +

- c -

+ + +

- d -

+ + +

- e -

+ + +

- i -

+ + +

- m -

+ + +

- n -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+
+
+ + + + diff --git a/globals_defs.html b/globals_defs.html new file mode 100644 index 0000000..beb6a22 --- /dev/null +++ b/globals_defs.html @@ -0,0 +1,127 @@ + + + + + + + +INA234 HAL Based Library: Globals + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all macros with links to the files they belong to:
+
+
+ + + + diff --git a/globals_enum.html b/globals_enum.html new file mode 100644 index 0000000..49152a0 --- /dev/null +++ b/globals_enum.html @@ -0,0 +1,121 @@ + + + + + + + +INA234 HAL Based Library: Globals + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all enums with links to the files they belong to:
+
+
+ + + + diff --git a/globals_eval.html b/globals_eval.html new file mode 100644 index 0000000..c57d86c --- /dev/null +++ b/globals_eval.html @@ -0,0 +1,182 @@ + + + + + + + +INA234 HAL Based Library: Globals + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all enum values with links to the files they belong to:
+ +

- a -

+ + +

- c -

+ + +

- e -

+ + +

- m -

+ + +

- n -

+ + +

- r -

+ + +

- s -

+
+
+ + + + diff --git a/globals_func.html b/globals_func.html new file mode 100644 index 0000000..90ba190 --- /dev/null +++ b/globals_func.html @@ -0,0 +1,142 @@ + + + + + + + +INA234 HAL Based Library: Globals + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all functions with links to the files they belong to:
+ +

- _ -

+ + +

- i -

+
+
+ + + + diff --git a/globals_type.html b/globals_type.html new file mode 100644 index 0000000..e7d7682 --- /dev/null +++ b/globals_type.html @@ -0,0 +1,122 @@ + + + + + + + +INA234 HAL Based Library: Globals + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Here is a list of all typedefs with links to the files they belong to:
+
+
+ + + + diff --git a/ina234_8c.html b/ina234_8c.html new file mode 100644 index 0000000..20b063e --- /dev/null +++ b/ina234_8c.html @@ -0,0 +1,1243 @@ + + + + + + + +INA234 HAL Based Library: ina234.c File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Functions
+
ina234.c File Reference
+
+
+
#include "ina234.h"
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

Status INA234_init (INA234 *self, uint8_t I2C_ADDR, I2C_HandleTypeDef *hi2c, float ShuntResistor, ADCRange adc_range, NumSamples numer_of_adc_samples, ConvTime vbus_conversion_time, ConvTime vshunt_conversion_time, Mode mode)
 Initialize the INA234 with the given config.
 
Status INA234_alert_init (INA234 *self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit)
 Initialize the alert functionality of INA234 with the given configurations.
 
Status __INA234_readTwoBytes (INA234 *self, uint8_t MemAddress)
 Read two bytes (a 16bit register) from INA234 and stores in the ina234::_reg::raw_data.
 
Status __INA234_writeTwoBytes (INA234 *self, uint8_t MemAddress)
 Write two bytes (a 16bit register) to INA234 from the ina234::_reg::raw_data.
 
Status INA234_setADCRange (INA234 *self, ADCRange adc_range)
 Set the ADC full scale range of INA234.
 
Status INA234_setNumberOfADCSamples (INA234 *self, NumSamples numer_of_adc_samples)
 Set the number of ADC samples to calculate the average.
 
Status INA234_setVBusConversionTime (INA234 *self, ConvTime vbus_conversion_time)
 Set the VBus convertion period.
 
Status INA234_setVShuntConversionTime (INA234 *self, ConvTime vshunt_conversion_time)
 Set the VShunt convertion period.
 
Status INA234_setMode (INA234 *self, Mode mode)
 Set the operating mode.
 
ADCRange INA234_getADCRange (INA234 *self)
 Get the ADC full scale range of INA234.
 
NumSamples INA234_getNumberOfADCSamples (INA234 *self)
 Get the number of ADC samples to calculate the average.
 
ConvTime INA234_getVBusConversionTime (INA234 *self)
 Get the VBus convertion period.
 
ConvTime INA234_getVShuntConversionTime (INA234 *self)
 Get the VShunt convertion period.
 
Mode INA234_getMode (INA234 *self)
 Set the operating mode.
 
void INA234_SoftResetAll (INA234 *self)
 Send a reset command to all of the INA234s on the bus.
 
uint16_t INA234_getManID (INA234 *self)
 Get the manufacturer ID.
 
uint16_t INA234_getDevID (INA234 *self)
 Get the device ID.
 
void INA234_readAll (INA234 *self)
 Read all of the measured values: Shunt voltage, bus voltage, power, and current. Then store the values to the ina234 object (struct) variables. Then you can read variables: ina234::ShuntVoltage, ina234::BusVoltage, ina234::Power, and ina234::Current.
 
float INA234_getCurrent (INA234 *self)
 Read the current from INA234.
 
float INA234_getBusVoltage (INA234 *self)
 Read the bus voltage from INA234.
 
float INA234_getShuntVoltage (INA234 *self)
 Read the shunt voltage from INA234.
 
float INA234_getPower (INA234 *self)
 Read the power from INA234.
 
uint8_t INA234_isDataReady (INA234 *self)
 Check if the conversion is done or not. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.
 
AlertSource INA234_getAlertSource (INA234 *self)
 Get the alert source. This function is usefull when you enabled both of the alert functions and data ready alert simultaneously. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.
 
ErrorType INA234_getErrors (INA234 *self)
 Get the error flags of INA234. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.
 
Status INA234_resetAlert (INA234 *self)
 Reset the alert pin. This function is useful when set the alert pin to latch mode.
 
+

Function Documentation

+ +

◆ __INA234_readTwoBytes()

+ +
+
+ + + + + + + + + + + +
Status __INA234_readTwoBytes (INA234 * self,
uint8_t MemAddress )
+
+ +

Read two bytes (a 16bit register) from INA234 and stores in the ina234::_reg::raw_data.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
MemAddressAddress of the register
+
+
+
Returns
Ths status of reading
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ __INA234_writeTwoBytes()

+ +
+
+ + + + + + + + + + + +
Status __INA234_writeTwoBytes (INA234 * self,
uint8_t MemAddress )
+
+ +

Write two bytes (a 16bit register) to INA234 from the ina234::_reg::raw_data.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
MemAddressAddress of the register
+
+
+
Returns
Ths status of writing
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_alert_init()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Status INA234_alert_init (INA234 * self,
AlertOn alert_on,
AlertPolarity alert_polarity,
AlertLatch alert_latch,
AlertConvReady alert_conv_ready,
float alert_limit )
+
+ +

Initialize the alert functionality of INA234 with the given configurations.

+
Parameters
+ + + + + + + +
selfA pointer to the ina234 object (struct)
alert_ondetermines the event that you want to assert the alert: +
alert_polarityThe alert polarity determines the polarity of alert assertion:
    +
  • ALERT_ACTIVE_LOW Alert pin goes low on alert
    • +
  • ALERT_ACTIVE_HIGH Alert pin goes HiZ on alert (alert pin is open-drain so you have to add a pull-up resistor to get high state)
    • +
+
alert_latchDetermine the alert pin behaviour. If the latch is enabled, you have to reset the pin by calling the INA234_resetAlert() function. +
alert_conv_readyShows if you want to get alert on "conversion done"/"data ready" too or not. If enabled, you have to distinguish the alert sourece by calling INA234_getAlertSource() function. +
alert_limitThis the limit value. It automatically maps to the alert function you have chosen. The unit of this limit is related to the alert_on argument: +
+
+
+

For example if the alert_limit was 10.4 and you give ALERT_SHUNT_OVER_LIMIT for the alert_on argument, it means you will get alert if the shunt voltage reaches over the 10.4mV. If you give ALERT_BUS_OVER_LIMIT to alert_on, it means you will get alert if the bus voltage reaches the 10.4V

Returns
Ths status of initialization
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_getADCRange()

+ +
+
+ + + + + + + +
ADCRange INA234_getADCRange (INA234 * self)
+
+ +

Get the ADC full scale range of INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
The full scale range of ADC.
+
Return values
+ + + +
RANGE_81_92mVfor 81.92 mV
RANGE_20_48mVfor 20.48 mV
+
+
+ +
+
+ +

◆ INA234_getAlertSource()

+ +
+
+ + + + + + + +
AlertSource INA234_getAlertSource (INA234 * self)
+
+ +

Get the alert source. This function is usefull when you enabled both of the alert functions and data ready alert simultaneously. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
The alert source
+
Return values
+ + + +
ALERT_DATA_READYThe alert source is convertion ready
ALERT_LIMIT_REACHEDThe alert source is limit reach
+
+
+ +
+
+ +

◆ INA234_getBusVoltage()

+ +
+
+ + + + + + + +
float INA234_getBusVoltage (INA234 * self)
+
+ +

Read the bus voltage from INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a float value in Volts representing the bus voltage
+ +
+
+ +

◆ INA234_getCurrent()

+ +
+
+ + + + + + + +
float INA234_getCurrent (INA234 * self)
+
+ +

Read the current from INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a float value in Amps representing the current
+ +
+
+ +

◆ INA234_getDevID()

+ +
+
+ + + + + + + +
uint16_t INA234_getDevID (INA234 * self)
+
+ +

Get the device ID.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a 12bit device ID
+ +
+
+ +

◆ INA234_getErrors()

+ +
+
+ + + + + + + +
ErrorType INA234_getErrors (INA234 * self)
+
+ +

Get the error flags of INA234. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
Error type
+
Return values
+ + + + + +
ERROR_NONENo error
ERROR_MEMORYMemory error (CRC or ECC)
ERROR_OVFMath overflow error
ERROR_BOTH_MEMORY_OVFBoth memory error (CRC or ECC) and math overflow error
+
+
+ +
+
+ +

◆ INA234_getManID()

+ +
+
+ + + + + + + +
uint16_t INA234_getManID (INA234 * self)
+
+ +

Get the manufacturer ID.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a 16bit manufacturer ID
+ +
+
+ +

◆ INA234_getMode()

+ +
+
+ + + + + + + +
Mode INA234_getMode (INA234 * self)
+
+ +

Set the operating mode.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
Operating mode
+
Return values
+ + + + + + + + +
MODE_SHUTDOWNshutdown mode
MODE_SINGLESHOT_SUNTonly measure the shunt voltage once
MODE_SINGLESHOT_BUSonly measure the bus voltage once
MODE_SINGLESHOT_BOTH_SHUNT_BUSmeasure the bus and shunt voltage once
MODE_CONTINUOUS_SHUNTonly measure the shunt voltage continuously
MODE_CONTINUOUS_BUSonly measure the bus voltage continuously
MODE_CONTINUOUS_BOTH_SHUNT_BUSmeasure the bus and shunt voltage continuously
+
+
+ +
+
+ +

◆ INA234_getNumberOfADCSamples()

+ +
+
+ + + + + + + +
NumSamples INA234_getNumberOfADCSamples (INA234 * self)
+
+ +

Get the number of ADC samples to calculate the average.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
Numer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency.
+
Return values
+ + + + + + + + + +
NADC_1for one sample (no average)
NADC_44 samples
NADC_1616 samples
NADC_6464 samples
NADC_128128 samples
NADC_256256 samples
NADC_512512 samples
NADC_10241024 samples
+
+
+ +
+
+ +

◆ INA234_getPower()

+ +
+
+ + + + + + + +
float INA234_getPower (INA234 * self)
+
+ +

Read the power from INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a float value in Watt representing the power
+ +
+
+ +

◆ INA234_getShuntVoltage()

+ +
+
+ + + + + + + +
float INA234_getShuntVoltage (INA234 * self)
+
+ +

Read the shunt voltage from INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a float value in miliVolts representing the shunt voltage
+ +
+
+ +

◆ INA234_getVBusConversionTime()

+ +
+
+ + + + + + + +
ConvTime INA234_getVBusConversionTime (INA234 * self)
+
+ +

Get the VBus convertion period.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
The conversion time of VBus measurment.
+
Return values
+ + + + + + + + + +
CTIME_140us
CTIME_204us
CTIME_332us
CTIME_588us
CTIME_1100us
CTIME_2116us
CTIME_4156us
CTIME_8244us
+
+
+ +
+
+ +

◆ INA234_getVShuntConversionTime()

+ +
+
+ + + + + + + +
ConvTime INA234_getVShuntConversionTime (INA234 * self)
+
+ +

Get the VShunt convertion period.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
The conversion time of VShunt measurment.
+
Return values
+ + + + + + + + + +
CTIME_140us
CTIME_204us
CTIME_332us
CTIME_588us
CTIME_1100us
CTIME_2116us
CTIME_4156us
CTIME_8244us
+
+
+ +
+
+ +

◆ INA234_init()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Status INA234_init (INA234 * self,
uint8_t I2C_ADDR,
I2C_HandleTypeDef * hi2c,
float ShuntResistor,
ADCRange adc_range,
NumSamples numer_of_adc_samples,
ConvTime vbus_conversion_time,
ConvTime vshunt_conversion_time,
Mode mode )
+
+ +

Initialize the INA234 with the given config.

+
Parameters
+ + + + + + + + + +
selfA pointer to the ina234 object (struct)
hi2cA pointer to the I2C handler that is connected to INA234
ShuntResistorThe resistance of your shunt resistor (in mOhm) connected to IN+ and IN- of the INA234
adc_rangeThe full scale range of ADC. It can be one of these values: +
numer_of_adc_samplesNumer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency. +
vbus_conversion_timeThe conversion time of VBus measurment. +
vshunt_conversion_timeThe conversion time of VShunt measurment. +
modeOperating mode: +
+
+
+
Returns
Ths status of initialization
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_isDataReady()

+ +
+
+ + + + + + + +
uint8_t INA234_isDataReady (INA234 * self)
+
+ +

Check if the conversion is done or not. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Return values
+ + + +
True
False
+
+
+ +
+
+ +

◆ INA234_readAll()

+ +
+
+ + + + + + + +
void INA234_readAll (INA234 * self)
+
+ +

Read all of the measured values: Shunt voltage, bus voltage, power, and current. Then store the values to the ina234 object (struct) variables. Then you can read variables: ina234::ShuntVoltage, ina234::BusVoltage, ina234::Power, and ina234::Current.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+ +
+
+ +

◆ INA234_resetAlert()

+ +
+
+ + + + + + + +
Status INA234_resetAlert (INA234 * self)
+
+ +

Reset the alert pin. This function is useful when set the alert pin to latch mode.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
Ths status of reset
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setADCRange()

+ +
+
+ + + + + + + + + + + +
Status INA234_setADCRange (INA234 * self,
ADCRange adc_range )
+
+ +

Set the ADC full scale range of INA234.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
adc_rangeThe full scale range of ADC. It can be one of these values: +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setMode()

+ +
+
+ + + + + + + + + + + +
Status INA234_setMode (INA234 * self,
Mode mode )
+
+ +

Set the operating mode.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
modeOperating mode: +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setNumberOfADCSamples()

+ +
+
+ + + + + + + + + + + +
Status INA234_setNumberOfADCSamples (INA234 * self,
NumSamples numer_of_adc_samples )
+
+ +

Set the number of ADC samples to calculate the average.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
numer_of_adc_samplesNumer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency. +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setVBusConversionTime()

+ +
+
+ + + + + + + + + + + +
Status INA234_setVBusConversionTime (INA234 * self,
ConvTime vbus_conversion_time )
+
+ +

Set the VBus convertion period.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
vbus_conversion_timeThe conversion time of VBus measurment. +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setVShuntConversionTime()

+ +
+
+ + + + + + + + + + + +
Status INA234_setVShuntConversionTime (INA234 * self,
ConvTime vshunt_conversion_time )
+
+ +

Set the VShunt convertion period.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
vshunt_conversion_timeThe conversion time of VShunt measurment. +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_SoftResetAll()

+ +
+
+ + + + + + + +
void INA234_SoftResetAll (INA234 * self)
+
+ +

Send a reset command to all of the INA234s on the bus.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+ +
+
+
+
+ + + + diff --git a/ina234_8c.js b/ina234_8c.js new file mode 100644 index 0000000..d485f0e --- /dev/null +++ b/ina234_8c.js @@ -0,0 +1,29 @@ +var ina234_8c = +[ + [ "__INA234_readTwoBytes", "ina234_8c.html#aa36cf3308ef4df72ddf8a78edff23556", null ], + [ "__INA234_writeTwoBytes", "ina234_8c.html#ac08e0ed8b382a2dd193753a2b302bae1", null ], + [ "INA234_alert_init", "ina234_8c.html#afb44437883ad8f8d08aaf695815da7ed", null ], + [ "INA234_getADCRange", "ina234_8c.html#ab9f2d8b23628fb6b060f837b9a4f71a5", null ], + [ "INA234_getAlertSource", "ina234_8c.html#a52cc3b785dea1f5af6f0803f02fcefdb", null ], + [ "INA234_getBusVoltage", "ina234_8c.html#a97ec39b6399d3ab449e499a57668748d", null ], + [ "INA234_getCurrent", "ina234_8c.html#a825a355395fef312e3642f9f8ca6463c", null ], + [ "INA234_getDevID", "ina234_8c.html#a88ff1503798836270a41d3b9f3913ca7", null ], + [ "INA234_getErrors", "ina234_8c.html#a14a3383eba06ce784ed526585a0cef9a", null ], + [ "INA234_getManID", "ina234_8c.html#ae646f51adec51af1aa6377c3dffeeb6a", null ], + [ "INA234_getMode", "ina234_8c.html#a4af7c34341c14b8bfb40daf0665a766c", null ], + [ "INA234_getNumberOfADCSamples", "ina234_8c.html#acda6b9d24c842d73ffca341ce39ac707", null ], + [ "INA234_getPower", "ina234_8c.html#a163121f0afcab9a5e49f419b94290f20", null ], + [ "INA234_getShuntVoltage", "ina234_8c.html#a256f66571357742aec8b4f0104c54b6b", null ], + [ "INA234_getVBusConversionTime", "ina234_8c.html#aa3f6130fa6074b931f415e9ca85f340d", null ], + [ "INA234_getVShuntConversionTime", "ina234_8c.html#a6afffb92bb828562997a6a5592bc141a", null ], + [ "INA234_init", "ina234_8c.html#a21acc30b187445a98f711a54b8678c7c", null ], + [ "INA234_isDataReady", "ina234_8c.html#a9637d475148409297883f05464a92e86", null ], + [ "INA234_readAll", "ina234_8c.html#ac7901cf62e078ff3a235839061a3608b", null ], + [ "INA234_resetAlert", "ina234_8c.html#a5810f9a740226a39ba5cc2afa6b64f77", null ], + [ "INA234_setADCRange", "ina234_8c.html#aba71c63deed65a0abdbf7269b5f382d8", null ], + [ "INA234_setMode", "ina234_8c.html#ac85c8e736ffae6d248971091b374d00f", null ], + [ "INA234_setNumberOfADCSamples", "ina234_8c.html#a84ff6173bf6cfa44348ba259a503c804", null ], + [ "INA234_setVBusConversionTime", "ina234_8c.html#a94ec7dc7cd10748c4ed822266174d0ff", null ], + [ "INA234_setVShuntConversionTime", "ina234_8c.html#ad19627414a2465c9cf1fac54f54eaa39", null ], + [ "INA234_SoftResetAll", "ina234_8c.html#af3d939ea27371b17fd265f19957234b2", null ] +]; \ No newline at end of file diff --git a/ina234_8h.html b/ina234_8h.html new file mode 100644 index 0000000..4b3e0a3 --- /dev/null +++ b/ina234_8h.html @@ -0,0 +1,2059 @@ + + + + + + + +INA234 HAL Based Library: ina234.h File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Structures | +Macros | +Typedefs | +Enumerations | +Functions
+
ina234.h File Reference
+
+
+
#include "main.h"
+#include "i2c.h"
+
+

Go to the source code of this file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Data Structures

struct  ina234
 Class (struct) that stores variables for interacting with INA234. More...
 
union  ina234::_reg
 
struct  ina234::_reg::_config_register
 
struct  ina234::_reg::_shunt_voltage_register
 
struct  ina234::_reg::_bus_voltage_register
 
struct  ina234::_reg::_power_register
 
struct  ina234::_reg::_current_register
 
struct  ina234::_reg::_calibration_register
 
struct  ina234::_reg::_mask_enable_register
 
struct  ina234::_reg::_alert_limit_register
 
struct  ina234::_reg::_manufacture_id_register
 
struct  ina234::_reg::_devide_id_register
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define MAXIMUM_EXPECTED_CURRENT   5.0
 
#define CURRENT_LSB_MINIMUM   (MAXIMUM_EXPECTED_CURRENT / 2048.0)
 
#define CURRENT_LSB   (CURRENT_LSB_MINIMUM * 1.0)
 
#define BUS_VOLTAGE_LSB   0.025
 
#define SHUNT_VOLTAGE_81_92mv_LSB   0.04
 
#define SHUNT_VOLTAGE_20_48mv_LSB   0.01
 
#define POWER_LSB   (CURRENT_LSB*0.032)
 
#define CONFIGURATION_REGISTER   0x00
 
#define SHUNT_VOLTAGE_REGISTER   0x01
 
#define BUS_VOLTAGE_REGISTER   0x02
 
#define POWER_REGISTER   0x03
 
#define CURRENT_REGISTER   0x04
 
#define CALIBRATION_REGISTER   0x05
 
#define MASK_ENABLE_REGISTER   0x06
 
#define ALERT_LIMIT_REGISTER   0x07
 
#define MANUFACTURERID_REGISTER   0x3E
 
#define DEVICEID_REGISTER   0x3F
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Typedefs

typedef enum ADCRange ADCRange
 
typedef enum NumSamples NumSamples
 
typedef enum ConvTime ConvTime
 
typedef enum Mode Mode
 
typedef enum Status Status
 
typedef enum AlertOn AlertOn
 
typedef enum AlertPolarity AlertPolarity
 
typedef enum AlertLatch AlertLatch
 
typedef enum AlertConvReady AlertConvReady
 
typedef enum AlertSource AlertSource
 
typedef enum ErrorType ErrorType
 
typedef struct ina234 INA234
 Class (struct) that stores variables for interacting with INA234.
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Enumerations

enum  ADCRange { RANGE_81_92mV +, RANGE_20_48mV + }
 
enum  NumSamples {
+  NADC_1 +, NADC_4 +, NADC_16 +, NADC_64 +,
+  NADC_128 +, NADC_256 +, NADC_512 +, NADC_1024 +
+ }
 
enum  ConvTime {
+  CTIME_140us +, CTIME_204us +, CTIME_332us +, CTIME_588us +,
+  CTIME_1100us +, CTIME_2116us +, CTIME_4156us +, CTIME_8244us +
+ }
 
enum  Mode {
+  MODE_SHUTDOWN +, MODE_SINGLESHOT_SUNT +, MODE_SINGLESHOT_BUS +, MODE_SINGLESHOT_BOTH_SHUNT_BUS +,
+  MODE_SHUTDOWN2 +, MODE_CONTINUOUS_SHUNT +, MODE_CONTINUOUS_BUS +, MODE_CONTINUOUS_BOTH_SHUNT_BUS +
+ }
 
enum  Status { STATUS_OK +, STATUS_TimeOut + }
 
enum  AlertOn {
+  ALERT_NONE +, ALERT_SHUNT_OVER_LIMIT +, ALERT_SHUNT_UNDER_LIMIT +, ALERT_BUS_OVER_LIMIT +,
+  ALERT_BUS_UNDER_LIMIT +, ALERT_POWER_OVER_LIMIT +
+ }
 
enum  AlertPolarity { ALERT_ACTIVE_LOW +, ALERT_ACTIVE_HIGH + }
 
enum  AlertLatch { ALERT_TRANSPARENT +, ALERT_LATCHED + }
 
enum  AlertConvReady { ALERT_CONV_DISABLE +, ALERT_CONV_ENABLE + }
 
enum  AlertSource { ALERT_DATA_READY +, ALERT_LIMIT_REACHED + }
 
enum  ErrorType { ERROR_NONE +, ERROR_MEMORY +, ERROR_OVF +, ERROR_BOTH_MEMORY_OVF + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

Status INA234_init (INA234 *self, uint8_t I2C_ADDR, I2C_HandleTypeDef *hi2c, float ShuntResistor, ADCRange adc_range, NumSamples numer_of_adc_samples, ConvTime vbus_conversion_time, ConvTime vshunt_conversion_time, Mode mode)
 Initialize the INA234 with the given config.
 
Status INA234_alert_init (INA234 *self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit)
 Initialize the alert functionality of INA234 with the given configurations.
 
Status __INA234_readTwoBytes (INA234 *self, uint8_t MemAddress)
 Read two bytes (a 16bit register) from INA234 and stores in the ina234::_reg::raw_data.
 
Status __INA234_writeTwoBytes (INA234 *self, uint8_t MemAddress)
 Write two bytes (a 16bit register) to INA234 from the ina234::_reg::raw_data.
 
Status INA234_setADCRange (INA234 *self, ADCRange adc_range)
 Set the ADC full scale range of INA234.
 
Status INA234_setNumberOfADCSamples (INA234 *self, NumSamples numer_of_adc_samples)
 Set the number of ADC samples to calculate the average.
 
Status INA234_setVBusConversionTime (INA234 *self, ConvTime vbus_conversion_time)
 Set the VBus convertion period.
 
Status INA234_setVShuntConversionTime (INA234 *self, ConvTime vshunt_conversion_time)
 Set the VShunt convertion period.
 
Status INA234_setMode (INA234 *self, Mode mode)
 Set the operating mode.
 
ADCRange INA234_getADCRange (INA234 *self)
 Get the ADC full scale range of INA234.
 
NumSamples INA234_getNumberOfADCSamples (INA234 *self)
 Get the number of ADC samples to calculate the average.
 
ConvTime INA234_getVBusConversionTime (INA234 *self)
 Get the VBus convertion period.
 
ConvTime INA234_getVShuntConversionTime (INA234 *self)
 Get the VShunt convertion period.
 
Mode INA234_getMode (INA234 *self)
 Set the operating mode.
 
void INA234_SoftResetAll (INA234 *self)
 Send a reset command to all of the INA234s on the bus.
 
uint16_t INA234_getManID (INA234 *self)
 Get the manufacturer ID.
 
uint16_t INA234_getDevID (INA234 *self)
 Get the device ID.
 
void INA234_readAll (INA234 *self)
 Read all of the measured values: Shunt voltage, bus voltage, power, and current. Then store the values to the ina234 object (struct) variables. Then you can read variables: ina234::ShuntVoltage, ina234::BusVoltage, ina234::Power, and ina234::Current.
 
float INA234_getCurrent (INA234 *self)
 Read the current from INA234.
 
float INA234_getBusVoltage (INA234 *self)
 Read the bus voltage from INA234.
 
float INA234_getShuntVoltage (INA234 *self)
 Read the shunt voltage from INA234.
 
float INA234_getPower (INA234 *self)
 Read the power from INA234.
 
uint8_t INA234_isDataReady (INA234 *self)
 Check if the conversion is done or not. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.
 
AlertSource INA234_getAlertSource (INA234 *self)
 Get the alert source. This function is usefull when you enabled both of the alert functions and data ready alert simultaneously. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.
 
ErrorType INA234_getErrors (INA234 *self)
 Get the error flags of INA234. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.
 
Status INA234_resetAlert (INA234 *self)
 Reset the alert pin. This function is useful when set the alert pin to latch mode.
 
+

Macro Definition Documentation

+ +

◆ ALERT_LIMIT_REGISTER

+ +
+
+ + + + +
#define ALERT_LIMIT_REGISTER   0x07
+
+ +
+
+ +

◆ BUS_VOLTAGE_LSB

+ +
+
+ + + + +
#define BUS_VOLTAGE_LSB   0.025
+
+ +
+
+ +

◆ BUS_VOLTAGE_REGISTER

+ +
+
+ + + + +
#define BUS_VOLTAGE_REGISTER   0x02
+
+ +
+
+ +

◆ CALIBRATION_REGISTER

+ +
+
+ + + + +
#define CALIBRATION_REGISTER   0x05
+
+ +
+
+ +

◆ CONFIGURATION_REGISTER

+ +
+
+ + + + +
#define CONFIGURATION_REGISTER   0x00
+
+ +
+
+ +

◆ CURRENT_LSB

+ +
+
+ + + + +
#define CURRENT_LSB   (CURRENT_LSB_MINIMUM * 1.0)
+
+ +
+
+ +

◆ CURRENT_LSB_MINIMUM

+ +
+
+ + + + +
#define CURRENT_LSB_MINIMUM   (MAXIMUM_EXPECTED_CURRENT / 2048.0)
+
+ +
+
+ +

◆ CURRENT_REGISTER

+ +
+
+ + + + +
#define CURRENT_REGISTER   0x04
+
+ +
+
+ +

◆ DEVICEID_REGISTER

+ +
+
+ + + + +
#define DEVICEID_REGISTER   0x3F
+
+ +
+
+ +

◆ MANUFACTURERID_REGISTER

+ +
+
+ + + + +
#define MANUFACTURERID_REGISTER   0x3E
+
+ +
+
+ +

◆ MASK_ENABLE_REGISTER

+ +
+
+ + + + +
#define MASK_ENABLE_REGISTER   0x06
+
+ +
+
+ +

◆ MAXIMUM_EXPECTED_CURRENT

+ +
+
+ + + + +
#define MAXIMUM_EXPECTED_CURRENT   5.0
+
+ +
+
+ +

◆ POWER_LSB

+ +
+
+ + + + +
#define POWER_LSB   (CURRENT_LSB*0.032)
+
+ +
+
+ +

◆ POWER_REGISTER

+ +
+
+ + + + +
#define POWER_REGISTER   0x03
+
+ +
+
+ +

◆ SHUNT_VOLTAGE_20_48mv_LSB

+ +
+
+ + + + +
#define SHUNT_VOLTAGE_20_48mv_LSB   0.01
+
+ +
+
+ +

◆ SHUNT_VOLTAGE_81_92mv_LSB

+ +
+
+ + + + +
#define SHUNT_VOLTAGE_81_92mv_LSB   0.04
+
+ +
+
+ +

◆ SHUNT_VOLTAGE_REGISTER

+ +
+
+ + + + +
#define SHUNT_VOLTAGE_REGISTER   0x01
+
+ +
+
+

Typedef Documentation

+ +

◆ ADCRange

+ +
+
+ + + + +
typedef enum ADCRange ADCRange
+
+ +
+
+ +

◆ AlertConvReady

+ +
+
+ + + + +
typedef enum AlertConvReady AlertConvReady
+
+ +
+
+ +

◆ AlertLatch

+ +
+
+ + + + +
typedef enum AlertLatch AlertLatch
+
+ +
+
+ +

◆ AlertOn

+ +
+
+ + + + +
typedef enum AlertOn AlertOn
+
+ +
+
+ +

◆ AlertPolarity

+ +
+
+ + + + +
typedef enum AlertPolarity AlertPolarity
+
+ +
+
+ +

◆ AlertSource

+ +
+
+ + + + +
typedef enum AlertSource AlertSource
+
+ +
+
+ +

◆ ConvTime

+ +
+
+ + + + +
typedef enum ConvTime ConvTime
+
+ +
+
+ +

◆ ErrorType

+ +
+
+ + + + +
typedef enum ErrorType ErrorType
+
+ +
+
+ +

◆ INA234

+ +
+
+ + + + +
typedef struct ina234 INA234
+
+ +

Class (struct) that stores variables for interacting with INA234.

+ +
+
+ +

◆ Mode

+ +
+
+ + + + +
typedef enum Mode Mode
+
+ +
+
+ +

◆ NumSamples

+ +
+
+ + + + +
typedef enum NumSamples NumSamples
+
+ +
+
+ +

◆ Status

+ +
+
+ + + + +
typedef enum Status Status
+
+ +
+
+

Enumeration Type Documentation

+ +

◆ ADCRange

+ +
+
+ + + + +
enum ADCRange
+
+ + + +
Enumerator
RANGE_81_92mV 
RANGE_20_48mV 
+ +
+
+ +

◆ AlertConvReady

+ +
+
+ + + + +
enum AlertConvReady
+
+ + + +
Enumerator
ALERT_CONV_DISABLE 
ALERT_CONV_ENABLE 
+ +
+
+ +

◆ AlertLatch

+ +
+
+ + + + +
enum AlertLatch
+
+ + + +
Enumerator
ALERT_TRANSPARENT 
ALERT_LATCHED 
+ +
+
+ +

◆ AlertOn

+ +
+
+ + + + +
enum AlertOn
+
+ + + + + + + +
Enumerator
ALERT_NONE 
ALERT_SHUNT_OVER_LIMIT 
ALERT_SHUNT_UNDER_LIMIT 
ALERT_BUS_OVER_LIMIT 
ALERT_BUS_UNDER_LIMIT 
ALERT_POWER_OVER_LIMIT 
+ +
+
+ +

◆ AlertPolarity

+ +
+
+ + + + +
enum AlertPolarity
+
+ + + +
Enumerator
ALERT_ACTIVE_LOW 
ALERT_ACTIVE_HIGH 
+ +
+
+ +

◆ AlertSource

+ +
+
+ + + + +
enum AlertSource
+
+ + + +
Enumerator
ALERT_DATA_READY 
ALERT_LIMIT_REACHED 
+ +
+
+ +

◆ ConvTime

+ +
+
+ + + + +
enum ConvTime
+
+ + + + + + + + + +
Enumerator
CTIME_140us 
CTIME_204us 
CTIME_332us 
CTIME_588us 
CTIME_1100us 
CTIME_2116us 
CTIME_4156us 
CTIME_8244us 
+ +
+
+ +

◆ ErrorType

+ +
+
+ + + + +
enum ErrorType
+
+ + + + + +
Enumerator
ERROR_NONE 
ERROR_MEMORY 
ERROR_OVF 
ERROR_BOTH_MEMORY_OVF 
+ +
+
+ +

◆ Mode

+ +
+
+ + + + +
enum Mode
+
+ + + + + + + + + +
Enumerator
MODE_SHUTDOWN 
MODE_SINGLESHOT_SUNT 
MODE_SINGLESHOT_BUS 
MODE_SINGLESHOT_BOTH_SHUNT_BUS 
MODE_SHUTDOWN2 
MODE_CONTINUOUS_SHUNT 
MODE_CONTINUOUS_BUS 
MODE_CONTINUOUS_BOTH_SHUNT_BUS 
+ +
+
+ +

◆ NumSamples

+ +
+
+ + + + +
enum NumSamples
+
+ + + + + + + + + +
Enumerator
NADC_1 
NADC_4 
NADC_16 
NADC_64 
NADC_128 
NADC_256 
NADC_512 
NADC_1024 
+ +
+
+ +

◆ Status

+ +
+
+ + + + +
enum Status
+
+ + + +
Enumerator
STATUS_OK 
STATUS_TimeOut 
+ +
+
+

Function Documentation

+ +

◆ __INA234_readTwoBytes()

+ +
+
+ + + + + + + + + + + +
Status __INA234_readTwoBytes (INA234 * self,
uint8_t MemAddress )
+
+ +

Read two bytes (a 16bit register) from INA234 and stores in the ina234::_reg::raw_data.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
MemAddressAddress of the register
+
+
+
Returns
Ths status of reading
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ __INA234_writeTwoBytes()

+ +
+
+ + + + + + + + + + + +
Status __INA234_writeTwoBytes (INA234 * self,
uint8_t MemAddress )
+
+ +

Write two bytes (a 16bit register) to INA234 from the ina234::_reg::raw_data.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
MemAddressAddress of the register
+
+
+
Returns
Ths status of writing
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_alert_init()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Status INA234_alert_init (INA234 * self,
AlertOn alert_on,
AlertPolarity alert_polarity,
AlertLatch alert_latch,
AlertConvReady alert_conv_ready,
float alert_limit )
+
+ +

Initialize the alert functionality of INA234 with the given configurations.

+
Parameters
+ + + + + + + +
selfA pointer to the ina234 object (struct)
alert_ondetermines the event that you want to assert the alert: +
alert_polarityThe alert polarity determines the polarity of alert assertion:
    +
  • ALERT_ACTIVE_LOW Alert pin goes low on alert
    • +
  • ALERT_ACTIVE_HIGH Alert pin goes HiZ on alert (alert pin is open-drain so you have to add a pull-up resistor to get high state)
    • +
+
alert_latchDetermine the alert pin behaviour. If the latch is enabled, you have to reset the pin by calling the INA234_resetAlert() function. +
alert_conv_readyShows if you want to get alert on "conversion done"/"data ready" too or not. If enabled, you have to distinguish the alert sourece by calling INA234_getAlertSource() function. +
alert_limitThis the limit value. It automatically maps to the alert function you have chosen. The unit of this limit is related to the alert_on argument: +
+
+
+

For example if the alert_limit was 10.4 and you give ALERT_SHUNT_OVER_LIMIT for the alert_on argument, it means you will get alert if the shunt voltage reaches over the 10.4mV. If you give ALERT_BUS_OVER_LIMIT to alert_on, it means you will get alert if the bus voltage reaches the 10.4V

Returns
Ths status of initialization
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_getADCRange()

+ +
+
+ + + + + + + +
ADCRange INA234_getADCRange (INA234 * self)
+
+ +

Get the ADC full scale range of INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
The full scale range of ADC.
+
Return values
+ + + +
RANGE_81_92mVfor 81.92 mV
RANGE_20_48mVfor 20.48 mV
+
+
+ +
+
+ +

◆ INA234_getAlertSource()

+ +
+
+ + + + + + + +
AlertSource INA234_getAlertSource (INA234 * self)
+
+ +

Get the alert source. This function is usefull when you enabled both of the alert functions and data ready alert simultaneously. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
The alert source
+
Return values
+ + + +
ALERT_DATA_READYThe alert source is convertion ready
ALERT_LIMIT_REACHEDThe alert source is limit reach
+
+
+ +
+
+ +

◆ INA234_getBusVoltage()

+ +
+
+ + + + + + + +
float INA234_getBusVoltage (INA234 * self)
+
+ +

Read the bus voltage from INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a float value in Volts representing the bus voltage
+ +
+
+ +

◆ INA234_getCurrent()

+ +
+
+ + + + + + + +
float INA234_getCurrent (INA234 * self)
+
+ +

Read the current from INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a float value in Amps representing the current
+ +
+
+ +

◆ INA234_getDevID()

+ +
+
+ + + + + + + +
uint16_t INA234_getDevID (INA234 * self)
+
+ +

Get the device ID.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a 12bit device ID
+ +
+
+ +

◆ INA234_getErrors()

+ +
+
+ + + + + + + +
ErrorType INA234_getErrors (INA234 * self)
+
+ +

Get the error flags of INA234. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
Error type
+
Return values
+ + + + + +
ERROR_NONENo error
ERROR_MEMORYMemory error (CRC or ECC)
ERROR_OVFMath overflow error
ERROR_BOTH_MEMORY_OVFBoth memory error (CRC or ECC) and math overflow error
+
+
+ +
+
+ +

◆ INA234_getManID()

+ +
+
+ + + + + + + +
uint16_t INA234_getManID (INA234 * self)
+
+ +

Get the manufacturer ID.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a 16bit manufacturer ID
+ +
+
+ +

◆ INA234_getMode()

+ +
+
+ + + + + + + +
Mode INA234_getMode (INA234 * self)
+
+ +

Set the operating mode.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
Operating mode
+
Return values
+ + + + + + + + +
MODE_SHUTDOWNshutdown mode
MODE_SINGLESHOT_SUNTonly measure the shunt voltage once
MODE_SINGLESHOT_BUSonly measure the bus voltage once
MODE_SINGLESHOT_BOTH_SHUNT_BUSmeasure the bus and shunt voltage once
MODE_CONTINUOUS_SHUNTonly measure the shunt voltage continuously
MODE_CONTINUOUS_BUSonly measure the bus voltage continuously
MODE_CONTINUOUS_BOTH_SHUNT_BUSmeasure the bus and shunt voltage continuously
+
+
+ +
+
+ +

◆ INA234_getNumberOfADCSamples()

+ +
+
+ + + + + + + +
NumSamples INA234_getNumberOfADCSamples (INA234 * self)
+
+ +

Get the number of ADC samples to calculate the average.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
Numer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency.
+
Return values
+ + + + + + + + + +
NADC_1for one sample (no average)
NADC_44 samples
NADC_1616 samples
NADC_6464 samples
NADC_128128 samples
NADC_256256 samples
NADC_512512 samples
NADC_10241024 samples
+
+
+ +
+
+ +

◆ INA234_getPower()

+ +
+
+ + + + + + + +
float INA234_getPower (INA234 * self)
+
+ +

Read the power from INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a float value in Watt representing the power
+ +
+
+ +

◆ INA234_getShuntVoltage()

+ +
+
+ + + + + + + +
float INA234_getShuntVoltage (INA234 * self)
+
+ +

Read the shunt voltage from INA234.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
a float value in miliVolts representing the shunt voltage
+ +
+
+ +

◆ INA234_getVBusConversionTime()

+ +
+
+ + + + + + + +
ConvTime INA234_getVBusConversionTime (INA234 * self)
+
+ +

Get the VBus convertion period.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
The conversion time of VBus measurment.
+
Return values
+ + + + + + + + + +
CTIME_140us
CTIME_204us
CTIME_332us
CTIME_588us
CTIME_1100us
CTIME_2116us
CTIME_4156us
CTIME_8244us
+
+
+ +
+
+ +

◆ INA234_getVShuntConversionTime()

+ +
+
+ + + + + + + +
ConvTime INA234_getVShuntConversionTime (INA234 * self)
+
+ +

Get the VShunt convertion period.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
The conversion time of VShunt measurment.
+
Return values
+ + + + + + + + + +
CTIME_140us
CTIME_204us
CTIME_332us
CTIME_588us
CTIME_1100us
CTIME_2116us
CTIME_4156us
CTIME_8244us
+
+
+ +
+
+ +

◆ INA234_init()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Status INA234_init (INA234 * self,
uint8_t I2C_ADDR,
I2C_HandleTypeDef * hi2c,
float ShuntResistor,
ADCRange adc_range,
NumSamples numer_of_adc_samples,
ConvTime vbus_conversion_time,
ConvTime vshunt_conversion_time,
Mode mode )
+
+ +

Initialize the INA234 with the given config.

+
Parameters
+ + + + + + + + + +
selfA pointer to the ina234 object (struct)
hi2cA pointer to the I2C handler that is connected to INA234
ShuntResistorThe resistance of your shunt resistor (in mOhm) connected to IN+ and IN- of the INA234
adc_rangeThe full scale range of ADC. It can be one of these values: +
numer_of_adc_samplesNumer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency. +
vbus_conversion_timeThe conversion time of VBus measurment. +
vshunt_conversion_timeThe conversion time of VShunt measurment. +
modeOperating mode: +
+
+
+
Returns
Ths status of initialization
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_isDataReady()

+ +
+
+ + + + + + + +
uint8_t INA234_isDataReady (INA234 * self)
+
+ +

Check if the conversion is done or not. NOTE: This function will reset the alert pin if it was in the latch mode. Exactly like calling the INA234_resetAlert() function.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Return values
+ + + +
True
False
+
+
+ +
+
+ +

◆ INA234_readAll()

+ +
+
+ + + + + + + +
void INA234_readAll (INA234 * self)
+
+ +

Read all of the measured values: Shunt voltage, bus voltage, power, and current. Then store the values to the ina234 object (struct) variables. Then you can read variables: ina234::ShuntVoltage, ina234::BusVoltage, ina234::Power, and ina234::Current.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+ +
+
+ +

◆ INA234_resetAlert()

+ +
+
+ + + + + + + +
Status INA234_resetAlert (INA234 * self)
+
+ +

Reset the alert pin. This function is useful when set the alert pin to latch mode.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+
Returns
Ths status of reset
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setADCRange()

+ +
+
+ + + + + + + + + + + +
Status INA234_setADCRange (INA234 * self,
ADCRange adc_range )
+
+ +

Set the ADC full scale range of INA234.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
adc_rangeThe full scale range of ADC. It can be one of these values: +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setMode()

+ +
+
+ + + + + + + + + + + +
Status INA234_setMode (INA234 * self,
Mode mode )
+
+ +

Set the operating mode.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
modeOperating mode: +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setNumberOfADCSamples()

+ +
+
+ + + + + + + + + + + +
Status INA234_setNumberOfADCSamples (INA234 * self,
NumSamples numer_of_adc_samples )
+
+ +

Set the number of ADC samples to calculate the average.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
numer_of_adc_samplesNumer of ADC samples to calculate the average. The higher ADC samples leads to lower noises and higher latency. +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setVBusConversionTime()

+ +
+
+ + + + + + + + + + + +
Status INA234_setVBusConversionTime (INA234 * self,
ConvTime vbus_conversion_time )
+
+ +

Set the VBus convertion period.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
vbus_conversion_timeThe conversion time of VBus measurment. +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_setVShuntConversionTime()

+ +
+
+ + + + + + + + + + + +
Status INA234_setVShuntConversionTime (INA234 * self,
ConvTime vshunt_conversion_time )
+
+ +

Set the VShunt convertion period.

+
Parameters
+ + + +
selfA pointer to the ina234 object (struct)
vshunt_conversion_timeThe conversion time of VShunt measurment. +
+
+
+
Returns
Ths status of config
+
Return values
+ + + +
STATUS_OKin case of success
STATUS_TimeOutin case of failure
+
+
+ +
+
+ +

◆ INA234_SoftResetAll()

+ +
+
+ + + + + + + +
void INA234_SoftResetAll (INA234 * self)
+
+ +

Send a reset command to all of the INA234s on the bus.

+
Parameters
+ + +
selfA pointer to the ina234 object (struct)
+
+
+ +
+
+
+
+ + + + diff --git a/ina234_8h.js b/ina234_8h.js new file mode 100644 index 0000000..32bf810 --- /dev/null +++ b/ina234_8h.js @@ -0,0 +1,138 @@ +var ina234_8h = +[ + [ "ina234", "structina234.html", "structina234" ], + [ "_reg", "unionina234_1_1__reg.html", "unionina234_1_1__reg" ], + [ "_config_register", "structina234_1_1__reg_1_1__config__register.html", "structina234_1_1__reg_1_1__config__register" ], + [ "_shunt_voltage_register", "structina234_1_1__reg_1_1__shunt__voltage__register.html", "structina234_1_1__reg_1_1__shunt__voltage__register" ], + [ "_bus_voltage_register", "structina234_1_1__reg_1_1__bus__voltage__register.html", "structina234_1_1__reg_1_1__bus__voltage__register" ], + [ "_power_register", "structina234_1_1__reg_1_1__power__register.html", "structina234_1_1__reg_1_1__power__register" ], + [ "_current_register", "structina234_1_1__reg_1_1__current__register.html", "structina234_1_1__reg_1_1__current__register" ], + [ "_calibration_register", "structina234_1_1__reg_1_1__calibration__register.html", "structina234_1_1__reg_1_1__calibration__register" ], + [ "_mask_enable_register", "structina234_1_1__reg_1_1__mask__enable__register.html", "structina234_1_1__reg_1_1__mask__enable__register" ], + [ "_alert_limit_register", "structina234_1_1__reg_1_1__alert__limit__register.html", "structina234_1_1__reg_1_1__alert__limit__register" ], + [ "_manufacture_id_register", "structina234_1_1__reg_1_1__manufacture__id__register.html", "structina234_1_1__reg_1_1__manufacture__id__register" ], + [ "_devide_id_register", "structina234_1_1__reg_1_1__devide__id__register.html", "structina234_1_1__reg_1_1__devide__id__register" ], + [ "ALERT_LIMIT_REGISTER", "ina234_8h.html#ab843670bdea443688a3c0fc1bb59df4c", null ], + [ "BUS_VOLTAGE_LSB", "ina234_8h.html#a775ced70ffbd32f6fb31cbb10a10187f", null ], + [ "BUS_VOLTAGE_REGISTER", "ina234_8h.html#a646eb67bd8e213ae03c5a03e6a569788", null ], + [ "CALIBRATION_REGISTER", "ina234_8h.html#ab59d55e52855c8c0f649304fa92a9a13", null ], + [ "CONFIGURATION_REGISTER", "ina234_8h.html#a7ee3d94a0cd2d145d66bae6abe5bb302", null ], + [ "CURRENT_LSB", "ina234_8h.html#a81ed9fb0bd16f43a3a5bc335f966a96f", null ], + [ "CURRENT_LSB_MINIMUM", "ina234_8h.html#a48ce45ec20267ca3c0159a444dc30c33", null ], + [ "CURRENT_REGISTER", "ina234_8h.html#a3640431a41e460b8e7ddf642adefae95", null ], + [ "DEVICEID_REGISTER", "ina234_8h.html#a238936614e386e75f2487559953cbc68", null ], + [ "MANUFACTURERID_REGISTER", "ina234_8h.html#a8243b56922df1eafe7faf2f5231642b6", null ], + [ "MASK_ENABLE_REGISTER", "ina234_8h.html#ae92b8bbb58abb306563771a0149472d2", null ], + [ "MAXIMUM_EXPECTED_CURRENT", "ina234_8h.html#ad157a86c3b3394bca27e86844852ee04", null ], + [ "POWER_LSB", "ina234_8h.html#ab01b539856e5c5102cd3d97a38435d26", null ], + [ "POWER_REGISTER", "ina234_8h.html#a731f54cd49fcbbca608bfbe367c75dfb", null ], + [ "SHUNT_VOLTAGE_20_48mv_LSB", "ina234_8h.html#a8c0e636ce427d3785aea74926fabc624", null ], + [ "SHUNT_VOLTAGE_81_92mv_LSB", "ina234_8h.html#a93329758cb0f2c6f52cffd48b8f961c8", null ], + [ "SHUNT_VOLTAGE_REGISTER", "ina234_8h.html#aa417fcb934d07b4af5c20c44b920e5ae", null ], + [ "ADCRange", "ina234_8h.html#a650dc7cee4ad520ed3fa35dbe7142216", null ], + [ "AlertConvReady", "ina234_8h.html#a848ebbc680edb7898d7edc1ca52a0d37", null ], + [ "AlertLatch", "ina234_8h.html#afc7b0844b88c911005553dd08939b096", null ], + [ "AlertOn", "ina234_8h.html#a6be1753fa6a5ab6a2afa25019e635f5f", null ], + [ "AlertPolarity", "ina234_8h.html#a74f38e65a7114a53a324d460820a43a4", null ], + [ "AlertSource", "ina234_8h.html#a3872be266ee7297b319f93420303a008", null ], + [ "ConvTime", "ina234_8h.html#ab303d390218c5cf7c69501e0559213ec", null ], + [ "ErrorType", "ina234_8h.html#a1324293b60f4d902ebc99cf0d31bad89", null ], + [ "INA234", "ina234_8h.html#a0ee8a79a292d53863aff0274ca030f5a", null ], + [ "Mode", "ina234_8h.html#a27e0b80eae69f3ea0f661dea593912c8", null ], + [ "NumSamples", "ina234_8h.html#a3bce910f55e3b114067517de3ca4ff28", null ], + [ "Status", "ina234_8h.html#a59ac6513a4c0c951eff022338ea6e9f6", null ], + [ "ADCRange", "ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fc", [ + [ "RANGE_81_92mV", "ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fcac35ce98e9a40c62ca3ce4054c4d72bb5", null ], + [ "RANGE_20_48mV", "ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fca39711bc57d71a9e56b586578de4da136", null ] + ] ], + [ "AlertConvReady", "ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4", [ + [ "ALERT_CONV_DISABLE", "ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4a083db3ebfb856b3fb387dd31d856c0c8", null ], + [ "ALERT_CONV_ENABLE", "ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4a5e0027e4e01b269be48d60a41243d854", null ] + ] ], + [ "AlertLatch", "ina234_8h.html#a9524876614527f1c1cad905b5586a61c", [ + [ "ALERT_TRANSPARENT", "ina234_8h.html#a9524876614527f1c1cad905b5586a61ca8e18da66cd5b403de50cd5cea2867a01", null ], + [ "ALERT_LATCHED", "ina234_8h.html#a9524876614527f1c1cad905b5586a61cae66cf6808527fe59bda82112ea1f0626", null ] + ] ], + [ "AlertOn", "ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4", [ + [ "ALERT_NONE", "ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4ab84e7751ae498fa5f6354fec90392f84", null ], + [ "ALERT_SHUNT_OVER_LIMIT", "ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4adf6cdb85c8967fba23a0f0244b49057c", null ], + [ "ALERT_SHUNT_UNDER_LIMIT", "ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a948a648cb59cafcc5382b1b5e599d28b", null ], + [ "ALERT_BUS_OVER_LIMIT", "ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a1ca5e700ee55d0dc367e350b23f11ec9", null ], + [ "ALERT_BUS_UNDER_LIMIT", "ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a94ace1d59fb93b2a18d3f81347d85baf", null ], + [ "ALERT_POWER_OVER_LIMIT", "ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a34e2f0c08f8c607c6bef4c42a1650fb3", null ] + ] ], + [ "AlertPolarity", "ina234_8h.html#ada37218468b40fbf8e3f7951165cf634", [ + [ "ALERT_ACTIVE_LOW", "ina234_8h.html#ada37218468b40fbf8e3f7951165cf634ac517f2dbfd71d39c6277a02c6a8e98b5", null ], + [ "ALERT_ACTIVE_HIGH", "ina234_8h.html#ada37218468b40fbf8e3f7951165cf634acc90eec8b0cea31c65d2125e1dec4b3d", null ] + ] ], + [ "AlertSource", "ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8", [ + [ "ALERT_DATA_READY", "ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8a83f1800832e2ed9bc6691a53c9a1359d", null ], + [ "ALERT_LIMIT_REACHED", "ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8aea5a0da07bc6063e3ad1f5bc0332dc65", null ] + ] ], + [ "ConvTime", "ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6", [ + [ "CTIME_140us", "ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6acfaa6a642034e5c48d5f172355a0e22d", null ], + [ "CTIME_204us", "ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6ac369ab9b892e484bf6f6e1c62cdf89a8", null ], + [ "CTIME_332us", "ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6abfd7d84dee689ba2bb2f17da3d09ac9a", null ], + [ "CTIME_588us", "ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a2fe24ae5755ffeb5b8082cd037b9dc7f", null ], + [ "CTIME_1100us", "ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a65ed0d16270a6141ab8dd8488fe7f41e", null ], + [ "CTIME_2116us", "ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a47c6de263bc91c68cc7aa33fa4ff0755", null ], + [ "CTIME_4156us", "ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a657a9b9f4cabd5ca90fee02c26638a04", null ], + [ "CTIME_8244us", "ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a08b6eaecf78753c12f67dddf9949be84", null ] + ] ], + [ "ErrorType", "ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45a", [ + [ "ERROR_NONE", "ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa4edc8aade11e1de7bbbdc04704baae5f", null ], + [ "ERROR_MEMORY", "ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa632a15615c9d0f691788ab4f0a66e41d", null ], + [ "ERROR_OVF", "ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa2a372620a5d99a4790787150ebe2a92c", null ], + [ "ERROR_BOTH_MEMORY_OVF", "ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa4a2fc9e6bcb0135acd74edfec8554512", null ] + ] ], + [ "Mode", "ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911", [ + [ "MODE_SHUTDOWN", "ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a0680164b529f8d29d670308298ec2a2b", null ], + [ "MODE_SINGLESHOT_SUNT", "ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911aa90b94d7cd6425245221d504534f0f2f", null ], + [ "MODE_SINGLESHOT_BUS", "ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a9f304d5978fa9370e3cd0da297f85470", null ], + [ "MODE_SINGLESHOT_BOTH_SHUNT_BUS", "ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911ab729c3948326475cd19e84a433ae96bd", null ], + [ "MODE_SHUTDOWN2", "ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a28192c7eb7daf555e5eb9def6b82c2db", null ], + [ "MODE_CONTINUOUS_SHUNT", "ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911ac089fb7ab69f944b618f18abe16b3600", null ], + [ "MODE_CONTINUOUS_BUS", "ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a6cba4ffadd57ed1e5f5a176ab21f4e85", null ], + [ "MODE_CONTINUOUS_BOTH_SHUNT_BUS", "ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a7bc1351d315d165a969fe64c964da364", null ] + ] ], + [ "NumSamples", "ina234_8h.html#aeec3587067ff840117ceeb10b98eda58", [ + [ "NADC_1", "ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a993c043bbf51fcb3e71e24560079b3e0", null ], + [ "NADC_4", "ina234_8h.html#aeec3587067ff840117ceeb10b98eda58ac9dd4285a560c534d22fca6840d0ebf5", null ], + [ "NADC_16", "ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a3a1205ed5042c059ebf47784254d1f29", null ], + [ "NADC_64", "ina234_8h.html#aeec3587067ff840117ceeb10b98eda58abdcabf69ca2812231b1ee322cda057d1", null ], + [ "NADC_128", "ina234_8h.html#aeec3587067ff840117ceeb10b98eda58aa7cf4006919e212a7d722e96c826fa8d", null ], + [ "NADC_256", "ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a91a4d2241e749494be617d895d318589", null ], + [ "NADC_512", "ina234_8h.html#aeec3587067ff840117ceeb10b98eda58af045584cc242ad52f42910989945250f", null ], + [ "NADC_1024", "ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a02bba2371c7cc4740a4bcccc82da45d7", null ] + ] ], + [ "Status", "ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b", [ + [ "STATUS_OK", "ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba7e4a42e3b6dd63708c64cf3db6f69566", null ], + [ "STATUS_TimeOut", "ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70bafddcb825c6c18107885a7d663dcf38e7", null ] + ] ], + [ "__INA234_readTwoBytes", "ina234_8h.html#aa36cf3308ef4df72ddf8a78edff23556", null ], + [ "__INA234_writeTwoBytes", "ina234_8h.html#ac08e0ed8b382a2dd193753a2b302bae1", null ], + [ "INA234_alert_init", "ina234_8h.html#afb44437883ad8f8d08aaf695815da7ed", null ], + [ "INA234_getADCRange", "ina234_8h.html#ab9f2d8b23628fb6b060f837b9a4f71a5", null ], + [ "INA234_getAlertSource", "ina234_8h.html#a52cc3b785dea1f5af6f0803f02fcefdb", null ], + [ "INA234_getBusVoltage", "ina234_8h.html#a97ec39b6399d3ab449e499a57668748d", null ], + [ "INA234_getCurrent", "ina234_8h.html#a825a355395fef312e3642f9f8ca6463c", null ], + [ "INA234_getDevID", "ina234_8h.html#a88ff1503798836270a41d3b9f3913ca7", null ], + [ "INA234_getErrors", "ina234_8h.html#a14a3383eba06ce784ed526585a0cef9a", null ], + [ "INA234_getManID", "ina234_8h.html#ae646f51adec51af1aa6377c3dffeeb6a", null ], + [ "INA234_getMode", "ina234_8h.html#a4af7c34341c14b8bfb40daf0665a766c", null ], + [ "INA234_getNumberOfADCSamples", "ina234_8h.html#acda6b9d24c842d73ffca341ce39ac707", null ], + [ "INA234_getPower", "ina234_8h.html#a163121f0afcab9a5e49f419b94290f20", null ], + [ "INA234_getShuntVoltage", "ina234_8h.html#a256f66571357742aec8b4f0104c54b6b", null ], + [ "INA234_getVBusConversionTime", "ina234_8h.html#aa3f6130fa6074b931f415e9ca85f340d", null ], + [ "INA234_getVShuntConversionTime", "ina234_8h.html#a6afffb92bb828562997a6a5592bc141a", null ], + [ "INA234_init", "ina234_8h.html#a21acc30b187445a98f711a54b8678c7c", null ], + [ "INA234_isDataReady", "ina234_8h.html#a9637d475148409297883f05464a92e86", null ], + [ "INA234_readAll", "ina234_8h.html#ac7901cf62e078ff3a235839061a3608b", null ], + [ "INA234_resetAlert", "ina234_8h.html#a5810f9a740226a39ba5cc2afa6b64f77", null ], + [ "INA234_setADCRange", "ina234_8h.html#aba71c63deed65a0abdbf7269b5f382d8", null ], + [ "INA234_setMode", "ina234_8h.html#ac85c8e736ffae6d248971091b374d00f", null ], + [ "INA234_setNumberOfADCSamples", "ina234_8h.html#a84ff6173bf6cfa44348ba259a503c804", null ], + [ "INA234_setVBusConversionTime", "ina234_8h.html#a94ec7dc7cd10748c4ed822266174d0ff", null ], + [ "INA234_setVShuntConversionTime", "ina234_8h.html#ad19627414a2465c9cf1fac54f54eaa39", null ], + [ "INA234_SoftResetAll", "ina234_8h.html#af3d939ea27371b17fd265f19957234b2", null ] +]; \ No newline at end of file diff --git a/ina234_8h_source.html b/ina234_8h_source.html new file mode 100644 index 0000000..08b509f --- /dev/null +++ b/ina234_8h_source.html @@ -0,0 +1,447 @@ + + + + + + + +INA234 HAL Based Library: ina234.h Source File + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
ina234.h
+
+
+Go to the documentation of this file.
1
+
41#ifndef __INA234_H_
+
42#define __INA234_H_
+
43
+
44#include "main.h"
+
45#include "i2c.h"
+
46
+
47#define MAXIMUM_EXPECTED_CURRENT 5.0
+
48#define CURRENT_LSB_MINIMUM (MAXIMUM_EXPECTED_CURRENT / 2048.0)
+
49#define CURRENT_LSB (CURRENT_LSB_MINIMUM * 1.0) // in A
+
50#define BUS_VOLTAGE_LSB 0.025 // in V
+
51#define SHUNT_VOLTAGE_81_92mv_LSB 0.04 // in mV
+
52#define SHUNT_VOLTAGE_20_48mv_LSB 0.01 // in mV
+
53#define POWER_LSB (CURRENT_LSB*0.032) // in W
+
54
+
55#define CONFIGURATION_REGISTER 0x00
+
56#define SHUNT_VOLTAGE_REGISTER 0x01
+
57#define BUS_VOLTAGE_REGISTER 0x02
+
58#define POWER_REGISTER 0x03
+
59#define CURRENT_REGISTER 0x04
+
60#define CALIBRATION_REGISTER 0x05
+
61#define MASK_ENABLE_REGISTER 0x06
+
62#define ALERT_LIMIT_REGISTER 0x07
+
63#define MANUFACTURERID_REGISTER 0x3E
+
64#define DEVICEID_REGISTER 0x3F
+
65
+
66typedef enum ADCRange {RANGE_81_92mV, RANGE_20_48mV} ADCRange;
+
67typedef enum NumSamples {NADC_1, NADC_4, NADC_16, NADC_64, NADC_128, NADC_256, NADC_512, NADC_1024} NumSamples;
+
68typedef enum ConvTime {CTIME_140us, CTIME_204us, CTIME_332us, CTIME_588us, CTIME_1100us, CTIME_2116us, CTIME_4156us, CTIME_8244us} ConvTime;
+
69typedef enum Mode {MODE_SHUTDOWN, MODE_SINGLESHOT_SUNT, MODE_SINGLESHOT_BUS, MODE_SINGLESHOT_BOTH_SHUNT_BUS, MODE_SHUTDOWN2, MODE_CONTINUOUS_SHUNT, MODE_CONTINUOUS_BUS, MODE_CONTINUOUS_BOTH_SHUNT_BUS} Mode;
+
70typedef enum Status {STATUS_OK, STATUS_TimeOut} Status;
+
71typedef enum AlertOn {ALERT_NONE, ALERT_SHUNT_OVER_LIMIT, ALERT_SHUNT_UNDER_LIMIT, ALERT_BUS_OVER_LIMIT, ALERT_BUS_UNDER_LIMIT, ALERT_POWER_OVER_LIMIT} AlertOn;
+
72typedef enum AlertPolarity {ALERT_ACTIVE_LOW, ALERT_ACTIVE_HIGH} AlertPolarity;
+
73typedef enum AlertLatch {ALERT_TRANSPARENT, ALERT_LATCHED} AlertLatch;
+
74typedef enum AlertConvReady {ALERT_CONV_DISABLE, ALERT_CONV_ENABLE} AlertConvReady;
+
75typedef enum AlertSource {ALERT_DATA_READY, ALERT_LIMIT_REACHED} AlertSource;
+
76typedef enum ErrorType {ERROR_NONE, ERROR_MEMORY, ERROR_OVF, ERROR_BOTH_MEMORY_OVF} ErrorType;
+
77
+
+
81typedef struct ina234{
+
82
+
83 I2C_HandleTypeDef* hi2c;
+
84 uint8_t I2C_ADDR;
+
85
+
86 // Main configs
+
87 ADCRange adc_range;
+
88 NumSamples number_of_adc_samples;
+
89 ConvTime vbus_conversion_time;
+
90 ConvTime vshunt_conversion_time;
+
91 Mode mode;
+
92 float ShuntResistor;
+
93
+
94 // Alert Configs
+
95 AlertOn alert_on;
+
96 AlertPolarity alert_polarity;
+
97 AlertLatch alert_latch;
+
98 AlertConvReady alert_conv_ready;
+
99 float alert_limit;
+
100 int32_t alert_limit_int;
+
101
+
102 float ShuntVoltage;
+
103 float BusVoltage;
+
104 float Power;
+
105 float Current;
+
106
+
+
107 union _reg {
+
108 uint8_t raw_data[2];
+
109
+
+
110 struct _config_register{
+
111 uint16_t MODE:3, VSHCT:3, VBUSCT:3, AVG:3, ACDRANGE:1, RESERVED:2, RST:1;
+
112 } config_register;
+
+
113
+ +
117
+ +
121
+
+
122 struct _power_register{
+
123 uint16_t POWER;
+
124 } power_register;
+
+
125
+ +
129
+ +
133
+
+
134 struct _mask_enable_register{
+
135 uint16_t LEN:1, APOL:1, OVF:1, CVRF:1, AFF:1, MemError:1, RESERVED:4, CNVR:1, POL:1, BUL:1, BOL:1, SUL:1, SOL:1;
+
136 } mask_enable_register;
+
+
137
+ +
141
+ +
145
+ +
149
+
150 } reg;
+
+
151
+
152} INA234;
+
+
153
+
154Status INA234_init(INA234* self, uint8_t I2C_ADDR, I2C_HandleTypeDef* hi2c, float ShuntResistor, ADCRange adc_range, NumSamples numer_of_adc_samples, ConvTime vbus_conversion_time, ConvTime vshunt_conversion_time, Mode mode);
+
155Status INA234_alert_init(INA234* self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit);
+
156
+
157// Privates ----------------------------------
+
158
+
159Status __INA234_readTwoBytes(INA234* self, uint8_t MemAddress);
+
160Status __INA234_writeTwoBytes(INA234* self, uint8_t MemAddress);
+
161
+
162// Configurations ----------------------------
+
163
+
164Status INA234_setADCRange(INA234* self, ADCRange adc_range);
+
165Status INA234_setNumberOfADCSamples(INA234* self, NumSamples numer_of_adc_samples);
+
166Status INA234_setVBusConversionTime(INA234* self, ConvTime vbus_conversion_time);
+
167Status INA234_setVShuntConversionTime(INA234* self, ConvTime vshunt_conversion_time);
+
168Status INA234_setMode(INA234* self, Mode mode);
+
169
+
170ADCRange INA234_getADCRange(INA234* self);
+
171NumSamples INA234_getNumberOfADCSamples(INA234* self);
+
172ConvTime INA234_getVBusConversionTime(INA234* self);
+
173ConvTime INA234_getVShuntConversionTime(INA234* self);
+
174Mode INA234_getMode(INA234* self);
+
175
+
176void INA234_SoftResetAll(INA234* self);
+
177
+
178// Getting Data ------------------------------
+
179
+
180uint16_t INA234_getManID(INA234* self);
+
181uint16_t INA234_getDevID(INA234* self);
+
182void INA234_readAll(INA234* self);
+
183float INA234_getCurrent(INA234* self);
+
184float INA234_getBusVoltage(INA234* self);
+
185float INA234_getShuntVoltage(INA234* self);
+
186float INA234_getPower(INA234* self);
+
187
+
188uint8_t INA234_isDataReady(INA234* self);
+
189AlertSource INA234_getAlertSource(INA234* self);
+
190ErrorType INA234_getErrors(INA234* self);
+
191Status INA234_resetAlert(INA234* self);
+
192
+
193#endif
+
INA234
struct ina234 INA234
Class (struct) that stores variables for interacting with INA234.
+
INA234_getErrors
ErrorType INA234_getErrors(INA234 *self)
Get the error flags of INA234. NOTE: This function will reset the alert pin if it was in the latch mo...
Definition ina234.c:626
+
INA234_getPower
float INA234_getPower(INA234 *self)
Read the power from INA234.
Definition ina234.c:585
+
INA234_init
Status INA234_init(INA234 *self, uint8_t I2C_ADDR, I2C_HandleTypeDef *hi2c, float ShuntResistor, ADCRange adc_range, NumSamples numer_of_adc_samples, ConvTime vbus_conversion_time, ConvTime vshunt_conversion_time, Mode mode)
Initialize the INA234 with the given config.
Definition ina234.c:99
+
INA234_getShuntVoltage
float INA234_getShuntVoltage(INA234 *self)
Read the shunt voltage from INA234.
Definition ina234.c:573
+
Mode
Mode
Definition ina234.h:69
+
MODE_SHUTDOWN
@ MODE_SHUTDOWN
Definition ina234.h:69
+
MODE_SHUTDOWN2
@ MODE_SHUTDOWN2
Definition ina234.h:69
+
MODE_CONTINUOUS_BUS
@ MODE_CONTINUOUS_BUS
Definition ina234.h:69
+
MODE_CONTINUOUS_BOTH_SHUNT_BUS
@ MODE_CONTINUOUS_BOTH_SHUNT_BUS
Definition ina234.h:69
+
MODE_SINGLESHOT_BUS
@ MODE_SINGLESHOT_BUS
Definition ina234.h:69
+
MODE_SINGLESHOT_SUNT
@ MODE_SINGLESHOT_SUNT
Definition ina234.h:69
+
MODE_SINGLESHOT_BOTH_SHUNT_BUS
@ MODE_SINGLESHOT_BOTH_SHUNT_BUS
Definition ina234.h:69
+
MODE_CONTINUOUS_SHUNT
@ MODE_CONTINUOUS_SHUNT
Definition ina234.h:69
+
INA234_getMode
Mode INA234_getMode(INA234 *self)
Set the operating mode.
Definition ina234.c:493
+
INA234_getAlertSource
AlertSource INA234_getAlertSource(INA234 *self)
Get the alert source. This function is usefull when you enabled both of the alert functions and data ...
Definition ina234.c:611
+
INA234_resetAlert
Status INA234_resetAlert(INA234 *self)
Reset the alert pin. This function is useful when set the alert pin to latch mode.
Definition ina234.c:646
+
Status
Status
Definition ina234.h:70
+
STATUS_OK
@ STATUS_OK
Definition ina234.h:70
+
STATUS_TimeOut
@ STATUS_TimeOut
Definition ina234.h:70
+
INA234_getVShuntConversionTime
ConvTime INA234_getVShuntConversionTime(INA234 *self)
Get the VShunt convertion period.
Definition ina234.c:476
+
AlertOn
AlertOn
Definition ina234.h:71
+
ALERT_BUS_OVER_LIMIT
@ ALERT_BUS_OVER_LIMIT
Definition ina234.h:71
+
ALERT_POWER_OVER_LIMIT
@ ALERT_POWER_OVER_LIMIT
Definition ina234.h:71
+
ALERT_SHUNT_UNDER_LIMIT
@ ALERT_SHUNT_UNDER_LIMIT
Definition ina234.h:71
+
ALERT_BUS_UNDER_LIMIT
@ ALERT_BUS_UNDER_LIMIT
Definition ina234.h:71
+
ALERT_NONE
@ ALERT_NONE
Definition ina234.h:71
+
ALERT_SHUNT_OVER_LIMIT
@ ALERT_SHUNT_OVER_LIMIT
Definition ina234.h:71
+
INA234_getCurrent
float INA234_getCurrent(INA234 *self)
Read the current from INA234.
Definition ina234.c:549
+
INA234_setNumberOfADCSamples
Status INA234_setNumberOfADCSamples(INA234 *self, NumSamples numer_of_adc_samples)
Set the number of ADC samples to calculate the average.
Definition ina234.c:313
+
INA234_getDevID
uint16_t INA234_getDevID(INA234 *self)
Get the device ID.
Definition ina234.c:525
+
INA234_setVBusConversionTime
Status INA234_setVBusConversionTime(INA234 *self, ConvTime vbus_conversion_time)
Set the VBus convertion period.
Definition ina234.c:343
+
AlertLatch
AlertLatch
Definition ina234.h:73
+
ALERT_TRANSPARENT
@ ALERT_TRANSPARENT
Definition ina234.h:73
+
ALERT_LATCHED
@ ALERT_LATCHED
Definition ina234.h:73
+
INA234_isDataReady
uint8_t INA234_isDataReady(INA234 *self)
Check if the conversion is done or not. NOTE: This function will reset the alert pin if it was in the...
Definition ina234.c:598
+
INA234_getBusVoltage
float INA234_getBusVoltage(INA234 *self)
Read the bus voltage from INA234.
Definition ina234.c:561
+
__INA234_readTwoBytes
Status __INA234_readTwoBytes(INA234 *self, uint8_t MemAddress)
Read two bytes (a 16bit register) from INA234 and stores in the ina234::_reg::raw_data.
Definition ina234.c:234
+
INA234_getVBusConversionTime
ConvTime INA234_getVBusConversionTime(INA234 *self)
Get the VBus convertion period.
Definition ina234.c:458
+
ErrorType
ErrorType
Definition ina234.h:76
+
ERROR_OVF
@ ERROR_OVF
Definition ina234.h:76
+
ERROR_BOTH_MEMORY_OVF
@ ERROR_BOTH_MEMORY_OVF
Definition ina234.h:76
+
ERROR_NONE
@ ERROR_NONE
Definition ina234.h:76
+
ERROR_MEMORY
@ ERROR_MEMORY
Definition ina234.h:76
+
INA234_getADCRange
ADCRange INA234_getADCRange(INA234 *self)
Get the ADC full scale range of INA234.
Definition ina234.c:422
+
INA234_setADCRange
Status INA234_setADCRange(INA234 *self, ADCRange adc_range)
Set the ADC full scale range of INA234.
Definition ina234.c:283
+
AlertSource
AlertSource
Definition ina234.h:75
+
ALERT_DATA_READY
@ ALERT_DATA_READY
Definition ina234.h:75
+
ALERT_LIMIT_REACHED
@ ALERT_LIMIT_REACHED
Definition ina234.h:75
+
__INA234_writeTwoBytes
Status __INA234_writeTwoBytes(INA234 *self, uint8_t MemAddress)
Write two bytes (a 16bit register) to INA234 from the ina234::_reg::raw_data.
Definition ina234.c:258
+
INA234_readAll
void INA234_readAll(INA234 *self)
Read all of the measured values: Shunt voltage, bus voltage, power, and current. Then store the value...
Definition ina234.c:536
+
INA234_setMode
Status INA234_setMode(INA234 *self, Mode mode)
Set the operating mode.
Definition ina234.c:402
+
ConvTime
ConvTime
Definition ina234.h:68
+
CTIME_8244us
@ CTIME_8244us
Definition ina234.h:68
+
CTIME_588us
@ CTIME_588us
Definition ina234.h:68
+
CTIME_2116us
@ CTIME_2116us
Definition ina234.h:68
+
CTIME_4156us
@ CTIME_4156us
Definition ina234.h:68
+
CTIME_1100us
@ CTIME_1100us
Definition ina234.h:68
+
CTIME_332us
@ CTIME_332us
Definition ina234.h:68
+
CTIME_204us
@ CTIME_204us
Definition ina234.h:68
+
CTIME_140us
@ CTIME_140us
Definition ina234.h:68
+
INA234_getNumberOfADCSamples
NumSamples INA234_getNumberOfADCSamples(INA234 *self)
Get the number of ADC samples to calculate the average.
Definition ina234.c:440
+
INA234_setVShuntConversionTime
Status INA234_setVShuntConversionTime(INA234 *self, ConvTime vshunt_conversion_time)
Set the VShunt convertion period.
Definition ina234.c:373
+
AlertPolarity
AlertPolarity
Definition ina234.h:72
+
ALERT_ACTIVE_LOW
@ ALERT_ACTIVE_LOW
Definition ina234.h:72
+
ALERT_ACTIVE_HIGH
@ ALERT_ACTIVE_HIGH
Definition ina234.h:72
+
INA234_getManID
uint16_t INA234_getManID(INA234 *self)
Get the manufacturer ID.
Definition ina234.c:514
+
ADCRange
ADCRange
Definition ina234.h:66
+
RANGE_20_48mV
@ RANGE_20_48mV
Definition ina234.h:66
+
RANGE_81_92mV
@ RANGE_81_92mV
Definition ina234.h:66
+
NumSamples
NumSamples
Definition ina234.h:67
+
NADC_1024
@ NADC_1024
Definition ina234.h:67
+
NADC_16
@ NADC_16
Definition ina234.h:67
+
NADC_256
@ NADC_256
Definition ina234.h:67
+
NADC_1
@ NADC_1
Definition ina234.h:67
+
NADC_128
@ NADC_128
Definition ina234.h:67
+
NADC_64
@ NADC_64
Definition ina234.h:67
+
NADC_4
@ NADC_4
Definition ina234.h:67
+
NADC_512
@ NADC_512
Definition ina234.h:67
+
INA234_SoftResetAll
void INA234_SoftResetAll(INA234 *self)
Send a reset command to all of the INA234s on the bus.
Definition ina234.c:502
+
AlertConvReady
AlertConvReady
Definition ina234.h:74
+
ALERT_CONV_DISABLE
@ ALERT_CONV_DISABLE
Definition ina234.h:74
+
ALERT_CONV_ENABLE
@ ALERT_CONV_ENABLE
Definition ina234.h:74
+
INA234_alert_init
Status INA234_alert_init(INA234 *self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit)
Initialize the alert functionality of INA234 with the given configurations.
Definition ina234.c:174
+
ina234::_reg::_alert_limit_register
Definition ina234.h:138
+
ina234::_reg::_alert_limit_register::LIMIT
int16_t LIMIT
Definition ina234.h:139
+
ina234::_reg::_bus_voltage_register
Definition ina234.h:118
+
ina234::_reg::_bus_voltage_register::RESERVED2
uint16_t RESERVED2
Definition ina234.h:119
+
ina234::_reg::_bus_voltage_register::RESERVED
uint16_t RESERVED
Definition ina234.h:119
+
ina234::_reg::_bus_voltage_register::VBUS
uint16_t VBUS
Definition ina234.h:119
+
ina234::_reg::_calibration_register
Definition ina234.h:130
+
ina234::_reg::_calibration_register::SHUNT_CAL
uint16_t SHUNT_CAL
Definition ina234.h:131
+
ina234::_reg::_calibration_register::RESERVED
uint16_t RESERVED
Definition ina234.h:131
+
ina234::_reg::_config_register
Definition ina234.h:110
+
ina234::_reg::_config_register::VBUSCT
uint16_t VBUSCT
Definition ina234.h:111
+
ina234::_reg::_config_register::ACDRANGE
uint16_t ACDRANGE
Definition ina234.h:111
+
ina234::_reg::_config_register::RESERVED
uint16_t RESERVED
Definition ina234.h:111
+
ina234::_reg::_config_register::VSHCT
uint16_t VSHCT
Definition ina234.h:111
+
ina234::_reg::_config_register::MODE
uint16_t MODE
Definition ina234.h:111
+
ina234::_reg::_config_register::RST
uint16_t RST
Definition ina234.h:111
+
ina234::_reg::_config_register::AVG
uint16_t AVG
Definition ina234.h:111
+
ina234::_reg::_current_register
Definition ina234.h:126
+
ina234::_reg::_current_register::CURRENT
int16_t CURRENT
Definition ina234.h:127
+
ina234::_reg::_current_register::RESERVED
int16_t RESERVED
Definition ina234.h:127
+
ina234::_reg::_devide_id_register
Definition ina234.h:146
+
ina234::_reg::_devide_id_register::DIEID
uint16_t DIEID
Definition ina234.h:147
+
ina234::_reg::_devide_id_register::RESERVED
uint16_t RESERVED
Definition ina234.h:147
+
ina234::_reg::_manufacture_id_register
Definition ina234.h:142
+
ina234::_reg::_manufacture_id_register::MANUFACTURE_ID
uint16_t MANUFACTURE_ID
Definition ina234.h:143
+
ina234::_reg::_mask_enable_register
Definition ina234.h:134
+
ina234::_reg::_mask_enable_register::LEN
uint16_t LEN
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::BOL
uint16_t BOL
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::APOL
uint16_t APOL
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::SOL
uint16_t SOL
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::AFF
uint16_t AFF
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::MemError
uint16_t MemError
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::OVF
uint16_t OVF
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::RESERVED
uint16_t RESERVED
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::POL
uint16_t POL
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::CNVR
uint16_t CNVR
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::BUL
uint16_t BUL
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::SUL
uint16_t SUL
Definition ina234.h:135
+
ina234::_reg::_mask_enable_register::CVRF
uint16_t CVRF
Definition ina234.h:135
+
ina234::_reg::_power_register
Definition ina234.h:122
+
ina234::_reg::_power_register::POWER
uint16_t POWER
Definition ina234.h:123
+
ina234::_reg::_shunt_voltage_register
Definition ina234.h:114
+
ina234::_reg::_shunt_voltage_register::VSHUNT
int16_t VSHUNT
Definition ina234.h:115
+
ina234::_reg::_shunt_voltage_register::RESERVED
int16_t RESERVED
Definition ina234.h:115
+
ina234
Class (struct) that stores variables for interacting with INA234.
Definition ina234.h:81
+
ina234::mode
Mode mode
Definition ina234.h:91
+
ina234::alert_latch
AlertLatch alert_latch
Definition ina234.h:97
+
ina234::number_of_adc_samples
NumSamples number_of_adc_samples
Definition ina234.h:88
+
ina234::ShuntResistor
float ShuntResistor
Definition ina234.h:92
+
ina234::alert_conv_ready
AlertConvReady alert_conv_ready
Definition ina234.h:98
+
ina234::BusVoltage
float BusVoltage
Definition ina234.h:103
+
ina234::vshunt_conversion_time
ConvTime vshunt_conversion_time
Definition ina234.h:90
+
ina234::alert_on
AlertOn alert_on
Definition ina234.h:95
+
ina234::alert_polarity
AlertPolarity alert_polarity
Definition ina234.h:96
+
ina234::reg
union ina234::_reg reg
+
ina234::hi2c
I2C_HandleTypeDef * hi2c
Definition ina234.h:83
+
ina234::vbus_conversion_time
ConvTime vbus_conversion_time
Definition ina234.h:89
+
ina234::ShuntVoltage
float ShuntVoltage
Definition ina234.h:102
+
ina234::I2C_ADDR
uint8_t I2C_ADDR
Definition ina234.h:84
+
ina234::alert_limit
float alert_limit
Definition ina234.h:99
+
ina234::alert_limit_int
int32_t alert_limit_int
Definition ina234.h:100
+
ina234::Current
float Current
Definition ina234.h:105
+
ina234::Power
float Power
Definition ina234.h:104
+
ina234::adc_range
ADCRange adc_range
Definition ina234.h:87
+
ina234::_reg
Definition ina234.h:107
+
ina234::_reg::manufacture_id_register
struct ina234::_reg::_manufacture_id_register manufacture_id_register
+
ina234::_reg::raw_data
uint8_t raw_data[2]
Definition ina234.h:108
+
ina234::_reg::mask_enable_register
struct ina234::_reg::_mask_enable_register mask_enable_register
+
ina234::_reg::bus_voltage_register
struct ina234::_reg::_bus_voltage_register bus_voltage_register
+
ina234::_reg::shunt_voltage_register
struct ina234::_reg::_shunt_voltage_register shunt_voltage_register
+
ina234::_reg::devide_id_register
struct ina234::_reg::_devide_id_register devide_id_register
+
ina234::_reg::config_register
struct ina234::_reg::_config_register config_register
+
ina234::_reg::current_register
struct ina234::_reg::_current_register current_register
+
ina234::_reg::alert_limit_register
struct ina234::_reg::_alert_limit_register alert_limit_register
+
ina234::_reg::power_register
struct ina234::_reg::_power_register power_register
+
ina234::_reg::calibration_register
struct ina234::_reg::_calibration_register calibration_register
+
+
+ + + + diff --git a/index.html b/index.html index 4b0cd44..23e344e 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ -INA234 HAL Based Library: Main Page +INA234 HAL Based Library: INA234 current/voltage/power monitor library @@ -95,10 +95,25 @@ -
-
INA234 HAL Based Library Documentation
+
+
INA234 current/voltage/power monitor library
+

+Introduction

+

The INA234 device is a 12-bit digital current monitor with an I2C/SMBus-compatible interface that is compliant with a wide range of digital bus voltages such as 1.2 V, 1.8 V, 3.3 V, and 5.0 V. The device monitors the voltage across an external sense resistor and reports values for current, bus voltage, and power.

+

The INA234 features programmable ADC conversion times and averaging. The device also has a programmable calibration value with an internal multiplier that enables direct readouts of current in amperes and power in watts. The device monitors the bus voltage present on the IN- pin and can alert on overcurent and undercurrent conditions as well as overvoltage and undervoltage conditions. High input impedance while in current measurement mode allows use of larger current sense resistors needed to measure small value system currents.

+

The INA234 senses current on common-mode bus voltages that can vary from -0.3 V to 28 V, independent of the supply voltage. The device operates from a single 1.7-V to 5.5-V supply, drawing a typical supply current of 300 uA in normal operation. The device can be placed in a low-power standby mode where the typical operating current is 2.2 uA.

+

+Author

+

Written by Salman Motlaq (@SMotlaq on Github)

+

+License

+

MIT License

+

+Getting Started

+

Go to my Github page to get started. You can also see the functions list to learn more.

+
diff --git a/index.js b/index.js new file mode 100644 index 0000000..95dc49d --- /dev/null +++ b/index.js @@ -0,0 +1,7 @@ +var index = +[ + [ "Introduction", "index.html#intro_sec", null ], + [ "Author", "index.html#author", null ], + [ "License", "index.html#license", null ], + [ "Getting Started", "index.html#start", null ] +]; \ No newline at end of file diff --git a/md_README.html b/md_README.html new file mode 100644 index 0000000..c04a6d6 --- /dev/null +++ b/md_README.html @@ -0,0 +1,114 @@ + + + + + + + +INA234 HAL Based Library: INA234 HAL Based Library + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
INA234 HAL Based Library
+
+
+

+

Hi

+
+
+
+ + + + diff --git a/menudata.js b/menudata.js index d1ece13..d7afac5 100644 --- a/menudata.js +++ b/menudata.js @@ -23,4 +23,69 @@ @licend The above is the entire license notice for the JavaScript code in this file */ var menudata={children:[ -{text:"Main Page",url:"index.html"}]} +{text:"Main Page",url:"index.html"}, +{text:"Related Pages",url:"pages.html"}, +{text:"Data Structures",url:"annotated.html",children:[ +{text:"Data Structures",url:"annotated.html"}, +{text:"Data Structure Index",url:"classes.html"}, +{text:"Data Fields",url:"functions.html",children:[ +{text:"All",url:"functions.html",children:[ +{text:"a",url:"functions.html#index_a"}, +{text:"b",url:"functions.html#index_b"}, +{text:"c",url:"functions.html#index_c"}, +{text:"d",url:"functions.html#index_d"}, +{text:"h",url:"functions.html#index_h"}, +{text:"i",url:"functions.html#index_i"}, +{text:"l",url:"functions.html#index_l"}, +{text:"m",url:"functions.html#index_m"}, +{text:"n",url:"functions.html#index_n"}, +{text:"o",url:"functions.html#index_o"}, +{text:"p",url:"functions.html#index_p"}, +{text:"r",url:"functions.html#index_r"}, +{text:"s",url:"functions.html#index_s"}, +{text:"v",url:"functions.html#index_v"}]}, +{text:"Variables",url:"functions_vars.html",children:[ +{text:"a",url:"functions_vars.html#index_a"}, +{text:"b",url:"functions_vars.html#index_b"}, +{text:"c",url:"functions_vars.html#index_c"}, +{text:"d",url:"functions_vars.html#index_d"}, +{text:"h",url:"functions_vars.html#index_h"}, +{text:"i",url:"functions_vars.html#index_i"}, +{text:"l",url:"functions_vars.html#index_l"}, +{text:"m",url:"functions_vars.html#index_m"}, +{text:"n",url:"functions_vars.html#index_n"}, +{text:"o",url:"functions_vars.html#index_o"}, +{text:"p",url:"functions_vars.html#index_p"}, +{text:"r",url:"functions_vars.html#index_r"}, +{text:"s",url:"functions_vars.html#index_s"}, +{text:"v",url:"functions_vars.html#index_v"}]}]}]}, +{text:"Files",url:"files.html",children:[ +{text:"File List",url:"files.html"}, +{text:"Globals",url:"globals.html",children:[ +{text:"All",url:"globals.html",children:[ +{text:"_",url:"globals.html#index__5F"}, +{text:"a",url:"globals.html#index_a"}, +{text:"b",url:"globals.html#index_b"}, +{text:"c",url:"globals.html#index_c"}, +{text:"d",url:"globals.html#index_d"}, +{text:"e",url:"globals.html#index_e"}, +{text:"i",url:"globals.html#index_i"}, +{text:"m",url:"globals.html#index_m"}, +{text:"n",url:"globals.html#index_n"}, +{text:"p",url:"globals.html#index_p"}, +{text:"r",url:"globals.html#index_r"}, +{text:"s",url:"globals.html#index_s"}]}, +{text:"Functions",url:"globals_func.html",children:[ +{text:"_",url:"globals_func.html#index__5F"}, +{text:"i",url:"globals_func.html#index_i"}]}, +{text:"Typedefs",url:"globals_type.html"}, +{text:"Enumerations",url:"globals_enum.html"}, +{text:"Enumerator",url:"globals_eval.html",children:[ +{text:"a",url:"globals_eval.html#index_a"}, +{text:"c",url:"globals_eval.html#index_c"}, +{text:"e",url:"globals_eval.html#index_e"}, +{text:"m",url:"globals_eval.html#index_m"}, +{text:"n",url:"globals_eval.html#index_n"}, +{text:"r",url:"globals_eval.html#index_r"}, +{text:"s",url:"globals_eval.html#index_s"}]}, +{text:"Macros",url:"globals_defs.html"}]}]}]} diff --git a/navtreedata.js b/navtreedata.js index 96ad7a6..b677273 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -24,12 +24,34 @@ */ var NAVTREE = [ - [ "INA234 HAL Based Library", "index.html", ] + [ "INA234 HAL Based Library", "index.html", [ + [ "INA234 current/voltage/power monitor library", "index.html", "index" ], + [ "INA234 HAL Based Library", "md_README.html", null ], + [ "Data Structures", "annotated.html", [ + [ "Data Structures", "annotated.html", "annotated_dup" ], + [ "Data Structure Index", "classes.html", null ], + [ "Data Fields", "functions.html", [ + [ "All", "functions.html", null ], + [ "Variables", "functions_vars.html", null ] + ] ] + ] ], + [ "Files", "files.html", [ + [ "File List", "files.html", "files_dup" ], + [ "Globals", "globals.html", [ + [ "All", "globals.html", null ], + [ "Functions", "globals_func.html", null ], + [ "Typedefs", "globals_type.html", null ], + [ "Enumerations", "globals_enum.html", null ], + [ "Enumerator", "globals_eval.html", null ], + [ "Macros", "globals_defs.html", null ] + ] ] + ] ] + ] ] ]; var NAVTREEINDEX = [ -"index.html" +"annotated.html" ]; var SYNCONMSG = 'click to disable panel synchronisation'; diff --git a/navtreeindex0.js b/navtreeindex0.js index 9e75a21..ea69f70 100644 --- a/navtreeindex0.js +++ b/navtreeindex0.js @@ -1,5 +1,239 @@ var NAVTREEINDEX0 = { +"annotated.html":[2,0], +"classes.html":[2,1], +"files.html":[3,0], +"functions.html":[2,2,0], +"functions_vars.html":[2,2,1], +"globals.html":[3,1,0], +"globals_defs.html":[3,1,5], +"globals_enum.html":[3,1,3], +"globals_eval.html":[3,1,4], +"globals_func.html":[3,1,1], +"globals_type.html":[3,1,2], +"ina234_8c.html":[3,0,0], +"ina234_8c.html#a14a3383eba06ce784ed526585a0cef9a":[3,0,0,8], +"ina234_8c.html#a163121f0afcab9a5e49f419b94290f20":[3,0,0,12], +"ina234_8c.html#a21acc30b187445a98f711a54b8678c7c":[3,0,0,16], +"ina234_8c.html#a256f66571357742aec8b4f0104c54b6b":[3,0,0,13], +"ina234_8c.html#a4af7c34341c14b8bfb40daf0665a766c":[3,0,0,10], +"ina234_8c.html#a52cc3b785dea1f5af6f0803f02fcefdb":[3,0,0,4], +"ina234_8c.html#a5810f9a740226a39ba5cc2afa6b64f77":[3,0,0,19], +"ina234_8c.html#a6afffb92bb828562997a6a5592bc141a":[3,0,0,15], +"ina234_8c.html#a825a355395fef312e3642f9f8ca6463c":[3,0,0,6], +"ina234_8c.html#a84ff6173bf6cfa44348ba259a503c804":[3,0,0,22], +"ina234_8c.html#a88ff1503798836270a41d3b9f3913ca7":[3,0,0,7], +"ina234_8c.html#a94ec7dc7cd10748c4ed822266174d0ff":[3,0,0,23], +"ina234_8c.html#a9637d475148409297883f05464a92e86":[3,0,0,17], +"ina234_8c.html#a97ec39b6399d3ab449e499a57668748d":[3,0,0,5], +"ina234_8c.html#aa36cf3308ef4df72ddf8a78edff23556":[3,0,0,0], +"ina234_8c.html#aa3f6130fa6074b931f415e9ca85f340d":[3,0,0,14], +"ina234_8c.html#ab9f2d8b23628fb6b060f837b9a4f71a5":[3,0,0,3], +"ina234_8c.html#aba71c63deed65a0abdbf7269b5f382d8":[3,0,0,20], +"ina234_8c.html#ac08e0ed8b382a2dd193753a2b302bae1":[3,0,0,1], +"ina234_8c.html#ac7901cf62e078ff3a235839061a3608b":[3,0,0,18], +"ina234_8c.html#ac85c8e736ffae6d248971091b374d00f":[3,0,0,21], +"ina234_8c.html#acda6b9d24c842d73ffca341ce39ac707":[3,0,0,11], +"ina234_8c.html#ad19627414a2465c9cf1fac54f54eaa39":[3,0,0,24], +"ina234_8c.html#ae646f51adec51af1aa6377c3dffeeb6a":[3,0,0,9], +"ina234_8c.html#af3d939ea27371b17fd265f19957234b2":[3,0,0,25], +"ina234_8c.html#afb44437883ad8f8d08aaf695815da7ed":[3,0,0,2], +"ina234_8h.html":[3,0,1], +"ina234_8h.html#a0ee8a79a292d53863aff0274ca030f5a":[3,0,1,37], +"ina234_8h.html#a1324293b60f4d902ebc99cf0d31bad89":[3,0,1,36], +"ina234_8h.html#a14a3383eba06ce784ed526585a0cef9a":[3,0,1,60], +"ina234_8h.html#a163121f0afcab9a5e49f419b94290f20":[3,0,1,64], +"ina234_8h.html#a21acc30b187445a98f711a54b8678c7c":[3,0,1,68], +"ina234_8h.html#a238936614e386e75f2487559953cbc68":[3,0,1,20], +"ina234_8h.html#a256f66571357742aec8b4f0104c54b6b":[3,0,1,65], +"ina234_8h.html#a27e0b80eae69f3ea0f661dea593912c8":[3,0,1,38], +"ina234_8h.html#a3640431a41e460b8e7ddf642adefae95":[3,0,1,19], +"ina234_8h.html#a3872be266ee7297b319f93420303a008":[3,0,1,34], +"ina234_8h.html#a3bce910f55e3b114067517de3ca4ff28":[3,0,1,39], +"ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911":[3,0,1,49], +"ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a0680164b529f8d29d670308298ec2a2b":[3,0,1,49,0], +"ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a28192c7eb7daf555e5eb9def6b82c2db":[3,0,1,49,4], +"ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a6cba4ffadd57ed1e5f5a176ab21f4e85":[3,0,1,49,6], +"ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a7bc1351d315d165a969fe64c964da364":[3,0,1,49,7], +"ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a9f304d5978fa9370e3cd0da297f85470":[3,0,1,49,2], +"ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911aa90b94d7cd6425245221d504534f0f2f":[3,0,1,49,1], +"ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911ab729c3948326475cd19e84a433ae96bd":[3,0,1,49,3], +"ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911ac089fb7ab69f944b618f18abe16b3600":[3,0,1,49,5], +"ina234_8h.html#a48ce45ec20267ca3c0159a444dc30c33":[3,0,1,18], +"ina234_8h.html#a4af7c34341c14b8bfb40daf0665a766c":[3,0,1,62], +"ina234_8h.html#a52cc3b785dea1f5af6f0803f02fcefdb":[3,0,1,56], +"ina234_8h.html#a5810f9a740226a39ba5cc2afa6b64f77":[3,0,1,71], +"ina234_8h.html#a59ac6513a4c0c951eff022338ea6e9f6":[3,0,1,40], +"ina234_8h.html#a646eb67bd8e213ae03c5a03e6a569788":[3,0,1,14], +"ina234_8h.html#a650dc7cee4ad520ed3fa35dbe7142216":[3,0,1,29], +"ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b":[3,0,1,51], +"ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba7e4a42e3b6dd63708c64cf3db6f69566":[3,0,1,51,0], +"ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70bafddcb825c6c18107885a7d663dcf38e7":[3,0,1,51,1], +"ina234_8h.html#a6afffb92bb828562997a6a5592bc141a":[3,0,1,67], +"ina234_8h.html#a6be1753fa6a5ab6a2afa25019e635f5f":[3,0,1,32], +"ina234_8h.html#a731f54cd49fcbbca608bfbe367c75dfb":[3,0,1,25], +"ina234_8h.html#a74f38e65a7114a53a324d460820a43a4":[3,0,1,33], +"ina234_8h.html#a775ced70ffbd32f6fb31cbb10a10187f":[3,0,1,13], +"ina234_8h.html#a7ee3d94a0cd2d145d66bae6abe5bb302":[3,0,1,16], +"ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4":[3,0,1,44], +"ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a1ca5e700ee55d0dc367e350b23f11ec9":[3,0,1,44,3], +"ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a34e2f0c08f8c607c6bef4c42a1650fb3":[3,0,1,44,5], +"ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a948a648cb59cafcc5382b1b5e599d28b":[3,0,1,44,2], +"ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a94ace1d59fb93b2a18d3f81347d85baf":[3,0,1,44,4], +"ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4ab84e7751ae498fa5f6354fec90392f84":[3,0,1,44,0], +"ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4adf6cdb85c8967fba23a0f0244b49057c":[3,0,1,44,1], +"ina234_8h.html#a81ed9fb0bd16f43a3a5bc335f966a96f":[3,0,1,17], +"ina234_8h.html#a8243b56922df1eafe7faf2f5231642b6":[3,0,1,21], +"ina234_8h.html#a825a355395fef312e3642f9f8ca6463c":[3,0,1,58], +"ina234_8h.html#a848ebbc680edb7898d7edc1ca52a0d37":[3,0,1,30], +"ina234_8h.html#a84ff6173bf6cfa44348ba259a503c804":[3,0,1,74], +"ina234_8h.html#a88ff1503798836270a41d3b9f3913ca7":[3,0,1,59], +"ina234_8h.html#a8c0e636ce427d3785aea74926fabc624":[3,0,1,26], +"ina234_8h.html#a93329758cb0f2c6f52cffd48b8f961c8":[3,0,1,27], +"ina234_8h.html#a94ec7dc7cd10748c4ed822266174d0ff":[3,0,1,75], +"ina234_8h.html#a9524876614527f1c1cad905b5586a61c":[3,0,1,43], +"ina234_8h.html#a9524876614527f1c1cad905b5586a61ca8e18da66cd5b403de50cd5cea2867a01":[3,0,1,43,0], +"ina234_8h.html#a9524876614527f1c1cad905b5586a61cae66cf6808527fe59bda82112ea1f0626":[3,0,1,43,1], +"ina234_8h.html#a9637d475148409297883f05464a92e86":[3,0,1,69], +"ina234_8h.html#a97ec39b6399d3ab449e499a57668748d":[3,0,1,57], +"ina234_8h.html#aa36cf3308ef4df72ddf8a78edff23556":[3,0,1,52], +"ina234_8h.html#aa3f6130fa6074b931f415e9ca85f340d":[3,0,1,66], +"ina234_8h.html#aa417fcb934d07b4af5c20c44b920e5ae":[3,0,1,28], +"ina234_8h.html#ab01b539856e5c5102cd3d97a38435d26":[3,0,1,24], +"ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45a":[3,0,1,48], +"ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa2a372620a5d99a4790787150ebe2a92c":[3,0,1,48,2], +"ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa4a2fc9e6bcb0135acd74edfec8554512":[3,0,1,48,3], +"ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa4edc8aade11e1de7bbbdc04704baae5f":[3,0,1,48,0], +"ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa632a15615c9d0f691788ab4f0a66e41d":[3,0,1,48,1], +"ina234_8h.html#ab303d390218c5cf7c69501e0559213ec":[3,0,1,35], +"ina234_8h.html#ab59d55e52855c8c0f649304fa92a9a13":[3,0,1,15], +"ina234_8h.html#ab843670bdea443688a3c0fc1bb59df4c":[3,0,1,12], +"ina234_8h.html#ab9f2d8b23628fb6b060f837b9a4f71a5":[3,0,1,55], +"ina234_8h.html#aba71c63deed65a0abdbf7269b5f382d8":[3,0,1,72], +"ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8":[3,0,1,46], +"ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8a83f1800832e2ed9bc6691a53c9a1359d":[3,0,1,46,0], +"ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8aea5a0da07bc6063e3ad1f5bc0332dc65":[3,0,1,46,1], +"ina234_8h.html#ac08e0ed8b382a2dd193753a2b302bae1":[3,0,1,53], +"ina234_8h.html#ac7901cf62e078ff3a235839061a3608b":[3,0,1,70], +"ina234_8h.html#ac85c8e736ffae6d248971091b374d00f":[3,0,1,73], +"ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6":[3,0,1,47], +"ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a08b6eaecf78753c12f67dddf9949be84":[3,0,1,47,7], +"ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a2fe24ae5755ffeb5b8082cd037b9dc7f":[3,0,1,47,3], +"ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a47c6de263bc91c68cc7aa33fa4ff0755":[3,0,1,47,5], +"ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a657a9b9f4cabd5ca90fee02c26638a04":[3,0,1,47,6], +"ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a65ed0d16270a6141ab8dd8488fe7f41e":[3,0,1,47,4], +"ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6abfd7d84dee689ba2bb2f17da3d09ac9a":[3,0,1,47,2], +"ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6ac369ab9b892e484bf6f6e1c62cdf89a8":[3,0,1,47,1], +"ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6acfaa6a642034e5c48d5f172355a0e22d":[3,0,1,47,0], +"ina234_8h.html#acda6b9d24c842d73ffca341ce39ac707":[3,0,1,63], +"ina234_8h.html#ad157a86c3b3394bca27e86844852ee04":[3,0,1,23], +"ina234_8h.html#ad19627414a2465c9cf1fac54f54eaa39":[3,0,1,76], +"ina234_8h.html#ada37218468b40fbf8e3f7951165cf634":[3,0,1,45], +"ina234_8h.html#ada37218468b40fbf8e3f7951165cf634ac517f2dbfd71d39c6277a02c6a8e98b5":[3,0,1,45,0], +"ina234_8h.html#ada37218468b40fbf8e3f7951165cf634acc90eec8b0cea31c65d2125e1dec4b3d":[3,0,1,45,1], +"ina234_8h.html#ae646f51adec51af1aa6377c3dffeeb6a":[3,0,1,61], +"ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fc":[3,0,1,41], +"ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fca39711bc57d71a9e56b586578de4da136":[3,0,1,41,1], +"ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fcac35ce98e9a40c62ca3ce4054c4d72bb5":[3,0,1,41,0], +"ina234_8h.html#ae92b8bbb58abb306563771a0149472d2":[3,0,1,22], +"ina234_8h.html#aeec3587067ff840117ceeb10b98eda58":[3,0,1,50], +"ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a02bba2371c7cc4740a4bcccc82da45d7":[3,0,1,50,7], +"ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a3a1205ed5042c059ebf47784254d1f29":[3,0,1,50,2], +"ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a91a4d2241e749494be617d895d318589":[3,0,1,50,5], +"ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a993c043bbf51fcb3e71e24560079b3e0":[3,0,1,50,0], +"ina234_8h.html#aeec3587067ff840117ceeb10b98eda58aa7cf4006919e212a7d722e96c826fa8d":[3,0,1,50,4], +"ina234_8h.html#aeec3587067ff840117ceeb10b98eda58abdcabf69ca2812231b1ee322cda057d1":[3,0,1,50,3], +"ina234_8h.html#aeec3587067ff840117ceeb10b98eda58ac9dd4285a560c534d22fca6840d0ebf5":[3,0,1,50,1], +"ina234_8h.html#aeec3587067ff840117ceeb10b98eda58af045584cc242ad52f42910989945250f":[3,0,1,50,6], +"ina234_8h.html#af3d939ea27371b17fd265f19957234b2":[3,0,1,77], +"ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4":[3,0,1,42], +"ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4a083db3ebfb856b3fb387dd31d856c0c8":[3,0,1,42,0], +"ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4a5e0027e4e01b269be48d60a41243d854":[3,0,1,42,1], +"ina234_8h.html#afb44437883ad8f8d08aaf695815da7ed":[3,0,1,54], +"ina234_8h.html#afc7b0844b88c911005553dd08939b096":[3,0,1,31], +"ina234_8h_source.html":[3,0,1], "index.html":[], -"pages.html":[] +"index.html":[0], +"index.html#author":[0,1], +"index.html#intro_sec":[0,0], +"index.html#license":[0,2], +"index.html#start":[0,3], +"md_README.html":[1], +"pages.html":[], +"structina234.html":[2,0,0], +"structina234.html#a2618e89b4c26dc851feae865df3a1a49":[2,0,0,12], +"structina234.html#a2a7579503920bd539e301005e0a000f9":[2,0,0,3], +"structina234.html#a2ab8a9d5ad14120cc622664faf5d9fef":[2,0,0,13], +"structina234.html#a2e10662b238ee4fa108ca0792851d136":[2,0,0,16], +"structina234.html#a3c24a2f4305134b1da6f3a4a7515608b":[2,0,0,2], +"structina234.html#a4cf12f3449e646afc1f8cc93a5264589":[2,0,0,8], +"structina234.html#a5675cd02ce9e463e2bb990cdd56b7e8a":[2,0,0,19], +"structina234.html#a88e4987220f0aeb0da2a012b9590201a":[2,0,0,6], +"structina234.html#a899269e44feff92f5675821efc09fbd5":[2,0,0,7], +"structina234.html#ab54a1e11860021b67b7c73b923423ae7":[2,0,0,15], +"structina234.html#abf45242a4a812df409b53ce5216f8d7e":[2,0,0,10], +"structina234.html#ac0ebad16cd5b42cd142546eab3aef22e":[2,0,0,18], +"structina234.html#ac63c1ad335c16bcdb33b5e55cf773ad3":[2,0,0,17], +"structina234.html#acede59719bc6487dd599349740fa29fc":[2,0,0,11], +"structina234.html#acf7d16f76c1d445ce5a62d94fad9472f":[2,0,0,4], +"structina234.html#ad2f27d00ab89273641b8c85897f63578":[2,0,0,5], +"structina234.html#ae8d3473f04d1b074e042108e0816efe6":[2,0,0,9], +"structina234.html#aeca176f09c48cbe15df7fc4fff7c77f7":[2,0,0,14], +"structina234.html#af614e8e36e36f2703a95b4cf98e6e47c":[2,0,0,1], +"structina234_1_1__reg_1_1__alert__limit__register.html":[2,0,0,0,0], +"structina234_1_1__reg_1_1__alert__limit__register.html#a8f69b5d3049c8432f1a7c671b7e759aa":[2,0,0,0,0,0], +"structina234_1_1__reg_1_1__bus__voltage__register.html":[2,0,0,0,1], +"structina234_1_1__reg_1_1__bus__voltage__register.html#a5573848497a716a9947fd87487709feb":[2,0,0,0,1,1], +"structina234_1_1__reg_1_1__bus__voltage__register.html#a9484db76faad15bb8da293c622dd2269":[2,0,0,0,1,0], +"structina234_1_1__reg_1_1__bus__voltage__register.html#adf5c609e86df6632a09ad897c2eb4e94":[2,0,0,0,1,2], +"structina234_1_1__reg_1_1__calibration__register.html":[2,0,0,0,2], +"structina234_1_1__reg_1_1__calibration__register.html#a115d21bedd85f661114c0c719fc22da0":[2,0,0,0,2,1], +"structina234_1_1__reg_1_1__calibration__register.html#a9484db76faad15bb8da293c622dd2269":[2,0,0,0,2,0], +"structina234_1_1__reg_1_1__config__register.html":[2,0,0,0,3], +"structina234_1_1__reg_1_1__config__register.html#a2854a902bb3af04427b00a8472b0cbb8":[2,0,0,0,3,5], +"structina234_1_1__reg_1_1__config__register.html#a2cae4ff84c5462b931bd99ef5a3434e8":[2,0,0,0,3,0], +"structina234_1_1__reg_1_1__config__register.html#a9484db76faad15bb8da293c622dd2269":[2,0,0,0,3,3], +"structina234_1_1__reg_1_1__config__register.html#a9efa998f60c85d1bdd04cc3dd4bdc693":[2,0,0,0,3,6], +"structina234_1_1__reg_1_1__config__register.html#abd348ee828aadd0781f3fa97d167e564":[2,0,0,0,3,2], +"structina234_1_1__reg_1_1__config__register.html#abef8327bfd071009d10633030379e701":[2,0,0,0,3,4], +"structina234_1_1__reg_1_1__config__register.html#ae5a0c05847ffa0e32d0903a07261dd71":[2,0,0,0,3,1], +"structina234_1_1__reg_1_1__current__register.html":[2,0,0,0,4], +"structina234_1_1__reg_1_1__current__register.html#a2ed399eace19c88cda48107e537271d2":[2,0,0,0,4,0], +"structina234_1_1__reg_1_1__current__register.html#aa42491e0ff1ccdf2056d947f78957917":[2,0,0,0,4,1], +"structina234_1_1__reg_1_1__devide__id__register.html":[2,0,0,0,5], +"structina234_1_1__reg_1_1__devide__id__register.html#a1c2fbd56052f9cd2aedf35c988950eb8":[2,0,0,0,5,0], +"structina234_1_1__reg_1_1__devide__id__register.html#a9484db76faad15bb8da293c622dd2269":[2,0,0,0,5,1], +"structina234_1_1__reg_1_1__manufacture__id__register.html":[2,0,0,0,6], +"structina234_1_1__reg_1_1__manufacture__id__register.html#ae9ec42bcafa5e076b6489e0aa8373d58":[2,0,0,0,6,0], +"structina234_1_1__reg_1_1__mask__enable__register.html":[2,0,0,0,7], +"structina234_1_1__reg_1_1__mask__enable__register.html#a045f31cd5049e505de87de0f6ff32d48":[2,0,0,0,7,6], +"structina234_1_1__reg_1_1__mask__enable__register.html#a0523a734c855650be9b9f060fc3cdf75":[2,0,0,0,7,2], +"structina234_1_1__reg_1_1__mask__enable__register.html#a1b52d5c7b321b1a00b920df8aaef4ebb":[2,0,0,0,7,1], +"structina234_1_1__reg_1_1__mask__enable__register.html#a5c27f0c90ddb7694a7242366879d4685":[2,0,0,0,7,11], +"structina234_1_1__reg_1_1__mask__enable__register.html#a5fe2c3e0f082c277a47c739bb4c050f0":[2,0,0,0,7,0], +"structina234_1_1__reg_1_1__mask__enable__register.html#a848f62ff7c149d4e1767499eca44f0e6":[2,0,0,0,7,7], +"structina234_1_1__reg_1_1__mask__enable__register.html#a924358cdfd4563e425c05b90f7f1b733":[2,0,0,0,7,8], +"structina234_1_1__reg_1_1__mask__enable__register.html#a9484db76faad15bb8da293c622dd2269":[2,0,0,0,7,10], +"structina234_1_1__reg_1_1__mask__enable__register.html#aa0b57507453cd43c4b79df8fcee20978":[2,0,0,0,7,9], +"structina234_1_1__reg_1_1__mask__enable__register.html#ab967f10721179bd6819267d3f28e7823":[2,0,0,0,7,4], +"structina234_1_1__reg_1_1__mask__enable__register.html#ad8d9d3c9c1f94b7a3685b53757033c55":[2,0,0,0,7,3], +"structina234_1_1__reg_1_1__mask__enable__register.html#ad8db42637055a897799c867c554ebdbe":[2,0,0,0,7,12], +"structina234_1_1__reg_1_1__mask__enable__register.html#afb1d44ecc07606d4604568fb8ac74a32":[2,0,0,0,7,5], +"structina234_1_1__reg_1_1__power__register.html":[2,0,0,0,8], +"structina234_1_1__reg_1_1__power__register.html#a8ef2a47bcdbc2202d402528a15b9a0a3":[2,0,0,0,8,0], +"structina234_1_1__reg_1_1__shunt__voltage__register.html":[2,0,0,0,9], +"structina234_1_1__reg_1_1__shunt__voltage__register.html#a66e0475d4572f9d2c526cdc06c229ae6":[2,0,0,0,9,1], +"structina234_1_1__reg_1_1__shunt__voltage__register.html#aa42491e0ff1ccdf2056d947f78957917":[2,0,0,0,9,0], +"unionina234_1_1__reg.html":[2,0,0,0], +"unionina234_1_1__reg.html#a1e929abda30270e8b0eda26e26d68f83":[2,0,0,0,16], +"unionina234_1_1__reg.html#a212c976969c3d66f4b79de05921422b5":[2,0,0,0,19], +"unionina234_1_1__reg.html#a2fa3a9f20fd08972d7968962ee824d4b":[2,0,0,0,17], +"unionina234_1_1__reg.html#a369b998af644dc917134f6075b6d0d8e":[2,0,0,0,11], +"unionina234_1_1__reg.html#a5788ff3d34c964926fed0bebed42e3ac":[2,0,0,0,20], +"unionina234_1_1__reg.html#a99a13b89ff65812966f048cc413de88e":[2,0,0,0,15], +"unionina234_1_1__reg.html#a99cf80892bd6eb97d2dfe5d8094d4375":[2,0,0,0,13], +"unionina234_1_1__reg.html#ab8acdea3a879f282b66100182c706b9b":[2,0,0,0,14], +"unionina234_1_1__reg.html#acee2fbb0cc5b0af342d28004e1421fc8":[2,0,0,0,10], +"unionina234_1_1__reg.html#adc2d71b0b9e065cf1fb9086b2834c3f1":[2,0,0,0,18], +"unionina234_1_1__reg.html#af8c8679ad9234831937cf17e85935231":[2,0,0,0,12] }; diff --git a/pages.html b/pages.html new file mode 100644 index 0000000..2d14174 --- /dev/null +++ b/pages.html @@ -0,0 +1,116 @@ + + + + + + + +INA234 HAL Based Library: Related Pages + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
Related Pages
+
+
+
Here is a list of all related documentation pages:
+ + +
 INA234 HAL Based Library
+
+
+
+ + + + diff --git a/search/all_0.js b/search/all_0.js new file mode 100644 index 0000000..be87b8b --- /dev/null +++ b/search/all_0.js @@ -0,0 +1,16 @@ +var searchData= +[ + ['_5f_5fina234_5freadtwobytes_0',['__INA234_readTwoBytes',['../ina234_8c.html#aa36cf3308ef4df72ddf8a78edff23556',1,'__INA234_readTwoBytes(INA234 *self, uint8_t MemAddress): ina234.c'],['../ina234_8h.html#aa36cf3308ef4df72ddf8a78edff23556',1,'__INA234_readTwoBytes(INA234 *self, uint8_t MemAddress): ina234.c']]], + ['_5f_5fina234_5fwritetwobytes_1',['__INA234_writeTwoBytes',['../ina234_8c.html#ac08e0ed8b382a2dd193753a2b302bae1',1,'__INA234_writeTwoBytes(INA234 *self, uint8_t MemAddress): ina234.c'],['../ina234_8h.html#ac08e0ed8b382a2dd193753a2b302bae1',1,'__INA234_writeTwoBytes(INA234 *self, uint8_t MemAddress): ina234.c']]], + ['_5falert_5flimit_5fregister_2',['_alert_limit_register',['../structina234_1_1__reg_1_1__alert__limit__register.html',1,'ina234::_reg']]], + ['_5fbus_5fvoltage_5fregister_3',['_bus_voltage_register',['../structina234_1_1__reg_1_1__bus__voltage__register.html',1,'ina234::_reg']]], + ['_5fcalibration_5fregister_4',['_calibration_register',['../structina234_1_1__reg_1_1__calibration__register.html',1,'ina234::_reg']]], + ['_5fconfig_5fregister_5',['_config_register',['../structina234_1_1__reg_1_1__config__register.html',1,'ina234::_reg']]], + ['_5fcurrent_5fregister_6',['_current_register',['../structina234_1_1__reg_1_1__current__register.html',1,'ina234::_reg']]], + ['_5fdevide_5fid_5fregister_7',['_devide_id_register',['../structina234_1_1__reg_1_1__devide__id__register.html',1,'ina234::_reg']]], + ['_5fmanufacture_5fid_5fregister_8',['_manufacture_id_register',['../structina234_1_1__reg_1_1__manufacture__id__register.html',1,'ina234::_reg']]], + ['_5fmask_5fenable_5fregister_9',['_mask_enable_register',['../structina234_1_1__reg_1_1__mask__enable__register.html',1,'ina234::_reg']]], + ['_5fpower_5fregister_10',['_power_register',['../structina234_1_1__reg_1_1__power__register.html',1,'ina234::_reg']]], + ['_5freg_11',['_reg',['../unionina234_1_1__reg.html',1,'ina234']]], + ['_5fshunt_5fvoltage_5fregister_12',['_shunt_voltage_register',['../structina234_1_1__reg_1_1__shunt__voltage__register.html',1,'ina234::_reg']]] +]; diff --git a/search/all_1.js b/search/all_1.js new file mode 100644 index 0000000..dd1bfdf --- /dev/null +++ b/search/all_1.js @@ -0,0 +1,37 @@ +var searchData= +[ + ['acdrange_0',['ACDRANGE',['../structina234_1_1__reg_1_1__config__register.html#a2cae4ff84c5462b931bd99ef5a3434e8',1,'ina234::_reg::_config_register']]], + ['adc_5frange_1',['adc_range',['../structina234.html#af614e8e36e36f2703a95b4cf98e6e47c',1,'ina234']]], + ['adcrange_2',['ADCRange',['../ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fc',1,'ADCRange: ina234.h'],['../ina234_8h.html#a650dc7cee4ad520ed3fa35dbe7142216',1,'ADCRange: ina234.h']]], + ['aff_3',['AFF',['../structina234_1_1__reg_1_1__mask__enable__register.html#a5fe2c3e0f082c277a47c739bb4c050f0',1,'ina234::_reg::_mask_enable_register']]], + ['alert_5factive_5fhigh_4',['ALERT_ACTIVE_HIGH',['../ina234_8h.html#ada37218468b40fbf8e3f7951165cf634acc90eec8b0cea31c65d2125e1dec4b3d',1,'ina234.h']]], + ['alert_5factive_5flow_5',['ALERT_ACTIVE_LOW',['../ina234_8h.html#ada37218468b40fbf8e3f7951165cf634ac517f2dbfd71d39c6277a02c6a8e98b5',1,'ina234.h']]], + ['alert_5fbus_5fover_5flimit_6',['ALERT_BUS_OVER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a1ca5e700ee55d0dc367e350b23f11ec9',1,'ina234.h']]], + ['alert_5fbus_5funder_5flimit_7',['ALERT_BUS_UNDER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a94ace1d59fb93b2a18d3f81347d85baf',1,'ina234.h']]], + ['alert_5fconv_5fdisable_8',['ALERT_CONV_DISABLE',['../ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4a083db3ebfb856b3fb387dd31d856c0c8',1,'ina234.h']]], + ['alert_5fconv_5fenable_9',['ALERT_CONV_ENABLE',['../ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4a5e0027e4e01b269be48d60a41243d854',1,'ina234.h']]], + ['alert_5fconv_5fready_10',['alert_conv_ready',['../structina234.html#a3c24a2f4305134b1da6f3a4a7515608b',1,'ina234']]], + ['alert_5fdata_5fready_11',['ALERT_DATA_READY',['../ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8a83f1800832e2ed9bc6691a53c9a1359d',1,'ina234.h']]], + ['alert_5flatch_12',['alert_latch',['../structina234.html#a2a7579503920bd539e301005e0a000f9',1,'ina234']]], + ['alert_5flatched_13',['ALERT_LATCHED',['../ina234_8h.html#a9524876614527f1c1cad905b5586a61cae66cf6808527fe59bda82112ea1f0626',1,'ina234.h']]], + ['alert_5flimit_14',['alert_limit',['../structina234.html#acf7d16f76c1d445ce5a62d94fad9472f',1,'ina234']]], + ['alert_5flimit_5fint_15',['alert_limit_int',['../structina234.html#ad2f27d00ab89273641b8c85897f63578',1,'ina234']]], + ['alert_5flimit_5freached_16',['ALERT_LIMIT_REACHED',['../ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8aea5a0da07bc6063e3ad1f5bc0332dc65',1,'ina234.h']]], + ['alert_5flimit_5fregister_17',['ALERT_LIMIT_REGISTER',['../ina234_8h.html#ab843670bdea443688a3c0fc1bb59df4c',1,'ina234.h']]], + ['alert_5flimit_5fregister_18',['alert_limit_register',['../unionina234_1_1__reg.html#acee2fbb0cc5b0af342d28004e1421fc8',1,'ina234::_reg']]], + ['alert_5fnone_19',['ALERT_NONE',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4ab84e7751ae498fa5f6354fec90392f84',1,'ina234.h']]], + ['alert_5fon_20',['alert_on',['../structina234.html#a88e4987220f0aeb0da2a012b9590201a',1,'ina234']]], + ['alert_5fpolarity_21',['alert_polarity',['../structina234.html#a899269e44feff92f5675821efc09fbd5',1,'ina234']]], + ['alert_5fpower_5fover_5flimit_22',['ALERT_POWER_OVER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a34e2f0c08f8c607c6bef4c42a1650fb3',1,'ina234.h']]], + ['alert_5fshunt_5fover_5flimit_23',['ALERT_SHUNT_OVER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4adf6cdb85c8967fba23a0f0244b49057c',1,'ina234.h']]], + ['alert_5fshunt_5funder_5flimit_24',['ALERT_SHUNT_UNDER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a948a648cb59cafcc5382b1b5e599d28b',1,'ina234.h']]], + ['alert_5ftransparent_25',['ALERT_TRANSPARENT',['../ina234_8h.html#a9524876614527f1c1cad905b5586a61ca8e18da66cd5b403de50cd5cea2867a01',1,'ina234.h']]], + ['alertconvready_26',['AlertConvReady',['../ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4',1,'AlertConvReady: ina234.h'],['../ina234_8h.html#a848ebbc680edb7898d7edc1ca52a0d37',1,'AlertConvReady: ina234.h']]], + ['alertlatch_27',['AlertLatch',['../ina234_8h.html#a9524876614527f1c1cad905b5586a61c',1,'AlertLatch: ina234.h'],['../ina234_8h.html#afc7b0844b88c911005553dd08939b096',1,'AlertLatch: ina234.h']]], + ['alerton_28',['AlertOn',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4',1,'AlertOn: ina234.h'],['../ina234_8h.html#a6be1753fa6a5ab6a2afa25019e635f5f',1,'AlertOn: ina234.h']]], + ['alertpolarity_29',['AlertPolarity',['../ina234_8h.html#ada37218468b40fbf8e3f7951165cf634',1,'AlertPolarity: ina234.h'],['../ina234_8h.html#a74f38e65a7114a53a324d460820a43a4',1,'AlertPolarity: ina234.h']]], + ['alertsource_30',['AlertSource',['../ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8',1,'AlertSource: ina234.h'],['../ina234_8h.html#a3872be266ee7297b319f93420303a008',1,'AlertSource: ina234.h']]], + ['apol_31',['APOL',['../structina234_1_1__reg_1_1__mask__enable__register.html#a1b52d5c7b321b1a00b920df8aaef4ebb',1,'ina234::_reg::_mask_enable_register']]], + ['author_32',['Author',['../index.html#author',1,'']]], + ['avg_33',['AVG',['../structina234_1_1__reg_1_1__config__register.html#ae5a0c05847ffa0e32d0903a07261dd71',1,'ina234::_reg::_config_register']]] +]; diff --git a/search/all_10.js b/search/all_10.js new file mode 100644 index 0000000..d941f79 --- /dev/null +++ b/search/all_10.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['vbus_0',['VBUS',['../structina234_1_1__reg_1_1__bus__voltage__register.html#adf5c609e86df6632a09ad897c2eb4e94',1,'ina234::_reg::_bus_voltage_register']]], + ['vbus_5fconversion_5ftime_1',['vbus_conversion_time',['../structina234.html#ac0ebad16cd5b42cd142546eab3aef22e',1,'ina234']]], + ['vbusct_2',['VBUSCT',['../structina234_1_1__reg_1_1__config__register.html#a2854a902bb3af04427b00a8472b0cbb8',1,'ina234::_reg::_config_register']]], + ['voltage_20power_20monitor_20library_3',['INA234 current/voltage/power monitor library',['../index.html',1,'']]], + ['vshct_4',['VSHCT',['../structina234_1_1__reg_1_1__config__register.html#a9efa998f60c85d1bdd04cc3dd4bdc693',1,'ina234::_reg::_config_register']]], + ['vshunt_5',['VSHUNT',['../structina234_1_1__reg_1_1__shunt__voltage__register.html#a66e0475d4572f9d2c526cdc06c229ae6',1,'ina234::_reg::_shunt_voltage_register']]], + ['vshunt_5fconversion_5ftime_6',['vshunt_conversion_time',['../structina234.html#a5675cd02ce9e463e2bb990cdd56b7e8a',1,'ina234']]] +]; diff --git a/search/all_2.js b/search/all_2.js new file mode 100644 index 0000000..69e55b3 --- /dev/null +++ b/search/all_2.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['based_20library_0',['INA234 HAL Based Library',['../md_README.html',1,'']]], + ['bol_1',['BOL',['../structina234_1_1__reg_1_1__mask__enable__register.html#a0523a734c855650be9b9f060fc3cdf75',1,'ina234::_reg::_mask_enable_register']]], + ['bul_2',['BUL',['../structina234_1_1__reg_1_1__mask__enable__register.html#ad8d9d3c9c1f94b7a3685b53757033c55',1,'ina234::_reg::_mask_enable_register']]], + ['bus_5fvoltage_5flsb_3',['BUS_VOLTAGE_LSB',['../ina234_8h.html#a775ced70ffbd32f6fb31cbb10a10187f',1,'ina234.h']]], + ['bus_5fvoltage_5fregister_4',['BUS_VOLTAGE_REGISTER',['../ina234_8h.html#a646eb67bd8e213ae03c5a03e6a569788',1,'ina234.h']]], + ['bus_5fvoltage_5fregister_5',['bus_voltage_register',['../unionina234_1_1__reg.html#a369b998af644dc917134f6075b6d0d8e',1,'ina234::_reg']]], + ['busvoltage_6',['BusVoltage',['../structina234.html#a4cf12f3449e646afc1f8cc93a5264589',1,'ina234']]] +]; diff --git a/search/all_3.js b/search/all_3.js new file mode 100644 index 0000000..15cbe54 --- /dev/null +++ b/search/all_3.js @@ -0,0 +1,25 @@ +var searchData= +[ + ['calibration_5fregister_0',['CALIBRATION_REGISTER',['../ina234_8h.html#ab59d55e52855c8c0f649304fa92a9a13',1,'ina234.h']]], + ['calibration_5fregister_1',['calibration_register',['../unionina234_1_1__reg.html#af8c8679ad9234831937cf17e85935231',1,'ina234::_reg']]], + ['cnvr_2',['CNVR',['../structina234_1_1__reg_1_1__mask__enable__register.html#ab967f10721179bd6819267d3f28e7823',1,'ina234::_reg::_mask_enable_register']]], + ['config_5fregister_3',['config_register',['../unionina234_1_1__reg.html#a99cf80892bd6eb97d2dfe5d8094d4375',1,'ina234::_reg']]], + ['configuration_5fregister_4',['CONFIGURATION_REGISTER',['../ina234_8h.html#a7ee3d94a0cd2d145d66bae6abe5bb302',1,'ina234.h']]], + ['convtime_5',['ConvTime',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6',1,'ConvTime: ina234.h'],['../ina234_8h.html#ab303d390218c5cf7c69501e0559213ec',1,'ConvTime: ina234.h']]], + ['ctime_5f1100us_6',['CTIME_1100us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a65ed0d16270a6141ab8dd8488fe7f41e',1,'ina234.h']]], + ['ctime_5f140us_7',['CTIME_140us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6acfaa6a642034e5c48d5f172355a0e22d',1,'ina234.h']]], + ['ctime_5f204us_8',['CTIME_204us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6ac369ab9b892e484bf6f6e1c62cdf89a8',1,'ina234.h']]], + ['ctime_5f2116us_9',['CTIME_2116us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a47c6de263bc91c68cc7aa33fa4ff0755',1,'ina234.h']]], + ['ctime_5f332us_10',['CTIME_332us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6abfd7d84dee689ba2bb2f17da3d09ac9a',1,'ina234.h']]], + ['ctime_5f4156us_11',['CTIME_4156us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a657a9b9f4cabd5ca90fee02c26638a04',1,'ina234.h']]], + ['ctime_5f588us_12',['CTIME_588us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a2fe24ae5755ffeb5b8082cd037b9dc7f',1,'ina234.h']]], + ['ctime_5f8244us_13',['CTIME_8244us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a08b6eaecf78753c12f67dddf9949be84',1,'ina234.h']]], + ['current_14',['CURRENT',['../structina234_1_1__reg_1_1__current__register.html#a2ed399eace19c88cda48107e537271d2',1,'ina234::_reg::_current_register']]], + ['current_15',['Current',['../structina234.html#ae8d3473f04d1b074e042108e0816efe6',1,'ina234']]], + ['current_20voltage_20power_20monitor_20library_16',['INA234 current/voltage/power monitor library',['../index.html',1,'']]], + ['current_5flsb_17',['CURRENT_LSB',['../ina234_8h.html#a81ed9fb0bd16f43a3a5bc335f966a96f',1,'ina234.h']]], + ['current_5flsb_5fminimum_18',['CURRENT_LSB_MINIMUM',['../ina234_8h.html#a48ce45ec20267ca3c0159a444dc30c33',1,'ina234.h']]], + ['current_5fregister_19',['CURRENT_REGISTER',['../ina234_8h.html#a3640431a41e460b8e7ddf642adefae95',1,'ina234.h']]], + ['current_5fregister_20',['current_register',['../unionina234_1_1__reg.html#ab8acdea3a879f282b66100182c706b9b',1,'ina234::_reg']]], + ['cvrf_21',['CVRF',['../structina234_1_1__reg_1_1__mask__enable__register.html#afb1d44ecc07606d4604568fb8ac74a32',1,'ina234::_reg::_mask_enable_register']]] +]; diff --git a/search/all_4.js b/search/all_4.js new file mode 100644 index 0000000..9ca1a7b --- /dev/null +++ b/search/all_4.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['deviceid_5fregister_0',['DEVICEID_REGISTER',['../ina234_8h.html#a238936614e386e75f2487559953cbc68',1,'ina234.h']]], + ['devide_5fid_5fregister_1',['devide_id_register',['../unionina234_1_1__reg.html#a99a13b89ff65812966f048cc413de88e',1,'ina234::_reg']]], + ['dieid_2',['DIEID',['../structina234_1_1__reg_1_1__devide__id__register.html#a1c2fbd56052f9cd2aedf35c988950eb8',1,'ina234::_reg::_devide_id_register']]] +]; diff --git a/search/all_5.js b/search/all_5.js new file mode 100644 index 0000000..24b25f1 --- /dev/null +++ b/search/all_5.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['error_5fboth_5fmemory_5fovf_0',['ERROR_BOTH_MEMORY_OVF',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa4a2fc9e6bcb0135acd74edfec8554512',1,'ina234.h']]], + ['error_5fmemory_1',['ERROR_MEMORY',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa632a15615c9d0f691788ab4f0a66e41d',1,'ina234.h']]], + ['error_5fnone_2',['ERROR_NONE',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa4edc8aade11e1de7bbbdc04704baae5f',1,'ina234.h']]], + ['error_5fovf_3',['ERROR_OVF',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa2a372620a5d99a4790787150ebe2a92c',1,'ina234.h']]], + ['errortype_4',['ErrorType',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45a',1,'ErrorType: ina234.h'],['../ina234_8h.html#a1324293b60f4d902ebc99cf0d31bad89',1,'ErrorType: ina234.h']]] +]; diff --git a/search/all_6.js b/search/all_6.js new file mode 100644 index 0000000..f2b93a3 --- /dev/null +++ b/search/all_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['getting_20started_0',['Getting Started',['../index.html#start',1,'']]] +]; diff --git a/search/all_7.js b/search/all_7.js new file mode 100644 index 0000000..8702b25 --- /dev/null +++ b/search/all_7.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['hal_20based_20library_0',['INA234 HAL Based Library',['../md_README.html',1,'']]], + ['hi2c_1',['hi2c',['../structina234.html#abf45242a4a812df409b53ce5216f8d7e',1,'ina234']]] +]; diff --git a/search/all_8.js b/search/all_8.js new file mode 100644 index 0000000..e55e9cf --- /dev/null +++ b/search/all_8.js @@ -0,0 +1,35 @@ +var searchData= +[ + ['i2c_5faddr_0',['I2C_ADDR',['../structina234.html#acede59719bc6487dd599349740fa29fc',1,'ina234']]], + ['ina234_1',['INA234',['../ina234_8h.html#a0ee8a79a292d53863aff0274ca030f5a',1,'ina234.h']]], + ['ina234_2',['ina234',['../structina234.html',1,'']]], + ['ina234_20current_20voltage_20power_20monitor_20library_3',['INA234 current/voltage/power monitor library',['../index.html',1,'']]], + ['ina234_20hal_20based_20library_4',['INA234 HAL Based Library',['../md_README.html',1,'']]], + ['ina234_2ec_5',['ina234.c',['../ina234_8c.html',1,'']]], + ['ina234_2eh_6',['ina234.h',['../ina234_8h.html',1,'']]], + ['ina234_5falert_5finit_7',['INA234_alert_init',['../ina234_8c.html#afb44437883ad8f8d08aaf695815da7ed',1,'INA234_alert_init(INA234 *self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit): ina234.c'],['../ina234_8h.html#afb44437883ad8f8d08aaf695815da7ed',1,'INA234_alert_init(INA234 *self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit): ina234.c']]], + ['ina234_5fgetadcrange_8',['INA234_getADCRange',['../ina234_8c.html#ab9f2d8b23628fb6b060f837b9a4f71a5',1,'INA234_getADCRange(INA234 *self): ina234.c'],['../ina234_8h.html#ab9f2d8b23628fb6b060f837b9a4f71a5',1,'INA234_getADCRange(INA234 *self): ina234.c']]], + ['ina234_5fgetalertsource_9',['INA234_getAlertSource',['../ina234_8c.html#a52cc3b785dea1f5af6f0803f02fcefdb',1,'INA234_getAlertSource(INA234 *self): ina234.c'],['../ina234_8h.html#a52cc3b785dea1f5af6f0803f02fcefdb',1,'INA234_getAlertSource(INA234 *self): ina234.c']]], + ['ina234_5fgetbusvoltage_10',['INA234_getBusVoltage',['../ina234_8c.html#a97ec39b6399d3ab449e499a57668748d',1,'INA234_getBusVoltage(INA234 *self): ina234.c'],['../ina234_8h.html#a97ec39b6399d3ab449e499a57668748d',1,'INA234_getBusVoltage(INA234 *self): ina234.c']]], + ['ina234_5fgetcurrent_11',['INA234_getCurrent',['../ina234_8c.html#a825a355395fef312e3642f9f8ca6463c',1,'INA234_getCurrent(INA234 *self): ina234.c'],['../ina234_8h.html#a825a355395fef312e3642f9f8ca6463c',1,'INA234_getCurrent(INA234 *self): ina234.c']]], + ['ina234_5fgetdevid_12',['INA234_getDevID',['../ina234_8c.html#a88ff1503798836270a41d3b9f3913ca7',1,'INA234_getDevID(INA234 *self): ina234.c'],['../ina234_8h.html#a88ff1503798836270a41d3b9f3913ca7',1,'INA234_getDevID(INA234 *self): ina234.c']]], + ['ina234_5fgeterrors_13',['INA234_getErrors',['../ina234_8c.html#a14a3383eba06ce784ed526585a0cef9a',1,'INA234_getErrors(INA234 *self): ina234.c'],['../ina234_8h.html#a14a3383eba06ce784ed526585a0cef9a',1,'INA234_getErrors(INA234 *self): ina234.c']]], + ['ina234_5fgetmanid_14',['INA234_getManID',['../ina234_8c.html#ae646f51adec51af1aa6377c3dffeeb6a',1,'INA234_getManID(INA234 *self): ina234.c'],['../ina234_8h.html#ae646f51adec51af1aa6377c3dffeeb6a',1,'INA234_getManID(INA234 *self): ina234.c']]], + ['ina234_5fgetmode_15',['INA234_getMode',['../ina234_8c.html#a4af7c34341c14b8bfb40daf0665a766c',1,'INA234_getMode(INA234 *self): ina234.c'],['../ina234_8h.html#a4af7c34341c14b8bfb40daf0665a766c',1,'INA234_getMode(INA234 *self): ina234.c']]], + ['ina234_5fgetnumberofadcsamples_16',['INA234_getNumberOfADCSamples',['../ina234_8c.html#acda6b9d24c842d73ffca341ce39ac707',1,'INA234_getNumberOfADCSamples(INA234 *self): ina234.c'],['../ina234_8h.html#acda6b9d24c842d73ffca341ce39ac707',1,'INA234_getNumberOfADCSamples(INA234 *self): ina234.c']]], + ['ina234_5fgetpower_17',['INA234_getPower',['../ina234_8c.html#a163121f0afcab9a5e49f419b94290f20',1,'INA234_getPower(INA234 *self): ina234.c'],['../ina234_8h.html#a163121f0afcab9a5e49f419b94290f20',1,'INA234_getPower(INA234 *self): ina234.c']]], + ['ina234_5fgetshuntvoltage_18',['INA234_getShuntVoltage',['../ina234_8c.html#a256f66571357742aec8b4f0104c54b6b',1,'INA234_getShuntVoltage(INA234 *self): ina234.c'],['../ina234_8h.html#a256f66571357742aec8b4f0104c54b6b',1,'INA234_getShuntVoltage(INA234 *self): ina234.c']]], + ['ina234_5fgetvbusconversiontime_19',['INA234_getVBusConversionTime',['../ina234_8c.html#aa3f6130fa6074b931f415e9ca85f340d',1,'INA234_getVBusConversionTime(INA234 *self): ina234.c'],['../ina234_8h.html#aa3f6130fa6074b931f415e9ca85f340d',1,'INA234_getVBusConversionTime(INA234 *self): ina234.c']]], + ['ina234_5fgetvshuntconversiontime_20',['INA234_getVShuntConversionTime',['../ina234_8c.html#a6afffb92bb828562997a6a5592bc141a',1,'INA234_getVShuntConversionTime(INA234 *self): ina234.c'],['../ina234_8h.html#a6afffb92bb828562997a6a5592bc141a',1,'INA234_getVShuntConversionTime(INA234 *self): ina234.c']]], + ['ina234_5finit_21',['INA234_init',['../ina234_8c.html#a21acc30b187445a98f711a54b8678c7c',1,'INA234_init(INA234 *self, uint8_t I2C_ADDR, I2C_HandleTypeDef *hi2c, float ShuntResistor, ADCRange adc_range, NumSamples numer_of_adc_samples, ConvTime vbus_conversion_time, ConvTime vshunt_conversion_time, Mode mode): ina234.c'],['../ina234_8h.html#a21acc30b187445a98f711a54b8678c7c',1,'INA234_init(INA234 *self, uint8_t I2C_ADDR, I2C_HandleTypeDef *hi2c, float ShuntResistor, ADCRange adc_range, NumSamples numer_of_adc_samples, ConvTime vbus_conversion_time, ConvTime vshunt_conversion_time, Mode mode): ina234.c']]], + ['ina234_5fisdataready_22',['INA234_isDataReady',['../ina234_8c.html#a9637d475148409297883f05464a92e86',1,'INA234_isDataReady(INA234 *self): ina234.c'],['../ina234_8h.html#a9637d475148409297883f05464a92e86',1,'INA234_isDataReady(INA234 *self): ina234.c']]], + ['ina234_5freadall_23',['INA234_readAll',['../ina234_8c.html#ac7901cf62e078ff3a235839061a3608b',1,'INA234_readAll(INA234 *self): ina234.c'],['../ina234_8h.html#ac7901cf62e078ff3a235839061a3608b',1,'INA234_readAll(INA234 *self): ina234.c']]], + ['ina234_5fresetalert_24',['INA234_resetAlert',['../ina234_8c.html#a5810f9a740226a39ba5cc2afa6b64f77',1,'INA234_resetAlert(INA234 *self): ina234.c'],['../ina234_8h.html#a5810f9a740226a39ba5cc2afa6b64f77',1,'INA234_resetAlert(INA234 *self): ina234.c']]], + ['ina234_5fsetadcrange_25',['INA234_setADCRange',['../ina234_8c.html#aba71c63deed65a0abdbf7269b5f382d8',1,'INA234_setADCRange(INA234 *self, ADCRange adc_range): ina234.c'],['../ina234_8h.html#aba71c63deed65a0abdbf7269b5f382d8',1,'INA234_setADCRange(INA234 *self, ADCRange adc_range): ina234.c']]], + ['ina234_5fsetmode_26',['INA234_setMode',['../ina234_8c.html#ac85c8e736ffae6d248971091b374d00f',1,'INA234_setMode(INA234 *self, Mode mode): ina234.c'],['../ina234_8h.html#ac85c8e736ffae6d248971091b374d00f',1,'INA234_setMode(INA234 *self, Mode mode): ina234.c']]], + ['ina234_5fsetnumberofadcsamples_27',['INA234_setNumberOfADCSamples',['../ina234_8c.html#a84ff6173bf6cfa44348ba259a503c804',1,'INA234_setNumberOfADCSamples(INA234 *self, NumSamples numer_of_adc_samples): ina234.c'],['../ina234_8h.html#a84ff6173bf6cfa44348ba259a503c804',1,'INA234_setNumberOfADCSamples(INA234 *self, NumSamples numer_of_adc_samples): ina234.c']]], + ['ina234_5fsetvbusconversiontime_28',['INA234_setVBusConversionTime',['../ina234_8c.html#a94ec7dc7cd10748c4ed822266174d0ff',1,'INA234_setVBusConversionTime(INA234 *self, ConvTime vbus_conversion_time): ina234.c'],['../ina234_8h.html#a94ec7dc7cd10748c4ed822266174d0ff',1,'INA234_setVBusConversionTime(INA234 *self, ConvTime vbus_conversion_time): ina234.c']]], + ['ina234_5fsetvshuntconversiontime_29',['INA234_setVShuntConversionTime',['../ina234_8c.html#ad19627414a2465c9cf1fac54f54eaa39',1,'INA234_setVShuntConversionTime(INA234 *self, ConvTime vshunt_conversion_time): ina234.c'],['../ina234_8h.html#ad19627414a2465c9cf1fac54f54eaa39',1,'INA234_setVShuntConversionTime(INA234 *self, ConvTime vshunt_conversion_time): ina234.c']]], + ['ina234_5fsoftresetall_30',['INA234_SoftResetAll',['../ina234_8c.html#af3d939ea27371b17fd265f19957234b2',1,'INA234_SoftResetAll(INA234 *self): ina234.c'],['../ina234_8h.html#af3d939ea27371b17fd265f19957234b2',1,'INA234_SoftResetAll(INA234 *self): ina234.c']]], + ['introduction_31',['Introduction',['../index.html#intro_sec',1,'']]] +]; diff --git a/search/all_9.js b/search/all_9.js new file mode 100644 index 0000000..2b06f33 --- /dev/null +++ b/search/all_9.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['len_0',['LEN',['../structina234_1_1__reg_1_1__mask__enable__register.html#a045f31cd5049e505de87de0f6ff32d48',1,'ina234::_reg::_mask_enable_register']]], + ['library_1',['INA234 HAL Based Library',['../md_README.html',1,'']]], + ['library_2',['INA234 current/voltage/power monitor library',['../index.html',1,'']]], + ['license_3',['License',['../index.html#license',1,'']]], + ['limit_4',['LIMIT',['../structina234_1_1__reg_1_1__alert__limit__register.html#a8f69b5d3049c8432f1a7c671b7e759aa',1,'ina234::_reg::_alert_limit_register']]] +]; diff --git a/search/all_a.js b/search/all_a.js new file mode 100644 index 0000000..0146f01 --- /dev/null +++ b/search/all_a.js @@ -0,0 +1,22 @@ +var searchData= +[ + ['manufacture_5fid_0',['MANUFACTURE_ID',['../structina234_1_1__reg_1_1__manufacture__id__register.html#ae9ec42bcafa5e076b6489e0aa8373d58',1,'ina234::_reg::_manufacture_id_register']]], + ['manufacture_5fid_5fregister_1',['manufacture_id_register',['../unionina234_1_1__reg.html#a1e929abda30270e8b0eda26e26d68f83',1,'ina234::_reg']]], + ['manufacturerid_5fregister_2',['MANUFACTURERID_REGISTER',['../ina234_8h.html#a8243b56922df1eafe7faf2f5231642b6',1,'ina234.h']]], + ['mask_5fenable_5fregister_3',['MASK_ENABLE_REGISTER',['../ina234_8h.html#ae92b8bbb58abb306563771a0149472d2',1,'ina234.h']]], + ['mask_5fenable_5fregister_4',['mask_enable_register',['../unionina234_1_1__reg.html#a2fa3a9f20fd08972d7968962ee824d4b',1,'ina234::_reg']]], + ['maximum_5fexpected_5fcurrent_5',['MAXIMUM_EXPECTED_CURRENT',['../ina234_8h.html#ad157a86c3b3394bca27e86844852ee04',1,'ina234.h']]], + ['memerror_6',['MemError',['../structina234_1_1__reg_1_1__mask__enable__register.html#a848f62ff7c149d4e1767499eca44f0e6',1,'ina234::_reg::_mask_enable_register']]], + ['mode_7',['MODE',['../structina234_1_1__reg_1_1__config__register.html#abd348ee828aadd0781f3fa97d167e564',1,'ina234::_reg::_config_register']]], + ['mode_8',['Mode',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911',1,'Mode: ina234.h'],['../ina234_8h.html#a27e0b80eae69f3ea0f661dea593912c8',1,'Mode: ina234.h']]], + ['mode_9',['mode',['../structina234.html#a2618e89b4c26dc851feae865df3a1a49',1,'ina234']]], + ['mode_5fcontinuous_5fboth_5fshunt_5fbus_10',['MODE_CONTINUOUS_BOTH_SHUNT_BUS',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a7bc1351d315d165a969fe64c964da364',1,'ina234.h']]], + ['mode_5fcontinuous_5fbus_11',['MODE_CONTINUOUS_BUS',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a6cba4ffadd57ed1e5f5a176ab21f4e85',1,'ina234.h']]], + ['mode_5fcontinuous_5fshunt_12',['MODE_CONTINUOUS_SHUNT',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911ac089fb7ab69f944b618f18abe16b3600',1,'ina234.h']]], + ['mode_5fshutdown_13',['MODE_SHUTDOWN',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a0680164b529f8d29d670308298ec2a2b',1,'ina234.h']]], + ['mode_5fshutdown2_14',['MODE_SHUTDOWN2',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a28192c7eb7daf555e5eb9def6b82c2db',1,'ina234.h']]], + ['mode_5fsingleshot_5fboth_5fshunt_5fbus_15',['MODE_SINGLESHOT_BOTH_SHUNT_BUS',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911ab729c3948326475cd19e84a433ae96bd',1,'ina234.h']]], + ['mode_5fsingleshot_5fbus_16',['MODE_SINGLESHOT_BUS',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a9f304d5978fa9370e3cd0da297f85470',1,'ina234.h']]], + ['mode_5fsingleshot_5fsunt_17',['MODE_SINGLESHOT_SUNT',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911aa90b94d7cd6425245221d504534f0f2f',1,'ina234.h']]], + ['monitor_20library_18',['INA234 current/voltage/power monitor library',['../index.html',1,'']]] +]; diff --git a/search/all_b.js b/search/all_b.js new file mode 100644 index 0000000..a8a098c --- /dev/null +++ b/search/all_b.js @@ -0,0 +1,13 @@ +var searchData= +[ + ['nadc_5f1_0',['NADC_1',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a993c043bbf51fcb3e71e24560079b3e0',1,'ina234.h']]], + ['nadc_5f1024_1',['NADC_1024',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a02bba2371c7cc4740a4bcccc82da45d7',1,'ina234.h']]], + ['nadc_5f128_2',['NADC_128',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58aa7cf4006919e212a7d722e96c826fa8d',1,'ina234.h']]], + ['nadc_5f16_3',['NADC_16',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a3a1205ed5042c059ebf47784254d1f29',1,'ina234.h']]], + ['nadc_5f256_4',['NADC_256',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a91a4d2241e749494be617d895d318589',1,'ina234.h']]], + ['nadc_5f4_5',['NADC_4',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58ac9dd4285a560c534d22fca6840d0ebf5',1,'ina234.h']]], + ['nadc_5f512_6',['NADC_512',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58af045584cc242ad52f42910989945250f',1,'ina234.h']]], + ['nadc_5f64_7',['NADC_64',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58abdcabf69ca2812231b1ee322cda057d1',1,'ina234.h']]], + ['number_5fof_5fadc_5fsamples_8',['number_of_adc_samples',['../structina234.html#a2ab8a9d5ad14120cc622664faf5d9fef',1,'ina234']]], + ['numsamples_9',['NumSamples',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58',1,'NumSamples: ina234.h'],['../ina234_8h.html#a3bce910f55e3b114067517de3ca4ff28',1,'NumSamples: ina234.h']]] +]; diff --git a/search/all_c.js b/search/all_c.js new file mode 100644 index 0000000..096f33d --- /dev/null +++ b/search/all_c.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['ovf_0',['OVF',['../structina234_1_1__reg_1_1__mask__enable__register.html#a924358cdfd4563e425c05b90f7f1b733',1,'ina234::_reg::_mask_enable_register']]] +]; diff --git a/search/all_d.js b/search/all_d.js new file mode 100644 index 0000000..e0fbdc7 --- /dev/null +++ b/search/all_d.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['pol_0',['POL',['../structina234_1_1__reg_1_1__mask__enable__register.html#aa0b57507453cd43c4b79df8fcee20978',1,'ina234::_reg::_mask_enable_register']]], + ['power_1',['POWER',['../structina234_1_1__reg_1_1__power__register.html#a8ef2a47bcdbc2202d402528a15b9a0a3',1,'ina234::_reg::_power_register']]], + ['power_2',['Power',['../structina234.html#aeca176f09c48cbe15df7fc4fff7c77f7',1,'ina234']]], + ['power_20monitor_20library_3',['INA234 current/voltage/power monitor library',['../index.html',1,'']]], + ['power_5flsb_4',['POWER_LSB',['../ina234_8h.html#ab01b539856e5c5102cd3d97a38435d26',1,'ina234.h']]], + ['power_5fregister_5',['POWER_REGISTER',['../ina234_8h.html#a731f54cd49fcbbca608bfbe367c75dfb',1,'ina234.h']]], + ['power_5fregister_6',['power_register',['../unionina234_1_1__reg.html#adc2d71b0b9e065cf1fb9086b2834c3f1',1,'ina234::_reg']]] +]; diff --git a/search/all_e.js b/search/all_e.js new file mode 100644 index 0000000..177f28d --- /dev/null +++ b/search/all_e.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['range_5f20_5f48mv_0',['RANGE_20_48mV',['../ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fca39711bc57d71a9e56b586578de4da136',1,'ina234.h']]], + ['range_5f81_5f92mv_1',['RANGE_81_92mV',['../ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fcac35ce98e9a40c62ca3ce4054c4d72bb5',1,'ina234.h']]], + ['raw_5fdata_2',['raw_data',['../unionina234_1_1__reg.html#a212c976969c3d66f4b79de05921422b5',1,'ina234::_reg']]], + ['readme_2emd_3',['README.md',['../README_8md.html',1,'']]], + ['reg_4',['reg',['../structina234.html#ab54a1e11860021b67b7c73b923423ae7',1,'ina234']]], + ['reserved_5',['RESERVED',['../structina234_1_1__reg_1_1__config__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_config_register::RESERVED'],['../structina234_1_1__reg_1_1__shunt__voltage__register.html#aa42491e0ff1ccdf2056d947f78957917',1,'ina234::_reg::_shunt_voltage_register::RESERVED'],['../structina234_1_1__reg_1_1__bus__voltage__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_bus_voltage_register::RESERVED'],['../structina234_1_1__reg_1_1__current__register.html#aa42491e0ff1ccdf2056d947f78957917',1,'ina234::_reg::_current_register::RESERVED'],['../structina234_1_1__reg_1_1__calibration__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_calibration_register::RESERVED'],['../structina234_1_1__reg_1_1__mask__enable__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_mask_enable_register::RESERVED'],['../structina234_1_1__reg_1_1__devide__id__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_devide_id_register::RESERVED']]], + ['reserved2_6',['RESERVED2',['../structina234_1_1__reg_1_1__bus__voltage__register.html#a5573848497a716a9947fd87487709feb',1,'ina234::_reg::_bus_voltage_register']]], + ['rst_7',['RST',['../structina234_1_1__reg_1_1__config__register.html#abef8327bfd071009d10633030379e701',1,'ina234::_reg::_config_register']]] +]; diff --git a/search/all_f.js b/search/all_f.js new file mode 100644 index 0000000..b07e3a8 --- /dev/null +++ b/search/all_f.js @@ -0,0 +1,16 @@ +var searchData= +[ + ['shunt_5fcal_0',['SHUNT_CAL',['../structina234_1_1__reg_1_1__calibration__register.html#a115d21bedd85f661114c0c719fc22da0',1,'ina234::_reg::_calibration_register']]], + ['shunt_5fvoltage_5f20_5f48mv_5flsb_1',['SHUNT_VOLTAGE_20_48mv_LSB',['../ina234_8h.html#a8c0e636ce427d3785aea74926fabc624',1,'ina234.h']]], + ['shunt_5fvoltage_5f81_5f92mv_5flsb_2',['SHUNT_VOLTAGE_81_92mv_LSB',['../ina234_8h.html#a93329758cb0f2c6f52cffd48b8f961c8',1,'ina234.h']]], + ['shunt_5fvoltage_5fregister_3',['SHUNT_VOLTAGE_REGISTER',['../ina234_8h.html#aa417fcb934d07b4af5c20c44b920e5ae',1,'ina234.h']]], + ['shunt_5fvoltage_5fregister_4',['shunt_voltage_register',['../unionina234_1_1__reg.html#a5788ff3d34c964926fed0bebed42e3ac',1,'ina234::_reg']]], + ['shuntresistor_5',['ShuntResistor',['../structina234.html#a2e10662b238ee4fa108ca0792851d136',1,'ina234']]], + ['shuntvoltage_6',['ShuntVoltage',['../structina234.html#ac63c1ad335c16bcdb33b5e55cf773ad3',1,'ina234']]], + ['sol_7',['SOL',['../structina234_1_1__reg_1_1__mask__enable__register.html#a5c27f0c90ddb7694a7242366879d4685',1,'ina234::_reg::_mask_enable_register']]], + ['started_8',['Getting Started',['../index.html#start',1,'']]], + ['status_9',['Status',['../ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b',1,'Status: ina234.h'],['../ina234_8h.html#a59ac6513a4c0c951eff022338ea6e9f6',1,'Status: ina234.h']]], + ['status_5fok_10',['STATUS_OK',['../ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba7e4a42e3b6dd63708c64cf3db6f69566',1,'ina234.h']]], + ['status_5ftimeout_11',['STATUS_TimeOut',['../ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70bafddcb825c6c18107885a7d663dcf38e7',1,'ina234.h']]], + ['sul_12',['SUL',['../structina234_1_1__reg_1_1__mask__enable__register.html#ad8db42637055a897799c867c554ebdbe',1,'ina234::_reg::_mask_enable_register']]] +]; diff --git a/search/classes_0.js b/search/classes_0.js new file mode 100644 index 0000000..319af56 --- /dev/null +++ b/search/classes_0.js @@ -0,0 +1,14 @@ +var searchData= +[ + ['_5falert_5flimit_5fregister_0',['_alert_limit_register',['../structina234_1_1__reg_1_1__alert__limit__register.html',1,'ina234::_reg']]], + ['_5fbus_5fvoltage_5fregister_1',['_bus_voltage_register',['../structina234_1_1__reg_1_1__bus__voltage__register.html',1,'ina234::_reg']]], + ['_5fcalibration_5fregister_2',['_calibration_register',['../structina234_1_1__reg_1_1__calibration__register.html',1,'ina234::_reg']]], + ['_5fconfig_5fregister_3',['_config_register',['../structina234_1_1__reg_1_1__config__register.html',1,'ina234::_reg']]], + ['_5fcurrent_5fregister_4',['_current_register',['../structina234_1_1__reg_1_1__current__register.html',1,'ina234::_reg']]], + ['_5fdevide_5fid_5fregister_5',['_devide_id_register',['../structina234_1_1__reg_1_1__devide__id__register.html',1,'ina234::_reg']]], + ['_5fmanufacture_5fid_5fregister_6',['_manufacture_id_register',['../structina234_1_1__reg_1_1__manufacture__id__register.html',1,'ina234::_reg']]], + ['_5fmask_5fenable_5fregister_7',['_mask_enable_register',['../structina234_1_1__reg_1_1__mask__enable__register.html',1,'ina234::_reg']]], + ['_5fpower_5fregister_8',['_power_register',['../structina234_1_1__reg_1_1__power__register.html',1,'ina234::_reg']]], + ['_5freg_9',['_reg',['../unionina234_1_1__reg.html',1,'ina234']]], + ['_5fshunt_5fvoltage_5fregister_10',['_shunt_voltage_register',['../structina234_1_1__reg_1_1__shunt__voltage__register.html',1,'ina234::_reg']]] +]; diff --git a/search/classes_1.js b/search/classes_1.js new file mode 100644 index 0000000..689af7f --- /dev/null +++ b/search/classes_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['ina234_0',['ina234',['../structina234.html',1,'']]] +]; diff --git a/search/defines_0.js b/search/defines_0.js new file mode 100644 index 0000000..b86a75c --- /dev/null +++ b/search/defines_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['alert_5flimit_5fregister_0',['ALERT_LIMIT_REGISTER',['../ina234_8h.html#ab843670bdea443688a3c0fc1bb59df4c',1,'ina234.h']]] +]; diff --git a/search/defines_1.js b/search/defines_1.js new file mode 100644 index 0000000..febce46 --- /dev/null +++ b/search/defines_1.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['bus_5fvoltage_5flsb_0',['BUS_VOLTAGE_LSB',['../ina234_8h.html#a775ced70ffbd32f6fb31cbb10a10187f',1,'ina234.h']]], + ['bus_5fvoltage_5fregister_1',['BUS_VOLTAGE_REGISTER',['../ina234_8h.html#a646eb67bd8e213ae03c5a03e6a569788',1,'ina234.h']]] +]; diff --git a/search/defines_2.js b/search/defines_2.js new file mode 100644 index 0000000..a224019 --- /dev/null +++ b/search/defines_2.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['calibration_5fregister_0',['CALIBRATION_REGISTER',['../ina234_8h.html#ab59d55e52855c8c0f649304fa92a9a13',1,'ina234.h']]], + ['configuration_5fregister_1',['CONFIGURATION_REGISTER',['../ina234_8h.html#a7ee3d94a0cd2d145d66bae6abe5bb302',1,'ina234.h']]], + ['current_5flsb_2',['CURRENT_LSB',['../ina234_8h.html#a81ed9fb0bd16f43a3a5bc335f966a96f',1,'ina234.h']]], + ['current_5flsb_5fminimum_3',['CURRENT_LSB_MINIMUM',['../ina234_8h.html#a48ce45ec20267ca3c0159a444dc30c33',1,'ina234.h']]], + ['current_5fregister_4',['CURRENT_REGISTER',['../ina234_8h.html#a3640431a41e460b8e7ddf642adefae95',1,'ina234.h']]] +]; diff --git a/search/defines_3.js b/search/defines_3.js new file mode 100644 index 0000000..b40a055 --- /dev/null +++ b/search/defines_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['deviceid_5fregister_0',['DEVICEID_REGISTER',['../ina234_8h.html#a238936614e386e75f2487559953cbc68',1,'ina234.h']]] +]; diff --git a/search/defines_4.js b/search/defines_4.js new file mode 100644 index 0000000..2650c45 --- /dev/null +++ b/search/defines_4.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['manufacturerid_5fregister_0',['MANUFACTURERID_REGISTER',['../ina234_8h.html#a8243b56922df1eafe7faf2f5231642b6',1,'ina234.h']]], + ['mask_5fenable_5fregister_1',['MASK_ENABLE_REGISTER',['../ina234_8h.html#ae92b8bbb58abb306563771a0149472d2',1,'ina234.h']]], + ['maximum_5fexpected_5fcurrent_2',['MAXIMUM_EXPECTED_CURRENT',['../ina234_8h.html#ad157a86c3b3394bca27e86844852ee04',1,'ina234.h']]] +]; diff --git a/search/defines_5.js b/search/defines_5.js new file mode 100644 index 0000000..cdb0e7d --- /dev/null +++ b/search/defines_5.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['power_5flsb_0',['POWER_LSB',['../ina234_8h.html#ab01b539856e5c5102cd3d97a38435d26',1,'ina234.h']]], + ['power_5fregister_1',['POWER_REGISTER',['../ina234_8h.html#a731f54cd49fcbbca608bfbe367c75dfb',1,'ina234.h']]] +]; diff --git a/search/defines_6.js b/search/defines_6.js new file mode 100644 index 0000000..09483ae --- /dev/null +++ b/search/defines_6.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['shunt_5fvoltage_5f20_5f48mv_5flsb_0',['SHUNT_VOLTAGE_20_48mv_LSB',['../ina234_8h.html#a8c0e636ce427d3785aea74926fabc624',1,'ina234.h']]], + ['shunt_5fvoltage_5f81_5f92mv_5flsb_1',['SHUNT_VOLTAGE_81_92mv_LSB',['../ina234_8h.html#a93329758cb0f2c6f52cffd48b8f961c8',1,'ina234.h']]], + ['shunt_5fvoltage_5fregister_2',['SHUNT_VOLTAGE_REGISTER',['../ina234_8h.html#aa417fcb934d07b4af5c20c44b920e5ae',1,'ina234.h']]] +]; diff --git a/search/enums_0.js b/search/enums_0.js new file mode 100644 index 0000000..ce537af --- /dev/null +++ b/search/enums_0.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['adcrange_0',['ADCRange',['../ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fc',1,'ina234.h']]], + ['alertconvready_1',['AlertConvReady',['../ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4',1,'ina234.h']]], + ['alertlatch_2',['AlertLatch',['../ina234_8h.html#a9524876614527f1c1cad905b5586a61c',1,'ina234.h']]], + ['alerton_3',['AlertOn',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4',1,'ina234.h']]], + ['alertpolarity_4',['AlertPolarity',['../ina234_8h.html#ada37218468b40fbf8e3f7951165cf634',1,'ina234.h']]], + ['alertsource_5',['AlertSource',['../ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8',1,'ina234.h']]] +]; diff --git a/search/enums_1.js b/search/enums_1.js new file mode 100644 index 0000000..35dd791 --- /dev/null +++ b/search/enums_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['convtime_0',['ConvTime',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6',1,'ina234.h']]] +]; diff --git a/search/enums_2.js b/search/enums_2.js new file mode 100644 index 0000000..ddc2517 --- /dev/null +++ b/search/enums_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['errortype_0',['ErrorType',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45a',1,'ina234.h']]] +]; diff --git a/search/enums_3.js b/search/enums_3.js new file mode 100644 index 0000000..90eae56 --- /dev/null +++ b/search/enums_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['mode_0',['Mode',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911',1,'ina234.h']]] +]; diff --git a/search/enums_4.js b/search/enums_4.js new file mode 100644 index 0000000..6276dab --- /dev/null +++ b/search/enums_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['numsamples_0',['NumSamples',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58',1,'ina234.h']]] +]; diff --git a/search/enums_5.js b/search/enums_5.js new file mode 100644 index 0000000..26fa8d7 --- /dev/null +++ b/search/enums_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['status_0',['Status',['../ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b',1,'ina234.h']]] +]; diff --git a/search/enumvalues_0.js b/search/enumvalues_0.js new file mode 100644 index 0000000..730ed3a --- /dev/null +++ b/search/enumvalues_0.js @@ -0,0 +1,17 @@ +var searchData= +[ + ['alert_5factive_5fhigh_0',['ALERT_ACTIVE_HIGH',['../ina234_8h.html#ada37218468b40fbf8e3f7951165cf634acc90eec8b0cea31c65d2125e1dec4b3d',1,'ina234.h']]], + ['alert_5factive_5flow_1',['ALERT_ACTIVE_LOW',['../ina234_8h.html#ada37218468b40fbf8e3f7951165cf634ac517f2dbfd71d39c6277a02c6a8e98b5',1,'ina234.h']]], + ['alert_5fbus_5fover_5flimit_2',['ALERT_BUS_OVER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a1ca5e700ee55d0dc367e350b23f11ec9',1,'ina234.h']]], + ['alert_5fbus_5funder_5flimit_3',['ALERT_BUS_UNDER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a94ace1d59fb93b2a18d3f81347d85baf',1,'ina234.h']]], + ['alert_5fconv_5fdisable_4',['ALERT_CONV_DISABLE',['../ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4a083db3ebfb856b3fb387dd31d856c0c8',1,'ina234.h']]], + ['alert_5fconv_5fenable_5',['ALERT_CONV_ENABLE',['../ina234_8h.html#af9b60a033119bbb624f6578c3dc1b6e4a5e0027e4e01b269be48d60a41243d854',1,'ina234.h']]], + ['alert_5fdata_5fready_6',['ALERT_DATA_READY',['../ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8a83f1800832e2ed9bc6691a53c9a1359d',1,'ina234.h']]], + ['alert_5flatched_7',['ALERT_LATCHED',['../ina234_8h.html#a9524876614527f1c1cad905b5586a61cae66cf6808527fe59bda82112ea1f0626',1,'ina234.h']]], + ['alert_5flimit_5freached_8',['ALERT_LIMIT_REACHED',['../ina234_8h.html#abfca48b6c5f91f6e8598c3366ec3f9a8aea5a0da07bc6063e3ad1f5bc0332dc65',1,'ina234.h']]], + ['alert_5fnone_9',['ALERT_NONE',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4ab84e7751ae498fa5f6354fec90392f84',1,'ina234.h']]], + ['alert_5fpower_5fover_5flimit_10',['ALERT_POWER_OVER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a34e2f0c08f8c607c6bef4c42a1650fb3',1,'ina234.h']]], + ['alert_5fshunt_5fover_5flimit_11',['ALERT_SHUNT_OVER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4adf6cdb85c8967fba23a0f0244b49057c',1,'ina234.h']]], + ['alert_5fshunt_5funder_5flimit_12',['ALERT_SHUNT_UNDER_LIMIT',['../ina234_8h.html#a81e9cf0869f985ab1a984626e9464ed4a948a648cb59cafcc5382b1b5e599d28b',1,'ina234.h']]], + ['alert_5ftransparent_13',['ALERT_TRANSPARENT',['../ina234_8h.html#a9524876614527f1c1cad905b5586a61ca8e18da66cd5b403de50cd5cea2867a01',1,'ina234.h']]] +]; diff --git a/search/enumvalues_1.js b/search/enumvalues_1.js new file mode 100644 index 0000000..800cffa --- /dev/null +++ b/search/enumvalues_1.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['ctime_5f1100us_0',['CTIME_1100us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a65ed0d16270a6141ab8dd8488fe7f41e',1,'ina234.h']]], + ['ctime_5f140us_1',['CTIME_140us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6acfaa6a642034e5c48d5f172355a0e22d',1,'ina234.h']]], + ['ctime_5f204us_2',['CTIME_204us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6ac369ab9b892e484bf6f6e1c62cdf89a8',1,'ina234.h']]], + ['ctime_5f2116us_3',['CTIME_2116us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a47c6de263bc91c68cc7aa33fa4ff0755',1,'ina234.h']]], + ['ctime_5f332us_4',['CTIME_332us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6abfd7d84dee689ba2bb2f17da3d09ac9a',1,'ina234.h']]], + ['ctime_5f4156us_5',['CTIME_4156us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a657a9b9f4cabd5ca90fee02c26638a04',1,'ina234.h']]], + ['ctime_5f588us_6',['CTIME_588us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a2fe24ae5755ffeb5b8082cd037b9dc7f',1,'ina234.h']]], + ['ctime_5f8244us_7',['CTIME_8244us',['../ina234_8h.html#ac8baaa7d3332fac0cb58606c8abacdb6a08b6eaecf78753c12f67dddf9949be84',1,'ina234.h']]] +]; diff --git a/search/enumvalues_2.js b/search/enumvalues_2.js new file mode 100644 index 0000000..023844a --- /dev/null +++ b/search/enumvalues_2.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['error_5fboth_5fmemory_5fovf_0',['ERROR_BOTH_MEMORY_OVF',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa4a2fc9e6bcb0135acd74edfec8554512',1,'ina234.h']]], + ['error_5fmemory_1',['ERROR_MEMORY',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa632a15615c9d0f691788ab4f0a66e41d',1,'ina234.h']]], + ['error_5fnone_2',['ERROR_NONE',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa4edc8aade11e1de7bbbdc04704baae5f',1,'ina234.h']]], + ['error_5fovf_3',['ERROR_OVF',['../ina234_8h.html#ab0df38968e4f03a3f1f6d6df0f31f45aa2a372620a5d99a4790787150ebe2a92c',1,'ina234.h']]] +]; diff --git a/search/enumvalues_3.js b/search/enumvalues_3.js new file mode 100644 index 0000000..9e29290 --- /dev/null +++ b/search/enumvalues_3.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['mode_5fcontinuous_5fboth_5fshunt_5fbus_0',['MODE_CONTINUOUS_BOTH_SHUNT_BUS',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a7bc1351d315d165a969fe64c964da364',1,'ina234.h']]], + ['mode_5fcontinuous_5fbus_1',['MODE_CONTINUOUS_BUS',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a6cba4ffadd57ed1e5f5a176ab21f4e85',1,'ina234.h']]], + ['mode_5fcontinuous_5fshunt_2',['MODE_CONTINUOUS_SHUNT',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911ac089fb7ab69f944b618f18abe16b3600',1,'ina234.h']]], + ['mode_5fshutdown_3',['MODE_SHUTDOWN',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a0680164b529f8d29d670308298ec2a2b',1,'ina234.h']]], + ['mode_5fshutdown2_4',['MODE_SHUTDOWN2',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a28192c7eb7daf555e5eb9def6b82c2db',1,'ina234.h']]], + ['mode_5fsingleshot_5fboth_5fshunt_5fbus_5',['MODE_SINGLESHOT_BOTH_SHUNT_BUS',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911ab729c3948326475cd19e84a433ae96bd',1,'ina234.h']]], + ['mode_5fsingleshot_5fbus_6',['MODE_SINGLESHOT_BUS',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911a9f304d5978fa9370e3cd0da297f85470',1,'ina234.h']]], + ['mode_5fsingleshot_5fsunt_7',['MODE_SINGLESHOT_SUNT',['../ina234_8h.html#a46c8a310cf4c094f8c80e1cb8dc1f911aa90b94d7cd6425245221d504534f0f2f',1,'ina234.h']]] +]; diff --git a/search/enumvalues_4.js b/search/enumvalues_4.js new file mode 100644 index 0000000..26be55f --- /dev/null +++ b/search/enumvalues_4.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['nadc_5f1_0',['NADC_1',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a993c043bbf51fcb3e71e24560079b3e0',1,'ina234.h']]], + ['nadc_5f1024_1',['NADC_1024',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a02bba2371c7cc4740a4bcccc82da45d7',1,'ina234.h']]], + ['nadc_5f128_2',['NADC_128',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58aa7cf4006919e212a7d722e96c826fa8d',1,'ina234.h']]], + ['nadc_5f16_3',['NADC_16',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a3a1205ed5042c059ebf47784254d1f29',1,'ina234.h']]], + ['nadc_5f256_4',['NADC_256',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58a91a4d2241e749494be617d895d318589',1,'ina234.h']]], + ['nadc_5f4_5',['NADC_4',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58ac9dd4285a560c534d22fca6840d0ebf5',1,'ina234.h']]], + ['nadc_5f512_6',['NADC_512',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58af045584cc242ad52f42910989945250f',1,'ina234.h']]], + ['nadc_5f64_7',['NADC_64',['../ina234_8h.html#aeec3587067ff840117ceeb10b98eda58abdcabf69ca2812231b1ee322cda057d1',1,'ina234.h']]] +]; diff --git a/search/enumvalues_5.js b/search/enumvalues_5.js new file mode 100644 index 0000000..8770ce4 --- /dev/null +++ b/search/enumvalues_5.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['range_5f20_5f48mv_0',['RANGE_20_48mV',['../ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fca39711bc57d71a9e56b586578de4da136',1,'ina234.h']]], + ['range_5f81_5f92mv_1',['RANGE_81_92mV',['../ina234_8h.html#ae77acd2b9e0633c6769c2275fc8c71fcac35ce98e9a40c62ca3ce4054c4d72bb5',1,'ina234.h']]] +]; diff --git a/search/enumvalues_6.js b/search/enumvalues_6.js new file mode 100644 index 0000000..13ffcae --- /dev/null +++ b/search/enumvalues_6.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['status_5fok_0',['STATUS_OK',['../ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba7e4a42e3b6dd63708c64cf3db6f69566',1,'ina234.h']]], + ['status_5ftimeout_1',['STATUS_TimeOut',['../ina234_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70bafddcb825c6c18107885a7d663dcf38e7',1,'ina234.h']]] +]; diff --git a/search/files_0.js b/search/files_0.js new file mode 100644 index 0000000..14c96ba --- /dev/null +++ b/search/files_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['ina234_2ec_0',['ina234.c',['../ina234_8c.html',1,'']]], + ['ina234_2eh_1',['ina234.h',['../ina234_8h.html',1,'']]] +]; diff --git a/search/files_1.js b/search/files_1.js new file mode 100644 index 0000000..9847676 --- /dev/null +++ b/search/files_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['readme_2emd_0',['README.md',['../README_8md.html',1,'']]] +]; diff --git a/search/functions_0.js b/search/functions_0.js new file mode 100644 index 0000000..bc32367 --- /dev/null +++ b/search/functions_0.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['_5f_5fina234_5freadtwobytes_0',['__INA234_readTwoBytes',['../ina234_8c.html#aa36cf3308ef4df72ddf8a78edff23556',1,'__INA234_readTwoBytes(INA234 *self, uint8_t MemAddress): ina234.c'],['../ina234_8h.html#aa36cf3308ef4df72ddf8a78edff23556',1,'__INA234_readTwoBytes(INA234 *self, uint8_t MemAddress): ina234.c']]], + ['_5f_5fina234_5fwritetwobytes_1',['__INA234_writeTwoBytes',['../ina234_8c.html#ac08e0ed8b382a2dd193753a2b302bae1',1,'__INA234_writeTwoBytes(INA234 *self, uint8_t MemAddress): ina234.c'],['../ina234_8h.html#ac08e0ed8b382a2dd193753a2b302bae1',1,'__INA234_writeTwoBytes(INA234 *self, uint8_t MemAddress): ina234.c']]] +]; diff --git a/search/functions_1.js b/search/functions_1.js new file mode 100644 index 0000000..1858bc6 --- /dev/null +++ b/search/functions_1.js @@ -0,0 +1,27 @@ +var searchData= +[ + ['ina234_5falert_5finit_0',['INA234_alert_init',['../ina234_8c.html#afb44437883ad8f8d08aaf695815da7ed',1,'INA234_alert_init(INA234 *self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit): ina234.c'],['../ina234_8h.html#afb44437883ad8f8d08aaf695815da7ed',1,'INA234_alert_init(INA234 *self, AlertOn alert_on, AlertPolarity alert_polarity, AlertLatch alert_latch, AlertConvReady alert_conv_ready, float alert_limit): ina234.c']]], + ['ina234_5fgetadcrange_1',['INA234_getADCRange',['../ina234_8c.html#ab9f2d8b23628fb6b060f837b9a4f71a5',1,'INA234_getADCRange(INA234 *self): ina234.c'],['../ina234_8h.html#ab9f2d8b23628fb6b060f837b9a4f71a5',1,'INA234_getADCRange(INA234 *self): ina234.c']]], + ['ina234_5fgetalertsource_2',['INA234_getAlertSource',['../ina234_8c.html#a52cc3b785dea1f5af6f0803f02fcefdb',1,'INA234_getAlertSource(INA234 *self): ina234.c'],['../ina234_8h.html#a52cc3b785dea1f5af6f0803f02fcefdb',1,'INA234_getAlertSource(INA234 *self): ina234.c']]], + ['ina234_5fgetbusvoltage_3',['INA234_getBusVoltage',['../ina234_8c.html#a97ec39b6399d3ab449e499a57668748d',1,'INA234_getBusVoltage(INA234 *self): ina234.c'],['../ina234_8h.html#a97ec39b6399d3ab449e499a57668748d',1,'INA234_getBusVoltage(INA234 *self): ina234.c']]], + ['ina234_5fgetcurrent_4',['INA234_getCurrent',['../ina234_8c.html#a825a355395fef312e3642f9f8ca6463c',1,'INA234_getCurrent(INA234 *self): ina234.c'],['../ina234_8h.html#a825a355395fef312e3642f9f8ca6463c',1,'INA234_getCurrent(INA234 *self): ina234.c']]], + ['ina234_5fgetdevid_5',['INA234_getDevID',['../ina234_8c.html#a88ff1503798836270a41d3b9f3913ca7',1,'INA234_getDevID(INA234 *self): ina234.c'],['../ina234_8h.html#a88ff1503798836270a41d3b9f3913ca7',1,'INA234_getDevID(INA234 *self): ina234.c']]], + ['ina234_5fgeterrors_6',['INA234_getErrors',['../ina234_8c.html#a14a3383eba06ce784ed526585a0cef9a',1,'INA234_getErrors(INA234 *self): ina234.c'],['../ina234_8h.html#a14a3383eba06ce784ed526585a0cef9a',1,'INA234_getErrors(INA234 *self): ina234.c']]], + ['ina234_5fgetmanid_7',['INA234_getManID',['../ina234_8c.html#ae646f51adec51af1aa6377c3dffeeb6a',1,'INA234_getManID(INA234 *self): ina234.c'],['../ina234_8h.html#ae646f51adec51af1aa6377c3dffeeb6a',1,'INA234_getManID(INA234 *self): ina234.c']]], + ['ina234_5fgetmode_8',['INA234_getMode',['../ina234_8c.html#a4af7c34341c14b8bfb40daf0665a766c',1,'INA234_getMode(INA234 *self): ina234.c'],['../ina234_8h.html#a4af7c34341c14b8bfb40daf0665a766c',1,'INA234_getMode(INA234 *self): ina234.c']]], + ['ina234_5fgetnumberofadcsamples_9',['INA234_getNumberOfADCSamples',['../ina234_8c.html#acda6b9d24c842d73ffca341ce39ac707',1,'INA234_getNumberOfADCSamples(INA234 *self): ina234.c'],['../ina234_8h.html#acda6b9d24c842d73ffca341ce39ac707',1,'INA234_getNumberOfADCSamples(INA234 *self): ina234.c']]], + ['ina234_5fgetpower_10',['INA234_getPower',['../ina234_8c.html#a163121f0afcab9a5e49f419b94290f20',1,'INA234_getPower(INA234 *self): ina234.c'],['../ina234_8h.html#a163121f0afcab9a5e49f419b94290f20',1,'INA234_getPower(INA234 *self): ina234.c']]], + ['ina234_5fgetshuntvoltage_11',['INA234_getShuntVoltage',['../ina234_8c.html#a256f66571357742aec8b4f0104c54b6b',1,'INA234_getShuntVoltage(INA234 *self): ina234.c'],['../ina234_8h.html#a256f66571357742aec8b4f0104c54b6b',1,'INA234_getShuntVoltage(INA234 *self): ina234.c']]], + ['ina234_5fgetvbusconversiontime_12',['INA234_getVBusConversionTime',['../ina234_8c.html#aa3f6130fa6074b931f415e9ca85f340d',1,'INA234_getVBusConversionTime(INA234 *self): ina234.c'],['../ina234_8h.html#aa3f6130fa6074b931f415e9ca85f340d',1,'INA234_getVBusConversionTime(INA234 *self): ina234.c']]], + ['ina234_5fgetvshuntconversiontime_13',['INA234_getVShuntConversionTime',['../ina234_8c.html#a6afffb92bb828562997a6a5592bc141a',1,'INA234_getVShuntConversionTime(INA234 *self): ina234.c'],['../ina234_8h.html#a6afffb92bb828562997a6a5592bc141a',1,'INA234_getVShuntConversionTime(INA234 *self): ina234.c']]], + ['ina234_5finit_14',['INA234_init',['../ina234_8c.html#a21acc30b187445a98f711a54b8678c7c',1,'INA234_init(INA234 *self, uint8_t I2C_ADDR, I2C_HandleTypeDef *hi2c, float ShuntResistor, ADCRange adc_range, NumSamples numer_of_adc_samples, ConvTime vbus_conversion_time, ConvTime vshunt_conversion_time, Mode mode): ina234.c'],['../ina234_8h.html#a21acc30b187445a98f711a54b8678c7c',1,'INA234_init(INA234 *self, uint8_t I2C_ADDR, I2C_HandleTypeDef *hi2c, float ShuntResistor, ADCRange adc_range, NumSamples numer_of_adc_samples, ConvTime vbus_conversion_time, ConvTime vshunt_conversion_time, Mode mode): ina234.c']]], + ['ina234_5fisdataready_15',['INA234_isDataReady',['../ina234_8c.html#a9637d475148409297883f05464a92e86',1,'INA234_isDataReady(INA234 *self): ina234.c'],['../ina234_8h.html#a9637d475148409297883f05464a92e86',1,'INA234_isDataReady(INA234 *self): ina234.c']]], + ['ina234_5freadall_16',['INA234_readAll',['../ina234_8c.html#ac7901cf62e078ff3a235839061a3608b',1,'INA234_readAll(INA234 *self): ina234.c'],['../ina234_8h.html#ac7901cf62e078ff3a235839061a3608b',1,'INA234_readAll(INA234 *self): ina234.c']]], + ['ina234_5fresetalert_17',['INA234_resetAlert',['../ina234_8c.html#a5810f9a740226a39ba5cc2afa6b64f77',1,'INA234_resetAlert(INA234 *self): ina234.c'],['../ina234_8h.html#a5810f9a740226a39ba5cc2afa6b64f77',1,'INA234_resetAlert(INA234 *self): ina234.c']]], + ['ina234_5fsetadcrange_18',['INA234_setADCRange',['../ina234_8c.html#aba71c63deed65a0abdbf7269b5f382d8',1,'INA234_setADCRange(INA234 *self, ADCRange adc_range): ina234.c'],['../ina234_8h.html#aba71c63deed65a0abdbf7269b5f382d8',1,'INA234_setADCRange(INA234 *self, ADCRange adc_range): ina234.c']]], + ['ina234_5fsetmode_19',['INA234_setMode',['../ina234_8c.html#ac85c8e736ffae6d248971091b374d00f',1,'INA234_setMode(INA234 *self, Mode mode): ina234.c'],['../ina234_8h.html#ac85c8e736ffae6d248971091b374d00f',1,'INA234_setMode(INA234 *self, Mode mode): ina234.c']]], + ['ina234_5fsetnumberofadcsamples_20',['INA234_setNumberOfADCSamples',['../ina234_8c.html#a84ff6173bf6cfa44348ba259a503c804',1,'INA234_setNumberOfADCSamples(INA234 *self, NumSamples numer_of_adc_samples): ina234.c'],['../ina234_8h.html#a84ff6173bf6cfa44348ba259a503c804',1,'INA234_setNumberOfADCSamples(INA234 *self, NumSamples numer_of_adc_samples): ina234.c']]], + ['ina234_5fsetvbusconversiontime_21',['INA234_setVBusConversionTime',['../ina234_8c.html#a94ec7dc7cd10748c4ed822266174d0ff',1,'INA234_setVBusConversionTime(INA234 *self, ConvTime vbus_conversion_time): ina234.c'],['../ina234_8h.html#a94ec7dc7cd10748c4ed822266174d0ff',1,'INA234_setVBusConversionTime(INA234 *self, ConvTime vbus_conversion_time): ina234.c']]], + ['ina234_5fsetvshuntconversiontime_22',['INA234_setVShuntConversionTime',['../ina234_8c.html#ad19627414a2465c9cf1fac54f54eaa39',1,'INA234_setVShuntConversionTime(INA234 *self, ConvTime vshunt_conversion_time): ina234.c'],['../ina234_8h.html#ad19627414a2465c9cf1fac54f54eaa39',1,'INA234_setVShuntConversionTime(INA234 *self, ConvTime vshunt_conversion_time): ina234.c']]], + ['ina234_5fsoftresetall_23',['INA234_SoftResetAll',['../ina234_8c.html#af3d939ea27371b17fd265f19957234b2',1,'INA234_SoftResetAll(INA234 *self): ina234.c'],['../ina234_8h.html#af3d939ea27371b17fd265f19957234b2',1,'INA234_SoftResetAll(INA234 *self): ina234.c']]] +]; diff --git a/search/pages_0.js b/search/pages_0.js new file mode 100644 index 0000000..d09a299 --- /dev/null +++ b/search/pages_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['based_20library_0',['INA234 HAL Based Library',['../md_README.html',1,'']]] +]; diff --git a/search/pages_1.js b/search/pages_1.js new file mode 100644 index 0000000..5c50b57 --- /dev/null +++ b/search/pages_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['current_20voltage_20power_20monitor_20library_0',['INA234 current/voltage/power monitor library',['../index.html',1,'']]] +]; diff --git a/search/pages_2.js b/search/pages_2.js new file mode 100644 index 0000000..e8b75f7 --- /dev/null +++ b/search/pages_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['hal_20based_20library_0',['INA234 HAL Based Library',['../md_README.html',1,'']]] +]; diff --git a/search/pages_3.js b/search/pages_3.js new file mode 100644 index 0000000..11392a8 --- /dev/null +++ b/search/pages_3.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['ina234_20current_20voltage_20power_20monitor_20library_0',['INA234 current/voltage/power monitor library',['../index.html',1,'']]], + ['ina234_20hal_20based_20library_1',['INA234 HAL Based Library',['../md_README.html',1,'']]] +]; diff --git a/search/pages_4.js b/search/pages_4.js new file mode 100644 index 0000000..7517fa0 --- /dev/null +++ b/search/pages_4.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['library_0',['INA234 HAL Based Library',['../md_README.html',1,'']]], + ['library_1',['INA234 current/voltage/power monitor library',['../index.html',1,'']]] +]; diff --git a/search/pages_5.js b/search/pages_5.js new file mode 100644 index 0000000..c6ff36e --- /dev/null +++ b/search/pages_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['monitor_20library_0',['INA234 current/voltage/power monitor library',['../index.html',1,'']]] +]; diff --git a/search/pages_6.js b/search/pages_6.js new file mode 100644 index 0000000..ab2a611 --- /dev/null +++ b/search/pages_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['power_20monitor_20library_0',['INA234 current/voltage/power monitor library',['../index.html',1,'']]] +]; diff --git a/search/pages_7.js b/search/pages_7.js new file mode 100644 index 0000000..9c44b93 --- /dev/null +++ b/search/pages_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['voltage_20power_20monitor_20library_0',['INA234 current/voltage/power monitor library',['../index.html',1,'']]] +]; diff --git a/search/searchdata.js b/search/searchdata.js index f95870c..a77c6a5 100644 --- a/search/searchdata.js +++ b/search/searchdata.js @@ -1,12 +1,42 @@ var indexSectionsWithContent = { + 0: "_abcdeghilmnoprsv", + 1: "_i", + 2: "ir", + 3: "_i", + 4: "abcdhilmnoprsv", + 5: "aceimns", + 6: "acemns", + 7: "acemnrs", + 8: "abcdmps", + 9: "bchilmpv" }; var indexSectionNames = { + 0: "all", + 1: "classes", + 2: "files", + 3: "functions", + 4: "variables", + 5: "typedefs", + 6: "enums", + 7: "enumvalues", + 8: "defines", + 9: "pages" }; var indexSectionLabels = { + 0: "All", + 1: "Data Structures", + 2: "Files", + 3: "Functions", + 4: "Variables", + 5: "Typedefs", + 6: "Enumerations", + 7: "Enumerator", + 8: "Macros", + 9: "Pages" }; diff --git a/search/typedefs_0.js b/search/typedefs_0.js new file mode 100644 index 0000000..3005b17 --- /dev/null +++ b/search/typedefs_0.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['adcrange_0',['ADCRange',['../ina234_8h.html#a650dc7cee4ad520ed3fa35dbe7142216',1,'ina234.h']]], + ['alertconvready_1',['AlertConvReady',['../ina234_8h.html#a848ebbc680edb7898d7edc1ca52a0d37',1,'ina234.h']]], + ['alertlatch_2',['AlertLatch',['../ina234_8h.html#afc7b0844b88c911005553dd08939b096',1,'ina234.h']]], + ['alerton_3',['AlertOn',['../ina234_8h.html#a6be1753fa6a5ab6a2afa25019e635f5f',1,'ina234.h']]], + ['alertpolarity_4',['AlertPolarity',['../ina234_8h.html#a74f38e65a7114a53a324d460820a43a4',1,'ina234.h']]], + ['alertsource_5',['AlertSource',['../ina234_8h.html#a3872be266ee7297b319f93420303a008',1,'ina234.h']]] +]; diff --git a/search/typedefs_1.js b/search/typedefs_1.js new file mode 100644 index 0000000..aef76fb --- /dev/null +++ b/search/typedefs_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['convtime_0',['ConvTime',['../ina234_8h.html#ab303d390218c5cf7c69501e0559213ec',1,'ina234.h']]] +]; diff --git a/search/typedefs_2.js b/search/typedefs_2.js new file mode 100644 index 0000000..be63219 --- /dev/null +++ b/search/typedefs_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['errortype_0',['ErrorType',['../ina234_8h.html#a1324293b60f4d902ebc99cf0d31bad89',1,'ina234.h']]] +]; diff --git a/search/typedefs_3.js b/search/typedefs_3.js new file mode 100644 index 0000000..e2cce98 --- /dev/null +++ b/search/typedefs_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['ina234_0',['INA234',['../ina234_8h.html#a0ee8a79a292d53863aff0274ca030f5a',1,'ina234.h']]] +]; diff --git a/search/typedefs_4.js b/search/typedefs_4.js new file mode 100644 index 0000000..17d8d39 --- /dev/null +++ b/search/typedefs_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['mode_0',['Mode',['../ina234_8h.html#a27e0b80eae69f3ea0f661dea593912c8',1,'ina234.h']]] +]; diff --git a/search/typedefs_5.js b/search/typedefs_5.js new file mode 100644 index 0000000..adb5e49 --- /dev/null +++ b/search/typedefs_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['numsamples_0',['NumSamples',['../ina234_8h.html#a3bce910f55e3b114067517de3ca4ff28',1,'ina234.h']]] +]; diff --git a/search/typedefs_6.js b/search/typedefs_6.js new file mode 100644 index 0000000..8f961e2 --- /dev/null +++ b/search/typedefs_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['status_0',['Status',['../ina234_8h.html#a59ac6513a4c0c951eff022338ea6e9f6',1,'ina234.h']]] +]; diff --git a/search/variables_0.js b/search/variables_0.js new file mode 100644 index 0000000..62532da --- /dev/null +++ b/search/variables_0.js @@ -0,0 +1,15 @@ +var searchData= +[ + ['acdrange_0',['ACDRANGE',['../structina234_1_1__reg_1_1__config__register.html#a2cae4ff84c5462b931bd99ef5a3434e8',1,'ina234::_reg::_config_register']]], + ['adc_5frange_1',['adc_range',['../structina234.html#af614e8e36e36f2703a95b4cf98e6e47c',1,'ina234']]], + ['aff_2',['AFF',['../structina234_1_1__reg_1_1__mask__enable__register.html#a5fe2c3e0f082c277a47c739bb4c050f0',1,'ina234::_reg::_mask_enable_register']]], + ['alert_5fconv_5fready_3',['alert_conv_ready',['../structina234.html#a3c24a2f4305134b1da6f3a4a7515608b',1,'ina234']]], + ['alert_5flatch_4',['alert_latch',['../structina234.html#a2a7579503920bd539e301005e0a000f9',1,'ina234']]], + ['alert_5flimit_5',['alert_limit',['../structina234.html#acf7d16f76c1d445ce5a62d94fad9472f',1,'ina234']]], + ['alert_5flimit_5fint_6',['alert_limit_int',['../structina234.html#ad2f27d00ab89273641b8c85897f63578',1,'ina234']]], + ['alert_5flimit_5fregister_7',['alert_limit_register',['../unionina234_1_1__reg.html#acee2fbb0cc5b0af342d28004e1421fc8',1,'ina234::_reg']]], + ['alert_5fon_8',['alert_on',['../structina234.html#a88e4987220f0aeb0da2a012b9590201a',1,'ina234']]], + ['alert_5fpolarity_9',['alert_polarity',['../structina234.html#a899269e44feff92f5675821efc09fbd5',1,'ina234']]], + ['apol_10',['APOL',['../structina234_1_1__reg_1_1__mask__enable__register.html#a1b52d5c7b321b1a00b920df8aaef4ebb',1,'ina234::_reg::_mask_enable_register']]], + ['avg_11',['AVG',['../structina234_1_1__reg_1_1__config__register.html#ae5a0c05847ffa0e32d0903a07261dd71',1,'ina234::_reg::_config_register']]] +]; diff --git a/search/variables_1.js b/search/variables_1.js new file mode 100644 index 0000000..62711de --- /dev/null +++ b/search/variables_1.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['bol_0',['BOL',['../structina234_1_1__reg_1_1__mask__enable__register.html#a0523a734c855650be9b9f060fc3cdf75',1,'ina234::_reg::_mask_enable_register']]], + ['bul_1',['BUL',['../structina234_1_1__reg_1_1__mask__enable__register.html#ad8d9d3c9c1f94b7a3685b53757033c55',1,'ina234::_reg::_mask_enable_register']]], + ['bus_5fvoltage_5fregister_2',['bus_voltage_register',['../unionina234_1_1__reg.html#a369b998af644dc917134f6075b6d0d8e',1,'ina234::_reg']]], + ['busvoltage_3',['BusVoltage',['../structina234.html#a4cf12f3449e646afc1f8cc93a5264589',1,'ina234']]] +]; diff --git a/search/variables_2.js b/search/variables_2.js new file mode 100644 index 0000000..2640c0f --- /dev/null +++ b/search/variables_2.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['calibration_5fregister_0',['calibration_register',['../unionina234_1_1__reg.html#af8c8679ad9234831937cf17e85935231',1,'ina234::_reg']]], + ['cnvr_1',['CNVR',['../structina234_1_1__reg_1_1__mask__enable__register.html#ab967f10721179bd6819267d3f28e7823',1,'ina234::_reg::_mask_enable_register']]], + ['config_5fregister_2',['config_register',['../unionina234_1_1__reg.html#a99cf80892bd6eb97d2dfe5d8094d4375',1,'ina234::_reg']]], + ['current_3',['CURRENT',['../structina234_1_1__reg_1_1__current__register.html#a2ed399eace19c88cda48107e537271d2',1,'ina234::_reg::_current_register']]], + ['current_4',['Current',['../structina234.html#ae8d3473f04d1b074e042108e0816efe6',1,'ina234']]], + ['current_5fregister_5',['current_register',['../unionina234_1_1__reg.html#ab8acdea3a879f282b66100182c706b9b',1,'ina234::_reg']]], + ['cvrf_6',['CVRF',['../structina234_1_1__reg_1_1__mask__enable__register.html#afb1d44ecc07606d4604568fb8ac74a32',1,'ina234::_reg::_mask_enable_register']]] +]; diff --git a/search/variables_3.js b/search/variables_3.js new file mode 100644 index 0000000..7b093f6 --- /dev/null +++ b/search/variables_3.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['devide_5fid_5fregister_0',['devide_id_register',['../unionina234_1_1__reg.html#a99a13b89ff65812966f048cc413de88e',1,'ina234::_reg']]], + ['dieid_1',['DIEID',['../structina234_1_1__reg_1_1__devide__id__register.html#a1c2fbd56052f9cd2aedf35c988950eb8',1,'ina234::_reg::_devide_id_register']]] +]; diff --git a/search/variables_4.js b/search/variables_4.js new file mode 100644 index 0000000..3ff25b2 --- /dev/null +++ b/search/variables_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['hi2c_0',['hi2c',['../structina234.html#abf45242a4a812df409b53ce5216f8d7e',1,'ina234']]] +]; diff --git a/search/variables_5.js b/search/variables_5.js new file mode 100644 index 0000000..8a65a30 --- /dev/null +++ b/search/variables_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['i2c_5faddr_0',['I2C_ADDR',['../structina234.html#acede59719bc6487dd599349740fa29fc',1,'ina234']]] +]; diff --git a/search/variables_6.js b/search/variables_6.js new file mode 100644 index 0000000..4fba7f7 --- /dev/null +++ b/search/variables_6.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['len_0',['LEN',['../structina234_1_1__reg_1_1__mask__enable__register.html#a045f31cd5049e505de87de0f6ff32d48',1,'ina234::_reg::_mask_enable_register']]], + ['limit_1',['LIMIT',['../structina234_1_1__reg_1_1__alert__limit__register.html#a8f69b5d3049c8432f1a7c671b7e759aa',1,'ina234::_reg::_alert_limit_register']]] +]; diff --git a/search/variables_7.js b/search/variables_7.js new file mode 100644 index 0000000..58563b3 --- /dev/null +++ b/search/variables_7.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['manufacture_5fid_0',['MANUFACTURE_ID',['../structina234_1_1__reg_1_1__manufacture__id__register.html#ae9ec42bcafa5e076b6489e0aa8373d58',1,'ina234::_reg::_manufacture_id_register']]], + ['manufacture_5fid_5fregister_1',['manufacture_id_register',['../unionina234_1_1__reg.html#a1e929abda30270e8b0eda26e26d68f83',1,'ina234::_reg']]], + ['mask_5fenable_5fregister_2',['mask_enable_register',['../unionina234_1_1__reg.html#a2fa3a9f20fd08972d7968962ee824d4b',1,'ina234::_reg']]], + ['memerror_3',['MemError',['../structina234_1_1__reg_1_1__mask__enable__register.html#a848f62ff7c149d4e1767499eca44f0e6',1,'ina234::_reg::_mask_enable_register']]], + ['mode_4',['MODE',['../structina234_1_1__reg_1_1__config__register.html#abd348ee828aadd0781f3fa97d167e564',1,'ina234::_reg::_config_register']]], + ['mode_5',['mode',['../structina234.html#a2618e89b4c26dc851feae865df3a1a49',1,'ina234']]] +]; diff --git a/search/variables_8.js b/search/variables_8.js new file mode 100644 index 0000000..fc88113 --- /dev/null +++ b/search/variables_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['number_5fof_5fadc_5fsamples_0',['number_of_adc_samples',['../structina234.html#a2ab8a9d5ad14120cc622664faf5d9fef',1,'ina234']]] +]; diff --git a/search/variables_9.js b/search/variables_9.js new file mode 100644 index 0000000..096f33d --- /dev/null +++ b/search/variables_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['ovf_0',['OVF',['../structina234_1_1__reg_1_1__mask__enable__register.html#a924358cdfd4563e425c05b90f7f1b733',1,'ina234::_reg::_mask_enable_register']]] +]; diff --git a/search/variables_a.js b/search/variables_a.js new file mode 100644 index 0000000..440fac5 --- /dev/null +++ b/search/variables_a.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['pol_0',['POL',['../structina234_1_1__reg_1_1__mask__enable__register.html#aa0b57507453cd43c4b79df8fcee20978',1,'ina234::_reg::_mask_enable_register']]], + ['power_1',['POWER',['../structina234_1_1__reg_1_1__power__register.html#a8ef2a47bcdbc2202d402528a15b9a0a3',1,'ina234::_reg::_power_register']]], + ['power_2',['Power',['../structina234.html#aeca176f09c48cbe15df7fc4fff7c77f7',1,'ina234']]], + ['power_5fregister_3',['power_register',['../unionina234_1_1__reg.html#adc2d71b0b9e065cf1fb9086b2834c3f1',1,'ina234::_reg']]] +]; diff --git a/search/variables_b.js b/search/variables_b.js new file mode 100644 index 0000000..902fce8 --- /dev/null +++ b/search/variables_b.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['raw_5fdata_0',['raw_data',['../unionina234_1_1__reg.html#a212c976969c3d66f4b79de05921422b5',1,'ina234::_reg']]], + ['reg_1',['reg',['../structina234.html#ab54a1e11860021b67b7c73b923423ae7',1,'ina234']]], + ['reserved_2',['RESERVED',['../structina234_1_1__reg_1_1__config__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_config_register::RESERVED'],['../structina234_1_1__reg_1_1__shunt__voltage__register.html#aa42491e0ff1ccdf2056d947f78957917',1,'ina234::_reg::_shunt_voltage_register::RESERVED'],['../structina234_1_1__reg_1_1__bus__voltage__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_bus_voltage_register::RESERVED'],['../structina234_1_1__reg_1_1__current__register.html#aa42491e0ff1ccdf2056d947f78957917',1,'ina234::_reg::_current_register::RESERVED'],['../structina234_1_1__reg_1_1__calibration__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_calibration_register::RESERVED'],['../structina234_1_1__reg_1_1__mask__enable__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_mask_enable_register::RESERVED'],['../structina234_1_1__reg_1_1__devide__id__register.html#a9484db76faad15bb8da293c622dd2269',1,'ina234::_reg::_devide_id_register::RESERVED']]], + ['reserved2_3',['RESERVED2',['../structina234_1_1__reg_1_1__bus__voltage__register.html#a5573848497a716a9947fd87487709feb',1,'ina234::_reg::_bus_voltage_register']]], + ['rst_4',['RST',['../structina234_1_1__reg_1_1__config__register.html#abef8327bfd071009d10633030379e701',1,'ina234::_reg::_config_register']]] +]; diff --git a/search/variables_c.js b/search/variables_c.js new file mode 100644 index 0000000..f55c54f --- /dev/null +++ b/search/variables_c.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['shunt_5fcal_0',['SHUNT_CAL',['../structina234_1_1__reg_1_1__calibration__register.html#a115d21bedd85f661114c0c719fc22da0',1,'ina234::_reg::_calibration_register']]], + ['shunt_5fvoltage_5fregister_1',['shunt_voltage_register',['../unionina234_1_1__reg.html#a5788ff3d34c964926fed0bebed42e3ac',1,'ina234::_reg']]], + ['shuntresistor_2',['ShuntResistor',['../structina234.html#a2e10662b238ee4fa108ca0792851d136',1,'ina234']]], + ['shuntvoltage_3',['ShuntVoltage',['../structina234.html#ac63c1ad335c16bcdb33b5e55cf773ad3',1,'ina234']]], + ['sol_4',['SOL',['../structina234_1_1__reg_1_1__mask__enable__register.html#a5c27f0c90ddb7694a7242366879d4685',1,'ina234::_reg::_mask_enable_register']]], + ['sul_5',['SUL',['../structina234_1_1__reg_1_1__mask__enable__register.html#ad8db42637055a897799c867c554ebdbe',1,'ina234::_reg::_mask_enable_register']]] +]; diff --git a/search/variables_d.js b/search/variables_d.js new file mode 100644 index 0000000..2aa29b5 --- /dev/null +++ b/search/variables_d.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['vbus_0',['VBUS',['../structina234_1_1__reg_1_1__bus__voltage__register.html#adf5c609e86df6632a09ad897c2eb4e94',1,'ina234::_reg::_bus_voltage_register']]], + ['vbus_5fconversion_5ftime_1',['vbus_conversion_time',['../structina234.html#ac0ebad16cd5b42cd142546eab3aef22e',1,'ina234']]], + ['vbusct_2',['VBUSCT',['../structina234_1_1__reg_1_1__config__register.html#a2854a902bb3af04427b00a8472b0cbb8',1,'ina234::_reg::_config_register']]], + ['vshct_3',['VSHCT',['../structina234_1_1__reg_1_1__config__register.html#a9efa998f60c85d1bdd04cc3dd4bdc693',1,'ina234::_reg::_config_register']]], + ['vshunt_4',['VSHUNT',['../structina234_1_1__reg_1_1__shunt__voltage__register.html#a66e0475d4572f9d2c526cdc06c229ae6',1,'ina234::_reg::_shunt_voltage_register']]], + ['vshunt_5fconversion_5ftime_5',['vshunt_conversion_time',['../structina234.html#a5675cd02ce9e463e2bb990cdd56b7e8a',1,'ina234']]] +]; diff --git a/structina234.html b/structina234.html new file mode 100644 index 0000000..0caa3fb --- /dev/null +++ b/structina234.html @@ -0,0 +1,440 @@ + + + + + + + +INA234 HAL Based Library: ina234 Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Structures | +Data Fields
+
ina234 Struct Reference
+
+
+ +

Class (struct) that stores variables for interacting with INA234. + More...

+ +

#include <ina234.h>

+ + + + +

+Data Structures

union  _reg
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Data Fields

I2C_HandleTypeDef * hi2c
 
uint8_t I2C_ADDR
 
ADCRange adc_range
 
NumSamples number_of_adc_samples
 
ConvTime vbus_conversion_time
 
ConvTime vshunt_conversion_time
 
Mode mode
 
float ShuntResistor
 
AlertOn alert_on
 
AlertPolarity alert_polarity
 
AlertLatch alert_latch
 
AlertConvReady alert_conv_ready
 
float alert_limit
 
int32_t alert_limit_int
 
float ShuntVoltage
 
float BusVoltage
 
float Power
 
float Current
 
union ina234::_reg reg
 
+

Detailed Description

+

Class (struct) that stores variables for interacting with INA234.

+

Field Documentation

+ +

◆ adc_range

+ +
+
+ + + + +
ADCRange adc_range
+
+ +
+
+ +

◆ alert_conv_ready

+ +
+
+ + + + +
AlertConvReady alert_conv_ready
+
+ +
+
+ +

◆ alert_latch

+ +
+
+ + + + +
AlertLatch alert_latch
+
+ +
+
+ +

◆ alert_limit

+ +
+
+ + + + +
float alert_limit
+
+ +
+
+ +

◆ alert_limit_int

+ +
+
+ + + + +
int32_t alert_limit_int
+
+ +
+
+ +

◆ alert_on

+ +
+
+ + + + +
AlertOn alert_on
+
+ +
+
+ +

◆ alert_polarity

+ +
+
+ + + + +
AlertPolarity alert_polarity
+
+ +
+
+ +

◆ BusVoltage

+ +
+
+ + + + +
float BusVoltage
+
+ +
+
+ +

◆ Current

+ +
+
+ + + + +
float Current
+
+ +
+
+ +

◆ hi2c

+ +
+
+ + + + +
I2C_HandleTypeDef* hi2c
+
+

Specifies the I2C handler.

+ +
+
+ +

◆ I2C_ADDR

+ +
+
+ + + + +
uint8_t I2C_ADDR
+
+ +
+
+ +

◆ mode

+ +
+
+ + + + +
Mode mode
+
+ +
+
+ +

◆ number_of_adc_samples

+ +
+
+ + + + +
NumSamples number_of_adc_samples
+
+ +
+
+ +

◆ Power

+ +
+
+ + + + +
float Power
+
+ +
+
+ +

◆ reg

+ +
+
+ + + + +
union ina234::_reg reg
+
+ +
+
+ +

◆ ShuntResistor

+ +
+
+ + + + +
float ShuntResistor
+
+ +
+
+ +

◆ ShuntVoltage

+ +
+
+ + + + +
float ShuntVoltage
+
+ +
+
+ +

◆ vbus_conversion_time

+ +
+
+ + + + +
ConvTime vbus_conversion_time
+
+ +
+
+ +

◆ vshunt_conversion_time

+ +
+
+ + + + +
ConvTime vshunt_conversion_time
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234.js b/structina234.js new file mode 100644 index 0000000..955c6d7 --- /dev/null +++ b/structina234.js @@ -0,0 +1,23 @@ +var structina234 = +[ + [ "_reg", "unionina234_1_1__reg.html", "unionina234_1_1__reg" ], + [ "adc_range", "structina234.html#af614e8e36e36f2703a95b4cf98e6e47c", null ], + [ "alert_conv_ready", "structina234.html#a3c24a2f4305134b1da6f3a4a7515608b", null ], + [ "alert_latch", "structina234.html#a2a7579503920bd539e301005e0a000f9", null ], + [ "alert_limit", "structina234.html#acf7d16f76c1d445ce5a62d94fad9472f", null ], + [ "alert_limit_int", "structina234.html#ad2f27d00ab89273641b8c85897f63578", null ], + [ "alert_on", "structina234.html#a88e4987220f0aeb0da2a012b9590201a", null ], + [ "alert_polarity", "structina234.html#a899269e44feff92f5675821efc09fbd5", null ], + [ "BusVoltage", "structina234.html#a4cf12f3449e646afc1f8cc93a5264589", null ], + [ "Current", "structina234.html#ae8d3473f04d1b074e042108e0816efe6", null ], + [ "hi2c", "structina234.html#abf45242a4a812df409b53ce5216f8d7e", null ], + [ "I2C_ADDR", "structina234.html#acede59719bc6487dd599349740fa29fc", null ], + [ "mode", "structina234.html#a2618e89b4c26dc851feae865df3a1a49", null ], + [ "number_of_adc_samples", "structina234.html#a2ab8a9d5ad14120cc622664faf5d9fef", null ], + [ "Power", "structina234.html#aeca176f09c48cbe15df7fc4fff7c77f7", null ], + [ "reg", "structina234.html#ab54a1e11860021b67b7c73b923423ae7", null ], + [ "ShuntResistor", "structina234.html#a2e10662b238ee4fa108ca0792851d136", null ], + [ "ShuntVoltage", "structina234.html#ac63c1ad335c16bcdb33b5e55cf773ad3", null ], + [ "vbus_conversion_time", "structina234.html#ac0ebad16cd5b42cd142546eab3aef22e", null ], + [ "vshunt_conversion_time", "structina234.html#a5675cd02ce9e463e2bb990cdd56b7e8a", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__alert__limit__register.html b/structina234_1_1__reg_1_1__alert__limit__register.html new file mode 100644 index 0000000..4028d3c --- /dev/null +++ b/structina234_1_1__reg_1_1__alert__limit__register.html @@ -0,0 +1,140 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_alert_limit_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_alert_limit_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + +

+Data Fields

int16_t LIMIT
 
+

Field Documentation

+ +

◆ LIMIT

+ +
+
+ + + + +
int16_t LIMIT
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__alert__limit__register.js b/structina234_1_1__reg_1_1__alert__limit__register.js new file mode 100644 index 0000000..a8f7bc0 --- /dev/null +++ b/structina234_1_1__reg_1_1__alert__limit__register.js @@ -0,0 +1,4 @@ +var structina234_1_1__reg_1_1__alert__limit__register = +[ + [ "LIMIT", "structina234_1_1__reg_1_1__alert__limit__register.html#a8f69b5d3049c8432f1a7c671b7e759aa", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__bus__voltage__register.html b/structina234_1_1__reg_1_1__bus__voltage__register.html new file mode 100644 index 0000000..c4800ad --- /dev/null +++ b/structina234_1_1__reg_1_1__bus__voltage__register.html @@ -0,0 +1,172 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_bus_voltage_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_bus_voltage_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + + + + + +

+Data Fields

uint16_t RESERVED:4
 
uint16_t VBUS:11
 
uint16_t RESERVED2:1
 
+

Field Documentation

+ +

◆ RESERVED

+ +
+
+ + + + +
uint16_t RESERVED
+
+ +
+
+ +

◆ RESERVED2

+ +
+
+ + + + +
uint16_t RESERVED2
+
+ +
+
+ +

◆ VBUS

+ +
+
+ + + + +
uint16_t VBUS
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__bus__voltage__register.js b/structina234_1_1__reg_1_1__bus__voltage__register.js new file mode 100644 index 0000000..c856706 --- /dev/null +++ b/structina234_1_1__reg_1_1__bus__voltage__register.js @@ -0,0 +1,6 @@ +var structina234_1_1__reg_1_1__bus__voltage__register = +[ + [ "RESERVED", "structina234_1_1__reg_1_1__bus__voltage__register.html#a9484db76faad15bb8da293c622dd2269", null ], + [ "RESERVED2", "structina234_1_1__reg_1_1__bus__voltage__register.html#a5573848497a716a9947fd87487709feb", null ], + [ "VBUS", "structina234_1_1__reg_1_1__bus__voltage__register.html#adf5c609e86df6632a09ad897c2eb4e94", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__calibration__register.html b/structina234_1_1__reg_1_1__calibration__register.html new file mode 100644 index 0000000..1e04ee8 --- /dev/null +++ b/structina234_1_1__reg_1_1__calibration__register.html @@ -0,0 +1,156 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_calibration_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_calibration_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + + + +

+Data Fields

uint16_t SHUNT_CAL:15
 
uint16_t RESERVED:1
 
+

Field Documentation

+ +

◆ RESERVED

+ +
+
+ + + + +
uint16_t RESERVED
+
+ +
+
+ +

◆ SHUNT_CAL

+ +
+
+ + + + +
uint16_t SHUNT_CAL
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__calibration__register.js b/structina234_1_1__reg_1_1__calibration__register.js new file mode 100644 index 0000000..87611f9 --- /dev/null +++ b/structina234_1_1__reg_1_1__calibration__register.js @@ -0,0 +1,5 @@ +var structina234_1_1__reg_1_1__calibration__register = +[ + [ "RESERVED", "structina234_1_1__reg_1_1__calibration__register.html#a9484db76faad15bb8da293c622dd2269", null ], + [ "SHUNT_CAL", "structina234_1_1__reg_1_1__calibration__register.html#a115d21bedd85f661114c0c719fc22da0", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__config__register.html b/structina234_1_1__reg_1_1__config__register.html new file mode 100644 index 0000000..b8959ba --- /dev/null +++ b/structina234_1_1__reg_1_1__config__register.html @@ -0,0 +1,236 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_config_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_config_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + + + + + + + + + + + + + +

+Data Fields

uint16_t MODE:3
 
uint16_t VSHCT:3
 
uint16_t VBUSCT:3
 
uint16_t AVG:3
 
uint16_t ACDRANGE:1
 
uint16_t RESERVED:2
 
uint16_t RST:1
 
+

Field Documentation

+ +

◆ ACDRANGE

+ +
+
+ + + + +
uint16_t ACDRANGE
+
+ +
+
+ +

◆ AVG

+ +
+
+ + + + +
uint16_t AVG
+
+ +
+
+ +

◆ MODE

+ +
+
+ + + + +
uint16_t MODE
+
+ +
+
+ +

◆ RESERVED

+ +
+
+ + + + +
uint16_t RESERVED
+
+ +
+
+ +

◆ RST

+ +
+
+ + + + +
uint16_t RST
+
+ +
+
+ +

◆ VBUSCT

+ +
+
+ + + + +
uint16_t VBUSCT
+
+ +
+
+ +

◆ VSHCT

+ +
+
+ + + + +
uint16_t VSHCT
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__config__register.js b/structina234_1_1__reg_1_1__config__register.js new file mode 100644 index 0000000..6a8e9f8 --- /dev/null +++ b/structina234_1_1__reg_1_1__config__register.js @@ -0,0 +1,10 @@ +var structina234_1_1__reg_1_1__config__register = +[ + [ "ACDRANGE", "structina234_1_1__reg_1_1__config__register.html#a2cae4ff84c5462b931bd99ef5a3434e8", null ], + [ "AVG", "structina234_1_1__reg_1_1__config__register.html#ae5a0c05847ffa0e32d0903a07261dd71", null ], + [ "MODE", "structina234_1_1__reg_1_1__config__register.html#abd348ee828aadd0781f3fa97d167e564", null ], + [ "RESERVED", "structina234_1_1__reg_1_1__config__register.html#a9484db76faad15bb8da293c622dd2269", null ], + [ "RST", "structina234_1_1__reg_1_1__config__register.html#abef8327bfd071009d10633030379e701", null ], + [ "VBUSCT", "structina234_1_1__reg_1_1__config__register.html#a2854a902bb3af04427b00a8472b0cbb8", null ], + [ "VSHCT", "structina234_1_1__reg_1_1__config__register.html#a9efa998f60c85d1bdd04cc3dd4bdc693", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__current__register.html b/structina234_1_1__reg_1_1__current__register.html new file mode 100644 index 0000000..6d39d0c --- /dev/null +++ b/structina234_1_1__reg_1_1__current__register.html @@ -0,0 +1,156 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_current_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_current_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + + + +

+Data Fields

int16_t RESERVED:4
 
int16_t CURRENT:12
 
+

Field Documentation

+ +

◆ CURRENT

+ +
+
+ + + + +
int16_t CURRENT
+
+ +
+
+ +

◆ RESERVED

+ +
+
+ + + + +
int16_t RESERVED
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__current__register.js b/structina234_1_1__reg_1_1__current__register.js new file mode 100644 index 0000000..7709316 --- /dev/null +++ b/structina234_1_1__reg_1_1__current__register.js @@ -0,0 +1,5 @@ +var structina234_1_1__reg_1_1__current__register = +[ + [ "CURRENT", "structina234_1_1__reg_1_1__current__register.html#a2ed399eace19c88cda48107e537271d2", null ], + [ "RESERVED", "structina234_1_1__reg_1_1__current__register.html#aa42491e0ff1ccdf2056d947f78957917", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__devide__id__register.html b/structina234_1_1__reg_1_1__devide__id__register.html new file mode 100644 index 0000000..b1ee5fd --- /dev/null +++ b/structina234_1_1__reg_1_1__devide__id__register.html @@ -0,0 +1,156 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_devide_id_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_devide_id_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + + + +

+Data Fields

uint16_t RESERVED:4
 
uint16_t DIEID:12
 
+

Field Documentation

+ +

◆ DIEID

+ +
+
+ + + + +
uint16_t DIEID
+
+ +
+
+ +

◆ RESERVED

+ +
+
+ + + + +
uint16_t RESERVED
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__devide__id__register.js b/structina234_1_1__reg_1_1__devide__id__register.js new file mode 100644 index 0000000..76366ce --- /dev/null +++ b/structina234_1_1__reg_1_1__devide__id__register.js @@ -0,0 +1,5 @@ +var structina234_1_1__reg_1_1__devide__id__register = +[ + [ "DIEID", "structina234_1_1__reg_1_1__devide__id__register.html#a1c2fbd56052f9cd2aedf35c988950eb8", null ], + [ "RESERVED", "structina234_1_1__reg_1_1__devide__id__register.html#a9484db76faad15bb8da293c622dd2269", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__manufacture__id__register.html b/structina234_1_1__reg_1_1__manufacture__id__register.html new file mode 100644 index 0000000..b5e3ebb --- /dev/null +++ b/structina234_1_1__reg_1_1__manufacture__id__register.html @@ -0,0 +1,140 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_manufacture_id_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_manufacture_id_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + +

+Data Fields

uint16_t MANUFACTURE_ID
 
+

Field Documentation

+ +

◆ MANUFACTURE_ID

+ +
+
+ + + + +
uint16_t MANUFACTURE_ID
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__manufacture__id__register.js b/structina234_1_1__reg_1_1__manufacture__id__register.js new file mode 100644 index 0000000..56c63dc --- /dev/null +++ b/structina234_1_1__reg_1_1__manufacture__id__register.js @@ -0,0 +1,4 @@ +var structina234_1_1__reg_1_1__manufacture__id__register = +[ + [ "MANUFACTURE_ID", "structina234_1_1__reg_1_1__manufacture__id__register.html#ae9ec42bcafa5e076b6489e0aa8373d58", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__mask__enable__register.html b/structina234_1_1__reg_1_1__mask__enable__register.html new file mode 100644 index 0000000..de47c6a --- /dev/null +++ b/structina234_1_1__reg_1_1__mask__enable__register.html @@ -0,0 +1,332 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_mask_enable_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_mask_enable_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Data Fields

uint16_t LEN:1
 
uint16_t APOL:1
 
uint16_t OVF:1
 
uint16_t CVRF:1
 
uint16_t AFF:1
 
uint16_t MemError:1
 
uint16_t RESERVED:4
 
uint16_t CNVR:1
 
uint16_t POL:1
 
uint16_t BUL:1
 
uint16_t BOL:1
 
uint16_t SUL:1
 
uint16_t SOL:1
 
+

Field Documentation

+ +

◆ AFF

+ +
+
+ + + + +
uint16_t AFF
+
+ +
+
+ +

◆ APOL

+ +
+
+ + + + +
uint16_t APOL
+
+ +
+
+ +

◆ BOL

+ +
+
+ + + + +
uint16_t BOL
+
+ +
+
+ +

◆ BUL

+ +
+
+ + + + +
uint16_t BUL
+
+ +
+
+ +

◆ CNVR

+ +
+
+ + + + +
uint16_t CNVR
+
+ +
+
+ +

◆ CVRF

+ +
+
+ + + + +
uint16_t CVRF
+
+ +
+
+ +

◆ LEN

+ +
+
+ + + + +
uint16_t LEN
+
+ +
+
+ +

◆ MemError

+ +
+
+ + + + +
uint16_t MemError
+
+ +
+
+ +

◆ OVF

+ +
+
+ + + + +
uint16_t OVF
+
+ +
+
+ +

◆ POL

+ +
+
+ + + + +
uint16_t POL
+
+ +
+
+ +

◆ RESERVED

+ +
+
+ + + + +
uint16_t RESERVED
+
+ +
+
+ +

◆ SOL

+ +
+
+ + + + +
uint16_t SOL
+
+ +
+
+ +

◆ SUL

+ +
+
+ + + + +
uint16_t SUL
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__mask__enable__register.js b/structina234_1_1__reg_1_1__mask__enable__register.js new file mode 100644 index 0000000..4f1b256 --- /dev/null +++ b/structina234_1_1__reg_1_1__mask__enable__register.js @@ -0,0 +1,16 @@ +var structina234_1_1__reg_1_1__mask__enable__register = +[ + [ "AFF", "structina234_1_1__reg_1_1__mask__enable__register.html#a5fe2c3e0f082c277a47c739bb4c050f0", null ], + [ "APOL", "structina234_1_1__reg_1_1__mask__enable__register.html#a1b52d5c7b321b1a00b920df8aaef4ebb", null ], + [ "BOL", "structina234_1_1__reg_1_1__mask__enable__register.html#a0523a734c855650be9b9f060fc3cdf75", null ], + [ "BUL", "structina234_1_1__reg_1_1__mask__enable__register.html#ad8d9d3c9c1f94b7a3685b53757033c55", null ], + [ "CNVR", "structina234_1_1__reg_1_1__mask__enable__register.html#ab967f10721179bd6819267d3f28e7823", null ], + [ "CVRF", "structina234_1_1__reg_1_1__mask__enable__register.html#afb1d44ecc07606d4604568fb8ac74a32", null ], + [ "LEN", "structina234_1_1__reg_1_1__mask__enable__register.html#a045f31cd5049e505de87de0f6ff32d48", null ], + [ "MemError", "structina234_1_1__reg_1_1__mask__enable__register.html#a848f62ff7c149d4e1767499eca44f0e6", null ], + [ "OVF", "structina234_1_1__reg_1_1__mask__enable__register.html#a924358cdfd4563e425c05b90f7f1b733", null ], + [ "POL", "structina234_1_1__reg_1_1__mask__enable__register.html#aa0b57507453cd43c4b79df8fcee20978", null ], + [ "RESERVED", "structina234_1_1__reg_1_1__mask__enable__register.html#a9484db76faad15bb8da293c622dd2269", null ], + [ "SOL", "structina234_1_1__reg_1_1__mask__enable__register.html#a5c27f0c90ddb7694a7242366879d4685", null ], + [ "SUL", "structina234_1_1__reg_1_1__mask__enable__register.html#ad8db42637055a897799c867c554ebdbe", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__power__register.html b/structina234_1_1__reg_1_1__power__register.html new file mode 100644 index 0000000..05250ea --- /dev/null +++ b/structina234_1_1__reg_1_1__power__register.html @@ -0,0 +1,140 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_power_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_power_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + +

+Data Fields

uint16_t POWER
 
+

Field Documentation

+ +

◆ POWER

+ +
+
+ + + + +
uint16_t POWER
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__power__register.js b/structina234_1_1__reg_1_1__power__register.js new file mode 100644 index 0000000..725d61e --- /dev/null +++ b/structina234_1_1__reg_1_1__power__register.js @@ -0,0 +1,4 @@ +var structina234_1_1__reg_1_1__power__register = +[ + [ "POWER", "structina234_1_1__reg_1_1__power__register.html#a8ef2a47bcdbc2202d402528a15b9a0a3", null ] +]; \ No newline at end of file diff --git a/structina234_1_1__reg_1_1__shunt__voltage__register.html b/structina234_1_1__reg_1_1__shunt__voltage__register.html new file mode 100644 index 0000000..d73276a --- /dev/null +++ b/structina234_1_1__reg_1_1__shunt__voltage__register.html @@ -0,0 +1,156 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg::_shunt_voltage_register Struct Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Fields
+
ina234::_reg::_shunt_voltage_register Struct Reference
+
+
+ +

#include <ina234.h>

+ + + + + + +

+Data Fields

int16_t RESERVED:4
 
int16_t VSHUNT:12
 
+

Field Documentation

+ +

◆ RESERVED

+ +
+
+ + + + +
int16_t RESERVED
+
+ +
+
+ +

◆ VSHUNT

+ +
+
+ + + + +
int16_t VSHUNT
+
+ +
+
+
The documentation for this struct was generated from the following file: +
+
+ + + + diff --git a/structina234_1_1__reg_1_1__shunt__voltage__register.js b/structina234_1_1__reg_1_1__shunt__voltage__register.js new file mode 100644 index 0000000..98caaba --- /dev/null +++ b/structina234_1_1__reg_1_1__shunt__voltage__register.js @@ -0,0 +1,5 @@ +var structina234_1_1__reg_1_1__shunt__voltage__register = +[ + [ "RESERVED", "structina234_1_1__reg_1_1__shunt__voltage__register.html#aa42491e0ff1ccdf2056d947f78957917", null ], + [ "VSHUNT", "structina234_1_1__reg_1_1__shunt__voltage__register.html#a66e0475d4572f9d2c526cdc06c229ae6", null ] +]; \ No newline at end of file diff --git a/unionina234_1_1__reg.html b/unionina234_1_1__reg.html new file mode 100644 index 0000000..d4ec661 --- /dev/null +++ b/unionina234_1_1__reg.html @@ -0,0 +1,324 @@ + + + + + + + +INA234 HAL Based Library: ina234::_reg Union Reference + + + + + + + + + + + + + + + +
+
+ + + + + + +
+
INA234 HAL Based Library 1.0.0 +
+
+
+ + + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Data Structures | +Data Fields
+
ina234::_reg Union Reference
+
+
+ +

#include <ina234.h>

+ + + + + + + + + + + + + + + + + + + + + + +

+Data Structures

struct  _alert_limit_register
 
struct  _bus_voltage_register
 
struct  _calibration_register
 
struct  _config_register
 
struct  _current_register
 
struct  _devide_id_register
 
struct  _manufacture_id_register
 
struct  _mask_enable_register
 
struct  _power_register
 
struct  _shunt_voltage_register
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Data Fields

uint8_t raw_data [2]
 
struct ina234::_reg::_config_register config_register
 
struct ina234::_reg::_shunt_voltage_register shunt_voltage_register
 
struct ina234::_reg::_bus_voltage_register bus_voltage_register
 
struct ina234::_reg::_power_register power_register
 
struct ina234::_reg::_current_register current_register
 
struct ina234::_reg::_calibration_register calibration_register
 
struct ina234::_reg::_mask_enable_register mask_enable_register
 
struct ina234::_reg::_alert_limit_register alert_limit_register
 
struct ina234::_reg::_manufacture_id_register manufacture_id_register
 
struct ina234::_reg::_devide_id_register devide_id_register
 
+

Field Documentation

+ +

◆ alert_limit_register

+ +
+
+ + + + +
struct ina234::_reg::_alert_limit_register alert_limit_register
+
+ +
+
+ +

◆ bus_voltage_register

+ +
+
+ + + + +
struct ina234::_reg::_bus_voltage_register bus_voltage_register
+
+ +
+
+ +

◆ calibration_register

+ +
+
+ + + + +
struct ina234::_reg::_calibration_register calibration_register
+
+ +
+
+ +

◆ config_register

+ +
+
+ + + + +
struct ina234::_reg::_config_register config_register
+
+ +
+
+ +

◆ current_register

+ +
+
+ + + + +
struct ina234::_reg::_current_register current_register
+
+ +
+
+ +

◆ devide_id_register

+ +
+
+ + + + +
struct ina234::_reg::_devide_id_register devide_id_register
+
+ +
+
+ +

◆ manufacture_id_register

+ +
+
+ + + + +
struct ina234::_reg::_manufacture_id_register manufacture_id_register
+
+ +
+
+ +

◆ mask_enable_register

+ +
+
+ + + + +
struct ina234::_reg::_mask_enable_register mask_enable_register
+
+ +
+
+ +

◆ power_register

+ +
+
+ + + + +
struct ina234::_reg::_power_register power_register
+
+ +
+
+ +

◆ raw_data

+ +
+
+ + + + +
uint8_t raw_data[2]
+
+ +
+
+ +

◆ shunt_voltage_register

+ +
+
+ + + + +
struct ina234::_reg::_shunt_voltage_register shunt_voltage_register
+
+ +
+
+
The documentation for this union was generated from the following file: +
+
+ + + + diff --git a/unionina234_1_1__reg.js b/unionina234_1_1__reg.js new file mode 100644 index 0000000..91cacba --- /dev/null +++ b/unionina234_1_1__reg.js @@ -0,0 +1,24 @@ +var unionina234_1_1__reg = +[ + [ "_alert_limit_register", "structina234_1_1__reg_1_1__alert__limit__register.html", "structina234_1_1__reg_1_1__alert__limit__register" ], + [ "_bus_voltage_register", "structina234_1_1__reg_1_1__bus__voltage__register.html", "structina234_1_1__reg_1_1__bus__voltage__register" ], + [ "_calibration_register", "structina234_1_1__reg_1_1__calibration__register.html", "structina234_1_1__reg_1_1__calibration__register" ], + [ "_config_register", "structina234_1_1__reg_1_1__config__register.html", "structina234_1_1__reg_1_1__config__register" ], + [ "_current_register", "structina234_1_1__reg_1_1__current__register.html", "structina234_1_1__reg_1_1__current__register" ], + [ "_devide_id_register", "structina234_1_1__reg_1_1__devide__id__register.html", "structina234_1_1__reg_1_1__devide__id__register" ], + [ "_manufacture_id_register", "structina234_1_1__reg_1_1__manufacture__id__register.html", "structina234_1_1__reg_1_1__manufacture__id__register" ], + [ "_mask_enable_register", "structina234_1_1__reg_1_1__mask__enable__register.html", "structina234_1_1__reg_1_1__mask__enable__register" ], + [ "_power_register", "structina234_1_1__reg_1_1__power__register.html", "structina234_1_1__reg_1_1__power__register" ], + [ "_shunt_voltage_register", "structina234_1_1__reg_1_1__shunt__voltage__register.html", "structina234_1_1__reg_1_1__shunt__voltage__register" ], + [ "alert_limit_register", "unionina234_1_1__reg.html#acee2fbb0cc5b0af342d28004e1421fc8", null ], + [ "bus_voltage_register", "unionina234_1_1__reg.html#a369b998af644dc917134f6075b6d0d8e", null ], + [ "calibration_register", "unionina234_1_1__reg.html#af8c8679ad9234831937cf17e85935231", null ], + [ "config_register", "unionina234_1_1__reg.html#a99cf80892bd6eb97d2dfe5d8094d4375", null ], + [ "current_register", "unionina234_1_1__reg.html#ab8acdea3a879f282b66100182c706b9b", null ], + [ "devide_id_register", "unionina234_1_1__reg.html#a99a13b89ff65812966f048cc413de88e", null ], + [ "manufacture_id_register", "unionina234_1_1__reg.html#a1e929abda30270e8b0eda26e26d68f83", null ], + [ "mask_enable_register", "unionina234_1_1__reg.html#a2fa3a9f20fd08972d7968962ee824d4b", null ], + [ "power_register", "unionina234_1_1__reg.html#adc2d71b0b9e065cf1fb9086b2834c3f1", null ], + [ "raw_data", "unionina234_1_1__reg.html#a212c976969c3d66f4b79de05921422b5", null ], + [ "shunt_voltage_register", "unionina234_1_1__reg.html#a5788ff3d34c964926fed0bebed42e3ac", null ] +]; \ No newline at end of file