Martin Sivak / EFM32_SegmentLCD

Fork of EFM32 Segment LCD library - used as pull request source for bugfixes

Fork of EFM32_SegmentLCD by Silicon Labs

EFM32_SegmentLCD.h@0:559902e88130, 2015-03-17 (annotated)

Committer:
Steven Cooreman
Date:
Tue Mar 17 11:45:46 2015 -0500
Revision:
0:559902e88130
Child:
1:5335eb33bfcb
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Steven Cooreman 0:559902e88130 1 /***************************************************************************//**
Steven Cooreman 0:559902e88130 2 * @file EFM32_SegmentLCD.h
Steven Cooreman 0:559902e88130 3 * @brief Driver class for the segment LCD's on some of the EFM32 kits.
Steven Cooreman 0:559902e88130 4 *******************************************************************************
Steven Cooreman 0:559902e88130 5 * @section License
Steven Cooreman 0:559902e88130 6 * <b>(C) Copyright 2015 Silicon Labs, http://www.silabs.com</b>
Steven Cooreman 0:559902e88130 7 *******************************************************************************
Steven Cooreman 0:559902e88130 8 *
Steven Cooreman 0:559902e88130 9 * Permission is granted to anyone to use this software for any purpose,
Steven Cooreman 0:559902e88130 10 * including commercial applications, and to alter it and redistribute it
Steven Cooreman 0:559902e88130 11 * freely, subject to the following restrictions:
Steven Cooreman 0:559902e88130 12 *
Steven Cooreman 0:559902e88130 13 * 1. The origin of this software must not be misrepresented; you must not
Steven Cooreman 0:559902e88130 14 * claim that you wrote the original software.
Steven Cooreman 0:559902e88130 15 * 2. Altered source versions must be plainly marked as such, and must not be
Steven Cooreman 0:559902e88130 16 * misrepresented as being the original software.
Steven Cooreman 0:559902e88130 17 * 3. This notice may not be removed or altered from any source distribution.
Steven Cooreman 0:559902e88130 18 *
Steven Cooreman 0:559902e88130 19 * DISCLAIMER OF WARRANTY/LIMITATION OF REMEDIES: Silicon Labs has no
Steven Cooreman 0:559902e88130 20 * obligation to support this Software. Silicon Labs is providing the
Steven Cooreman 0:559902e88130 21 * Software "AS IS", with no express or implied warranties of any kind,
Steven Cooreman 0:559902e88130 22 * including, but not limited to, any implied warranties of merchantability
Steven Cooreman 0:559902e88130 23 * or fitness for any particular purpose or warranties against infringement
Steven Cooreman 0:559902e88130 24 * of any proprietary rights of a third party.
Steven Cooreman 0:559902e88130 25 *
Steven Cooreman 0:559902e88130 26 * Silicon Labs will not be liable for any consequential, incidental, or
Steven Cooreman 0:559902e88130 27 * special damages, or any other relief, or for any claim by any third party,
Steven Cooreman 0:559902e88130 28 * arising from your use of this Software.
Steven Cooreman 0:559902e88130 29 *
Steven Cooreman 0:559902e88130 30 ******************************************************************************/
Steven Cooreman 0:559902e88130 31
Steven Cooreman 0:559902e88130 32 #ifndef SILABS_SEGMENTLCD_H
Steven Cooreman 0:559902e88130 33 #define SILABS_SEGMENTLCD_H
Steven Cooreman 0:559902e88130 34
Steven Cooreman 0:559902e88130 35 #define TARGET_EFM32
Steven Cooreman 0:559902e88130 36 #define TARGET_EFM32GG_STK3700
Steven Cooreman 0:559902e88130 37
Steven Cooreman 0:559902e88130 38 #ifndef TARGET_EFM32
Steven Cooreman 0:559902e88130 39 #error "The Silicon Labs SegmentLCD library is specifically designed for EFM32 targets."
Steven Cooreman 0:559902e88130 40 #else
Steven Cooreman 0:559902e88130 41 #include "platform.h"
Steven Cooreman 0:559902e88130 42 #include <mbed.h>
Steven Cooreman 0:559902e88130 43
Steven Cooreman 0:559902e88130 44 #include "segmentlcd.h"
Steven Cooreman 0:559902e88130 45
Steven Cooreman 0:559902e88130 46 namespace silabs {
Steven Cooreman 0:559902e88130 47 class EFM32_SegmentLCD {
Steven Cooreman 0:559902e88130 48 public:
Steven Cooreman 0:559902e88130 49 /*
Steven Cooreman 0:559902e88130 50 * Constructor.
Steven Cooreman 0:559902e88130 51 */
Steven Cooreman 0:559902e88130 52 EFM32_SegmentLCD();
Steven Cooreman 0:559902e88130 53
Steven Cooreman 0:559902e88130 54 /*
Steven Cooreman 0:559902e88130 55 * Switch off all elements
Steven Cooreman 0:559902e88130 56 */
Steven Cooreman 0:559902e88130 57 void AllOff( void );
Steven Cooreman 0:559902e88130 58
Steven Cooreman 0:559902e88130 59 /*
Steven Cooreman 0:559902e88130 60 * Switch on all elements
Steven Cooreman 0:559902e88130 61 */
Steven Cooreman 0:559902e88130 62 void AllOn( void );
Steven Cooreman 0:559902e88130 63
Steven Cooreman 0:559902e88130 64 /*
Steven Cooreman 0:559902e88130 65 * Switch off (clear) the alphanumeric portion of the display
Steven Cooreman 0:559902e88130 66 */
Steven Cooreman 0:559902e88130 67 void AlphaNumberOff(void);
Steven Cooreman 0:559902e88130 68
Steven Cooreman 0:559902e88130 69 /*
Steven Cooreman 0:559902e88130 70 * Switch specified segment on the ring on/off
Steven Cooreman 0:559902e88130 71 * anum: ring segment index
Steven Cooreman 0:559902e88130 72 * on: true to turn on, false to turn off
Steven Cooreman 0:559902e88130 73 */
Steven Cooreman 0:559902e88130 74 void ARing(int anum, bool on);
Steven Cooreman 0:559902e88130 75
Steven Cooreman 0:559902e88130 76 /*
Steven Cooreman 0:559902e88130 77 * Display a battery level on the LCD.
Steven Cooreman 0:559902e88130 78 * 0 = off
Steven Cooreman 0:559902e88130 79 * 1 = lowest block
Steven Cooreman 0:559902e88130 80 * 2 = lowest + second-to-lowest
Steven Cooreman 0:559902e88130 81 * ...
Steven Cooreman 0:559902e88130 82 */
Steven Cooreman 0:559902e88130 83 void Battery(int batteryLevel);
Steven Cooreman 0:559902e88130 84
Steven Cooreman 0:559902e88130 85 /*
Steven Cooreman 0:559902e88130 86 * Display an energy mode ring on the LCD.
Steven Cooreman 0:559902e88130 87 * em = energy mode number to display
Steven Cooreman 0:559902e88130 88 * on = true to turn on, false to turn off.
Steven Cooreman 0:559902e88130 89 */
Steven Cooreman 0:559902e88130 90 void EnergyMode(int em, bool on);
Steven Cooreman 0:559902e88130 91
Steven Cooreman 0:559902e88130 92 /*
Steven Cooreman 0:559902e88130 93 * Display an unsigned integer on the alphanumeric
Steven Cooreman 0:559902e88130 94 * portion of the display as a hex value.
Steven Cooreman 0:559902e88130 95 *
Steven Cooreman 0:559902e88130 96 * num = number to display
Steven Cooreman 0:559902e88130 97 */
Steven Cooreman 0:559902e88130 98 void LowerHex( uint32_t num );
Steven Cooreman 0:559902e88130 99
Steven Cooreman 0:559902e88130 100 /*
Steven Cooreman 0:559902e88130 101 * Display a signed integer as decimal number on
Steven Cooreman 0:559902e88130 102 * the alphanumeric part of the display.
Steven Cooreman 0:559902e88130 103 */
Steven Cooreman 0:559902e88130 104 void LowerNumber( int num );
Steven Cooreman 0:559902e88130 105
Steven Cooreman 0:559902e88130 106 /*
Steven Cooreman 0:559902e88130 107 * Display a signed integer on the numeric part
Steven Cooreman 0:559902e88130 108 * of the display (clock area).
Steven Cooreman 0:559902e88130 109 * max = 9999, min = -9999
Steven Cooreman 0:559902e88130 110 */
Steven Cooreman 0:559902e88130 111 void Number(int value);
Steven Cooreman 0:559902e88130 112
Steven Cooreman 0:559902e88130 113 /*
Steven Cooreman 0:559902e88130 114 * Clear the numeric part of the display.
Steven Cooreman 0:559902e88130 115 */
Steven Cooreman 0:559902e88130 116 void NumberOff(void);
Steven Cooreman 0:559902e88130 117
Steven Cooreman 0:559902e88130 118 /*
Steven Cooreman 0:559902e88130 119 * Turn a predefined symbol on or off.
Steven Cooreman 0:559902e88130 120 * lcdSymbol = predefined symbol in segmentlcdconfig_*.h
Steven Cooreman 0:559902e88130 121 * on = true to turn on, false to turn off.
Steven Cooreman 0:559902e88130 122 */
Steven Cooreman 0:559902e88130 123 void Symbol(lcdSymbol s, bool on);
Steven Cooreman 0:559902e88130 124
Steven Cooreman 0:559902e88130 125 /*
Steven Cooreman 0:559902e88130 126 * Display an unsigned short integer as a hex value
Steven Cooreman 0:559902e88130 127 * on the numeric part of the display.
Steven Cooreman 0:559902e88130 128 * max = FFFF, min = 0
Steven Cooreman 0:559902e88130 129 */
Steven Cooreman 0:559902e88130 130 void UnsignedHex(uint16_t value);
Steven Cooreman 0:559902e88130 131
Steven Cooreman 0:559902e88130 132 /*
Steven Cooreman 0:559902e88130 133 * Display a 7-character string on the alphanumeric
Steven Cooreman 0:559902e88130 134 * portion of the display.
Steven Cooreman 0:559902e88130 135 */
Steven Cooreman 0:559902e88130 136 void Write(char *string);
Steven Cooreman 0:559902e88130 137 protected:
Steven Cooreman 0:559902e88130 138
Steven Cooreman 0:559902e88130 139 };
Steven Cooreman 0:559902e88130 140 }
Steven Cooreman 0:559902e88130 141
Steven Cooreman 0:559902e88130 142 #endif //TARGET_EFM32
Steven Cooreman 0:559902e88130 143 #endif //SILABS_SEGMENTLCD_H