Maxim Integrated
Demo for MAXREFDES99
Diff: maxrefdes99.h
- Revision:
- 8:a6a0c9e280ae
- Parent:
- 6:00aabe967e51
--- a/maxrefdes99.h Thu Apr 28 08:46:24 2016 +0000
+++ b/maxrefdes99.h Tue May 24 08:40:07 2016 +0000
@@ -1,17 +1,5 @@
/******************************************************************//**
* @file maxrefdes99.h
-*
-* @author Justin Jordan
-*
-* @version 0.2
-*
-* Started: 08JAN16
-*
-* Updated: 26 APR16,Pradip Vatharkar
-*
-* @brief Source file for maxrefdes99 demo with 5x7, 16x16 aerial bold
-* and 16x16 manual fonts
-***********************************************************************
* Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
@@ -43,7 +31,6 @@
* ownership rights.
**********************************************************************/
-
#ifndef MAXREFDES99_H
#define MAXREFDES99_H
@@ -53,7 +40,7 @@
/**********************************************************//**
-* @brief gets character bitmap fom memory
+* @brief Gets character bitmap fom memory
*
* @details
*
@@ -63,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
*
@@ -81,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
*
@@ -99,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
@@ -116,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
@@ -133,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
@@ -149,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
@@ -165,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
*
@@ -179,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
*
@@ -193,13 +180,13 @@
* @param[in] p_display - pointer to Max7219 object
*
* On Exit:
-* @return none
+* @return None
**************************************************************/
void all_off(Max7219 *p_display);
/**********************************************************//**
-* @brief demo loop for MAXREFDES99
+* @brief Demo loop for MAXREFDES99
*
* @details
*
@@ -209,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
*
@@ -224,12 +211,12 @@
* @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
+* @brief Gets 16x16 character bitmap fom memory
*
* @details
*
@@ -239,13 +226,13 @@
* Buffer should be 32 bytes
* @param[in] font_type - 16x16 font type used for display
* On Exit:
-* @return none
+* @return None
**************************************************************/
-void get_16x16_character(char c, uint8_t *char_buff,uint8_t font_type);
+void get_16x16_character(char c, uint8_t *char_buff, uint8_t font_type);
/**********************************************************//**
-* @brief prints character to MAXREFDES99 16x16 LED display
+* @brief Prints character to MAXREFDES99 16x16 LED display
*
* @details
*
@@ -257,13 +244,13 @@
* @param[in] font_type - 16x16 font type used for display
*
* On Exit:
-* @return none
+* @return None
**************************************************************/
-void print_char_16x16(Max7219 *p_display, uint16_t position, char c,uint8_t font_type);
+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
+* @brief Prints given string to MAXREFDES99 16x16 LED display
*
* @details
*
@@ -273,13 +260,13 @@
* @param[in] font_type - 16x16 font type used for display
*
* On Exit:
-* @return none
+* @return None
**************************************************************/
void print_string_16x16(Max7219 *p_display, char *s, uint8_t font_type);
/**********************************************************//**
-* @brief shifts 16x16 font display right 'count' positions with given
+* @brief Shifts 16x16 font display right 'count' positions with given
* delay between shifts
*
* @details
@@ -290,13 +277,13 @@
* @param[in] delay - delay between shifts in milliseconds
*
* On Exit:
-* @return none
+* @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
+* @brief Shifts 16x16 font display left 'count' positions with given
* delay between shifts
*
* @details
@@ -307,12 +294,12 @@
* @param[in] delay - delay between shifts in milliseconds
*
* On Exit:
-* @return none
+* @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
+* @brief Demo loop for MAXREFDES99 with 16x16 font display
*
* @details
*
@@ -323,13 +310,13 @@
* @param[in] endless_loop - if true run demo in endless loop
*
* On Exit:
-* @return none
+* @return None
**************************************************************/
-void demo_16x16(Max7219 *display, max7219_configuration_t display_config,uint8_t font_type, bool endless_loop);
+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
+* @brief Shift 16x16 font display in given direction forever
*
* @details
*
@@ -338,26 +325,26 @@
* @param[in] scroll_right - if true shift right, else shift left
*
* On Exit:
-* @return none
+* @return None
**************************************************************/
void endless_scroll_display_16x16(Max7219 *display, uint32_t scroll_right);
/**********************************************************//**
-* @brief print demo menu
+* @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
*
@@ -366,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
*
@@ -380,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
*
@@ -394,7 +381,7 @@
* @param[in] msg - prompt for user
*
* On Exit:
-* @return user entry
+* @return User entry
**************************************************************/
char * get_user_string(char *msg);