Merge pull request #1 from gcoonrod/feature/board-rev2

Finished board rev1

Author: gcoonrod

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "cSpell.words": [
+        "Supercap",
+        "VBAT"
+    ]
+}

README.md

@@ -2,8 +2,33 @@
 
 A proof-of-concept STM32 based development board designed for experimentation with 74x595 driven 7-segment LED character displays.
 
+## Current Revision
+Sponsored by: 
+
+![PCBWay](./hardware/assets/PCBWay.png)
+
+Due to a generous sponsorship from PCBWay the current hardware revision (rev 1) includes a number of substantial design changes over the initial revision:
+-  All SMD components from rev 0 moved to the back.
+-  Most THT components from rev 0 changed to hand-solder friendly SMD components.
+-  Supercap backup for VBAT switched to more common CR2032 battery holder.
+-  Addition of ESD IC for the USB connection and a correction for an issue with the USB FS series and pull-up resistors.
+-  Move to a 4 layer PCB and use of via-in-pad resin plug with copper capping to simplify routing.
+-  Addition of an aluminum sheet metal stand.
+-  Remap latch OE pin and user LED pins to PWM capable outputs.
+-  Break out UART3 "just in case".
+
+### Revision Objectives
+Issues with the USB connection in the first revision (rev 0) made a second revision necessary in order to support UART communication over the USB connection. While the USB termination bug was the primary driver for spinning a new board, there were also a few other short comings of the original design that became apparent during firmware development. The choice of shift registers to drive the LED displays instead of multiplexing made writing the display driver code simple but gave up the brightness control (from PoV) that comes "for free" with that approach. The 74HC595 has an output enable control signal that _maybe_ could be used to achieve a similar effect, so this revision includes a remapping of some of the signals, including the user LEDs, to pins on the MCU that support hardware PWM. 
+
+As the objective of this project is as much learning as arriving at a finished "product", I took the opportunity to try out a number of new things as well. Did you know that PCBWay does sheet metal bending?
+
+![final product](./hardware/assets/rev1.jpg)
+
+### Pushing the Envelope
+With a green light to "showcase capabilities" from PCBWay, I wanted to make something worth showing off. After reviewing the website and discovering their 3D printing/CNC milling service I decided to design something that would take advantage of more than just PCBWay's PCB printing capabilities. While the core of this project would remain a development board for STM32F1 hardware and software design, this sponsored revision would be the "STM32 Shift Clock". After a brief affair with a split board design I landed on the simple board and stand design above. This design allowed me to highlight three of PCBWay's capabilities that make them great board partners for hobbyists and professionals alike. First, the PCB is a 4-layer design utilizing [via-in-pad to simplify the routing](./hardware/assets/via-in-pad.PNG) between the shift registers and LEDs characters. PCBWay's engineers were great to work with on this and made the process of indicating which vias needed to be filled and capped simple. Which was really great because KiCad does not currently have a way to indicate if a specific via should be filled. Second, I moved all of the tiny (i.e. too hard to hand solder) components to the back of the board and relied on PCBWay's turnkey PCB assembly service to source the parts and do the hard work of getting all those tiny bits in the right spots. Again, PCBWay's engineers made the process of approving the parts selection and confirming placement and orientation easy. I used LCSC as the supplier for all of the parts on this board and all I had to do was indicate the LCSC part numbers and PCBWay took care of the rest. Their engineers even sent pictures of the boards in production so that I could visually inspect all of the parts placements. And finally, the stand. I've only ever dabbled in 3D printing and certainly never with metal. So when I saw that PCBWay could do low volume sheet metal bending I had to try it out. What followed was a caffeine fueled afternoon of YouTube tutorials and frustrating attempts to get the idea in my head out into FreeCAD. In the end I went with a very simple design that displays the PCB nicely while keeping it from tipping/sliding when pressing the buttons. I chose 5052 Aluminum with a bead blasted and anodized finish to match the PCB. Given the materials and manual labor involved I was really pleased with how reasonable the quoted cost was per piece. All in all I was very impressed with my interactions with PCBWay for this project. From the initial design submissions to the engineering verification and the customer service interactions PCBWay helped me take an idea from mind to matter and I look forward to working with them again on my future projects.
+
 ## Schematic
 ![current schematic](./hardware/assets/stm32-shift-display.svg)
 
-## Board Design
+## Board Render
 ![current board](./hardware/assets/stm32-shift-display-front.png)

firmware/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "files.associations": {
+        "ostream": "cpp"
+    },
+    "cSpell.words": [
+        "pinmap"
+    ]
+}

firmware/lib/ShiftDisplay/src/ShiftDisplay.cpp

@@ -11,31 +11,36 @@
 #include <Arduino.h>
 #include "./ShiftDisplay.h"
 
