Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Atmel YMCC42412AAAFDCL LCD Glass component

This is a driver for Atmel YMCC42412AAAFDCL LCD component.

This component is the custom LCD used for SAM4L-Xplained-Pro. This driver provides functions for initialization and control of the LCD segments.

Dependencies

This driver depends on the following modules:

Modules

 
 Quick Start Guide(s)
 In this section you can find a list of all Quick Start guides related to the Atmel YMCC42412AAAFDCL LCD Glass component.
 

Circular Animation Shift Direction

#define C42412A_CSR_RIGHT   1
 Right Direction. More...
 
#define C42412A_CSR_LEFT   0
 Left Direction. More...
 

Value for battery Icon setting

enum  c42412a_battery_value {
  C42412A_BATTERY_NONE = 0,
  C42412A_BATTERY_ONE,
  C42412A_BATTERY_TWO,
  C42412A_BATTERY_THREE
}
 

Value for wireless Icon setting

enum  c42412a_wireless_value {
  C42412A_WIRELESS_NONE = 0,
  C42412A_WIRELESS_ONE,
  C42412A_WIRELESS_TWO,
  C42412A_WIRELESS_THREE
}
 

Function Prototypes

status_code_t c42412a_init (void)
 Initialize the C42412A LCD Glass component. More...
 
void c42412a_show_text (const uint8_t *data)
 Show text on C42412A LCD glass alphanumeric field. More...
 
void c42412a_clear_text (void)
 Clear C42412A LCD glass alphanumeric field. More...
 
void c42412a_clear_icon (uint8_t icon_com, uint8_t icon_seg)
 Clear a specific icon on the LCD glass. More...
 
void c42412a_show_icon (uint8_t icon_com, uint8_t icon_seg)
 Show a specific icon on the LCD glass. More...
 
void c42412a_blink_icon_start (uint8_t icon_com, uint8_t icon_seg)
 Blink a specific icon on the LCD glass. More...
 
void c42412a_blink_icon_stop (uint8_t icon_com, uint8_t icon_seg)
 Stop blink a specific icon on the LCD glass. More...
 
void c42412a_blink_screen (void)
 Blink the current screen content. More...
 
void c42412a_blink_disable (void)
 Disable all Blink. More...
 
void c42412a_set_contrast (int8_t contrast)
 Set the C42412A LCD glass contrast. More...
 
void c42412a_text_scrolling_start (const uint8_t *data, uint32_t length)
 Scrolling start. More...
 
void c42412a_text_scrolling_stop (void)
 Scrolling stop. More...
 
void c42412a_show_all (void)
 Show all content of the LCD glass. More...
 
void c42412a_clear_all (void)
 Clear all content of the LCD glass. More...
 
void c42412a_show_numeric_dec (int32_t value)
 Show a decimal numeric value to LCD glass. More...
 
void c42412a_clear_numeric_dec (void)
 Clear C42412A LCD glass numeric field and the three C42412A_ICON_MINUS*** icons. More...
 
void c42412a_show_battery (enum c42412a_battery_value val)
 Show battery condition by the battery icons on the LCD glass. More...
 
void c42412a_show_wireless (enum c42412a_wireless_value val)
 Show wireless signal condition by the wireless icons on the LCD glass. More...
 

#define C42412A_CSR_LEFT   0

Left Direction.

#define C42412A_CSR_RIGHT   1

Right Direction.

Enumerator
C42412A_BATTERY_NONE 
C42412A_BATTERY_ONE 
C42412A_BATTERY_TWO 
C42412A_BATTERY_THREE 
Enumerator
C42412A_WIRELESS_NONE 
C42412A_WIRELESS_ONE 
C42412A_WIRELESS_TWO 
C42412A_WIRELESS_THREE 

void c42412a_blink_disable ( void  )

Disable all Blink.

This function will disable all Blink content.

References lcdca_blink_disable().

void c42412a_blink_icon_start ( uint8_t  icon_com,
uint8_t  icon_seg 
)

Blink a specific icon on the LCD glass.

This function will blink a specific icon.

Parameters
icon_comPixel coordinate - COMx - of the icon.
icon_segPixel coordinate - SEGy - of the icon.
Note
Use the icon define in header file(with selected segments blinking feature).

References lcdca_blink_config::lcd_blink_mode, lcdca_blink_config::lcd_blink_timer, lcdca_blink_enable(), LCDCA_BLINK_SELECTED, lcdca_blink_set_config(), lcdca_set_blink_pixel(), and lcdca_set_pixel().

Referenced by main().

void c42412a_blink_icon_stop ( uint8_t  icon_com,
uint8_t  icon_seg 
)

Stop blink a specific icon on the LCD glass.

This function will stop blink a specific icon.

Parameters
icon_comPixel coordinate - COMx - of the icon.
icon_segPixel coordinate - SEGy - of the icon.
Note
Use the icon define in header file(with selected segments blinking feature).

References lcdca_clear_blink_pixel().

Referenced by main().

void c42412a_blink_screen ( void  )

Blink the current screen content.

This function will make the current screen blink.

References lcdca_blink_config::lcd_blink_mode, lcdca_blink_config::lcd_blink_timer, lcdca_blink_enable(), LCDCA_BLINK_FULL, lcdca_blink_set_config(), and lcdca_clear_blink_all_pixel().

void c42412a_clear_all ( void  )

Clear all content of the LCD glass.

