diff --git a/annotated.html b/annotated.html index 4e144dd..72644e5 100644 --- a/annotated.html +++ b/annotated.html @@ -92,18 +92,19 @@
Here are the data structures with brief descriptions:
- - - - - - - - - - - - + + + + + + + + + + + + +
 Ccollector_args_t
 CCRC8LookupTable
 Cdummy_write_t
 CLSM6DSO32Context
 CMS5611Context
 CSensor
 CSensorContext
 CSensorLocation
 CSensorTagData
 CSensorTagList
 CSysClockContext
 Cvec3d_t
 Cclctr_entry_t
 Ccollector_args_t
 CCRC8LookupTable
 Cdummy_write_t
 CLSM6DSO32Context
 CMS5611Context
 CSensor
 CSensorContext
 CSensorLocation
 CSensorTagData
 CSensorTagList
 CSysClockContext
 Cvec3d_t
diff --git a/annotated_dup.js b/annotated_dup.js index 3953af3..6e72280 100644 --- a/annotated_dup.js +++ b/annotated_dup.js @@ -1,5 +1,6 @@ var annotated_dup = [ + [ "clctr_entry_t", "structclctr__entry__t.html", "structclctr__entry__t" ], [ "collector_args_t", "structcollector__args__t.html", "structcollector__args__t" ], [ "CRC8LookupTable", "structCRC8LookupTable.html", "structCRC8LookupTable" ], [ "dummy_write_t", "structdummy__write__t.html", "structdummy__write__t" ], diff --git a/classes.html b/classes.html index 0237bf6..c7f5435 100644 --- a/classes.html +++ b/classes.html @@ -94,7 +94,7 @@
C
-
collector_args_t
CRC8LookupTable
+
clctr_entry_t
collector_args_t
CRC8LookupTable
D
dummy_write_t
diff --git a/collectors_8c.html b/collectors_8c.html new file mode 100644 index 0000000..64b421e --- /dev/null +++ b/collectors_8c.html @@ -0,0 +1,140 @@ + + + + + + + +fetcher: src/collectors/collectors.c File Reference + + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
fetcher 0.0.0 +
+
A command line utility for reading sensor data over I2C and providing it over stdout.
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Functions
+
collectors.c File Reference
+
+
+
#include "collectors.h"
+#include <string.h>
+
+ + + +

+Functions

collector_t collector_search (const char *sensor_name)
 
+

Function Documentation

+ +

◆ collector_search()

+ +
+
+ + + + + + + + +
collector_t collector_search (const char * sensor_name)
+
+

Searches for a collector matching the sensor name in the list of implemented collectors.

Parameters
+ + +
sensor_nameThe name of the sensor to find a collector thread for.
+
+
+
Returns
A function pointer to the collector thread, or NULL if no match is found.
+ +
+
+
+
+ + diff --git a/collectors_8c.js b/collectors_8c.js new file mode 100644 index 0000000..74e0c36 --- /dev/null +++ b/collectors_8c.js @@ -0,0 +1,4 @@ +var collectors_8c = +[ + [ "collector_search", "collectors_8c.html#a0b028788968140b6be2957e737f7e53d", null ] +]; \ No newline at end of file diff --git a/collectors_8h.html b/collectors_8h.html index f93cf29..52eafbf 100644 --- a/collectors_8h.html +++ b/collectors_8h.html @@ -90,6 +90,7 @@
Data Structures | Macros | +Typedefs | Functions
collectors.h File Reference
@@ -104,6 +105,8 @@ + +

Data Structures

struct  clctr_entry_t
 
struct  collector_args_t
 
@@ -112,8 +115,15 @@
#define clctr_args(args)   ((collector_args_t *)((args)))
 
+ + + +

+Typedefs

typedef void *(* collector_t) (void *)
 
+ + @@ -141,9 +151,49 @@

Macro for dereferencing the collector argument.

+ + +

Typedef Documentation

+ +

◆ collector_t

+ +
+
+

Functions

collector_t collector_search (const char *sensor_name)
 
void * sysclock_collector (void *args)
 
void * ms5611_collector (void *args)
+ + + +
typedef void *(* collector_t) (void *)
+
+

Function Documentation

+ +

◆ collector_search()

+ +
+
+ + + + + + + + +
collector_t collector_search (const char * sensor_name)
+
+

Searches for a collector matching the sensor name in the list of implemented collectors.

Parameters
+ + +
sensor_nameThe name of the sensor to find a collector thread for.
+
+
+
Returns
A function pointer to the collector thread, or NULL if no match is found.
+ +
+

◆ lsm6dso32_collector()

diff --git a/collectors_8h.js b/collectors_8h.js index d8f4a94..18814a6 100644 --- a/collectors_8h.js +++ b/collectors_8h.js @@ -1,7 +1,10 @@ var collectors_8h = [ + [ "clctr_entry_t", "structclctr__entry__t.html", "structclctr__entry__t" ], [ "collector_args_t", "structcollector__args__t.html", "structcollector__args__t" ], [ "clctr_args", "collectors_8h.html#af93fb2db64ecef265e8e018d15f2d5ab", null ], + [ "collector_t", "collectors_8h.html#a7d2d2653f6c7a5e57a2b7877b9982f69", null ], + [ "collector_search", "collectors_8h.html#a0b028788968140b6be2957e737f7e53d", null ], [ "lsm6dso32_collector", "collectors_8h.html#ab62890efc5396e30f0abf69a3b40b274", null ], [ "ms5611_collector", "collectors_8h.html#adbdfcef6321a9913163afe155f733aa7", null ], [ "sht41_collector", "collectors_8h.html#a5cf5eddfe43ab7809fcbdf67bc1bcb64", null ], diff --git a/collectors_8h_source.html b/collectors_8h_source.html index 03c65fb..0cbbc87 100644 --- a/collectors_8h_source.html +++ b/collectors_8h_source.html @@ -101,25 +101,39 @@
9
11#define clctr_args(args) ((collector_args_t *)((args)))
12
-
14typedef struct {
-
15 int bus;
-
16 uint8_t addr;
-
17} collector_args_t;
-
18
-
19/* Collector threads */
-
20void *sysclock_collector(void *args);
-
21void *ms5611_collector(void *args);
-
22void *sht41_collector(void *args);
-
23void *lsm6dso32_collector(void *args);
-
24
-
25#endif // _COLLECTORS_H_
+
13typedef void *(*collector_t)(void *);
+
14
+
16typedef struct {
+
17 const char *name;
+
18 const collector_t collector;
+
19} clctr_entry_t;
+
20
+
22typedef struct {
+
23 int bus;
+
24 uint8_t addr;
+
25} collector_args_t;
+
26
+
27collector_t collector_search(const char *sensor_name);
+
28
+
29/* Collector threads */
+
30void *sysclock_collector(void *args);
+
31void *ms5611_collector(void *args);
+
32void *sht41_collector(void *args);
+
33void *lsm6dso32_collector(void *args);
+
34
+
35#endif // _COLLECTORS_H_
+
collector_search
collector_t collector_search(const char *sensor_name)
Definition: collectors.c:16
sysclock_collector
void * sysclock_collector(void *args)
Definition: sysclock_clctr.c:4
sht41_collector
void * sht41_collector(void *args)
Definition: sht41_clctr.c:6
+
collector_t
void *(* collector_t)(void *)
Definition: collectors.h:13
lsm6dso32_collector
void * lsm6dso32_collector(void *args)
Definition: lsm6dso32_clctr.c:5
ms5611_collector
void * ms5611_collector(void *args)
Definition: ms5611_clctr.c:5
-
collector_args_t
Definition: collectors.h:14
-
collector_args_t::addr
uint8_t addr
Definition: collectors.h:16
-
collector_args_t::bus
int bus
Definition: collectors.h:15
+
clctr_entry_t
Definition: collectors.h:16
+
clctr_entry_t::collector
const collector_t collector
Definition: collectors.h:18
+
clctr_entry_t::name
const char * name
Definition: collectors.h:17
+
collector_args_t
Definition: collectors.h:22
+
collector_args_t::addr
uint8_t addr
Definition: collectors.h:24
+
collector_args_t::bus
int bus
Definition: collectors.h:23
diff --git a/dir_ea15f3e29f1f7486634305b6e31c3d1a.html b/dir_ea15f3e29f1f7486634305b6e31c3d1a.html index c2f831d..94bde77 100644 --- a/dir_ea15f3e29f1f7486634305b6e31c3d1a.html +++ b/dir_ea15f3e29f1f7486634305b6e31c3d1a.html @@ -93,6 +93,8 @@ + + diff --git a/dir_ea15f3e29f1f7486634305b6e31c3d1a.js b/dir_ea15f3e29f1f7486634305b6e31c3d1a.js index 871ee5a..1cd5c9d 100644 --- a/dir_ea15f3e29f1f7486634305b6e31c3d1a.js +++ b/dir_ea15f3e29f1f7486634305b6e31c3d1a.js @@ -1,5 +1,6 @@ var dir_ea15f3e29f1f7486634305b6e31c3d1a = [ + [ "collectors.c", "collectors_8c.html", "collectors_8c" ], [ "collectors.h", "collectors_8h.html", "collectors_8h" ], [ "lsm6dso32_clctr.c", "lsm6dso32__clctr_8c.html", "lsm6dso32__clctr_8c" ], [ "ms5611_clctr.c", "ms5611__clctr_8c.html", "ms5611__clctr_8c" ], diff --git a/files.html b/files.html index bd87adb..5b39597 100644 --- a/files.html +++ b/files.html @@ -94,33 +94,34 @@
[detail level 1234]

Files

file  collectors.c
 
file  collectors.h [code]
 
file  lsm6dso32_clctr.c
- - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼ src
 ▼ collectors
 collectors.h
 lsm6dso32_clctr.c
 ms5611_clctr.c
 sht41_clctr.c
 sysclock_clctr.c
 ▼ crc-utils
 crc.cThis file contains the required functions and data to calculate cyclic redundancy checks
 crc.hHeader file containing function prototypes for calculating cyclic redundancy checks
 ▼ drivers
 ▼ lsm6dso32
 lsm6dso32.cSensor API interface implementation for the LSM6DSO32 inertial module
 lsm6dso32.hHeader file containing the necessary types and function prototypes for controlling the LSM6DSO32 inertial module
 ▼ ms5611
 ms5611.cSensor API interface implementation for the MS5611 pressure and temperature sensor
 ms5611.hHeader file containing the necessary types and function prototypes for controlling the MS611 Barometric Pressure Sensor
 ▼ sht41
 sht41.c
 sht41.hSensor API implementation for the SHT41 temperature and humidity sensor
 ▼ sysclock
 sysclock.cContains the types and function definitions required for the system clock sensor to function
 sysclock.hContains the sensor API interface implemented by the system clock sensor
 sensor_api.cThis file contains the implementations for the sensor API interface
 sensor_api.hTypes and function prototypes for the sensor API used to communicate with I2C bus sensors
 ▼ eeprom
 eeprom.c
 eeprom.h
 main.cThe main function for the fetcher module, where program logic is used to create a console application
 collectors.c
 collectors.h
 lsm6dso32_clctr.c
 ms5611_clctr.c
 sht41_clctr.c
 sysclock_clctr.c
 ▼ crc-utils
 crc.cThis file contains the required functions and data to calculate cyclic redundancy checks
 crc.hHeader file containing function prototypes for calculating cyclic redundancy checks
 ▼ drivers
 ▼ lsm6dso32
 lsm6dso32.cSensor API interface implementation for the LSM6DSO32 inertial module
 lsm6dso32.hHeader file containing the necessary types and function prototypes for controlling the LSM6DSO32 inertial module
 ▼ ms5611
 ms5611.cSensor API interface implementation for the MS5611 pressure and temperature sensor
 ms5611.hHeader file containing the necessary types and function prototypes for controlling the MS611 Barometric Pressure Sensor
 ▼ sht41
 sht41.c
 sht41.hSensor API implementation for the SHT41 temperature and humidity sensor
 ▼ sysclock
 sysclock.cContains the types and function definitions required for the system clock sensor to function
 sysclock.hContains the sensor API interface implemented by the system clock sensor
 sensor_api.cThis file contains the implementations for the sensor API interface
 sensor_api.hTypes and function prototypes for the sensor API used to communicate with I2C bus sensors
 ▼ eeprom
 eeprom.c
 eeprom.h
 main.cThe main function for the fetcher module, where program logic is used to create a console application
diff --git a/functions.html b/functions.html index 4b87298..dea6add 100644 --- a/functions.html +++ b/functions.html @@ -103,6 +103,7 @@

- b -