Merge pull request #2 from jasonacox/master

Updates my branch

Author: hackerceo

README.md

@@ -1,14 +1,17 @@
-# TM1637 Tiny Display # 
+# TM1637 Tiny Display
+
 [![arduino-library-badge](https://www.ardu-badge.com/badge/TM1637TinyDisplay.svg?)](https://www.ardu-badge.com/TM1637TinyDisplay)
 [![Build Status](https://github.com/jasonacox/TM1637TinyDisplay/actions/workflows/sketch.yml/badge.svg)](https://github.com/jasonacox/TM1637TinyDisplay/actions/workflows/sketch.yml)
 
 Arduino Library for the TM1637 Based LED Display Module
 
 ## Description
+
 This is an Arduino library for 4 and 6 digit 7-segment LED display modules based on the TM1637 chip.
-Connect the TM1637 display CLK and DIO pins to your Arduino GPIO pins, include this library, initialize TM1637TinyDisplay and call easy to use functions like showNumber(), showString(), showLevel() and showAnimation(). Display will scroll text for larger strings. Functions support screen splitting for easy number + text formatting. Library also runs well on tiny controllers including the ATtiny85.
+Connect the TM1637 display CLK and DIO pins to your Arduino GPIO pins, include this library, initialize TM1637TinyDisplay and call easy to use functions like `showNumber()`, `showString()`, `showLevel()` and `showAnimation()`. Display will scroll text for larger strings. Functions support screen splitting for easy number + text formatting. Library also runs well on tiny controllers including the ATtiny85.
+
+## Hardware
 
-## Hardware 
 ![TM1637](examples/tm1637.png)
 
 * 4-Digit Display modules based on the TM1637 chip are available from [HiLetgo](https://www.amazon.com/gp/product/B01DKISMXK/ref=ppx_yo_dt_b_search_asin_title?ie=UTF8&psc=1), [DX](https://dx.com/p/0-36-led-4-digit-display-module-for-arduino-black-blue-works-with-official-arduino-boards-254978) and [SeeedStudio](https://www.digikey.com/products/en?keywords=tm1637).
@@ -17,62 +20,43 @@ Connect the TM1637 display CLK and DIO pins to your Arduino GPIO pins, include t
 ![TM1637](examples/tm1637back.png)
 
 The display has four connectors:
-* CLK - Clock - attach to any GPIO output 
-* DIO - Data  - attach to any GPIO output 
+
+* CLK - Clock - attach to any GPIO output
+* DIO - Data  - attach to any GPIO output
 * VCC - Power 5v
 * GND - Ground
 
-Power Note: Steady clean power is important for circuit stability. If you are seeing display artifacts during high frequency updates or animation sequences, you may be experiencing power fluctuations that are impacting signal timing and communication with the TM1637. This is especially true with standalone microprocessor applications that lack any power conditioning (e.g. ATtiny85). A polarized 100uF electrolytic capacitor inserted across VCC and GND can help smooth out the spikes.
+**Power Note:** Steady clean power is important for circuit stability. If you are seeing display artifacts during high frequency updates or animation sequences, you may be experiencing power fluctuations that are impacting signal timing and communication with the TM1637. This is especially true with standalone microprocessor applications that lack any power conditioning (e.g. ATtiny85). A polarized 100uF electrolytic capacitor inserted across VCC and GND can help smooth out the spikes.
 
-Decimals and Colons: Some TM1637 displays come equipped with a middle colon LED (as shown above) as used in digital clocks but with no decimal points. Some displays come with decimal point LEDS for each digit. Some come with both but often the decimal point LEDs are not connected. These extra LEDs are activated by setting the upper bit (0x80) for the digit next to the dot. This library will handle setting that for you via the showNumber() function when you specify floating point numbers or via the showNumberDec() function where you can set the decimal point manually.
+**Decimals and Colons:** Some TM1637 displays come equipped with a middle colon LED (like above) as used in digital clocks but with no decimal points. Some displays come with decimal point LEDS for each digit. Some come with both but often the decimal point LEDs are not connected. These extra LEDs are activated by setting the upper eighth bit (0x80) for the digit to the left of the dot. This library will handle setting that for you via the `showNumber()` function when you specify floating point numbers, or you can do it manually via the `showNumberDec()` function where you can set the decimal points/colon yourself.
 
 ## Installation
-This library is available via the Arduino IDE.  Install this library via `Tools`, `Manage Libraries`, search for "TM1637TinyDisplay" and click `Install`.
-
-Alternatively, you can install this manually by cloning this repo into your Arduino library folder (e.g. `~/Documents/Arduino/libraries`).  
 
-## Usage
-The library provides a single class named TM1637TinyDisplay with the following functions:
-
-* `showNumber` - Display an integer and floating point numbers (positive or negative)
-* `showNumberDec` - Display a number with ability to manually set decimal points or colon
-* `showNumberHex` - Display a number in hexadecimal format and set decimal point or colon
-* `showString` - Display a ASCII string of text with optional scrolling for long strings
-* `showLevel` - Use display LEDs to simulate a level indicator (vertical or horizontal)  
-* `showAnimation` - Display a sequence of frames to render an animation
-* `startAnimation` - Begins a non-blocking animation of a sequence of frames
-* `startStringScroll` - Begins a non-blocking scrolling of a string message
-* `Animate` - Worker routine to be called regularly which handles animations and scrolling in a non-blocking manner
-* `setSegments` - Directly set the value of the LED segments in each digit
-* `setBrightness` - Sets the brightness of the display
-* `setScrolldelay` - Sets the speed for text scrolling
-* `flipDisplay` - Sets/flips the orientation of the display
-* `isflipDisplay` - Returns orientation of the display (True = flip)
-* `readBuffer` - Returns current display segment values
-
-PROGMEM functions: Large string or animation data can be left in Flash instead of being loaded in to SRAM to save memory. 
+This library is available via the Arduino IDE.  Install this library via `Tools`, `Manage Libraries`, search for "TM1637TinyDisplay" and click `Install`.
 
-* `showAnimation_P` - Display a sequence of frames to render an animation (in PROGMEM)
-* `showString_P` - Display a ASCII string of text with optional scrolling for long strings (in PROGMEM)
-* `startAnimation_P` - Begins a non-blocking animation of a sequence of frames stored in PROGMEM
-* `startStringScroll_P` - Begins a non-blocking scrolling of a string message stored in PROGMEM
+Alternatively, you can install this manually by cloning this repo into your Arduino library folder (e.g. `~/Documents/Arduino/libraries`).
 
+## Example Code
 
+<p align="center">
+  <a href="examples/4-digit-display-basic.fzz"><img src="examples/4-digit-display-basic_bb.svg" width="40%" /></a><br />
+  Basic connection schematic done with <a href="https://fritzing.org">Fritzing</a>
+</p>
 
-## Example Code
 ```cpp
 #include <Arduino.h>
 #include <TM1637TinyDisplay.h>
 
 // Define Digital Pins
-#define CLK 1
-#define DIO 2
+#define CLK 2
+#define DIO 3
 
-// Initialize TM1637TinyDisplay
+// Instantiate TM1637TinyDisplay Class
 TM1637TinyDisplay display(CLK, DIO);
 
 void setup() {
-  display.setBrightness(0x0f);
+  // Initialize Display
+  display.begin();
 }
 
 void loop() {
@@ -111,12 +95,11 @@ void loop() {
 }
 ```
 
-Refer to [TM1637TinyDisplay.h](TM1637TinyDisplay.h) for information on available functions. See also [Examples](examples) for more demonstration.
-
 ## Animation and Animator Tool
-The showAnimation() function projects a sequence of frames (patterns) onto the display.  This works by defining the animation sequence through a multi-dimensional array of patterns.  
 
-You can use the included javascript based interactive [7-Segment LED Animator Tool](https://jasonacox.github.io/TM1637TinyDisplay/examples/7-segment-animator.html) to help build your animation. The source code is in the [Examples](examples) folder.  This tool will let you set up the LED sequences you want, save each frame and copy the final code (a static array) directly into your sketch to use for the `showAnimation(data, frames, timing)` function.  Here is an example:
+The `showAnimation()` function projects a sequence of frames (patterns) onto the display.  This works by defining the animation sequence through a multi-dimensional array of patterns.
+
+You can use the included javascript based interactive [7-Segment LED Animator Tool](https://jasonacox.github.io/TM1637TinyDisplay/examples/7-segment-animator.html) to help build your animation. The source code is in the [Examples](examples) folder. This tool will let you set up the LED sequences you want, save each frame and copy the final code (a static array) directly into your sketch to use for the `showAnimation(data, frames, timing)` function. Here is an example:
 
 ```cpp
 // Data from Animator Tool
@@ -147,7 +130,7 @@ const uint8_t ANIMATION[12][4] = {
 
 ![TM1637-6-Back](examples/tm1637-6-back.png)
 
-This library now supports the 6-digit display as well as the 4-digit display.  The 6-digit display requires additional handling.  Specifically, the display digits are not sequential (requires a map) and the 7-segment LED data must be uploaded in reverse order.  
+This library now supports the 6-digit display as well as the 4-digit display.  The 6-digit display requires additional handling.  Specifically, the display digits are not sequential (requires a map) and the 7-segment LED data must be uploaded in reverse order.
 
 TM1637TinyDisplay6 handles this for you but you must initialize the display using the TM1637TinyDisplay6 class:
 
@@ -157,15 +140,14 @@ TM1637TinyDisplay6 handles this for you but you must initialize the display usin
 #include <TM1637TinyDisplay6.h>       // Include 6-Digit Display Class Header
 
 // Define Digital Pins
-#define CLK 1
-#define DIO 2
+#define CLK 2
+#define DIO 3
 
 TM1637TinyDisplay6 display(CLK, DIO); // 6-Digit Display Class
 
 void setup()
 {
-  display.setBrightness(BRIGHT_HIGH);
-  display.clear();
+  display.begin();
   display.showString("digits");
   delay(1000);
   display.showNumber(123456);
@@ -175,13 +157,46 @@ void setup()
 }
 ```
 
+## Functions
+
+The library provides a single class named TM1637TinyDisplay with the following functions:
+
+* `begin()` - Initialize display memory and hardware (call in `setup()`)
+* `clear()` - Display an integer and floating point numbers (positive or negative)
+* `showNumber(..)` - Display a number
+* `showNumberDec(..)` - Display a number with ability to manually set decimal points or colon
+* `showNumberHex(..)` - Display a number in hexadecimal format and set decimal point or colon
+* `showString(..)` - Display a ASCII string of text with optional scrolling for long strings
+* `startStringScroll(..)` - Begins a non-blocking scrolling of a string message
+* `showLevel(..)` - Use display LEDs to simulate a level indicator (vertical or horizontal)  
+* `showAnimation(..)` - Display a sequence of frames to render an animation
+* `startAnimation(..)` - Begins a non-blocking animation of a sequence of frames
+* `Animate()` - Worker routine to be called regularly which handles animations and scrolling in a non-blocking manner
+* `setSegments(..)` - Directly set the value of the LED segments in each digit
+* `setBrightness(..)` - Sets the brightness of the display
+* `setScrolldelay(..)` - Sets the speed for text scrolling
+* `flipDisplay(..)` - Sets/flips the orientation of the display
+* `isflipDisplay()` - Returns orientation of the display (True = flip)
+* `readBuffer(..)` - Returns current display segment values
+
+PROGMEM functions: Large string or animation data can be left in Flash instead of being loaded in to SRAM to save memory.
+
+* `showAnimation_P(..)` - Display a sequence of frames to render an animation (in PROGMEM)
+* `showString_P(..)` - Display a ASCII string of text with optional scrolling for long strings (in PROGMEM)
+* `startAnimation_P(..)` - Begins a non-blocking animation of a sequence of frames stored in PROGMEM
+* `startStringScroll_P(..)` - Begins a non-blocking scrolling of a string message stored in PROGMEM
+
+Refer to [TM1637TinyDisplay.h](TM1637TinyDisplay.h) for information on available functions. See also [Examples](examples) for more demonstration.
+
 ## Arduino Library
+
 * Library: https://www.arduinolibraries.info/libraries/tm1637-tiny-display
 * Scan Logs: http://downloads.arduino.cc/libraries/logs/github.com/jasonacox/TM1637TinyDisplay/
 
 ## References and Credit
+
 * This library is based on the great work by Avishay Orpaz - https://github.com/avishorp/TM1637
 * SevenSegmentTM1637 Arduino Library by Bram Harmsen - https://github.com/bremme/arduino-tm1637 
 * Arduino - https://playground.arduino.cc/Main/TM1637/
 * MCI Electronics Datasheet for TM1637 - https://www.mcielectronics.cl/website_MCI/static/documents/Datasheet_TM1637.pdf
-* TM16xx - Library for entire TM16xx chip family include maxint-rd's own [display-modules](https://github.com/maxint-rd/arduino-modules#display-modules) - https://github.com/maxint-rd/TM16xx
+* TM16xx - Library for entire TM16xx chip family include maxint-rd's own [display-modules](https://github.com/maxint-rd/arduino-modules#display-modules) - https://github.com/maxint-rd/TM16xx

RELEASE.md

@@ -1,5 +1,18 @@
 # Release Notes for TM1637TinyDisplay
 
+## v1.8.1 - Add Default Brightness
+
+* Updated the `begin()` method to set a non zero default brightness for the display, as reported in https://github.com/jasonacox/TM1637TinyDisplay/pull/29#issuecomment-1446362105 and submitted by @mgesteiro in https://github.com/jasonacox/TM1637TinyDisplay/pull/30
+
+## v1.8.0 - Updated Library Operation with New begin() Method
+
+* Updated library operation to include an initializing method `begin()` to move outside the constructor hardware related calls, as reported in https://github.com/jasonacox/TM1637TinyDisplay/issues/28
+
+## v1.7.1 - Fix Compile Errors for ESP8266
+
+* Fix compile errors and warnings on ESP8266 cores (type casts and erroneous defaults in functions) as reported in https://github.com/jasonacox/TM1637TinyDisplay/issues/26
+* Fix function names for async animation/scroll in keywords.txt by @hackerceo in https://github.com/jasonacox/TM1637TinyDisplay/pull/25
+
 ## v1.7.0 - Add Non-Blocking Animation for 4-Digit
 
 * Add non-blocking animation and string scrolling to 4-digit display by @hackerceo in https://github.com/jasonacox/TM1637TinyDisplay/pull/24

TM1637TinyDisplay.cpp

@@ -172,14 +172,18 @@ TM1637TinyDisplay::TM1637TinyDisplay(uint8_t pinClk, uint8_t pinDIO, unsigned in
   m_scrollDelay = scrollDelay;
   // Flip 
   m_flipDisplay = flip;
-  
+}
+
+void TM1637TinyDisplay::begin()
+{
   // Set the pin direction and default value.
   // Both pins are set as inputs, allowing the pull-up resistors to pull them up
   pinMode(m_pinClk, INPUT);
   pinMode(m_pinDIO, INPUT);
   digitalWrite(m_pinClk, LOW);
   digitalWrite(m_pinDIO, LOW);
   clear();
+  setBrightness(BRIGHT_HIGH);
 }
 
 void TM1637TinyDisplay::flipDisplay(bool flip)
@@ -638,17 +642,17 @@ void TM1637TinyDisplay::startAnimation(const uint8_t (*data)[MAXDIGITS], unsigne
     m_animation_start = millis() ;
     m_animation_frames = frames;
     m_animation_frame_ms = ms;
-    m_animation_sequence = data;
+    m_animation_sequence = (uint8_t (*)[MAXDIGITS]) data;
     m_animation_string = nullptr;
 }
 
 
-void TM1637TinyDisplay::startStringScroll_P(const char s[], unsigned int ms) 
+void TM1637TinyDisplay::startStringScroll_P(const char s[], unsigned int ms)
 {
     startStringScroll(s, ms, true);
 }
 
-void TM1637TinyDisplay::startStringScroll(const char (*s), unsigned int ms, bool usePROGMEM = false) {
+void TM1637TinyDisplay::startStringScroll(const char s[], unsigned int ms, bool usePROGMEM) {
     if (usePROGMEM) {
         m_animation_frames = strlen_P(s);
         if (m_animation_frames <= MAXDIGITS) {
@@ -674,7 +678,7 @@ void TM1637TinyDisplay::startStringScroll(const char (*s), unsigned int ms, bool
     m_animation_start = millis();
     m_animation_frame_ms = ms;
     m_animation_sequence = nullptr;
-    m_animation_string = s;
+    m_animation_string = (uint8_t *) s;
 }
 
 

TM1637TinyDisplay.h

@@ -117,8 +117,7 @@
 class TM1637TinyDisplay {
 
 public:
-  //! Initialize a TM1637TinyDisplay object, setting the clock and
-  //! data pins.
+  //! Initialize a TM1637TinyDisplay object.
   //!
   //! @param pinClk - The number of the digital pin connected to the clock pin of the module
   //! @param pinDIO - The number of the digital pin connected to the DIO pin of the module
@@ -128,6 +127,12 @@ class TM1637TinyDisplay {
   TM1637TinyDisplay(uint8_t pinClk, uint8_t pinDIO, unsigned int bitDelay = DEFAULT_BIT_DELAY, 
     unsigned int scrollDelay = DEFAULT_SCROLL_DELAY, bool flip=DEFAULT_FLIP);
 
+  //! Initialize the display, setting the clock and data pins.
+  //!
+  //! This method should be called once (typically in setup()) before calling any other.
+  //! @note It may be unnecessary depending on your hardware configuration.
+  void begin();
+
   //! Sets the orientation of the display.
   //!
   //! Setting this parameter to true will cause the rendering on digits to be displayed
@@ -475,7 +480,7 @@ class TM1637TinyDisplay {
   unsigned int m_animation_frames;
   unsigned int m_animation_last_frame;
   unsigned int m_animation_frame_ms;
-  uint8_t (*m_animation_sequence)[4];
+  uint8_t (*m_animation_sequence)[MAXDIGITS];
   uint8_t (*m_animation_string);
   uint8_t m_animation_type;
 };

TM1637TinyDisplay6.cpp

@@ -174,14 +174,18 @@ TM1637TinyDisplay6::TM1637TinyDisplay6(uint8_t pinClk, uint8_t pinDIO,
   m_scrollDelay = scrollDelay;
   // Flip 
   m_flipDisplay = flip;
-  
+}
+
+void TM1637TinyDisplay6::begin()
+{
   // Set the pin direction and default value.
   // Both pins are set as inputs, allowing the pull-up resistors to pull them up
   pinMode(m_pinClk, INPUT);
   pinMode(m_pinDIO, INPUT);
   digitalWrite(m_pinClk, LOW);
   digitalWrite(m_pinDIO, LOW);
   clear();
+  setBrightness(BRIGHT_HIGH);
 }
 
 void TM1637TinyDisplay6::flipDisplay(bool flip)

TM1637TinyDisplay6.h

@@ -117,8 +117,7 @@
 class TM1637TinyDisplay6 {
 
 public:
-  //! Initialize a TM1637TinyDisplay object, setting the clock and
-  //! data pins.
+  //! Initialize a TM1637TinyDisplay object.
   //!
   //! @param pinClk - The number of the digital pin connected to the clock pin of the module
   //! @param pinDIO - The number of the digital pin connected to the DIO pin of the module
@@ -128,6 +127,12 @@ class TM1637TinyDisplay6 {
   TM1637TinyDisplay6(uint8_t pinClk, uint8_t pinDIO, unsigned int bitDelay = DEFAULT_BIT_DELAY, 
     unsigned int scrollDelay = DEFAULT_SCROLL_DELAY, bool flip=DEFAULT_FLIP);
 
+  //! Initialize the display, setting the clock and data pins.
+  //!
+  //! This method should be called once (typically in setup()) before calling any other.
+  //! @note It may be unnecessary depending on your hardware configuration.
+  void begin();
+
   //! Sets the orientation of the display.
   //!
   //! Setting this parameter to true will cause the rendering on digits to be displayed