This function clears all pixels and areas of the LCD glass C42412A.

References lcdca_automated_char_stop(), lcdca_blink_disable(), lcdca_circular_shift_disable(), and lcdca_clear_display_memory().

Referenced by main().

void c42412a_clear_icon ( uint8_t  icon_com,
uint8_t  icon_seg 
)

Clear a specific icon on the LCD glass.

This function will clear a specific icon.

Parameters
icon_comPixel coordinate - COMx - of the icon.
icon_segPixel coordinate - SEGy - of the icon.
Note
Use the icon define in header file.

References lcdca_clear_pixel().

Referenced by main().

void c42412a_clear_numeric_dec ( void  )

Clear C42412A LCD glass numeric field and the three C42412A_ICON_MINUS*** icons.

This function will clear the numeric field of the LCD glass.

References C42412A_ICON_MINUS, C42412A_ICON_MINUS_SEG1, C42412A_ICON_MINUS_SEG2, c42412a_show_text(), and lcdca_clear_pixel().

Referenced by main().

void c42412a_clear_text ( void  )

Clear C42412A LCD glass alphanumeric field.

This function will clear the alphanumeric field of the LCD glass.

References LCDCA_CMCFG_DREV_RIGHT, LCDCA_TDG_14SEG4COM, and lcdca_write_packet().

Referenced by main().

status_code_t c42412a_init ( void  )

Initialize the C42412A LCD Glass component.

This function initializes the LCD driver to control the LCD glass. It perform LCD module intialization according to the C42412A characteristics.

References lcdca_config::contrast, lcdca_config::duty_type, lcdca_config::fc0, lcdca_config::fc1, lcdca_config::fc2, lcdca_config::lcd_clkdiv, lcdca_config::lcd_pres, lcdca_clk_init(), lcdca_enable(), lcdca_enable_timer(), lcdca_set_config(), LCDCA_TIMER_FC0, LCDCA_TIMER_FC1, LCDCA_TIMER_FC2, lcdca_config::lp_wave, lcdca_config::port_mask, STATUS_OK, and lcdca_config::x_bias.

Referenced by main().

void c42412a_set_contrast ( int8_t  contrast)

Set the C42412A LCD glass contrast.

This function allows to adjust the contrast of the C42412A LCD glass.

Parameters
contrast-32 <= signed contrast value <= 31(Using LCDCA) 0 <= contrast value <= 15(Using SLCDC).

References lcdca_set_contrast().

void c42412a_show_all ( void  )

Show all content of the LCD glass.

This function sets all pixels and areas of the LCD glass C42412A.

References lcdca_automated_char_stop(), lcdca_blink_disable(), lcdca_circular_shift_disable(), and lcdca_set_display_memory().

Referenced by main().

void c42412a_show_battery ( enum c42412a_battery_value  val)

Show battery condition by the battery icons on the LCD glass.

This function allows to Show battery condition by the battery icons on the LCD glass..

Parameters
valThe 0 to 3 value which show the battery condition.

References C42412A_ICON_BAT, C42412A_ICON_BAT_LEVEL_1, C42412A_ICON_BAT_LEVEL_2, C42412A_ICON_BAT_LEVEL_3, lcdca_clear_pixel(), and lcdca_set_pixel().

Referenced by main().

void c42412a_show_icon ( uint8_t  icon_com,
uint8_t  icon_seg 
)

Show a specific icon on the LCD glass.

This function will show a specific icon.

Parameters
icon_comPixel coordinate - COMx - of the icon.
icon_segPixel coordinate - SEGy - of the icon.
Note
Use the icon define in header file.

References lcdca_clear_blink_pixel(), and lcdca_set_pixel().

Referenced by main().

void c42412a_show_numeric_dec ( int32_t  value)

Show a decimal numeric value to LCD glass.

This function displays an int32 value to the LCD numeric field of the glass.

Parameters
valueThe int32_t value to be displayed
Note
The value range is [-199999,199999].

References Abs, Assert, C42412A_ICON_MINUS, C42412A_ICON_MINUS_SEG1, C42412A_ICON_MINUS_SEG2, c42412a_show_text(), lcdca_clear_pixel(), and lcdca_set_pixel().

Referenced by main().

void c42412a_show_text ( const uint8_t *  data)

Show text on C42412A LCD glass alphanumeric field.

This function will show text on the alphanumeric field of the LCD glass.

Parameters
dataPointer to the input string(max length is 5)

References LCDCA_CMCFG_DREV_RIGHT, LCDCA_TDG_14SEG4COM, and lcdca_write_packet().

Referenced by c42412a_clear_numeric_dec(), c42412a_show_numeric_dec(), and main().

void c42412a_show_wireless ( enum c42412a_wireless_value  val)

Show wireless signal condition by the wireless icons on the LCD glass.

This function allows to Show wireless signal condition by the wireless icons on the LCD glass..

Parameters
valThe 0 to 3 value which show the wireless signal condition.

References C42412A_ICON_WLESS_LEVEL_0, C42412A_ICON_WLESS_LEVEL_1, C42412A_ICON_WLESS_LEVEL_2, C42412A_ICON_WLESS_LEVEL_3, lcdca_clear_pixel(), and lcdca_set_pixel().

Referenced by main().

void c42412a_text_scrolling_stop ( void  )

Scrolling stop.

This function stop the text scrolling.

References lcdca_automated_char_stop().

Referenced by main().