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@3:4e4f16874281, 2015-03-18 (annotated)

Committer:
Steven Cooreman
Date:
Wed Mar 18 16:06:15 2015 -0500
Revision:
3:4e4f16874281
Parent:
2:ee5ef7bb4fb0
Child:
5:e692ded4462b
Add destructor to segmentLCD driver, block correct sleep mode.

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 2:ee5ef7bb4fb0 47 /** A driver for the Segment LCD present on some EFM32 starter kits
Steven Cooreman 2:ee5ef7bb4fb0 48 *
Steven Cooreman 2:ee5ef7bb4fb0 49 * Supports Giant, Leopard and Wonder Gecko STKs
Steven Cooreman 2:ee5ef7bb4fb0 50 *
Steven Cooreman 2:ee5ef7bb4fb0 51 * @code
Steven Cooreman 2:ee5ef7bb4fb0 52 * #include "mbed.h"
Steven Cooreman 2:ee5ef7bb4fb0 53 * #include "EFM32_SegmentLCD.h"
Steven Cooreman 2:ee5ef7bb4fb0 54 *
Steven Cooreman 2:ee5ef7bb4fb0 55 * EFM32_SegmentLCD segmentDisplay;
Steven Cooreman 2:ee5ef7bb4fb0 56 *
Steven Cooreman 2:ee5ef7bb4fb0 57 * int main() {
Steven Cooreman 2:ee5ef7bb4fb0 58 * segmentDisplay.Write("Hello");
Steven Cooreman 2:ee5ef7bb4fb0 59 * while(1);
Steven Cooreman 2:ee5ef7bb4fb0 60 * }
Steven Cooreman 2:ee5ef7bb4fb0 61 * @endcode
Steven Cooreman 2:ee5ef7bb4fb0 62 */
Steven Cooreman 2:ee5ef7bb4fb0 63
Steven Cooreman 0:559902e88130 64 class EFM32_SegmentLCD {
Steven Cooreman 0:559902e88130 65 public:
Steven Cooreman 2:ee5ef7bb4fb0 66 /**
Steven Cooreman 0:559902e88130 67 * Constructor.
Steven Cooreman 0:559902e88130 68 */
Steven Cooreman 0:559902e88130 69 EFM32_SegmentLCD();
Steven Cooreman 3:4e4f16874281 70
Steven Cooreman 3:4e4f16874281 71 /**
Steven Cooreman 3:4e4f16874281 72 * Destructor.
Steven Cooreman 3:4e4f16874281 73 */
Steven Cooreman 3:4e4f16874281 74 ~EFM32_SegmentLCD();
Steven Cooreman 0:559902e88130 75
Steven Cooreman 1:5335eb33bfcb 76 /**
Steven Cooreman 0:559902e88130 77 * Switch off all elements
Steven Cooreman 0:559902e88130 78 */
Steven Cooreman 0:559902e88130 79 void AllOff( void );
Steven Cooreman 0:559902e88130 80
Steven Cooreman 1:5335eb33bfcb 81 /**
Steven Cooreman 0:559902e88130 82 * Switch on all elements
Steven Cooreman 0:559902e88130 83 */
Steven Cooreman 0:559902e88130 84 void AllOn( void );
Steven Cooreman 0:559902e88130 85
Steven Cooreman 1:5335eb33bfcb 86 /**
Steven Cooreman 0:559902e88130 87 * Switch off (clear) the alphanumeric portion of the display
Steven Cooreman 0:559902e88130 88 */
Steven Cooreman 0:559902e88130 89 void AlphaNumberOff(void);
Steven Cooreman 0:559902e88130 90
Steven Cooreman 1:5335eb33bfcb 91 /**
Steven Cooreman 0:559902e88130 92 * Switch specified segment on the ring on/off
Steven Cooreman 2:ee5ef7bb4fb0 93 *
Steven Cooreman 2:ee5ef7bb4fb0 94 * @param anum ring segment index
Steven Cooreman 2:ee5ef7bb4fb0 95 * @param on true to turn on, false to turn off
Steven Cooreman 0:559902e88130 96 */
Steven Cooreman 0:559902e88130 97 void ARing(int anum, bool on);
Steven Cooreman 0:559902e88130 98
Steven Cooreman 1:5335eb33bfcb 99 /**
Steven Cooreman 0:559902e88130 100 * Display a battery level on the LCD.
Steven Cooreman 0:559902e88130 101 * 0 = off
Steven Cooreman 0:559902e88130 102 * 1 = lowest block
Steven Cooreman 0:559902e88130 103 * 2 = lowest + second-to-lowest
Steven Cooreman 0:559902e88130 104 * ...
Steven Cooreman 2:ee5ef7bb4fb0 105 *
Steven Cooreman 2:ee5ef7bb4fb0 106 * @param batteryLevel Level to show
Steven Cooreman 0:559902e88130 107 */
Steven Cooreman 0:559902e88130 108 void Battery(int batteryLevel);
Steven Cooreman 0:559902e88130 109
Steven Cooreman 1:5335eb33bfcb 110 /**
Steven Cooreman 0:559902e88130 111 * Display an energy mode ring on the LCD.
Steven Cooreman 2:ee5ef7bb4fb0 112 *
Steven Cooreman 2:ee5ef7bb4fb0 113 * @param em energy mode number to display
Steven Cooreman 2:ee5ef7bb4fb0 114 * @param on true to turn on, false to turn off.
Steven Cooreman 0:559902e88130 115 */
Steven Cooreman 0:559902e88130 116 void EnergyMode(int em, bool on);
Steven Cooreman 0:559902e88130 117
Steven Cooreman 1:5335eb33bfcb 118 /**
Steven Cooreman 0:559902e88130 119 * Display an unsigned integer on the alphanumeric
Steven Cooreman 0:559902e88130 120 * portion of the display as a hex value.
Steven Cooreman 0:559902e88130 121 *
Steven Cooreman 2:ee5ef7bb4fb0 122 * @param num number to display
Steven Cooreman 0:559902e88130 123 */
Steven Cooreman 0:559902e88130 124 void LowerHex( uint32_t num );
Steven Cooreman 0:559902e88130 125
Steven Cooreman 1:5335eb33bfcb 126 /**
Steven Cooreman 0:559902e88130 127 * Display a signed integer as decimal number on
Steven Cooreman 0:559902e88130 128 * the alphanumeric part of the display.
Steven Cooreman 2:ee5ef7bb4fb0 129 *
Steven Cooreman 2:ee5ef7bb4fb0 130 * @param num number to display
Steven Cooreman 0:559902e88130 131 */
Steven Cooreman 0:559902e88130 132 void LowerNumber( int num );
Steven Cooreman 0:559902e88130 133
Steven Cooreman 1:5335eb33bfcb 134 /**
Steven Cooreman 0:559902e88130 135 * Display a signed integer on the numeric part
Steven Cooreman 0:559902e88130 136 * of the display (clock area).
Steven Cooreman 0:559902e88130 137 * max = 9999, min = -9999
Steven Cooreman 0:559902e88130 138 */
Steven Cooreman 0:559902e88130 139 void Number(int value);
Steven Cooreman 0:559902e88130 140
Steven Cooreman 1:5335eb33bfcb 141 /**
Steven Cooreman 0:559902e88130 142 * Clear the numeric part of the display.
Steven Cooreman 0:559902e88130 143 */
Steven Cooreman 0:559902e88130 144 void NumberOff(void);
Steven Cooreman 0:559902e88130 145
Steven Cooreman 1:5335eb33bfcb 146 /**
Steven Cooreman 0:559902e88130 147 * Turn a predefined symbol on or off.
Steven Cooreman 2:ee5ef7bb4fb0 148 *
Steven Cooreman 2:ee5ef7bb4fb0 149 * @param lcdSymbol predefined symbol in segmentlcdconfig_*.h
Steven Cooreman 2:ee5ef7bb4fb0 150 * @param on true to turn on, false to turn off.
Steven Cooreman 0:559902e88130 151 */
Steven Cooreman 0:559902e88130 152 void Symbol(lcdSymbol s, bool on);
Steven Cooreman 0:559902e88130 153
Steven Cooreman 1:5335eb33bfcb 154 /**
Steven Cooreman 0:559902e88130 155 * Display an unsigned short integer as a hex value
Steven Cooreman 0:559902e88130 156 * on the numeric part of the display.
Steven Cooreman 0:559902e88130 157 * max = FFFF, min = 0
Steven Cooreman 2:ee5ef7bb4fb0 158 *
Steven Cooreman 2:ee5ef7bb4fb0 159 * @param value Value to show
Steven Cooreman 0:559902e88130 160 */
Steven Cooreman 0:559902e88130 161 void UnsignedHex(uint16_t value);
Steven Cooreman 0:559902e88130 162
Steven Cooreman 1:5335eb33bfcb 163 /**
Steven Cooreman 0:559902e88130 164 * Display a 7-character string on the alphanumeric
Steven Cooreman 0:559902e88130 165 * portion of the display.
Steven Cooreman 2:ee5ef7bb4fb0 166 *
Steven Cooreman 2:ee5ef7bb4fb0 167 * @param string String to show (only the first 7 characters will be shown)
Steven Cooreman 0:559902e88130 168 */
Steven Cooreman 0:559902e88130 169 void Write(char *string);
Steven Cooreman 0:559902e88130 170 protected:
Steven Cooreman 0:559902e88130 171
Steven Cooreman 0:559902e88130 172 };
Steven Cooreman 0:559902e88130 173 }
Steven Cooreman 0:559902e88130 174
Steven Cooreman 0:559902e88130 175 #endif //TARGET_EFM32
Steven Cooreman 0:559902e88130 176 #endif //SILABS_SEGMENTLCD_H