-#define DP_BP 7
-#define DP_BM 0b01000000
+#define DP_BP 1
+#define DP_BM 0b00000001
+#define GET_BIT(byte, bit) (((byte) >> (bit)) & 0x01)
 
 /**
  * Bit Position:  7   6   5   5   3   2   1   0
  * 595 Outputs:   QA  QB  QC  QD  QE  QF  QG  QH
- * 7 Segment LED: B   DP  C   A   F   D   G   E
+ * 7 Segment LED: A   B   C   D   E   F   G   DP
  */
 static const uint8_t segment_data[] = {
-    0b10111101, // '0'
-    0b10100000, // '1'
-    0b10010111, // '2'
-    0b10110110, // '3'
-    0b10101010, // '4'
-    0b00111110, // '5'
-    0b00111111, // '6'
-    0b10110000, // '7'
-    0b10111111, // '8'
-    0b10111110, // '9'
-    0b10111011, // 'A'
-    0b00101111, // 'B' (b)
-    0b00011101, // 'C'
-    0b10100111, // 'D' (d)
-    0b00011111, // 'E'
-    0b00011011  // 'F'
+    0b11111100, // '0'
+    0b01100000, // '1'
+    0b11011010, // '2'
+    0b11110010, // '3'
+    0b01100110, // '4'
+    0b10110110, // '5'
+    0b10111110, // '6'
+    0b11100000, // '7'
+    0b11111110, // '8'
+    0b11110110, // '9'
+    0b11101110, // 'A'
+    0b00011110, // 'B' (b)
+    0b10011101, // 'C'
+    0b01111010, // 'D' (d)
+    0b10011110, // 'E'
+    0b10001110, // 'F'
+    0b10111100, // 'G'
+    0b01101110, // 'H'
+    0b00000000, // ' ' (space)
+    
 };
 
 ShiftDisplay::ShiftDisplay(uint16_t data, uint16_t sclk, uint16_t sclr, uint16_t rclk, uint16_t oe)
@@ -50,6 +55,45 @@ ShiftDisplay::ShiftDisplay(uint16_t data, uint16_t sclk, uint16_t sclr, uint16_t
     _delay_ms = 0;
 }
 
+void ShiftDisplay::update_buffer(const char *new_content)
+{
+    if (new_content == nullptr)
+    {
+        return;
+    }
+
+    size_t len = strlen(new_content);
+    if (len > _char_buffer_size)
+    {
+        len = _char_buffer_size;
+    }
+
+    for (size_t i = 0; i < len; i++)
+    {
+        _buffer[i] = new_content[i];
+    }
+}
+
+void ShiftDisplay::update_character(uint8_t index, char ascii, bool dp)
+{
+    if (index >= _char_buffer_size)
+    {
+        return;
+    }
+
+    _buffer[index] = ascii;
+    _dp_state = dp ? SET_BIT(_dp_state, index) : CLEAR_BIT(_dp_state, index);
+}
+
+void ShiftDisplay::update_display()
+{
+    // Shift out the buffer in reverse order
+    for (int i = _char_buffer_size - 1; i >= 0; i--)
+    {
+        shiftOutAscii(_buffer[i], GET_BIT(_dp_state, i));
+    }
+}
+
 void ShiftDisplay::begin(uint32_t delay_us)
 {
     pinMode(_serial_data_pin, OUTPUT);
@@ -69,18 +113,29 @@ void ShiftDisplay::begin(uint32_t delay_us)
     _initialized = true;
 }
 
+void ShiftDisplay::update()
+{
+    if (!_initialized)
+    {
+        return;
+    }
+
+    update_display();
+}
+
 uint8_t ShiftDisplay::map_ascii(char hex_char)
 {
     // Error checking: ensure input is a valid hexadecimal character
-    if (!((hex_char >= '0' && hex_char <= '9') || (hex_char >= 'A' && hex_char <= 'F')))
+    if (!((hex_char >= '0' && hex_char <= '9') || (hex_char >= 'A' && hex_char <= 'H') || (hex_char == ' ')))
     {
-        if (hex_char == ' ')
-        {
-            return 0;
-        }
         return 0b10101000; // Indicate invalid character with 3 horizontal bars
     }
 
+    if (hex_char == ' ')
+    {
+        return 0;
+    }
+
     // Convert character to index (subtract ASCII offset)
     uint8_t index = (hex_char <= '9') ? (hex_char - '0') : (hex_char - 'A' + 10);
 
@@ -122,6 +177,13 @@ void ShiftDisplay::shiftOutAscii(char ascii, bool dp)
     shiftOutByte(map_ascii(ascii), dp);
 }
 
