lorenzo cervelli / Mbed 2 deprecated DisplayTemperature_Max7219-Max6675_SD

A program to measure the temperature using the Max6675 board. The temperature is shown on 8x8 Max7219 matrix display and it is saved on SD as well.

Dependencies:   MAX7219 SDFileSystem mbed

Fork of MAXREFDES99_demo by Maxim Integrated

The program measures the temperature using the Max6675 board designed for Arduino. The temperature is shown on Max7219 8x8 matrix display (designed for Arduino as well) as text marque from right to left. The fonf size is 5x7 so the last row is used to show some info:

- All leds off: Normal temperature measuring - Leds shifting: Saving on SD card - Leds blinking: SD card missing or damaged

The Blue "user button" is used to save measured temperature on SD card. First click start saving, the second stop the process. Together the temperature is saved also the time. The time is reset when the process start. Connecting the USB to PC it's possible to see instant temperature and all saved data on SD.

Diff: maxrefdes99.h

Revision:
1:06c0a61ca171
Parent:
0:6b0161c3e440
Child:
3:41bdbc9b3cec
--- a/maxrefdes99.h	Tue Jan 12 23:44:43 2016 +0000
+++ b/maxrefdes99.h	Tue Jan 26 02:39:36 2016 +0000
@@ -51,48 +51,236 @@
 #include "max7219.h"
     
 
+/**********************************************************//**
+* @brief gets 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 in
+*                            must be at least 6 bytes
+*
+* On Exit:
+*    @return none
+**************************************************************/
 void get_5x7_character(char c, uint8_t *char_buff);
 
 
+/**********************************************************//**
+* @brief prints character to MAXREFDES99 at given position
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] position - position to print char to
+*                posiion 1 is top left column, position 32
+*                is bottom right column
+*     @param[in] c - char to print
+*
+* On Exit:
+*    @return none
+**************************************************************/
 void print_char(Max7219 *p_display, uint8_t position, char c);
 
 
+/**********************************************************//**
+* @brief prints given string to MAXREFDES99 at given position
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] position - position to print char to
+*                posiion 1 is top left column, position 32
+*                is bottom right column
+*     @param[in] s - pointer to string to print
+*
+* On Exit:
+*    @return none
+**************************************************************/
 void print_string(Max7219 *p_display, uint8_t position, const char *s);
 
 
+/**********************************************************//**
+* @brief shifts 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
+*
+* On Exit:
+*    @return none
+**************************************************************/
 void shift_display_right(Max7219 *p_display, uint8_t count, uint8_t delay);
 
 
+/**********************************************************//**
+* @brief shifts 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
+*
+* On Exit:
+*    @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
+*        top left and quad 4 being bottom right
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] quad - see brief
+*
+* On Exit:
+*    @return none
+**************************************************************/
 void quad_all_on(Max7219 *p_display, uint8_t quad);
 
 
+/**********************************************************//**
+* @brief turns off all leds for given quadrant, with quad 1 being
+*        top left and quad 4 being bottom right
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] quad - see brief
+*
+* On Exit:
+*    @return none
+**************************************************************/
 void quad_all_off(Max7219 *p_display, uint8_t quad);
 
 
+/**********************************************************//**
+* @brief turns all leds for whole display on
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*
+* On Exit:
+*    @return none
+**************************************************************/
 void all_on(Max7219 *p_display);
 
 
+/**********************************************************//**
+* @brief turns all leds for whole display off
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*
+* On Exit:
+*    @return none
+**************************************************************/
 void all_off(Max7219 *p_display);
 
 
+/**********************************************************//**
+* @brief demo loop for MAXREFDES99
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] p_display - pointer to Max7219 object
+*     @param[in] display_config - structure holding configuration data
+*     @param[in] endless_loop - if true run demo in endless loop
+*
+* On Exit:
+*    @return none
+**************************************************************/
 void demo(Max7219 *display, max7219_configuration_t display_config, bool endless_loop);
 
 
+/**********************************************************//**
+* @brief shift 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(Max7219 *display, uint32_t scroll_right);
 
 
+/**********************************************************//**
+* @brief print demo menu
+* 
+* @details 
+*
+* On Entry:
+*
+* On Exit:
+*    @return user entry
+**************************************************************/
 uint32_t print_menu(void);
 
 
+/**********************************************************//**
+* @brief get integer value from user
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] msg - prompt for user
+*     @param[in] max_val - maximum allowable input
+*
+* On Exit:
+*    @return user entry
+**************************************************************/
 uint32_t get_user_input(char *msg, uint32_t max_val);
 
 
+/**********************************************************//**
+* @brief get char from user
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] msg - prompt for user
+*
+* On Exit:
+*    @return user entry
+**************************************************************/
 char get_user_char(char *msg);
 
 
+/**********************************************************//**
+* @brief get string from user
+* 
+* @details 
+*
+* On Entry:
+*     @param[in] msg - prompt for user
+*
+* On Exit:
+*    @return user entry
+**************************************************************/
 char * get_user_string(char *msg);