proxfusion3 2.0.0.0
ProxFusion 3 Click Driver

API for configuring and manipulating ProxFusion 3 Click driver. More...

Topics

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

Functions

void proxfusion3_cfg_setup (proxfusion3_cfg_t *cfg)
 ProxFusion 3 configuration object setup function.
 
err_t proxfusion3_init (proxfusion3_t *ctx, proxfusion3_cfg_t *cfg)
 ProxFusion 3 initialization function.
 
err_t proxfusion3_default_cfg (proxfusion3_t *ctx)
 ProxFusion 3 default configuration function.
 
void proxfusion3_set_state_int_pin (proxfusion3_t *ctx, uint8_t pin_state)
 ProxFusion 3 INT pin setting function.
 
uint8_t proxfusion3_get_state_gp_pin (proxfusion3_t *ctx)
 ProxFusion 3 get state of GP pin function.
 
err_t proxfusion3_generic_write (proxfusion3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
 ProxFusion 3 I2C writing function.
 
err_t proxfusion3_generic_read (proxfusion3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
 ProxFusion 3 I2C reading function.
 
void proxfusion3_write_reg (proxfusion3_t *ctx, uint8_t reg, uint16_t tx_data)
 ProxFusion 3 I2C register writing function.
 
uint16_t proxfusion3_read_reg (proxfusion3_t *ctx, uint8_t reg)
 ProxFusion 3 I2C register reading function.
 
err_t proxfusion3_get_version_info (proxfusion3_t *ctx, uint8_t *product_number, uint8_t *software_version)
 ProxFusion 3 get version info data function.
 
void proxfusion3_sw_reset (proxfusion3_t *ctx)
 ProxFusion 3 software reset function.
 
void proxfusion3_enable_channels (proxfusion3_t *ctx)
 ProxFusion 3 enable channels function.
 
void proxfusion3_channel_remap (proxfusion3_t *ctx)
 ProxFusion 3 channel remap function.
 
void proxfusion3_adjust_touch_thresholds (proxfusion3_t *ctx)
 ProxFusion 3 adjust touch thresholds function.
 
void proxfusion3_adjust_deep_touch_thresholds (proxfusion3_t *ctx)
 ProxFusion 3 adjust deep touch thresholds function.
 
void proxfusion3_auto_tune (proxfusion3_t *ctx)
 ProxFusion 3 auto tune function.
 
void proxfusion3_set_event (proxfusion3_t *ctx, uint8_t event)
 ProxFusion 3 set event function.
 
float proxfusion3_get_absolute_measurement (proxfusion3_t *ctx)
 ProxFusion 3 get absolute measurement function.
 
uint16_t proxfusion3_read_channel_delta (proxfusion3_t *ctx, uint8_t channel)
 ProxFusion 3 read channel delta function.
 
uint8_t proxfusion3_check_touch_event (proxfusion3_t *ctx)
 ProxFusion 3 check touch event function.
 
uint8_t proxfusion3_get_touch (proxfusion3_t *ctx)
 ProxFusion 3 get touch function.
 
void proxfusion3_en_abs_cap (proxfusion3_t *ctx)
 ProxFusion 3 enables the absolute capacitiance function.
 
void proxfusion3_set_even_mode (proxfusion3_t *ctx, uint8_t mode)
 ProxFusion 3 set even mode function.
 
uint8_t proxfusion3_get_events (proxfusion3_t *ctx)
 ProxFusion 3 get events function.
 
uint8_t proxfusion3_get_gestures (proxfusion3_t *ctx)
 ProxFusion 3 get gestures function.
 

Detailed Description

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

◆ proxfusion3_adjust_deep_touch_thresholds()

void proxfusion3_adjust_deep_touch_thresholds ( proxfusion3_t * ctx)

ProxFusion 3 adjust deep touch thresholds function.

This function adjust deep touch thresholds of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ proxfusion3_adjust_touch_thresholds()

void proxfusion3_adjust_touch_thresholds ( proxfusion3_t * ctx)

ProxFusion 3 adjust touch thresholds function.

This function adjust touch thresholds of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ proxfusion3_auto_tune()

void proxfusion3_auto_tune ( proxfusion3_t * ctx)

ProxFusion 3 auto tune function.

This function force the device to run the Automatic Tuning Implementation (ATI) routine of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ proxfusion3_cfg_setup()

void proxfusion3_cfg_setup ( proxfusion3_cfg_t * cfg)

ProxFusion 3 configuration object setup function.

This function initializes click configuration structure to initial values.

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

◆ proxfusion3_channel_remap()

void proxfusion3_channel_remap ( proxfusion3_t * ctx)

ProxFusion 3 channel remap function.

This function is remap the channels of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ proxfusion3_check_touch_event()

uint8_t proxfusion3_check_touch_event ( proxfusion3_t * ctx)

ProxFusion 3 check touch event function.

This function reads and check touch event of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
  • 0x00 ( PROXFUSION3_EVENT_NO_TOUCH ) - No Touch event,
  • 0x01 ( PROXFUSION3_EVENT_TOUCH ) - Touch event.
Note
None.

◆ proxfusion3_default_cfg()

err_t proxfusion3_default_cfg ( proxfusion3_t * ctx)

ProxFusion 3 default configuration function.

This function executes a default configuration of ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_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. The delay is approximately 600 milliseconds.

◆ proxfusion3_en_abs_cap()

void proxfusion3_en_abs_cap ( proxfusion3_t * ctx)

ProxFusion 3 enables the absolute capacitiance function.

This function is a method which enables the absolute capacitiance UI of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ proxfusion3_enable_channels()

void proxfusion3_enable_channels ( proxfusion3_t * ctx)

ProxFusion 3 enable channels function.

This function is a method which enables all channels of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ proxfusion3_generic_read()

err_t proxfusion3_generic_read ( proxfusion3_t * ctx,
uint8_t reg,
uint8_t * rx_buf,
uint8_t rx_len )

ProxFusion 3 I2C reading function.

This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
[in]reg: Start register address.
[out]rx_buf: Output read data.
[in]rx_len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ proxfusion3_generic_write()

err_t proxfusion3_generic_write ( proxfusion3_t * ctx,
uint8_t reg,
uint8_t * tx_buf,
uint8_t tx_len )

ProxFusion 3 I2C writing function.

This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
[in]reg: Start register address.
[in]tx_buf: Data to be written.
[in]tx_len: Number of bytes to be written.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ proxfusion3_get_absolute_measurement()

float proxfusion3_get_absolute_measurement ( proxfusion3_t * ctx)

ProxFusion 3 get absolute measurement function.

This function read the absolute capacitance registers and calculate the absolute capacitance of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
absolute capacitance.
Note
None.

◆ proxfusion3_get_events()

uint8_t proxfusion3_get_events ( proxfusion3_t * ctx)

ProxFusion 3 get events function.

This function reads and returns the byte which holds the event flags of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
Byte which contains the event flags.
Note
None.

◆ proxfusion3_get_gestures()

uint8_t proxfusion3_get_gestures ( proxfusion3_t * ctx)

ProxFusion 3 get gestures function.

This function reads and returns the byte which holds the gesture flags of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
Byte which contains the gesture flags.
Note
The user must determine which gestures occurred by use of the gesture bit definitions. It is up to the user to decide which one to use.

◆ proxfusion3_get_state_gp_pin()

uint8_t proxfusion3_get_state_gp_pin ( proxfusion3_t * ctx)

ProxFusion 3 get state of GP pin function.

This function get State of GP pin on ProxFusion 3 click board.

Parameters
[out]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
  • 0x00 - Low,
  • 0x01 - High.
Note
None.

◆ proxfusion3_get_touch()

uint8_t proxfusion3_get_touch ( proxfusion3_t * ctx)

ProxFusion 3 get touch function.

This function reads and returns the position of the touch of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
position of the touch:
  • 0x01 - Number 1,
  • 0x02 - Number 2,
  • 0x03 - Number 3,
  • 0x04 - Number 4,
  • 0x05 - Number 5,
  • 0x06 - Number 6,
  • 0x07 - Number 7,
  • 0x08 - Number 8.
Note
None.

◆ proxfusion3_get_version_info()

err_t proxfusion3_get_version_info ( proxfusion3_t * ctx,
uint8_t * product_number,
uint8_t * software_version )

ProxFusion 3 get version info data function.

This function reads a version info data by using I2C serial interface.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
[out]product_number: Output product number data.
[out]software_version: Output software version data.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ proxfusion3_init()

err_t proxfusion3_init ( proxfusion3_t * ctx,
proxfusion3_cfg_t * cfg )

ProxFusion 3 initialization function.

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

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

◆ proxfusion3_read_channel_delta()

uint16_t proxfusion3_read_channel_delta ( proxfusion3_t * ctx,
uint8_t channel )

ProxFusion 3 read channel delta function.

This function reads and returns the Delta value of a specific channel of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
[in]channel: The enumerator which specifes which channel's Delta value to return.
Returns
16-bit Delta value of the channel.
Note
None.

◆ proxfusion3_read_reg()

uint16_t proxfusion3_read_reg ( proxfusion3_t * ctx,
uint8_t reg )

ProxFusion 3 I2C register reading function.

This function reads a 16-bit data from the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
[in]reg: Register address.
Returns
16-bit read data.
Note
None.

◆ proxfusion3_set_even_mode()

void proxfusion3_set_even_mode ( proxfusion3_t * ctx,
uint8_t mode )

ProxFusion 3 set even mode function.

This function set the desire even mode of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
[in]mode:
  • 0x01 ( PROXFUSION3_PROX_EVENT_BIT ) - Proxy event,
  • 0x02 ( PROXFUSION3_TOUCH_EVENT_BIT ) - Touch event,
  • 0x04 ( PROXFUSION3_DEEP_EVENT_BIT ) - Deep event,
  • 0x08 ( PROXFUSION3_GESTURE_EVENT_BIT ) - Gesture event,
  • 0x10 ( PROXFUSION3_MOV_EVENT_BIT ) - Mov event,
  • 0x20 ( PROXFUSION3_REF_EVENT_BIT ) - Reference event,
  • 0x40 ( PROXFUSION3_SYS_EVENT_BIT ) - System event,
  • 0x80 ( PROXFUSION3_LP_EVENT_BIT ) - LP event.
Returns
Nothing.
Note
None.

◆ proxfusion3_set_event()

void proxfusion3_set_event ( proxfusion3_t * ctx,
uint8_t event )

ProxFusion 3 set event function.

This function set desired event of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
[in]event:
  • 0x01 ( PROXFUSION3_PROX_EVENT_BIT ) - Proxy event,
  • 0x02 ( PROXFUSION3_TOUCH_EVENT_BIT ) - Touch event,
  • 0x04 ( PROXFUSION3_DEEP_EVENT_BIT ) - Deep event,
  • 0x08 ( PROXFUSION3_GESTURE_EVENT_BIT ) - Gesture event,
  • 0x10 ( PROXFUSION3_MOV_EVENT_BIT ) - Mov event,
  • 0x20 ( PROXFUSION3_REF_EVENT_BIT ) - Reference event,
  • 0x40 ( PROXFUSION3_SYS_EVENT_BIT ) - System event,
  • 0x80 ( PROXFUSION3_LP_EVENT_BIT ) - LP event.
Returns
Nothing.
Note
None.

◆ proxfusion3_set_state_int_pin()

void proxfusion3_set_state_int_pin ( proxfusion3_t * ctx,
uint8_t pin_state )

ProxFusion 3 INT pin setting function.

This function sets the INT pin state to the desired level ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
[in]pin_state:
  • 0x00 ( PROXFUSION3_SET_PIN_STATE_LOW ) - Set INT pin on the low level,
  • 0x01 ( PROXFUSION3_SET_PIN_STATE_HIGH ) - Set INT pin on the high level.
Returns
Nothing.
Note
None.

◆ proxfusion3_sw_reset()

void proxfusion3_sw_reset ( proxfusion3_t * ctx)

ProxFusion 3 software reset function.

This function is a method which clears the Show Reset bit by writing it to a 0 of the IQS269A 8 Channel capacitive touch and proximity controller on the ProxFusion 3 click board.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ proxfusion3_write_reg()

void proxfusion3_write_reg ( proxfusion3_t * ctx,
uint8_t reg,
uint16_t tx_data )

ProxFusion 3 I2C register writing function.

This function register writes a 16-bit data to the selected register by using I2C serial interface.

Parameters
[in]ctx: Click context object. See proxfusion3_t object definition for detailed explanation.
[in]reg: Register address.
[in]tx_buf: 16-bit data to be written.
Returns
Nothing.
Note
None.