lighthz
2.1.0.0
|
API for configuring and manipulating LightHz Click driver. More...
Modules | |
LightHz Settings | |
Settings for LightHz Click driver. | |
LightHz MikroBUS Map | |
MikroBUS pin mapping of LightHz Click driver. | |
Functions | |
void | lighthz_cfg_setup (lighthz_cfg_t *cfg) |
LightHz configuration object setup function. More... | |
err_t | lighthz_init (lighthz_t *ctx, lighthz_cfg_t *cfg) |
LightHz initialization function. More... | |
void | lighthz_set_s0_pin (lighthz_t *ctx, uint8_t state) |
LightHz set s0 pin function. More... | |
void | lighthz_set_s1_pin (lighthz_t *ctx, uint8_t state) |
LightHz set s1 pin function. More... | |
void | lighthz_set_s2_pin (lighthz_t *ctx, uint8_t state) |
LightHz set s2 pin function. More... | |
void | lighthz_set_s3_pin (lighthz_t *ctx, uint8_t state) |
LightHz set s3 pin function. More... | |
void | lighthz_set_sensitivity (lighthz_t *ctx, uint8_t mode) |
LightHz set sensitivity function. More... | |
void | lighthz_set_frequency_scaling (lighthz_t *ctx, uint8_t mode) |
LightHz set frequency scaling function. More... | |
uint8_t | lighthz_get_freq_pin (lighthz_t *ctx) |
LightHz get freq pin function. More... | |
API for configuring and manipulating LightHz Click driver.
void lighthz_cfg_setup | ( | lighthz_cfg_t * | cfg | ) |
LightHz configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See lighthz_cfg_t object definition for detailed explanation. |
uint8_t lighthz_get_freq_pin | ( | lighthz_t * | ctx | ) |
LightHz get freq pin function.
This function returns the freq pin logic state.
[in] | ctx | : Click context object. See lighthz_t object definition for detailed explanation. |
err_t lighthz_init | ( | lighthz_t * | ctx, |
lighthz_cfg_t * | cfg | ||
) |
LightHz initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See lighthz_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See lighthz_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void lighthz_set_frequency_scaling | ( | lighthz_t * | ctx, |
uint8_t | mode | ||
) |
LightHz set frequency scaling function.
This function sets the sensor frequency scaling.
[in] | ctx | : Click context object. See lighthz_t object definition for detailed explanation. |
[in] | mode | :
|
void lighthz_set_s0_pin | ( | lighthz_t * | ctx, |
uint8_t | state | ||
) |
LightHz set s0 pin function.
This function sets the s0 pin logic state.
[in] | ctx | : Click context object. See lighthz_t object definition for detailed explanation. |
[in] | state | :
|
void lighthz_set_s1_pin | ( | lighthz_t * | ctx, |
uint8_t | state | ||
) |
LightHz set s1 pin function.
This function sets the s1 pin logic state.
[in] | ctx | : Click context object. See lighthz_t object definition for detailed explanation. |
[in] | state | :
|
void lighthz_set_s2_pin | ( | lighthz_t * | ctx, |
uint8_t | state | ||
) |
LightHz set s2 pin function.
This function sets the s2 pin logic state.
[in] | ctx | : Click context object. See lighthz_t object definition for detailed explanation. |
[in] | state | :
|
void lighthz_set_s3_pin | ( | lighthz_t * | ctx, |
uint8_t | state | ||
) |
LightHz set s3 pin function.
This function sets the s3 pin logic state.
[in] | ctx | : Click context object. See lighthz_t object definition for detailed explanation. |
[in] | state | :
|
void lighthz_set_sensitivity | ( | lighthz_t * | ctx, |
uint8_t | mode | ||
) |
LightHz set sensitivity function.
This function sets the sensor sensitivity.
[in] | ctx | : Click context object. See lighthz_t object definition for detailed explanation. |
[in] | mode | :
|