First version

Author: cristiancristea00

README.md

@@ -1 +1,27 @@
-# Pico-TM1637
+# Raspberry Pi Pico - TM1637 7-Segment Displays Library
+
+This repository contains a Raspberry Pi Pico library using its SDK writen for the 7-Degment Displays that are equiped with an TM1637 module. It also contains one example. Below are the instructions on how to build it.
+
+## Example
+
+After you clone the repo you run the following commands to build it. You have to have installed *CMake* and *Make*. Also you need to have the SDK on your system and point `PICO_SDK_PATH` to it.
+```sh
+export PICO_SDK_PATH='/Path/to/SDK'
+```
+```sh
+cd Pico-TM1637/example
+```
+```sh
+mkdir build
+```
+```sh
+cd build
+```
+```sh
+cmake ..
+```
+```sh
+make -j4
+```
+### How to connect the LCD to the board
+![Fritzing drawing](img/fritzing.png)

TM1637.cpp

@@ -131,13 +131,7 @@ auto TM1637::Two_Digits_To_Segment(data number, bool hex, bool leading_zeros) no
     return segments;
 }
 
-void TM1637::SetBrightness(byte brightness_level) noexcept
-{
-    brightness = std::min(brightness_level, MAX_BRIGHTNESS);
-    Send_4_Bytes(current_segments);
-}
-
-void TM1637::Display(int16_t number, bool hex, bool leading_zeros) noexcept
+void TM1637::Internal_Display(int16_t number, bool hex, bool leading_zeros) noexcept
 {
     static constexpr byte DASH = 0x40;
 
@@ -208,7 +202,7 @@ void TM1637::Display(int16_t number, bool hex, bool leading_zeros) noexcept
     Send_4_Bytes(current_segments);
 }
 
-void TM1637::DisplayLeft(data number, bool hex, bool leading_zeros) noexcept
+void TM1637::Internal_Display_Left(data number, bool hex, bool leading_zeros) noexcept
 {
     static constexpr size_t LEFT_BYTE_MASK = 0xFFFF0000;
 
@@ -220,7 +214,7 @@ void TM1637::DisplayLeft(data number, bool hex, bool leading_zeros) noexcept
     Send_4_Bytes(current_segments);
 }
 
-void TM1637::DisplayRight(data number, bool hex, bool leading_zeros) noexcept
+void TM1637::Internal_Display_Right(data number, bool hex, bool leading_zeros) noexcept
 {
     static constexpr size_t RIGHT_BYTE_MASK = 0x0000FFFF;
 
@@ -233,6 +227,42 @@ void TM1637::DisplayRight(data number, bool hex, bool leading_zeros) noexcept
     Send_4_Bytes(current_segments);
 }
 
