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

Topics
	ISM Registers List
	List of registers of ISM Click driver.

	ISM Registers Settings
	Settings for registers of ISM Click driver.

	ISM MikroBUS Map
	MikroBUS pin mapping of ISM Click driver.

	Ism_cmd

Functions
void	ism_cfg_setup (ism_cfg_t *cfg)
	ISM configuration object setup function.

err_t	ism_init (ism_t ctx, ism_cfg_t cfg)
	ISM initialization function.

void	ism_default_cfg (ism_t *ctx)
	ISM default configuration function.

err_t	ism_generic_write (ism_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	ISM data writing function.

err_t	ism_generic_read (ism_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	ISM data reading function.

err_t	ism_set_cmd (ism_t *ctx, uint8_t cmd, uint8_t cmd_data)
	ISM set command function.

void	ism_chip_enable (ism_t *ctx)
	ISM set chip enable function.

void	ism_chip_disable (ism_t *ctx)
	ISM set chip disable function.

void	ism_set_rl_pin_state (ism_t *ctx, uint8_t rt_pin_state)
	ISM RL pin setting function.

void	ism_set_tl_pin_state (ism_t *ctx, uint8_t tl_pin_state)
	ISM TL pin setting function.

uint8_t	ism_check_interrupt_request (ism_t *ctx)
	ISM check interrupt request function.

err_t	ism_switch_bank (ism_t *ctx, uint8_t bank_sel)
	ISM switch bank function.

err_t	ism_switch_rx_mode (ism_t *ctx)
	ISM switch RX mode function.

err_t	ism_switch_tx_mode (ism_t *ctx)
	ISM switch TX mode function.

err_t	ism_device_config (ism_t *ctx)
	ISM device configuration function.

err_t	ism_receive_packet (ism_t ctx, uint8_t rx_data)
	ISM receive packet function.

err_t	ism_transmit_packet (ism_t ctx, uint8_t type, uint8_t tx_data, uint8_t len)
	ISM transmit package function.

Detailed Description

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

◆ ism_cfg_setup()

void ism_cfg_setup ( ism_cfg_t * cfg )

ISM configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See ism_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ ism_check_interrupt_request()

uint8_t ism_check_interrupt_request ( ism_t * ctx )

ISM check interrupt request function.

This function check interrupt request, get states of the IRQ ( INT ) pin of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in] ctx : Click context object. See ism_t object definition for detailed explanation.

Returns

0 - Low pin state,
1 - High pin state.

Note: None.

◆ ism_chip_disable()

void ism_chip_disable ( ism_t * ctx )

ISM set chip disable function.

This function set chip disable of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in] ctx : Click context object. See ism_t object definition for detailed explanation.

Returns: Nothing.

Note: None.

◆ ism_chip_enable()

void ism_chip_enable ( ism_t * ctx )

ISM set chip enable function.

This function set chip enable of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in] ctx : Click context object. See ism_t object definition for detailed explanation.

Returns: Noting

Note: None.

◆ ism_default_cfg()

void ism_default_cfg ( ism_t * ctx )

ISM default configuration function.

This function executes a default configuration of ISM click board™.

Parameters

[in] ctx : Click context object. See ism_t object definition for detailed explanation.

Returns: None.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ ism_device_config()

err_t ism_device_config ( ism_t * ctx )

ISM device configuration function.

This function performs configuration of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in] ctx : Click context object. See ism_t object definition for detailed explanation.

Returns

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

Note: None.

◆ ism_generic_read()

