Diff: maxrefdes99.h

Revision:

1:ce6a3accca77

Parent:

0:52f9ecc09233

--- a/maxrefdes99.h	Fri Mar 25 22:50:52 2016 +0000
+++ b/maxrefdes99.h	Tue May 31 22:32:53 2016 +0000
@@ -1,16 +1,5 @@
 /******************************************************************//**
 * @file maxrefdes99.h
-*
-* @author Justin Jordan
-*
-* @version 0.0
-*
-* Started: 08JAN16
-*
-* Updated: 
-*
-* @brief Header file for maxrefdes99 demo
-***********************************************************************
 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
@@ -42,19 +31,16 @@
 * ownership rights.
 **********************************************************************/
 
-
 #ifndef MAXREFDES99_H
 #define MAXREFDES99_H
 
 
 #include "mbed.h"
 #include "max7219.h"
-
-#define ESC 0x1B
     
 
 /**********************************************************//**
-* @brief gets character bitmap fom memory
+* @brief Gets character bitmap fom memory
 * 
 * @details 
 *
@@ -64,13 +50,13 @@
 *                            must be at least 6 bytes
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void get_5x7_character(char c, uint8_t *char_buff);
 
 
 /**********************************************************//**
-* @brief prints character to MAXREFDES99 at given position
+* @brief Prints character to MAXREFDES99 at given position
 * 
 * @details 
 *
@@ -82,13 +68,13 @@
 *     @param[in] c - char to print
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void print_char(Max7219 *p_display, uint8_t position, char c);
 
 
 /**********************************************************//**
-* @brief prints given string to MAXREFDES99 at given position
+* @brief Prints given string to MAXREFDES99 at given position
 * 
 * @details 
 *
@@ -100,13 +86,13 @@
 *     @param[in] s - pointer to string to print
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void print_string(Max7219 *p_display, uint8_t position, const char *s);
 
 
 /**********************************************************//**
-* @brief shifts display right 'count' positions with given
+* @brief Shifts display right 'count' positions with given
 *        delay between shifts 
 * 
 * @details 
@@ -117,13 +103,13 @@
 *     @param[in] delay - delay between shifts
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void shift_display_right(Max7219 *p_display, uint8_t count, uint8_t delay);
 
 
 /**********************************************************//**
-* @brief shifts display left 'count' positions with given
+* @brief Shifts display left 'count' positions with given
 *        delay between shifts
 * 
 * @details 
@@ -134,13 +120,13 @@
 *     @param[in] delay - delay between shifts
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void shift_display_left(Max7219 *p_display, uint8_t count, uint8_t delay);
 
 
 /**********************************************************//**
-* @brief turns on all leds for given quadrant, with quad 1 being
+* @brief Turns on all leds for given quadrant, with quad 1 being
 *        top left and quad 4 being bottom right
 * 
 * @details 
@@ -150,13 +136,13 @@
 *     @param[in] quad - see brief
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void quad_all_on(Max7219 *p_display, uint8_t quad);
 
 
 /**********************************************************//**
-* @brief turns off all leds for given quadrant, with quad 1 being
+* @brief Turns off all leds for given quadrant, with quad 1 being
 *        top left and quad 4 being bottom right
 * 
 * @details 
@@ -166,13 +152,13 @@
 *     @param[in] quad - see brief
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void quad_all_off(Max7219 *p_display, uint8_t quad);
 
 
 /**********************************************************//**
-* @brief turns all leds for whole display on
+* @brief Turns all leds for whole display on
 * 
 * @details 
 *
@@ -180,13 +166,13 @@
 *     @param[in] p_display - pointer to Max7219 object
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void all_on(Max7219 *p_display);
 
 
 /**********************************************************//**
-* @brief turns all leds for whole display off
+* @brief Turns all leds for whole display off
 * 
 * @details 
 *
@@ -194,16 +180,13 @@
 *     @param[in] p_display - pointer to Max7219 object
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void all_off(Max7219 *p_display);
 
 
-void clear_buffer(void);
-
-
 /**********************************************************//**
-* @brief demo loop for MAXREFDES99
+* @brief Demo loop for MAXREFDES99
 * 
 * @details 
 *
@@ -213,13 +196,13 @@
 *     @param[in] endless_loop - if true run demo in endless loop
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void demo(Max7219 *display, max7219_configuration_t display_config, bool endless_loop);
 
 
 /**********************************************************//**
-* @brief shift display in given direction forever
+* @brief Shift display in given direction forever
 * 
 * @details 
 *
@@ -228,26 +211,140 @@
 *     @param[in] scroll_right - if true shift right, else shift left
 *
 * On Exit:
-*    @return none
+*    @return None
 **************************************************************/
 void endless_scroll_display(Max7219 *display, uint32_t scroll_right);
 