+void TM1637::Display(int16_t number, bool leading_zeros) noexcept
+{
+    Internal_Display(number, false, leading_zeros);
+}
+
+void TM1637::DisplayHex(int16_t number, bool leading_zeros) noexcept
+{
+    Internal_Display(number, true, leading_zeros);
+}
+
+void TM1637::DisplayLeft(data number, bool leading_zeros) noexcept
+{
+    Internal_Display_Left(number, false, leading_zeros);
+}
+
+void TM1637::DisplayLeftHex(data number, bool leading_zeros) noexcept
+{
+    Internal_Display_Left(number, true, leading_zeros);
+}
+
+void TM1637::DisplayRight(data number, bool leading_zeros) noexcept
+{
+    Internal_Display_Right(number, false, leading_zeros);
+}
+
+void TM1637::DisplayRightHex(data number, bool leading_zeros) noexcept
+{
+    Internal_Display_Right(number, true, leading_zeros);
+}
+
+void TM1637::SetBrightness(byte brightness_level) noexcept
+{
+    brightness = std::min(brightness_level, MAX_BRIGHTNESS);
+    Send_4_Bytes(current_segments);
+}
+
 void TM1637::ColonOn() noexcept
 {
     static constexpr size_t CONTROL_DISPLAY = 0x8000;

TM1637.hpp

@@ -91,6 +91,33 @@ class TM1637
      */
     static auto Two_Digits_To_Segment(data number, bool hex = false, bool leading_zeros = false) noexcept -> data;
 
+    /**
+     * Internal function to display a number on all four digits.
+     *
+     * @param number The number to be displayed
+     * @param hex The hex display option
+     * @param leading_zeros Optional leading zeros
+     */
+    void Internal_Display(int16_t number, bool hex = false, bool leading_zeros = false) noexcept;
+
+    /**
+     * Internal function to display a number on the most significant two digits.
+     *
+     * @param number The number to be displayed
+     * @param hex The hex display option
+     * @param leading_zeros Optional leading zeros
+     */
+    void Internal_Display_Left(data number, bool hex = false, bool leading_zeros = false) noexcept;
+
+    /**
+     * Internal function to display a number on the least significant two digits.
+     *
+     * @param number The number to be displayed
+     * @param hex The hex display option
+     * @param leading_zeros Optional leading zeros
+     */
+    void Internal_Display_Right(data number, bool hex = false, bool leading_zeros = false) noexcept;
+
  public:
 
     /**
@@ -103,39 +130,60 @@ class TM1637
     TM1637(byte DIO, byte CLK, PIO pio) noexcept;
 
     /**
-     * Sets the brightness brightness_level. The minimum brightness_level is 0
-     * and the maximum is 7.
+     * Display a number on all four digits.
      *
-     * @param brightness_level The desired brightness brightness_level
+     * @param number
+     * @param leading_zeros
      */
-    void SetBrightness(byte brightness_level) noexcept;
+    void Display(int16_t number, bool leading_zeros = false) noexcept;
 
     /**
-     * Display a number on all four digits.
+     * Display a number on all four digits in hex format.
      *
-     * @param number The number to be displayed
-     * @param hex The hex display option
-     * @param leading_zeros Optional leading zeros
+     * @param number
+     * @param leading_zeros
      */
-    void Display(int16_t number, bool hex = false, bool leading_zeros = false) noexcept;
+    void DisplayHex(int16_t number, bool leading_zeros = false) noexcept;
 
     /**
      * Display a number on the most significant two digits.
      *
-     * @param number The number to be displayed
-     * @param hex The hex display option
-     * @param leading_zeros Optional leading zeros
+     * @param number
+     * @param leading_zeros
      */
-    void DisplayLeft(data number, bool hex = false, bool leading_zeros = false) noexcept;
+    void DisplayLeft(data number, bool leading_zeros = false) noexcept;
+
+    /**
+     * Display a number on the most significant two digits in hex format.
+     *
+     * @param number
+     * @param leading_zeros
+     */
+    void DisplayLeftHex(data number, bool leading_zeros = false) noexcept;
 
     /**
      * Display a number on the least significant two digits.
      *
-     * @param number The number to be displayed
-     * @param hex The hex display option
-     * @param leading_zeros Optional leading zeros
+     * @param number
+     * @param leading_zeros
      */
-    void DisplayRight(data number, bool hex = false, bool leading_zeros = false) noexcept;
+    void DisplayRight(data number, bool leading_zeros = false) noexcept;
+
+    /**
+     * Display a number on the least significant two digits in hex format.
+     *
+     * @param number
+     * @param leading_zeros
+     */
+    void DisplayRightHex(data number, bool leading_zeros = false) noexcept;
+
+    /**
+     * Sets the brightness brightness_level. The minimum brightness_level is 0
+     * and the maximum is 7.
+     *
+     * @param brightness_level The desired brightness brightness_level
+     */
+    void SetBrightness(byte brightness_level) noexcept;
 
     /**
      * Turns on the middle colon.

example/main.cpp

@@ -1,7 +1,7 @@
 #include <pico/binary_info/code.h>
+#include <pico/time.h>
 #include "../TM1637.hpp"
 #include <memory>
-#include <pico/time.h>
 
 int main()
 {
@@ -10,10 +10,31 @@ int main()
     constexpr auto CLK = 28;
     auto * pio = pio0;
 
-    bi_decl(bi_1pin_with_name(DIO, "[DIO] Scoreboard data pin"))
-    bi_decl(bi_1pin_with_name(CLK, "[CLK] Scoreboard clock pin"))
+    bi_decl(bi_1pin_with_name(DIO, "[DIO] LED segments data pin"))
+    bi_decl(bi_1pin_with_name(CLK, "[CLK] LED segments clock pin"))
 
     auto led_segments = std::make_unique<TM1637>(DIO, CLK, pio);
-    led_segments->Display(-612, false, true);
+
+    static constexpr size_t PAUSE_MS = 5000;
+
+    for (size_t i = 0; i <= 100; ++i)
+    {
+        led_segments->Display(i, true);
+        sleep_ms(100);
+    }
+
+    sleep_ms(PAUSE_MS);
+
+    for (size_t i = 0; i <= 0x100; ++i)
+    {
+        led_segments->DisplayHex(i, true);
+        sleep_ms(100);
+    }
+
+    sleep_ms(PAUSE_MS);
+
+    led_segments->ColonOn();
+    led_segments->DisplayLeft(15);
+    led_segments->DisplayRight(45);
 }