+void ShiftDisplay::writeDisplay(const char *buffer, uint8_t dp)
+{
+    update_buffer(buffer);
+    _dp_state = dp;
+    update_display();
+}
+
 void ShiftDisplay::enable()
 {
     digitalWrite(_output_en_pin, LOW);

firmware/lib/ShiftDisplay/src/ShiftDisplay.h

@@ -27,8 +27,16 @@ class ShiftDisplay: public Print
     uint32_t _delay_us;
     uint32_t _delay_ms;
 
+    // Private display state vars
+    uint8_t _dp_state = 0b00000000; // [0:5] -> [0:5] DP state for each character, [6:7] -> Not used
+    static const uint8_t _char_buffer_size = 6;
+    char _buffer[_char_buffer_size] = {' ', ' ', ' ', ' ', ' ', ' '};
+
 protected:
     uint8_t map_ascii(char hex_char);
+    void update_buffer(const char* new_content);
+    void update_character(uint8_t index, char ascii, bool dp);
+    void update_display();
 
 public:
     ShiftDisplay(uint16_t data, uint16_t sclk, uint16_t sclr, uint16_t rclk, uint16_t oe);
@@ -38,6 +46,8 @@ class ShiftDisplay: public Print
         begin(0U);
     }
 
+    void update();
+
     void shiftOutByte(uint8_t byte, bool dp);
     void shiftOutByte(uint8_t byte)
     {
@@ -50,6 +60,8 @@ class ShiftDisplay: public Print
         shiftOutAscii(ascii, false);
     }
 
+    void writeDisplay(const char* buffer, uint8_t dp);
+
     void enable();
     void disable();
 

firmware/lib/ShiftDisplayFSM/src/ShiftDisplayFSM.cpp

@@ -0,0 +1,53 @@
+#include "ShiftDisplayFSM.h"
+
+void ShiftDisplayFSM::update()
+{
+    currentState = nextState;
+}
+
+void ShiftDisplayFSM::setState(State state)
+{
+    nextState = state;
+}
+
+State ShiftDisplayFSM::getState()
+{
+    return currentState;
+}
+
+void ShiftDisplayFSM::execute(Action action)
+{
+    switch (action)
+    {
+    case Action::MENU_ENTER:
+        if (currentState == State::IDLE)
+        {
+            nextState = State::MENU;
+            nextMenuState = MenuState::MENU_SET_TIME;
+        }
+        break;
+    case Action::MENU_EXIT:
+        nextState = State::IDLE;
+        nextMenuState = MenuState::MENU_NONE;
+        break;
+    case Action::MENU_UP:
+        break;
+    case Action::MENU_DOWN:
+        break;
+    case Action::MENU_SELECT:
+        if (currentState == State::IDLE)
+            break;
+        switch (currentMenuState)
+        {
+        case MenuState::MENU_SET_TIME:
+            nextMenuState = MenuState::MENU_SET_HOUR;
+            break;
+        case MenuState::MENU_SET_DATE:
+            nextMenuState = MenuState::MENU_SET_DAY;
+            
+            break;
+        default:
+            break;
+        }
+    }
+}

firmware/lib/ShiftDisplayFSM/src/ShiftDisplayFSM.h

@@ -0,0 +1,36 @@
+#ifndef _SHIFTDISPLAYFSM_H
+#define _SHIFTDISPLAYFSM_H
+
+#include <inttypes.h>
+
+enum State {
+    IDLE, MENU
+};
+
+enum MenuState {
+    MENU_NONE, MENU_SET_TIME, MENU_SET_DATE, MENU_SET_HOUR, MENU_SET_MINUTE, MENU_SET_SECOND, MENU_SET_DAY, MENU_SET_MONTH, MENU_SET_YEAR
+};
+
+enum Action {
+    ACTION_NONE, MENU_ENTER, MENU_EXIT, MENU_UP, MENU_DOWN, MENU_SELECT
+};
+
+class ShiftDisplayFSM {
+private:
+    State currentState;
+    State nextState;
+
+    MenuState currentMenuState;
+    MenuState nextMenuState;
+
+public:
+    ShiftDisplayFSM() : currentState(IDLE), nextState(IDLE), currentMenuState(MENU_NONE), nextMenuState(MENU_NONE) {}
+    void update();
+    void execute(Action action);
+    void setState(State state);
+    State getState();
+};
+
+
+
+#endif // _SHIFTDISPLAYFSM_H

firmware/platformio.ini

@@ -25,4 +25,5 @@ build_flags =
 lib_deps =
   stm32duino/STM32duino RTC @ ^1.4.0
   stm32duino/STM32duino Low Power @ ^1.2.5
-  bxparks/AceButton @ ^1.10.1
+  bxparks/AceButton @ ^1.10.1
+  ppedro74/SerialCommands @ ^2.2.0