OOK TX Click Driver

API for configuring and manipulating OOK TX Click driver. More...

Topics
	OOK TX Settings
	Settings for configuration of OOK TX Click driver.
	OOK TX MikroBUS Map
	MikroBUS pin mapping of OOK TX Click driver.

Functions
void	ooktx_cfg_setup (ooktx_cfg_t *cfg)
	OOK TX configuration object setup function.
err_t	ooktx_init (ooktx_t *ctx, ooktx_cfg_t *cfg)
	OOK TX initialization function.
void	ooktx_set_data_pin (ooktx_t *ctx)
	OOK TX set data pin function.
void	ooktx_clear_data_pin (ooktx_t *ctx)
	OOK TX clear data pin function.
void	ooktx_set_clock_pin (ooktx_t *ctx)
	OOK TX set clock pin function.
void	ooktx_clear_clock_pin (ooktx_t *ctx)
	OOK TX clear clock pin function.
void	ooktx_start (ooktx_t *ctx, uint8_t calib_en, uint8_t cfg_en, uint16_t cfg)
	OOK TX start function.
void	ooktx_stop (ooktx_t *ctx)
	OOK TX stop function.

Detailed Description

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

ooktx_cfg_setup()

void ooktx_cfg_setup

(

ooktx_cfg_t *

cfg

)

OOK TX configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

ooktx_clear_clock_pin()

void ooktx_clear_clock_pin

(

ooktx_t *

ctx

)

OOK TX clear clock pin function.

This function clears the clock pin to low logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

ooktx_clear_data_pin()

void ooktx_clear_data_pin

(

ooktx_t *

ctx

)

OOK TX clear data pin function.

This function clears the data pin to low logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

ooktx_init()

err_t ooktx_init	(	ooktx_t *	ctx,
		ooktx_cfg_t *	cfg )

OOK TX initialization function.

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

Parameters

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

Returns

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

Note

None.

ooktx_set_clock_pin()

void ooktx_set_clock_pin

(

ooktx_t *

ctx

)

OOK TX set clock pin function.

This function sets the clock pin to high logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

ooktx_set_data_pin()

void ooktx_set_data_pin

(

ooktx_t *

ctx

)

OOK TX set data pin function.

This function sets the data pin to high logic state.

Parameters

[in]

ctx

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

Returns

None.

Note

None.

ooktx_start()

void ooktx_start	(	ooktx_t *	ctx,
		uint8_t	calib_en,
		uint8_t	cfg_en,
		uint16_t	cfg )

OOK TX start function.

This function starts transmit with the selected settings.

Parameters

[in]	ctx	: Click context object. See ooktx_t object definition for detailed explanation.
[in]	calib_en	: Calibration enable flag.
[in]	cfg_en	: Configuration enable flag.
[in]	cfg	: Configuration word.

Returns

None.

Note

None.

ooktx_stop()

void ooktx_stop

(

ooktx_t *

ctx

)

OOK TX stop function.

This function stops transmit.

Parameters

[in]	ctx	: Click context object. See ooktx_t object definition for detailed explanation.
[in]	calib_en	: Calibration enable flag.
[in]	cfg_en	: Configuration enable flag.
[in]	cfg	: Configuration word.

Returns

None.

Note

None.