Firmware SDK
twr_module_infra_grid

Library to communicate with Infra Grid Module with Panasonic AMG8833 Grid-EYE sensor. More...

Typedefs

typedef struct twr_module_infra_grid_t twr_module_infra_grid_t
 Infra Grid Module instance.
 

Enumerations

enum  twr_module_infra_grid_event_t {
  TWR_MODULE_INFRA_GRID_EVENT_ERROR = 0,
  TWR_MODULE_INFRA_GRID_EVENT_UPDATE = 1
}
 Callback events. More...
 
enum  twr_module_infra_grid_revision_t {
  TWR_MODULE_INFRA_GRID_REVISION_R1_0 = 0,
  TWR_MODULE_INFRA_GRID_REVISION_R1_1 = 1
}
 Infragrid Module Revision. More...
 

Functions

void twr_module_infra_grid_init (twr_module_infra_grid_t *self)
 Initialize Infra Grid Module. More...
 
void twr_module_infra_grid_set_event_handler (twr_module_infra_grid_t *self, void(*event_handler)(twr_module_infra_grid_t *, twr_module_infra_grid_event_t, void *), void *event_param)
 Set callback function. More...
 
void twr_module_infra_grid_set_update_interval (twr_module_infra_grid_t *self, twr_tick_t interval)
 Set measurement interval. More...
 
bool twr_module_infra_grid_measure (twr_module_infra_grid_t *self)
 Start measurement manually. More...
 
bool twr_module_infra_grid_read_values (twr_module_infra_grid_t *self)
 Read measured data from sensor to the buffer. More...
 
bool twr_module_infra_grid_get_temperatures_celsius (twr_module_infra_grid_t *self, float *values)
 Get measured temperature in degrees of Celsius as a array of float numbers. More...
 
float twr_module_infra_grid_read_thermistor (twr_module_infra_grid_t *self)
 Read and return thermistor temperature sensor value. More...
 
twr_module_infra_grid_revision_t twr_module_infra_grid_get_revision (twr_module_infra_grid_t *self)
 Get module revision. More...
 

Detailed Description

Library to communicate with Infra Grid Module with Panasonic AMG8833 Grid-EYE sensor.

Enumeration Type Documentation

◆ twr_module_infra_grid_event_t

Callback events.

Enumerator
TWR_MODULE_INFRA_GRID_EVENT_ERROR 

Error event.

TWR_MODULE_INFRA_GRID_EVENT_UPDATE 

Update event.

Definition at line 14 of file twr_module_infra_grid.h.

◆ twr_module_infra_grid_revision_t

Infragrid Module Revision.

Enumerator
TWR_MODULE_INFRA_GRID_REVISION_R1_0 

Revision 1.0.

TWR_MODULE_INFRA_GRID_REVISION_R1_1 

Revision 1.1.

Definition at line 30 of file twr_module_infra_grid.h.

Function Documentation

◆ twr_module_infra_grid_get_revision()

twr_module_infra_grid_revision_t twr_module_infra_grid_get_revision ( twr_module_infra_grid_t self)

Get module revision.

Parameters
[in]selfInstance
Returns
module revision

Definition at line 415 of file twr_module_infra_grid.c.

◆ twr_module_infra_grid_get_temperatures_celsius()

bool twr_module_infra_grid_get_temperatures_celsius ( twr_module_infra_grid_t self,
float *  values 
)

Get measured temperature in degrees of Celsius as a array of float numbers.

Parameters
[in]selfInstance
[out]valuesPointer to float array of size 64 where result will be stored

Definition at line 120 of file twr_module_infra_grid.c.

Here is the call graph for this function:

◆ twr_module_infra_grid_init()

void twr_module_infra_grid_init ( twr_module_infra_grid_t self)

Initialize Infra Grid Module.

Parameters
[in]selfInstance

Definition at line 42 of file twr_module_infra_grid.c.

Here is the call graph for this function:

◆ twr_module_infra_grid_measure()

bool twr_module_infra_grid_measure ( twr_module_infra_grid_t self)

Start measurement manually.

Parameters
[in]selfInstance
Returns
true On success
false When other measurement is in progress

Definition at line 83 of file twr_module_infra_grid.c.

Referenced by twr_module_infra_grid_get_temperatures_celsius(), and twr_module_infra_grid_set_update_interval().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ twr_module_infra_grid_read_thermistor()

float twr_module_infra_grid_read_thermistor ( twr_module_infra_grid_t self)

Read and return thermistor temperature sensor value.

Parameters
[in]selfInstance
Returns
value in degreen of Celsius

Definition at line 97 of file twr_module_infra_grid.c.

Here is the call graph for this function:

◆ twr_module_infra_grid_read_values()

bool twr_module_infra_grid_read_values ( twr_module_infra_grid_t self)

Read measured data from sensor to the buffer.

Parameters
[in]selfInstance
Returns
true When values are valid
false When values are invalid

Definition at line 108 of file twr_module_infra_grid.c.

Here is the call graph for this function:

◆ twr_module_infra_grid_set_event_handler()

void twr_module_infra_grid_set_event_handler ( twr_module_infra_grid_t self,
void(*)(twr_module_infra_grid_t *, twr_module_infra_grid_event_t, void *)  event_handler,
void *  event_param 
)

Set callback function.

Parameters
[in]selfInstance
[in]event_handlerFunction address
[in]event_paramOptional event parameter (can be NULL)

Definition at line 57 of file twr_module_infra_grid.c.

◆ twr_module_infra_grid_set_update_interval()

void twr_module_infra_grid_set_update_interval ( twr_module_infra_grid_t self,
twr_tick_t  interval 
)

Set measurement interval.

Parameters
[in]selfInstance
[in]intervalMeasurement interval

Definition at line 63 of file twr_module_infra_grid.c.

Here is the call graph for this function: