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

Topics
	UT-S 7-SEG B 2 Registers Settings
	Settings for registers of UT-S 7-SEG B 2 Click driver.

	UT-S 7-SEG B 2 MikroBUS Map
	MikroBUS pin mapping of UT-S 7-SEG B 2 Click driver.

Functions
void	uts7segb2_cfg_setup (uts7segb2_cfg_t *cfg)
	UT-S 7-SEG B 2 configuration object setup function.

err_t	uts7segb2_init (uts7segb2_t ctx, uts7segb2_cfg_t cfg)
	UT-S 7-SEG B 2 initialization function.

err_t	uts7segb2_default_cfg (uts7segb2_t *ctx)
	UT-S 7-SEG B 2 default configuration function.

err_t	uts7segb2_top_seg_write (uts7segb2_t ctx, uint8_t data_in, uint8_t len)
	UT-S 7-SEG B 2 top segment data writing function.

err_t	uts7segb2_top_seg_read (uts7segb2_t ctx, uint8_t data_out, uint8_t len)
	UT-S 7-SEG B 2 top segment data reading function.

err_t	uts7segb2_bottom_seg_write (uts7segb2_t ctx, uint8_t data_in, uint8_t len)
	UT-S 7-SEG B 2 bottom segment data writing function.

err_t	uts7segb2_bottom_seg_read (uts7segb2_t ctx, uint8_t data_out, uint8_t len)
	UT-S 7-SEG B 2 bottom segment data reading function.

void	uts7segb2_set_outputs_on (uts7segb2_t *ctx)
	UT-S 7-SEG B 2 set outputs ON function.

void	uts7segb2_set_outputs_off (uts7segb2_t *ctx)
	UT-S 7-SEG B 2 set outputs OFF function.

err_t	uts7segb2_set_seg_pos (uts7segb2_t *ctx, uts7segb2_seg_sel_t seg_sel, uint8_t seg_num, uint16_t brightness)
	UT-S 7-SEG B 2 set segment position function.

err_t	uts7segb2_set_led_output (uts7segb2_t *ctx, uts7segb2_seg_sel_t seg_sel, uint32_t seg_bit_mask, uint16_t brightness)
	UT-S 7-SEG B 2 set LED output function.

err_t	uts7segb2_display_character (uts7segb2_t *ctx, uts7segb2_character_cfg_t ascii_char)
	UT-S 7-SEG B 2 display character function.

err_t	uts7segb2_display_number (uts7segb2_t *ctx, uts7segb2_number_cfg_t number)
	UT-S 7-SEG B 2 display number function.

Detailed Description

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

◆ uts7segb2_bottom_seg_read()

err_t uts7segb2_bottom_seg_read	(	uts7segb2_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len )

UT-S 7-SEG B 2 bottom segment data reading function.

This function reads a desired number of data bytes on bottom segment of the TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

[in]	ctx	: Click context object. See uts7segb2_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.

◆ uts7segb2_bottom_seg_write()