err_t ism_generic_read	(	ism_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

ISM data reading function.

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

Parameters

[in]	ctx	: Click context object. See ism_t object definition for detailed explanation.
[in]	reg	: Start register address.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

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

Note: None.

◆ ism_generic_write()

err_t ism_generic_write	(	ism_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

ISM data writing function.

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

Parameters

[in]	ctx	: Click context object. See ism_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

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

Note: None.

◆ ism_init()

err_t ism_init	(	ism_t *	ctx,
		ism_cfg_t *	cfg )

ISM initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ ism_receive_packet()

err_t ism_receive_packet	(	ism_t *	ctx,
		uint8_t *	rx_data )

ISM receive packet function.

This function receive packet of data of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in]	ctx	: Click context object. See ism_t object definition for detailed explanation.
[out]	rx_data	: Pointer to the memory location where receive data be stored.

Returns

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

Note: None.

◆ ism_set_cmd()

err_t ism_set_cmd	(	ism_t *	ctx,
		uint8_t	cmd,
		uint8_t	cmd_data )

ISM set command function.

This function writes a desired command data by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See ism_t object definition for detailed explanation.
[in]	cmd	: Command register address.
[in]	cmd_data	: Command data to be written.

Returns

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

Note: None.

◆ ism_set_rl_pin_state()

void ism_set_rl_pin_state	(	ism_t *	ctx,
		uint8_t	rt_pin_state )

ISM RL pin setting function.

This function sets the RL pin state to the desired level of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in]	ctx	: Click context object. See ism_t object definition for detailed explanation.
[in]	rt_pin_state	: `0` ( ISM_RT_PIN_STATE_LOW ) - Set pin state on the low level, `1` ( ISM_RT_PIN_STATE_HIGH ) - Set pin state on the high level.

Returns: Nothing.

Note: None.

◆ ism_set_tl_pin_state()

void ism_set_tl_pin_state	(	ism_t *	ctx,
		uint8_t	tl_pin_state )

ISM TL pin setting function.

This function sets the TL pin state to the desired level of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in]	ctx	: Click context object. See ism_t object definition for detailed explanation.
[in]	tl_pin_state	: `0` ( ISM_RT_PIN_STATE_LOW ) - Set pin state on the low level, `1` ( ISM_RT_PIN_STATE_HIGH ) - Set pin state on the high level.

Returns: Nothing.

Note: None.

◆ ism_switch_bank()

err_t ism_switch_bank	(	ism_t *	ctx,
		uint8_t	bank_sel )

ISM switch bank function.

This function switch to the desire register bank of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in]	ctx	: Click context object. See ism_t object definition for detailed explanation.
[in]	bank_sel	: Bank selection `0` - Register Bank 0, `1` - Register Bank 1.

Returns

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

Note: None.

◆ ism_switch_rx_mode()

err_t ism_switch_rx_mode ( ism_t * ctx )

ISM switch RX mode function.

This function switch to RX mode of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in] ctx : Click context object. See ism_t object definition for detailed explanation.

Returns

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

Note: None.

◆ ism_switch_tx_mode()

err_t ism_switch_tx_mode ( ism_t * ctx )

ISM switch TX mode function.

This function switch to TX mode of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in] ctx : Click context object. See ism_t object definition for detailed explanation.

Returns

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

Note: None.

◆ ism_transmit_packet()

err_t ism_transmit_packet	(	ism_t *	ctx,
		uint8_t	type,
		uint8_t *	tx_data,
		uint8_t	len )

ISM transmit package function.

This function transmit the package of data of the RFM75, Low Power High Performance 2.4 GHz GFSK Transceiver on the ISM click board™.

Parameters

[in]	ctx	: Click context object. See ism_t object definition for detailed explanation.
[in]	type	: Transmission type.
[in]	tx_data	: Pointer to the memory location where transmitted data be stored.
[in]	len	: The number of bytes to be transmitted.

Returns

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

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ ism_cfg_setup()

◆ ism_check_interrupt_request()

◆ ism_chip_disable()

◆ ism_chip_enable()

◆ ism_default_cfg()

◆ ism_device_config()

◆ ism_generic_read()

◆ ism_generic_write()

◆ ism_init()

◆ ism_receive_packet()

◆ ism_set_cmd()

◆ ism_set_rl_pin_state()

◆ ism_set_tl_pin_state()

◆ ism_switch_bank()

◆ ism_switch_rx_mode()

◆ ism_switch_tx_mode()

◆ ism_transmit_packet()