ISM RX 3 Click Driver

API for configuring and manipulating ISM RX 3 Click driver. More...

Topics
	ISM RX 3 Registers List
	List of registers of ISM RX 3 Click driver.
	ISM RX 3 Registers Settings
	Settings for registers of ISM RX 3 Click driver.
	ISM RX 3 MikroBUS Map
	MikroBUS pin mapping of ISM RX 3 Click driver.

Functions
void	ismrx3_cfg_setup (ismrx3_cfg_t *cfg)
	ISM RX 3 configuration object setup function.
err_t	ismrx3_init (ismrx3_t *ctx, ismrx3_cfg_t *cfg)
	ISM RX 3 initialization function.
err_t	ismrx3_default_cfg (ismrx3_t *ctx)
	ISM RX 3 default configuration function.
err_t	ismrx3_generic_write (ismrx3_t *ctx, uint8_t reg, uint8_t data_in)
	ISM RX 3 data writing function.
err_t	ismrx3_generic_read (ismrx3_t *ctx, uint8_t reg, uint8_t *data_out)
	ISM RX 3 data reading function.
void	ismrx3_reset (ismrx3_t *ctx)
	Reset function.
uint8_t	ismrx3_get_clk (ismrx3_t *ctx)
	Read clock output.
uint8_t	ismrx3_get_data (ismrx3_t *ctx)
	Read data output.

Detailed Description

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

ismrx3_cfg_setup()

void ismrx3_cfg_setup

(

ismrx3_cfg_t *

cfg

)

ISM RX 3 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See ismrx3_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

ismrx3_default_cfg()

err_t ismrx3_default_cfg

(

ismrx3_t *

ctx

)

ISM RX 3 default configuration function.

This function executes a default configuration of ISM RX 3 click board.

Parameters

[in]

ctx

: Click context object. See ismrx3_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.

ismrx3_generic_read()

err_t ismrx3_generic_read	(	ismrx3_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

ISM RX 3 data reading function.

This function reads a byte from register.

Parameters

[in]	ctx	: Click context object. See ismrx3_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

ismrx3_generic_write()

err_t ismrx3_generic_write	(	ismrx3_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

ISM RX 3 data writing function.

This function writes a byte to the register.

Parameters

[in]	ctx	: Click context object. See ismrx3_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

ismrx3_get_clk()

uint8_t ismrx3_get_clk

(

ismrx3_t *

ctx

)

Read clock output.

This function reads int_pin state.

Parameters

[in]

ctx

: Click context object. See ismrx3_t object definition for detailed explanation.

Returns

Clock state.

ismrx3_get_data()

uint8_t ismrx3_get_data

(

ismrx3_t *

ctx

)

Read data output.

This function reads dat pin state.

Parameters

[in]

ctx

: Click context object. See ismrx3_t object definition for detailed explanation.

Returns

Data state.

ismrx3_init()

err_t ismrx3_init	(	ismrx3_t *	ctx,
		ismrx3_cfg_t *	cfg )

ISM RX 3 initialization function.

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

Parameters

[out]	ctx	: Click context object. See ismrx3_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See ismrx3_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

ismrx3_reset()

void ismrx3_reset

(

ismrx3_t *

ctx

)

Reset function.

This function resets device by toggling pdn pin.

Parameters

[in]

ctx

: Click context object. See ismrx3_t object definition for detailed explanation.

Returns

Nothing.