binhonova 2.1.0.0
Binho Nova Click Driver

API for configuring and manipulating Binho Nova Click driver. More...

Topics

 Binho Nova Device Settings
 Settings for registers of Binho Nova Click driver.
 
 Binho Nova MikroBUS Map
 MikroBUS pin mapping of Binho Nova Click driver.
 

Functions

void binhonova_cfg_setup (binhonova_cfg_t *cfg)
 Binho Nova configuration object setup function.
 
err_t binhonova_init (binhonova_t *ctx, binhonova_cfg_t *cfg)
 Binho Nova initialization function.
 
err_t binhonova_generic_write (binhonova_t *ctx, uint8_t *data_in, uint16_t len)
 Binho Nova data writing function.
 
err_t binhonova_generic_read (binhonova_t *ctx, uint8_t *data_out, uint16_t len)
 Binho Nova data reading function.
 

Detailed Description

API for configuring and manipulating Binho Nova Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ binhonova_cfg_setup()

void binhonova_cfg_setup ( binhonova_cfg_t * cfg)

Binho Nova configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See binhonova_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ binhonova_generic_read()

err_t binhonova_generic_read ( binhonova_t * ctx,
uint8_t * data_out,
uint16_t len )

Binho Nova data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See binhonova_t object definition for detailed explanation.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.
Note
None.

◆ binhonova_generic_write()

err_t binhonova_generic_write ( binhonova_t * ctx,
uint8_t * data_in,
uint16_t len )

Binho Nova data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See binhonova_t object definition for detailed explanation.
[in]data_in: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ binhonova_init()

err_t binhonova_init ( binhonova_t * ctx,
binhonova_cfg_t * cfg )

Binho Nova initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See binhonova_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See binhonova_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.