neomesh868mhz
2.1.0.0
|
API for configuring and manipulating NeoMesh 868MHz Click driver. More...
Modules | |
NeoMesh 868MHz Device Settings | |
Settings for registers of NeoMesh 868MHz Click driver. | |
NeoMesh 868MHz MikroBUS Map | |
MikroBUS pin mapping of NeoMesh 868MHz Click driver. | |
Functions | |
void | neomesh868mhz_cfg_setup (neomesh868mhz_cfg_t *cfg) |
NeoMesh 868MHz configuration object setup function. More... | |
err_t | neomesh868mhz_init (neomesh868mhz_t *ctx, neomesh868mhz_cfg_t *cfg) |
NeoMesh 868MHz initialization function. More... | |
err_t | neomesh868mhz_send_aapi_frame (neomesh868mhz_t *ctx, neomesh868mhz_aapi_frame_t *frame) |
NeoMesh 868MHz send aapi frame function. More... | |
err_t | neomesh868mhz_read_aapi_frame (neomesh868mhz_t *ctx, neomesh868mhz_aapi_frame_t *frame) |
NeoMesh 868MHz read aapi frame function. More... | |
err_t | neomesh868mhz_send_sapi_frame (neomesh868mhz_t *ctx, neomesh868mhz_sapi_frame_t *frame) |
NeoMesh 868MHz send sapi frame function. More... | |
err_t | neomesh868mhz_read_sapi_frame (neomesh868mhz_t *ctx, neomesh868mhz_sapi_frame_t *frame) |
NeoMesh 868MHz read sapi frame function. More... | |
void | neomesh868mhz_set_rst_pin (neomesh868mhz_t *ctx, uint8_t state) |
NeoMesh 868MHz set rst pin function. More... | |
void | neomesh868mhz_set_wes_pin (neomesh868mhz_t *ctx, uint8_t state) |
NeoMesh 868MHz set wes pin function. More... | |
uint8_t | neomesh868mhz_get_app_pin (neomesh868mhz_t *ctx) |
NeoMesh 868MHz get app pin function. More... | |
uint8_t | neomesh868mhz_get_cts_pin (neomesh868mhz_t *ctx) |
NeoMesh 868MHz get cts pin function. More... | |
uint8_t | neomesh868mhz_get_wup_pin (neomesh868mhz_t *ctx) |
NeoMesh 868MHz get wup pin function. More... | |
API for configuring and manipulating NeoMesh 868MHz Click driver.
void neomesh868mhz_cfg_setup | ( | neomesh868mhz_cfg_t * | cfg | ) |
NeoMesh 868MHz configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See neomesh868mhz_cfg_t object definition for detailed explanation. |
uint8_t neomesh868mhz_get_app_pin | ( | neomesh868mhz_t * | ctx | ) |
NeoMesh 868MHz get app pin function.
This function returns the APP pin logic state.
[in] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
uint8_t neomesh868mhz_get_cts_pin | ( | neomesh868mhz_t * | ctx | ) |
NeoMesh 868MHz get cts pin function.
This function returns the CTS pin logic state.
[in] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
uint8_t neomesh868mhz_get_wup_pin | ( | neomesh868mhz_t * | ctx | ) |
NeoMesh 868MHz get wup pin function.
This function returns the WUP pin logic state.
[in] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
err_t neomesh868mhz_init | ( | neomesh868mhz_t * | ctx, |
neomesh868mhz_cfg_t * | cfg | ||
) |
NeoMesh 868MHz initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See neomesh868mhz_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t neomesh868mhz_read_aapi_frame | ( | neomesh868mhz_t * | ctx, |
neomesh868mhz_aapi_frame_t * | frame | ||
) |
NeoMesh 868MHz read aapi frame function.
This function reads an AAPI frame by using UART serial interface.
[in] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
[out] | frame | : AAPI frame structure read. See neomesh868mhz_aapi_frame_t object definition for detailed explanation. |
0
- Success, -1
- Error, frame is not read correctly, -2
- Timeout error. See #err_t definition for detailed explanation. err_t neomesh868mhz_read_sapi_frame | ( | neomesh868mhz_t * | ctx, |
neomesh868mhz_sapi_frame_t * | frame | ||
) |
NeoMesh 868MHz read sapi frame function.
This function reads an SAPI frame by using UART serial interface.
[in] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
[out] | frame | : SAPI frame structure read. See neomesh868mhz_sapi_frame_t object definition for detailed explanation. |
0
- Success, -1
- Error, frame is not read correctly, -2
- Timeout error. See #err_t definition for detailed explanation. err_t neomesh868mhz_send_aapi_frame | ( | neomesh868mhz_t * | ctx, |
neomesh868mhz_aapi_frame_t * | frame | ||
) |
NeoMesh 868MHz send aapi frame function.
This function sends a desired AAPI frame by using UART serial interface.
[in] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
[in] | frame | : AAPI frame structure to be sent. See neomesh868mhz_aapi_frame_t object definition for detailed explanation. |
0
- Success, -2
- Timeout error. See #err_t definition for detailed explanation. err_t neomesh868mhz_send_sapi_frame | ( | neomesh868mhz_t * | ctx, |
neomesh868mhz_sapi_frame_t * | frame | ||
) |
NeoMesh 868MHz send sapi frame function.
This function sends a desired SAPI frame by using UART serial interface.
[in] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
[in] | frame | : SAPI frame structure to be sent. See neomesh868mhz_sapi_frame_t object definition for detailed explanation. |
0
- Success, -2
- Timeout error. See #err_t definition for detailed explanation. void neomesh868mhz_set_rst_pin | ( | neomesh868mhz_t * | ctx, |
uint8_t | state | ||
) |
NeoMesh 868MHz set rst pin function.
This function sets the RST pin logic state.
[in] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void neomesh868mhz_set_wes_pin | ( | neomesh868mhz_t * | ctx, |
uint8_t | state | ||
) |
NeoMesh 868MHz set wes pin function.
This function sets the WES pin logic state.
[in] | ctx | : Click context object. See neomesh868mhz_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |