Public function

Functions
void	ldc1000_cfg_setup (ldc1000_cfg_t *cfg)
	Config Object Initialization function.
LDC1000_RETVAL	ldc1000_init (ldc1000_t *ctx, ldc1000_cfg_t *cfg)
	Initialization function.
void	ldc1000_default_cfg (ldc1000_t *ctx)
	Click Default Configuration function.
void	ldc1000_write_byte (ldc1000_t *ctx, uint8_t address, uint8_t input_data)
	Byte write function.
uint8_t	ldc1000_read_byte (ldc1000_t *ctx, uint8_t address)
	Byte read function.
uint16_t	ldc1000_get_proximity_data (ldc1000_t *ctx)
	Get proximity data function.
float	ldc1000_get_inductance_data (ldc1000_t *ctx)
	Get inductance data function.
uint8_t	ldc1000_get_int_input (ldc1000_t *ctx)
	Get interrupt pin input function.

Detailed Description

Function Documentation

ldc1000_cfg_setup()

void ldc1000_cfg_setup

(

ldc1000_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

ldc1000_default_cfg()

void ldc1000_default_cfg

(

ldc1000_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for LDC 1000 click.

ldc1000_get_inductance_data()

float ldc1000_get_inductance_data

(

ldc1000_t *

ctx

)

Get inductance data function.

Parameters

ctx	Click object.

@description This function reads the inductance data.

ldc1000_get_int_input()

uint8_t ldc1000_get_int_input

(

ldc1000_t *

ctx

)

Get interrupt pin input function.

Parameters

ctx	Click object.

@description This function reads the input voltage from the INT pin.

ldc1000_get_proximity_data()

uint16_t ldc1000_get_proximity_data

(

ldc1000_t *

ctx

)

Get proximity data function.

Parameters

ctx	Click object.

@description This function reads the proximity data.

ldc1000_init()

LDC1000_RETVAL ldc1000_init	(	ldc1000_t *	ctx,
		ldc1000_cfg_t *	cfg )

Initialization function.

Parameters

ldc1000	Click object.
cfg	Click configuration structure.

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

ldc1000_read_byte()

uint8_t ldc1000_read_byte	(	ldc1000_t *	ctx,
		uint8_t	address )

Byte read function.

Parameters

ctx	Click object.
address	Register address.

@description This function reads 1 byte of data from the specified register address.

ldc1000_write_byte()

void ldc1000_write_byte	(	ldc1000_t *	ctx,
		uint8_t	address,
		uint8_t	input_data )

Byte write function.

Parameters

ctx	Click object.
address	Register address.
input_data	Data byte.

@description This function writes 1 byte of data to the specified register address.