Fork of EFM32 Segment LCD library - used as pull request source for bugfixes
Fork of EFM32_SegmentLCD by
EFM32_SegmentLCD.h@7:c7948fbb8729, 2017-04-01 (annotated)
- Committer:
- MarSik
- Date:
- Sat Apr 01 14:13:33 2017 +0000
- Revision:
- 7:c7948fbb8729
- Parent:
- 5:e692ded4462b
Add missing include (clocking.h); ; This include defines the LOW_ENERGY_CLOCK_FREQUENCY symbol; that is needed for computing the prescaler.;
Who changed what in which revision?
User | Revision | Line number | New 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 | #ifndef TARGET_EFM32 |
Steven Cooreman |
0:559902e88130 | 36 | #error "The Silicon Labs SegmentLCD library is specifically designed for EFM32 targets." |
Steven Cooreman |
0:559902e88130 | 37 | #else |
Steven Cooreman |
0:559902e88130 | 38 | #include "platform.h" |
Steven Cooreman |
0:559902e88130 | 39 | #include <mbed.h> |
Steven Cooreman |
0:559902e88130 | 40 | |
Steven Cooreman |
0:559902e88130 | 41 | #include "segmentlcd.h" |
stevew817 | 5:e692ded4462b | 42 | #include "sleepmodes.h" |
Steven Cooreman |
0:559902e88130 | 43 | |
Steven Cooreman |
0:559902e88130 | 44 | namespace silabs { |
Steven Cooreman |
2:ee5ef7bb4fb0 | 45 | /** A driver for the Segment LCD present on some EFM32 starter kits |
Steven Cooreman |
2:ee5ef7bb4fb0 | 46 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 47 | * Supports Giant, Leopard and Wonder Gecko STKs |
Steven Cooreman |
2:ee5ef7bb4fb0 | 48 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 49 | * @code |
Steven Cooreman |
2:ee5ef7bb4fb0 | 50 | * #include "mbed.h" |
Steven Cooreman |
2:ee5ef7bb4fb0 | 51 | * #include "EFM32_SegmentLCD.h" |
Steven Cooreman |
2:ee5ef7bb4fb0 | 52 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 53 | * EFM32_SegmentLCD segmentDisplay; |
Steven Cooreman |
2:ee5ef7bb4fb0 | 54 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 55 | * int main() { |
Steven Cooreman |
2:ee5ef7bb4fb0 | 56 | * segmentDisplay.Write("Hello"); |
Steven Cooreman |
2:ee5ef7bb4fb0 | 57 | * while(1); |
Steven Cooreman |
2:ee5ef7bb4fb0 | 58 | * } |
Steven Cooreman |
2:ee5ef7bb4fb0 | 59 | * @endcode |
Steven Cooreman |
2:ee5ef7bb4fb0 | 60 | */ |
Steven Cooreman |
2:ee5ef7bb4fb0 | 61 | |
Steven Cooreman |
0:559902e88130 | 62 | class EFM32_SegmentLCD { |
Steven Cooreman |
0:559902e88130 | 63 | public: |
Steven Cooreman |
2:ee5ef7bb4fb0 | 64 | /** |
Steven Cooreman |
0:559902e88130 | 65 | * Constructor. |
Steven Cooreman |
0:559902e88130 | 66 | */ |
Steven Cooreman |
0:559902e88130 | 67 | EFM32_SegmentLCD(); |
Steven Cooreman |
3:4e4f16874281 | 68 | |
Steven Cooreman |
3:4e4f16874281 | 69 | /** |
Steven Cooreman |
3:4e4f16874281 | 70 | * Destructor. |
Steven Cooreman |
3:4e4f16874281 | 71 | */ |
Steven Cooreman |
3:4e4f16874281 | 72 | ~EFM32_SegmentLCD(); |
Steven Cooreman |
0:559902e88130 | 73 | |
Steven Cooreman |
1:5335eb33bfcb | 74 | /** |
Steven Cooreman |
0:559902e88130 | 75 | * Switch off all elements |
Steven Cooreman |
0:559902e88130 | 76 | */ |
Steven Cooreman |
0:559902e88130 | 77 | void AllOff( void ); |
Steven Cooreman |
0:559902e88130 | 78 | |
Steven Cooreman |
1:5335eb33bfcb | 79 | /** |
Steven Cooreman |
0:559902e88130 | 80 | * Switch on all elements |
Steven Cooreman |
0:559902e88130 | 81 | */ |
Steven Cooreman |
0:559902e88130 | 82 | void AllOn( void ); |
Steven Cooreman |
0:559902e88130 | 83 | |
Steven Cooreman |
1:5335eb33bfcb | 84 | /** |
Steven Cooreman |
0:559902e88130 | 85 | * Switch off (clear) the alphanumeric portion of the display |
Steven Cooreman |
0:559902e88130 | 86 | */ |
Steven Cooreman |
0:559902e88130 | 87 | void AlphaNumberOff(void); |
Steven Cooreman |
0:559902e88130 | 88 | |
Steven Cooreman |
1:5335eb33bfcb | 89 | /** |
Steven Cooreman |
0:559902e88130 | 90 | * Switch specified segment on the ring on/off |
Steven Cooreman |
2:ee5ef7bb4fb0 | 91 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 92 | * @param anum ring segment index |
Steven Cooreman |
2:ee5ef7bb4fb0 | 93 | * @param on true to turn on, false to turn off |
Steven Cooreman |
0:559902e88130 | 94 | */ |
Steven Cooreman |
0:559902e88130 | 95 | void ARing(int anum, bool on); |
Steven Cooreman |
0:559902e88130 | 96 | |
Steven Cooreman |
1:5335eb33bfcb | 97 | /** |
Steven Cooreman |
0:559902e88130 | 98 | * Display a battery level on the LCD. |
Steven Cooreman |
0:559902e88130 | 99 | * 0 = off |
Steven Cooreman |
0:559902e88130 | 100 | * 1 = lowest block |
Steven Cooreman |
0:559902e88130 | 101 | * 2 = lowest + second-to-lowest |
Steven Cooreman |
0:559902e88130 | 102 | * ... |
Steven Cooreman |
2:ee5ef7bb4fb0 | 103 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 104 | * @param batteryLevel Level to show |
Steven Cooreman |
0:559902e88130 | 105 | */ |
Steven Cooreman |
0:559902e88130 | 106 | void Battery(int batteryLevel); |
Steven Cooreman |
0:559902e88130 | 107 | |
Steven Cooreman |
1:5335eb33bfcb | 108 | /** |
Steven Cooreman |
0:559902e88130 | 109 | * Display an energy mode ring on the LCD. |
Steven Cooreman |
2:ee5ef7bb4fb0 | 110 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 111 | * @param em energy mode number to display |
Steven Cooreman |
2:ee5ef7bb4fb0 | 112 | * @param on true to turn on, false to turn off. |
Steven Cooreman |
0:559902e88130 | 113 | */ |
Steven Cooreman |
0:559902e88130 | 114 | void EnergyMode(int em, bool on); |
Steven Cooreman |
0:559902e88130 | 115 | |
Steven Cooreman |
1:5335eb33bfcb | 116 | /** |
Steven Cooreman |
0:559902e88130 | 117 | * Display an unsigned integer on the alphanumeric |
Steven Cooreman |
0:559902e88130 | 118 | * portion of the display as a hex value. |
Steven Cooreman |
0:559902e88130 | 119 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 120 | * @param num number to display |
Steven Cooreman |
0:559902e88130 | 121 | */ |
Steven Cooreman |
0:559902e88130 | 122 | void LowerHex( uint32_t num ); |
Steven Cooreman |
0:559902e88130 | 123 | |
Steven Cooreman |
1:5335eb33bfcb | 124 | /** |
Steven Cooreman |
0:559902e88130 | 125 | * Display a signed integer as decimal number on |
Steven Cooreman |
0:559902e88130 | 126 | * the alphanumeric part of the display. |
Steven Cooreman |
2:ee5ef7bb4fb0 | 127 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 128 | * @param num number to display |
Steven Cooreman |
0:559902e88130 | 129 | */ |
Steven Cooreman |
0:559902e88130 | 130 | void LowerNumber( int num ); |
Steven Cooreman |
0:559902e88130 | 131 | |
Steven Cooreman |
1:5335eb33bfcb | 132 | /** |
Steven Cooreman |
0:559902e88130 | 133 | * Display a signed integer on the numeric part |
Steven Cooreman |
0:559902e88130 | 134 | * of the display (clock area). |
Steven Cooreman |
0:559902e88130 | 135 | * max = 9999, min = -9999 |
Steven Cooreman |
0:559902e88130 | 136 | */ |
Steven Cooreman |
0:559902e88130 | 137 | void Number(int value); |
Steven Cooreman |
0:559902e88130 | 138 | |
Steven Cooreman |
1:5335eb33bfcb | 139 | /** |
Steven Cooreman |
0:559902e88130 | 140 | * Clear the numeric part of the display. |
Steven Cooreman |
0:559902e88130 | 141 | */ |
Steven Cooreman |
0:559902e88130 | 142 | void NumberOff(void); |
Steven Cooreman |
0:559902e88130 | 143 | |
Steven Cooreman |
1:5335eb33bfcb | 144 | /** |
Steven Cooreman |
0:559902e88130 | 145 | * Turn a predefined symbol on or off. |
Steven Cooreman |
2:ee5ef7bb4fb0 | 146 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 147 | * @param lcdSymbol predefined symbol in segmentlcdconfig_*.h |
Steven Cooreman |
2:ee5ef7bb4fb0 | 148 | * @param on true to turn on, false to turn off. |
Steven Cooreman |
0:559902e88130 | 149 | */ |
Steven Cooreman |
0:559902e88130 | 150 | void Symbol(lcdSymbol s, bool on); |
Steven Cooreman |
0:559902e88130 | 151 | |
Steven Cooreman |
1:5335eb33bfcb | 152 | /** |
Steven Cooreman |
0:559902e88130 | 153 | * Display an unsigned short integer as a hex value |
Steven Cooreman |
0:559902e88130 | 154 | * on the numeric part of the display. |
Steven Cooreman |
0:559902e88130 | 155 | * max = FFFF, min = 0 |
Steven Cooreman |
2:ee5ef7bb4fb0 | 156 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 157 | * @param value Value to show |
Steven Cooreman |
0:559902e88130 | 158 | */ |
Steven Cooreman |
0:559902e88130 | 159 | void UnsignedHex(uint16_t value); |
Steven Cooreman |
0:559902e88130 | 160 | |
Steven Cooreman |
1:5335eb33bfcb | 161 | /** |
Steven Cooreman |
0:559902e88130 | 162 | * Display a 7-character string on the alphanumeric |
Steven Cooreman |
0:559902e88130 | 163 | * portion of the display. |
Steven Cooreman |
2:ee5ef7bb4fb0 | 164 | * |
Steven Cooreman |
2:ee5ef7bb4fb0 | 165 | * @param string String to show (only the first 7 characters will be shown) |
Steven Cooreman |
0:559902e88130 | 166 | */ |
Steven Cooreman |
0:559902e88130 | 167 | void Write(char *string); |
Steven Cooreman |
0:559902e88130 | 168 | protected: |
Steven Cooreman |
0:559902e88130 | 169 | |
Steven Cooreman |
0:559902e88130 | 170 | }; |
Steven Cooreman |
0:559902e88130 | 171 | } |
Steven Cooreman |
0:559902e88130 | 172 | |
Steven Cooreman |
0:559902e88130 | 173 | #endif //TARGET_EFM32 |
Steven Cooreman |
0:559902e88130 | 174 | #endif //SILABS_SEGMENTLCD_H |