AlphaNum R Click Driver

API for configuring and manipulating AlphaNum R Click driver. More...

Topics
	AlphaNum R MikroBUS Map
	MikroBUS pin mapping of AlphaNum R Click driver.

Functions
void	alphanumr_cfg_setup (alphanumr_cfg_t *cfg)
	AlphaNum R configuration object setup function.
err_t	alphanumr_init (alphanumr_t *ctx, alphanumr_cfg_t *cfg)
	AlphaNum R initialization function.
void	alphanumr_set_display_interval (alphanumr_t *ctx, uint16_t delay_char_display)
	Delay character display function.
void	alphanumr_display_write (alphanumr_t *ctx, uint16_t left_char, uint16_t right_char)
	Display write function.
void	alphanumr_write_character (alphanumr_t *ctx, uint8_t left_char, uint8_t right_char)
	Character write function.
void	alphanumr_write_number (alphanumr_t *ctx, uint8_t left_char, uint8_t right_char)
	Number write function.
void	alphanumr_set_rst_high (alphanumr_t *ctx)
	Reset set high function.
void	alphanumr_set_rst_low (alphanumr_t *ctx)
	Reset set low function.
void	alphanumr_set_pwm_high (alphanumr_t *ctx)
	PWM set high function.
void	alphanumr_set_pwm_low (alphanumr_t *ctx)
	PWM set low function.
void	alphanumr_set_int_high (alphanumr_t *ctx)
	Interrupt set high function.
void	alphanumr_set_int_low (alphanumr_t *ctx)
	Interrupt set low function.

Detailed Description

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

alphanumr_cfg_setup()

void alphanumr_cfg_setup

(

alphanumr_cfg_t *

cfg

)

AlphaNum R configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

alphanumr_display_write()

void alphanumr_display_write	(	alphanumr_t *	ctx,
		uint16_t	left_char,
		uint16_t	right_char )

Display write function.

This function displays symbols on the left and right LED segments.

Parameters

[in]	ctx	: Click configuration structure. See alphanumr_t object definition for detailed explanation
[in]	left_char	Left segment symbol.
[in]	right_char	Right segment symbol.

Returns

Nothing.

alphanumr_init()

err_t alphanumr_init	(	alphanumr_t *	ctx,
		alphanumr_cfg_t *	cfg )

AlphaNum R initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

alphanumr_set_display_interval()

void alphanumr_set_display_interval	(	alphanumr_t *	ctx,
		uint16_t	delay_char_display )

Delay character display function.

This function sets the time interval at which the symbols are displayed.

Parameters

[in]	ctx	: Click configuration structure. See alphanumr_t object definition for detailed explanation
[in]	delay_char_display	Delay time interval in ms.

Returns

Nothing.

alphanumr_set_int_high()

void alphanumr_set_int_high

(

alphanumr_t *

ctx

)

Interrupt set high function.

This function sets the output voltage on the interrupt pin to high.

Parameters

[in]

ctx

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

Returns

Nothing.

alphanumr_set_int_low()

void alphanumr_set_int_low

(

alphanumr_t *

ctx

)

Interrupt set low function.

This function sets the output voltage on the interrupt pin to high.

Parameters

[in]

ctx

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

Returns

Nothing.

alphanumr_set_pwm_high()

void alphanumr_set_pwm_high

(

alphanumr_t *

ctx

)

PWM set high function.

This function sets the output voltage on the PWM pin to high.

Parameters

[in]

ctx

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

Returns

Nothing.

alphanumr_set_pwm_low()

void alphanumr_set_pwm_low

(

alphanumr_t *

ctx

)

PWM set low function.

This function sets the output voltage on the PWM pin to highlow.

Parameters

[in]

ctx

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

Returns

Nothing.

alphanumr_set_rst_high()

void alphanumr_set_rst_high

(

alphanumr_t *

ctx

)

Reset set high function.

This function sets the output voltage on the reset pin to high.

Parameters

[in]

ctx

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

Returns

Nothing.

alphanumr_set_rst_low()

void alphanumr_set_rst_low

(

alphanumr_t *

ctx

)

Reset set low function.

This function sets the output voltage on the reset pin to low.

Parameters

[in]

ctx

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

Returns

Nothing.

alphanumr_write_character()

void alphanumr_write_character	(	alphanumr_t *	ctx,
		uint8_t	left_char,
		uint8_t	right_char )

Character write function.

This function displays characters on the left and right LED segments.

Parameters

[in]	ctx	: Click configuration structure. See alphanumr_t object definition for detailed explanation
[in]	left_char	Left segment symbol.
[in]	right_char	Right segment symbol.

Returns

Nothing.

alphanumr_write_number()

void alphanumr_write_number	(	alphanumr_t *	ctx,
		uint8_t	left_char,
		uint8_t	right_char )

Number write function.

This function displays numbers on the left and right LED segments.

Parameters

[in]	ctx	: Click configuration structure. See alphanumr_t object definition for detailed explanation
[in]	left_char	Left segment symbol.
[in]	right_char	Right segment symbol.

Returns

Nothing.