UT-L 7-SEG B Click Driver

API for configuring and manipulating UT-L 7-SEG B Click driver. More...

Topics
	UT-L 7-SEG B Registers List
	List of registers of UT-L 7-SEG B Click driver.
	UT-L 7-SEG B Registers Settings
	Settings for registers of UT-L 7-SEG B Click driver.
	UT-L 7-SEG B MikroBUS Map
	MikroBUS pin mapping of UT-L 7-SEG B Click driver.

Functions
void	utl7segb_cfg_setup (utl7segb_cfg_t *cfg)
	UT-L 7-SEG B configuration object setup function.
err_t	utl7segb_init (utl7segb_t *ctx, utl7segb_cfg_t *cfg)
	UT-L 7-SEG B initialization function.
err_t	utl7segb_default_cfg (utl7segb_t *ctx)
	UT-L 7-SEG B default configuration function.
err_t	utl7segb_generic_write (utl7segb_t *ctx, uint8_t *data_in, uint8_t len)
	UT-L 7-SEG B data writing function.
err_t	utl7segb_generic_read (utl7segb_t *ctx, uint8_t *data_out, uint8_t len)
	UT-L 7-SEG B data reading function.
void	utl7segb_enable (utl7segb_t *ctx)
	UT-L 7-SEG B enable function.
void	utl7segb_disable (utl7segb_t *ctx)
	UT-L 7-SEG B disable function.
err_t	utl7segb_display_number (utl7segb_t *ctx, uint8_t base, uint8_t num, uint8_t dot_pos)
	UT-L 7-SEG B display number function.
err_t	utl7segb_get_number (utl7segb_t *ctx, uint8_t base, uint8_t *num, uint8_t *dot_pos)
	UT-L 7-SEG B get number function.

Detailed Description

API for configuring and manipulating UT-L 7-SEG B 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

utl7segb_cfg_setup()

void utl7segb_cfg_setup

(

utl7segb_cfg_t *

cfg

)

UT-L 7-SEG B configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

utl7segb_default_cfg()

err_t utl7segb_default_cfg

(

utl7segb_t *

ctx

)

UT-L 7-SEG B default configuration function.

This function executes a default configuration of UT-L 7-SEG B click board.

Parameters

[in]

ctx

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

utl7segb_disable()

void utl7segb_disable

(

utl7segb_t *

ctx

)

UT-L 7-SEG B disable function.

This function disable the output, without altering the contents of the output latches of the MAX6969, 16-Port, 5.5V Constant-Current LED Driver on the UT-L 7-SEG B Click board™.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

None.

utl7segb_display_number()

err_t utl7segb_display_number	(	utl7segb_t *	ctx,
		uint8_t	base,
		uint8_t	num,
		uint8_t	dot_pos )

UT-L 7-SEG B display number function.

This function display the desired number of the MAX6969, 16-Port, 5.5V Constant-Current LED Driver on the UT-L 7-SEG B Click board™.

Parameters

[in]	ctx	: Click context object. See utl7segb_t object definition for detailed explanation.
[in]	base	: Total count of digits used to express numbers in a number system [0-16].
[in]	num	: Number (range depends on the base).
[in]	dot_pos	: Dot position (No use dot, dot left, right and left and right) [0-3].

Returns

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

Note

None.

utl7segb_enable()

void utl7segb_enable

(

utl7segb_t *

ctx

)

UT-L 7-SEG B enable function.

This function enables outputs to follow the state of the output latches of the MAX6969, 16-Port, 5.5V Constant-Current LED Driver on the UT-L 7-SEG B Click board™.

Parameters

[in]

ctx

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

Returns

Nothing.

Note

None.

utl7segb_generic_read()

err_t utl7segb_generic_read	(	utl7segb_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len )

UT-L 7-SEG B data reading function.

This function reads a desired number of data bytes by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See utl7segb_t object definition for detailed explanation.
[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.

utl7segb_generic_write()

err_t utl7segb_generic_write	(	utl7segb_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

UT-L 7-SEG B data writing function.

This function writes a desired number of data bytes by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See utl7segb_t object definition for detailed explanation.
[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.

utl7segb_get_number()

err_t utl7segb_get_number	(	utl7segb_t *	ctx,
		uint8_t	base,
		uint8_t *	num,
		uint8_t *	dot_pos )

UT-L 7-SEG B get number function.

This function reads and calculates the number shown on the display of the MAX6969, 16-Port, 5.5V Constant-Current LED Driver on the UT-L 7-SEG B Click board™.

Parameters

[in]	ctx	: Click context object. See utl7segb_t object definition for detailed explanation.
[in]	base	: Total count of digits used to express numbers in a number system [0-16].
[out]	num	: Number (range depends on the base).
[out]	dot_pos	: Dot position (No use dot, dot left, right and left and right) [0-3].

Returns

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

Note

None.

utl7segb_init()

err_t utl7segb_init	(	utl7segb_t *	ctx,
		utl7segb_cfg_t *	cfg )

UT-L 7-SEG B initialization function.

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

Parameters

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

Returns

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

Note

None.