charger29 2.2.0
Loading...
Searching...
No Matches
Charger 29 Click Driver

API for configuring and manipulating Charger 29 Click driver. More...

Topics

 Charger 29 Registers List
 List of registers of Charger 29 Click driver.
 Charger 29 Registers Settings
 Settings for registers of Charger 29 Click driver.
 Charger 29 MikroBUS Map
 MikroBUS pin mapping of Charger 29 Click driver.

Functions

void charger29_cfg_setup (charger29_cfg_t *cfg)
 Charger 29 configuration object setup function.
err_t charger29_init (charger29_t *ctx, charger29_cfg_t *cfg)
 Charger 29 initialization function.
err_t charger29_default_cfg (charger29_t *ctx)
 Charger 29 default configuration function.
err_t charger29_write_reg (charger29_t *ctx, uint8_t reg, uint8_t data_in)
 Charger 29 write register function.
err_t charger29_write_regs (charger29_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 Charger 29 write registers function.
err_t charger29_read_reg (charger29_t *ctx, uint8_t reg, uint8_t *data_out)
 Charger 29 read register function.
err_t charger29_read_regs (charger29_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 Charger 29 read registers function.
uint8_t charger29_get_int_pin (charger29_t *ctx)
 Charger 29 get INT pin function.
err_t charger29_check_communication (charger29_t *ctx)
 Charger 29 check communication function.
err_t charger29_sw_reset (charger29_t *ctx)
 Charger 29 software reset function.
err_t charger29_enable_charging (charger29_t *ctx)
 Charger 29 enable charging function.
err_t charger29_disable_charging (charger29_t *ctx)
 Charger 29 disable charging function.
err_t charger29_set_charging_current (charger29_t *ctx, uint16_t ichg)
 Charger 29 set charging current function.
err_t charger29_set_vbat_reg (charger29_t *ctx, uint16_t vbat_mv)
 Charger 29 set battery regulation voltage function.
err_t charger29_read_status (charger29_t *ctx, charger29_status_t *status)
 Charger 29 read status function.

Detailed Description

API for configuring and manipulating Charger 29 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

◆ charger29_cfg_setup()

void charger29_cfg_setup ( charger29_cfg_t * cfg)

Charger 29 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ charger29_check_communication()

err_t charger29_check_communication ( charger29_t * ctx)

Charger 29 check communication function.

This function checks device communication by reading and verifying the device ID from the Charger 29 Click board.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_default_cfg()

err_t charger29_default_cfg ( charger29_t * ctx)

Charger 29 default configuration function.

This function executes a default configuration of Charger 29 Click board.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ charger29_disable_charging()

err_t charger29_disable_charging ( charger29_t * ctx)

Charger 29 disable charging function.

This function disables charging by setting the charging disable bit.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_enable_charging()

err_t charger29_enable_charging ( charger29_t * ctx)

Charger 29 enable charging function.

This function enables charging by clearing the charging disable bit.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_get_int_pin()

uint8_t charger29_get_int_pin ( charger29_t * ctx)

Charger 29 get INT pin function.

This function reads the logic state of the INT pin.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ charger29_init()

err_t charger29_init ( charger29_t * ctx,
charger29_cfg_t * cfg )

Charger 29 initialization function.

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

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

◆ charger29_read_reg()

err_t charger29_read_reg ( charger29_t * ctx,
uint8_t reg,
uint8_t * data_out )

Charger 29 read register function.

This function reads a single byte of data from the selected register of the Charger 29 Click board.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
[in]reg: Register address.
[out]data_out: Pointer to the memory where the read byte will be stored.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_read_regs()

err_t charger29_read_regs ( charger29_t * ctx,
uint8_t reg,
uint8_t * data_out,
uint8_t len )

Charger 29 read registers function.

This function reads a sequence of bytes starting from the selected register of the Charger 29 Click board.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: Pointer to the memory where the read data will be stored.
[in]len: Number of bytes to read.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_read_status()

err_t charger29_read_status ( charger29_t * ctx,
charger29_status_t * status )

Charger 29 read status function.

This function reads the status and flag registers of the Charger 29 Click board.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
[out]status: Pointer to the structure where status register values will be stored. See charger29_status_t structure definition for detailed information.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_set_charging_current()

err_t charger29_set_charging_current ( charger29_t * ctx,
uint16_t ichg )

Charger 29 set charging current function.

This function sets the charging current based on the specified value in milliamps.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
[in]ichg: Charging current in milliamps [5mA to 1000mA].
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_set_vbat_reg()

err_t charger29_set_vbat_reg ( charger29_t * ctx,
uint16_t vbat_mv )

Charger 29 set battery regulation voltage function.

This function sets the battery regulation voltage in millivolts.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
[in]vbat_mv: Battery voltage regulation value in millivolts [3500mV to 4650mV].
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_sw_reset()

err_t charger29_sw_reset ( charger29_t * ctx)

Charger 29 software reset function.

This function performs a software reset of the Charger 29 Click board.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_write_reg()

err_t charger29_write_reg ( charger29_t * ctx,
uint8_t reg,
uint8_t data_in )

Charger 29 write register function.

This function writes a single byte of data to the selected register of the Charger 29 Click board.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
[in]reg: Register address.
[in]data_in: Data byte to be written.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ charger29_write_regs()

err_t charger29_write_regs ( charger29_t * ctx,
uint8_t reg,
uint8_t * data_in,
uint8_t len )

Charger 29 write registers function.

This function writes a sequence of bytes starting from the selected register of the Charger 29 Click board.

Parameters
[in]ctx: Click context object. See charger29_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: Pointer to the data buffer to be written.
[in]len: Number of bytes to write.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.