+/**********************************************************//**
+* @brief Gets 16x16 character bitmap fom memory
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] c - character to get bitmap for
+*     @param[in] char_buff - pointer to buffer to store bitmap 
+*                            Buffer should be 32 bytes
+*     @param[in] font_type - 16x16 font type used for display 
+* On Exit:
+*    @return None
+**************************************************************/
+void get_16x16_character(char c, uint8_t *char_buff, uint8_t font_type);
+
+
+/**********************************************************//**
+* @brief Prints character to MAXREFDES99 16x16 LED display
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+      @param[in] position -  for single char print this value is zero,
+                 for string case it is multiple of 32 bytes as each char data is 32 bytes, 
+*     @param[in] c - char to print
+*     @param[in] font_type - 16x16 font type used for display 
+*
+* On Exit:
+*    @return None
+**************************************************************/
+void print_char_16x16(Max7219 *p_display, uint16_t position, char c, uint8_t font_type);
+
+
+/**********************************************************//**
+* @brief Prints given string to MAXREFDES99 16x16 LED display
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] s - pointer to string to print
+*     @param[in] font_type - 16x16 font type used for display 
+*
+* On Exit:
+*    @return None
+**************************************************************/
+void print_string_16x16(Max7219 *p_display, char *s, uint8_t font_type);
+
 
 /**********************************************************//**
-* @brief print demo menu
+* @brief Shifts 16x16 font display right 'count' positions with given
+*        delay between shifts 
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] count - number of positions to shift
+*     @param[in] delay - delay between shifts in milliseconds
+*
+* On Exit:
+*    @return None
+**************************************************************/
+void shift_display_right_16x16(Max7219 *p_display, uint8_t count, uint8_t delay);
+
+
+/**********************************************************//**
+* @brief Shifts 16x16 font display left 'count' positions with given
+*        delay between shifts
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] count - number of positions to shift
+*     @param[in] delay - delay between shifts in milliseconds
+*
+* On Exit:
+*    @return None
+**************************************************************/
+void shift_display_left_16x16(Max7219 *p_display, uint8_t count, uint8_t delay);
+
+/**********************************************************//**
+* @brief Demo loop for MAXREFDES99 with 16x16 font display
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] display_config - structure holding configuration data
+*     @param[in] font_type - 16x16 font type used for display 
+*     @param[in] endless_loop - if true run demo in endless loop
+*
+* On Exit:
+*    @return None
+**************************************************************/
+void demo_16x16(Max7219 *display, max7219_configuration_t display_config, uint8_t font_type, bool endless_loop);
+
+
+/**********************************************************//**
+* @brief Shift 16x16 font display in given direction forever
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] scroll_right - if true shift right, else shift left
+*
+* On Exit:
+*    @return None
+**************************************************************/
+void endless_scroll_display_16x16(Max7219 *display, uint32_t scroll_right);
+
+
+/**********************************************************//**
+* @brief Print demo menu
 * 
 * @details 
 *
 * On Entry:
 *
 * On Exit:
-*    @return user entry
+*    @return User entry
 **************************************************************/
 uint32_t print_menu(void);
 
 
 /**********************************************************//**
-* @brief get integer value from user
+* @brief Get integer value from user
 * 
 * @details 
 *
@@ -256,13 +353,13 @@
 *     @param[in] max_val - maximum allowable input
 *
 * On Exit:
-*    @return user entry
+*    @return User entry
 **************************************************************/
 uint32_t get_user_input(char *msg, uint32_t max_val);
 
 
 /**********************************************************//**
-* @brief get char from user
+* @brief Get char from user
 * 
 * @details 
 *
@@ -270,13 +367,13 @@
 *     @param[in] msg - prompt for user
 *
 * On Exit:
-*    @return user entry
+*    @return User entry
 **************************************************************/
 char get_user_char(char *msg);
 
 
 /**********************************************************//**
-* @brief get string from user
+* @brief Get string from user
 * 
 * @details 
 *
@@ -284,10 +381,13 @@
 *     @param[in] msg - prompt for user
 *
 * On Exit:
-*    @return user entry
+*    @return User entry
 **************************************************************/
 char * get_user_string(char *msg);
 
 
+void clear_buffer(void);
+
+
 #endif /*MAXREFDES99_H*/