ISM RX 2 Click Driver

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

Topics
	ISM RX 2 MikroBUS Map
	MikroBUS pin mapping of ISM RX 2 Click driver.
	Ismrx2_set

Functions
void	ismrx2_cfg_setup (ismrx2_cfg_t *cfg)
	ISM RX 2 configuration object setup function.
err_t	ismrx2_init (ismrx2_t *ctx, ismrx2_cfg_t *cfg)
	ISM RX 2 initialization function.
err_t	ismrx2_default_cfg (ismrx2_t *ctx)
	ISM RX 2 default configuration function.
void	ismrx2_set_rst_pin_state (ismrx2_t *ctx, uint8_t state)
	ISM RX 2 set state of RST pin function.
void	ismrx2_set_stb_pin_state (ismrx2_t *ctx, uint8_t state)
	ISM RX 2 set state of STB pin function.
uint8_t	ismrx2_get_mst_pin_state (ismrx2_t *ctx)
	ISM RX 2 get state of MST pin function.
uint8_t	ismrx2_get_data_pin_state (ismrx2_t *ctx)
	ISM RX 2 get state of DATA pin function.
err_t	ismrx2_read_manchester_data (ismrx2_t *ctx, uint8_t *data_out)
	ISM RX 2 read manchester encoded data function.
err_t	ismrx2_read_rf_data (ismrx2_t *ctx, uint8_t *data_out)
	ISM RX 2 read data function.

Detailed Description

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

ismrx2_cfg_setup()

void ismrx2_cfg_setup

(

ismrx2_cfg_t *

cfg

)

ISM RX 2 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

ismrx2_default_cfg()

err_t ismrx2_default_cfg

(

ismrx2_t *

ctx

)

ISM RX 2 default configuration function.

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

Parameters

[in]

ctx

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

ismrx2_get_data_pin_state()

uint8_t ismrx2_get_data_pin_state

(

ismrx2_t *

ctx

)

ISM RX 2 get state of DATA pin function.

This function get state of the DATA pin.

Parameters

[in]

ctx

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

Returns

State of the DATA pin.

Note

None.

ismrx2_get_mst_pin_state()

uint8_t ismrx2_get_mst_pin_state

(

ismrx2_t *

ctx

)

ISM RX 2 get state of MST pin function.

This function get state of the MST pin.

Parameters

[in]

ctx

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

Returns

State of the MST pin.

Note

None.

ismrx2_init()

err_t ismrx2_init	(	ismrx2_t *	ctx,
		ismrx2_cfg_t *	cfg )

ISM RX 2 initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

ismrx2_read_manchester_data()

err_t ismrx2_read_manchester_data	(	ismrx2_t *	ctx,
		uint8_t *	data_out )

ISM RX 2 read manchester encoded data function.

This function read manchester encoded data.

Parameters

[in]	ctx	: Click context object. See ismrx2_t object definition for detailed explanation.
[out]	data_out	: Read data.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

ismrx2_read_rf_data()

err_t ismrx2_read_rf_data	(	ismrx2_t *	ctx,
		uint8_t *	data_out )

ISM RX 2 read data function.

This function read data.

Parameters

[in]	ctx	: Click context object. See ismrx2_t object definition for detailed explanation.
[out]	data_out	: Read data.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

ismrx2_set_rst_pin_state()

void ismrx2_set_rst_pin_state	(	ismrx2_t *	ctx,
		uint8_t	state )

ISM RX 2 set state of RST pin function.

This function sets state of the RST pin.

Parameters

[in]	ctx	: Click context object. See ismrx2_t object definition for detailed explanation.
[in]	state	: Desired state of the pin.

Returns

Nothing.

Note

None.

ismrx2_set_stb_pin_state()

void ismrx2_set_stb_pin_state	(	ismrx2_t *	ctx,
		uint8_t	state )

ISM RX 2 set state of STB pin function.

This function sets state of the STB pin.

Parameters

[in]	ctx	: Click context object. See ismrx2_t object definition for detailed explanation.
[in]	state	: Desired state of the pin.

Returns

Nothing.

Note

None.