err_t uts7segb2_bottom_seg_write	(	uts7segb2_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

UT-S 7-SEG B 2 bottom segment data writing function.

This function writes a desired number of data bytes on bottom segment of the TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

[in]	ctx	: Click context object. See uts7segb2_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.

◆ uts7segb2_cfg_setup()

void uts7segb2_cfg_setup ( uts7segb2_cfg_t * cfg )

UT-S 7-SEG B 2 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ uts7segb2_default_cfg()

err_t uts7segb2_default_cfg ( uts7segb2_t * ctx )

UT-S 7-SEG B 2 default configuration function.

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

Parameters

[in] ctx : Click context object. See uts7segb2_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.

◆ uts7segb2_display_character()

err_t uts7segb2_display_character	(	uts7segb2_t *	ctx,
		uts7segb2_character_cfg_t	ascii_char )

UT-S 7-SEG B 2 display character function.

This function displays the desired characters and brightness on the selected segments driven by TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

[in]	ctx	: Click context object. See uts7segb2_t object definition for detailed explanation.
[in]	ascii_char	: ASCII character configuration object. See uts7segb2_character_cfg_t object definition for detailed explanation.

Returns

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

Note: None.

◆ uts7segb2_display_number()

err_t uts7segb2_display_number	(	uts7segb2_t *	ctx,
		uts7segb2_number_cfg_t	number )

UT-S 7-SEG B 2 display number function.

This function displays the desired number and brightness on the selected segments driven by TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

[in]	ctx	: Click context object. See uts7segb2_t object definition for detailed explanation.
[in]	number	: Number configuration object. See uts7segb2_number_cfg_t object definition for detailed explanation.

Returns

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

Note: None.

◆ uts7segb2_init()

err_t uts7segb2_init	(	uts7segb2_t *	ctx,
		uts7segb2_cfg_t *	cfg )

UT-S 7-SEG B 2 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ uts7segb2_set_led_output()

err_t uts7segb2_set_led_output	(	uts7segb2_t *	ctx,
		uts7segb2_seg_sel_t	seg_sel,
		uint32_t	seg_bit_mask,
		uint16_t	brightness )

UT-S 7-SEG B 2 set LED output function.

This function sets the LED driver output to control 6 x JSS-3011BUB-21 driven by TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

[in]	ctx	: Click context object. See uts7segb2_t object definition for detailed explanation.
[in]	seg_sel	: Segment group selection [0-1] - [Top-Bottom].
[in]	seg_bit_mask	: Selected segment bitmaks [0-0x01FFFFFF].
[in]	brightness	: Brightness [0-4095].

Returns

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

Note: None.

◆ uts7segb2_set_outputs_off()

void uts7segb2_set_outputs_off ( uts7segb2_t * ctx )

UT-S 7-SEG B 2 set outputs OFF function.

This function sets all constant-current outputs forced to turn off of the TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

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

Returns: Nothing.

Note: None.

◆ uts7segb2_set_outputs_on()

void uts7segb2_set_outputs_on ( uts7segb2_t * ctx )

UT-S 7-SEG B 2 set outputs ON function.

This function sets all constant current outputs to be controlled by a PWM grayscale time controller of the TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

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

Returns: Nothing.

Note: None.

◆ uts7segb2_set_seg_pos()

err_t uts7segb2_set_seg_pos	(	uts7segb2_t *	ctx,
		uts7segb2_seg_sel_t	seg_sel,
		uint8_t	seg_num,
		uint16_t	brightness )

UT-S 7-SEG B 2 set segment position function.

This function sets desired brightness value of the selected segment position of the JSS-3011BUB-21 driven by TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

[in]	ctx	: Click context object. See uts7segb2_t object definition for detailed explanation.
[in]	seg_sel	: Segment group selection [0-1] - [Top-Bottom].
[in]	seg_num	: Selected segment position, 3 7-seg groups of 8 positions each [0-23].
[in]	brightness	: Brightness [0-4095].

Returns

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

Note: None.

◆ uts7segb2_top_seg_read()

err_t uts7segb2_top_seg_read	(	uts7segb2_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len )

UT-S 7-SEG B 2 top segment data reading function.

This function reads a desired number of data bytes on top segment of the TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

[in]	ctx	: Click context object. See uts7segb2_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.

◆ uts7segb2_top_seg_write()

err_t uts7segb2_top_seg_write	(	uts7segb2_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

UT-S 7-SEG B 2 top segment data writing function.

This function writes a desired number of data bytes on top segment of the TLC5947DAPR, 24-Channel, 12-Bit PWM LED Driver With Internal Oscillator on the UT-S 7-SEG B 2 Click board?.

Parameters

[in]	ctx	: Click context object. See uts7segb2_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.

Topics

Functions

Detailed Description

Function Documentation

◆ uts7segb2_bottom_seg_read()

◆ uts7segb2_bottom_seg_write()

◆ uts7segb2_cfg_setup()

◆ uts7segb2_default_cfg()

◆ uts7segb2_display_character()

◆ uts7segb2_display_number()

◆ uts7segb2_init()

◆ uts7segb2_set_led_output()

◆ uts7segb2_set_outputs_off()

◆ uts7segb2_set_outputs_on()

◆ uts7segb2_set_seg_pos()

◆ uts7segb2_top_seg_read()

◆ uts7segb2_top_seg_write()