capslider3 2.2.0
Loading...
Searching...
No Matches
Cap Slider 3 Click Driver

API for configuring and manipulating Cap Slider 3 Click driver. More...

Topics

 Cap Slider 3 Registers List
 List of registers of Cap Slider 3 Click driver.
 Cap Slider 3 Registers Settings
 Settings for registers of Cap Slider 3 Click driver.
 Cap Slider 3 MikroBUS Map
 MikroBUS pin mapping of Cap Slider 3 Click driver.

Functions

void capslider3_cfg_setup (capslider3_cfg_t *cfg)
 Cap Slider 3 configuration object setup function.
err_t capslider3_init (capslider3_t *ctx, capslider3_cfg_t *cfg)
 Cap Slider 3 initialization function.
err_t capslider3_default_cfg (capslider3_t *ctx)
 Cap Slider 3 default configuration function.
err_t capslider3_write_reg (capslider3_t *ctx, uint8_t reg, uint16_t data_in)
 Cap Slider 3 write register function.
err_t capslider3_write_regs (capslider3_t *ctx, uint8_t reg, uint16_t *data_in, uint8_t len)
 Cap Slider 3 write registers function.
err_t capslider3_read_reg (capslider3_t *ctx, uint8_t reg, uint16_t *data_out)
 Cap Slider 3 read register function.
err_t capslider3_read_regs (capslider3_t *ctx, uint8_t reg, uint16_t *data_out, uint8_t len)
 Cap Slider 3 read registers function.
uint8_t capslider3_get_rdy_pin (capslider3_t *ctx)
 Cap Slider 3 get ready pin function.
err_t capslider3_check_communication (capslider3_t *ctx)
 Cap Slider 3 check communication function.
err_t capslider3_sw_reset (capslider3_t *ctx)
 Cap Slider 3 software reset function.
err_t capslider3_read_data (capslider3_t *ctx, capslider3_data_t *data_out)
 Cap Slider 3 read data function.

Detailed Description

API for configuring and manipulating Cap Slider 3 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

◆ capslider3_cfg_setup()

void capslider3_cfg_setup ( capslider3_cfg_t * cfg)

Cap Slider 3 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ capslider3_check_communication()

err_t capslider3_check_communication ( capslider3_t * ctx)

Cap Slider 3 check communication function.

This function checks the communication by reading the product number register.

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

◆ capslider3_default_cfg()

err_t capslider3_default_cfg ( capslider3_t * ctx)

Cap Slider 3 default configuration function.

This function executes a default configuration of Cap Slider 3 Click board.

Parameters
[in]ctx: Click context object. See capslider3_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.

◆ capslider3_get_rdy_pin()

uint8_t capslider3_get_rdy_pin ( capslider3_t * ctx)

Cap Slider 3 get ready pin function.

This function reads the state of the RDY pin.

Parameters
[in]ctx: Click context object. See capslider3_t object definition for detailed explanation.
Returns
Pin logic state (0 or 1).
Note
None.

◆ capslider3_init()

err_t capslider3_init ( capslider3_t * ctx,
capslider3_cfg_t * cfg )

Cap Slider 3 initialization function.

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

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

◆ capslider3_read_data()

err_t capslider3_read_data ( capslider3_t * ctx,
capslider3_data_t * data_out )

Cap Slider 3 read data function.

This function reads various system information and sensor data from the Click board.

Parameters
[in]ctx: Click context object. See capslider3_t object definition for detailed explanation.
[out]data_out: Pointer to the structure where read data will be stored. See capslider3_data_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ capslider3_read_reg()

err_t capslider3_read_reg ( capslider3_t * ctx,
uint8_t reg,
uint16_t * data_out )

Cap Slider 3 read register function.

This function reads a 16-bit data from the specified register.

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

◆ capslider3_read_regs()

err_t capslider3_read_regs ( capslider3_t * ctx,
uint8_t reg,
uint16_t * data_out,
uint8_t len )

Cap Slider 3 read registers function.

This function reads multiple 16-bit data from consecutive registers starting from the specified register address.

Parameters
[in]ctx: Click context object. See capslider3_t object definition for detailed explanation.
[in]reg: Starting register address.
[out]data_out: Pointer to a memory location where read data will be stored.
[in]len: Number of 16-bit data entries to read.
Returns
  • 0 - Success,
  • -1 - Error.
Note
None.

◆ capslider3_sw_reset()

err_t capslider3_sw_reset ( capslider3_t * ctx)

Cap Slider 3 software reset function.

This function performs a software reset by modifying the system control register.

Parameters
[in]ctx: Click context object. See capslider3_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
Note
This function ensures reset acknowledgment before proceeding.

◆ capslider3_write_reg()

err_t capslider3_write_reg ( capslider3_t * ctx,
uint8_t reg,
uint16_t data_in )

Cap Slider 3 write register function.

This function writes a 16-bit data to the specified register.

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

◆ capslider3_write_regs()

err_t capslider3_write_regs ( capslider3_t * ctx,
uint8_t reg,
uint16_t * data_in,
uint8_t len )

Cap Slider 3 write registers function.

This function writes multiple 16-bit data to consecutive registers starting from the specified register address.

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