M5: returned ok/error on UART command

twystd · twystd · commit b031dff9ee70 · 2025-07-21T13:08:30.000-07:00
diff --git a/m5-stack/Rev.0/TODO.md b/m5-stack/Rev.0/TODO.md
@@ -15,13 +15,13 @@
    - [x] SK6812
    - [x] Wiegand 
    - [x] GPIO
-   - [ ] UART
+   - [x] UART
       - [x] uart0
       - [x] uart1
       - [x] card
       - [x] keycode
       - [x] card + keycode
-      - [ ] error/ok
+      - [x] error/ok
    - [ ] USB
       - [x] bootsel
       - [ ] card
diff --git a/m5-stack/Rev.0/coreS3/main.py b/m5-stack/Rev.0/coreS3/main.py
@@ -1,4 +1,5 @@
 import os
+import re
 import sys
 import io
 import M5
@@ -11,23 +12,29 @@
 
 Point = namedtuple("Point", "x y timestamp")
 Button = namedtuple("Button", "x y w h label pressed")
+Label = namedtuple("Label", "x y w h text")
 
 BLACK = 0x222222
 BACKGROUND = 0xEACDCD
+GRAY = 0x808080
+DARKGRAY = 0x444444
+RED = 0xC04040
 BORDER = 0xFC0000
 
 IO1 = Pin(1, Pin.OUT)
 IO2 = Pin(2, Pin.OUT)
 uart1 = UART(1, baudrate=115200, tx=43, rx=44)
 uart2 = UART(2, baudrate=115200, tx=17, rx=18)
 
-B10058399 = Button(32,        32, 120, 48, '10058399',         lambda: press(IO2))
-B10058400 = Button(32 + 136,  32, 120, 48, '10058400',         lambda: press(IO1))
-B10058401 = Button(32,        96, 120, 48, '10058401',         lambda: swipe(uart1, '10058401', None))
-C1357     = Button(32 + 136,  96, 120, 48, '1357#',            lambda: keypad(uart1, '1357'))
-B10058402 = Button(32,       160, 256, 48, '10058402 + 7531#', lambda: swipe(uart2, '10058402', '7531'))
+B10058399 = Button(32, 8, 120, 48, "10058399", lambda: press(IO2))
+B10058400 = Button(32 + 136, 8, 120, 48, "10058400", lambda: press(IO1))
+B10058401 = Button(32, 8 + 64, 120, 48, "10058401", lambda: swipe(uart1, "10058401", None))
+C1357 = Button(32 + 136, 8 + 64, 120, 48, "1357#", lambda: keypad(uart1, "1357"))
+B10058402 = Button(32, 8 + 128, 256, 48, "10058402 + 7531#", lambda: swipe(uart2, "10058402", "7531"))
+LMSG = Label(0, 216, 320, 24, "")
 
 touched = None
+message = None
 
 
 def setup():
@@ -46,23 +53,32 @@ def screen():
     button(B10058401)
     button(B10058402)
     button(C1357)
+    label(LMSG)
 
 
 def button(b):
-    offset = int(b.w/2 - 12*len(b.label)/2)
+    offset = int(b.w / 2 - 12 * len(b.label) / 2)
     Widgets.Rectangle(b.x, b.y, b.w, b.h, BORDER, BACKGROUND)
     Widgets.Label(b.label, b.x + offset, b.y + 14, 1.0, BLACK, BACKGROUND, Widgets.FONTS.DejaVu18)
 
 
+def label(l):
+    global message
+    Widgets.Rectangle(l.x, l.y, l.w, l.h, DARKGRAY, DARKGRAY)
+    message = Widgets.Label(l.text, l.x + 16, l.y + 8, 1.0, RED, DARKGRAY, Widgets.FONTS.DejaVu12)
+
+
 def pressed(b):
     global touched
 
     return touched.x >= b.x and touched.x <= (b.x + b.w) and touched.y >= b.y and touched.y <= (b.y + b.h)
 
 
 def press(pin):
+    message.setText(f"%-48s" % "")
     if pin.value():
         pin.value(False)
+        message.setText(f"%-48s" % "Ok")
         return True
 
     return False
@@ -81,17 +97,58 @@ def release():
 
 
 def swipe(uart, card, code):
+    display("")
+
     if code is None:
-        uart.write(f'SWIPE {card}\n')
+        uart.write(f"SWIPE {card}\n")
     else:
-        uart.write(f'SWIPE {card} {code}#\n')
+        uart.write(f"SWIPE {card} {code}#\n")
 
-    return True
+    return read(uart)
 
 
 def keypad(uart, code):
-    uart.write(f'CODE {code}#\n')
-    return True
+    display("")
+    uart.write(f"CODE {code}#\n")
+
+    return read(uart)
+
+
+def read(uart):
+    timeout = 500  # milliseconds
+    start = time.ticks_ms()
+    response = b""
+
+    while time.ticks_diff(time.ticks_ms(), start) < timeout:
+        if uart.any():
+            response += uart.read()
+            if b"\n" in response:
+                break
+
+    if response:
+        line = response.decode().strip()
+        print(f">>> {line}")
+        if line == "OK":
+            display("Ok")
+            return True
+
+        match = re.compile(r"^ERROR\s+(\d+)\s+(.+)$").match(line)
+        if match:
+            code = int(match.group(1))
+            msg = match.group(2)
+            display(f"** ERROR {code} {msg}")
+            return False
+
+        display("** ERROR <unknown>")
+        return False
+
+    display(f"** ERROR <no reply>")
+    return False
+
+
+def display(msg):
+    global message
+    message.setText(f"%-128s" % f"{msg}")
 
 
 def loop():
diff --git a/m5-stack/Rev.0/firmware/core/src/uart.c b/m5-stack/Rev.0/firmware/core/src/uart.c
@@ -22,6 +22,11 @@
 
 extern const constants HW;
 
+const char *ERR_OK = "OK\n";
+const char *ERR_BAD_REQUEST = "ERROR 1000 bad request\n";
+const char *ERR_INVALID_CARD = "ERROR 1001 invalid card\n";
+const char *ERR_WRITE = "ERROR 1002 write failed\n";
+
 typedef struct line {
     char bytes[64];
     int ix;
@@ -77,11 +82,13 @@ void on_uart1_rx();
 bool on_uart_monitor(repeating_timer_t *);
 void uart0_rxchar(uint8_t);
 void uart1_rxchar(uint8_t);
-void uart_rxchar(uint8_t, line *);
-void uart_exec(char *);
+void uart_flush(uint8_t);
+void uart_rxchar(const uart_inst_t *, uint8_t, line *);
+void uart_exec(const uart_inst_t *, char *);
+void uart_write(const uart_inst_t *, const char *);
 
-void uart_swipe(char *msg);
-void uart_keypad(char *msg);
+void uart_swipe(const uart_inst_t *uart, char *msg);
+void uart_keypad(const uart_inst_t *uart, char *msg);
 
 void UART_init() {
     // ... uart0
@@ -173,23 +180,32 @@ bool on_uart_monitor(repeating_timer_t *rt) {
 }
 
 void UART_rx(uart_inst_t *uart, buffer *b) {
-    buffer_flush(b, uart0_rxchar);
+    if (uart == uart0) {
+        buffer_flush(b, uart0_rxchar);
+    } else if (uart == uart1) {
+        buffer_flush(b, uart1_rxchar);
+    } else {
+        buffer_flush(b, uart_flush);
+    }
 }
 
 void uart0_rxchar(uint8_t ch) {
-    uart_rxchar(ch, &UART.UART0.line);
+    uart_rxchar(uart0, ch, &UART.UART0.line);
 }
 
 void uart1_rxchar(uint8_t ch) {
-    uart_rxchar(ch, &UART.UART1.line);
+    uart_rxchar(uart1, ch, &UART.UART1.line);
+}
+
+void uart_flush(uint8_t ch) {
 }
 
-void uart_rxchar(uint8_t ch, line *line) {
+void uart_rxchar(const uart_inst_t *uart, uint8_t ch, line *line) {
     switch (ch) {
     case CR:
     case LF:
         if (line->ix > 0) {
-            uart_exec(line->bytes);
+            uart_exec(uart, line->bytes);
         }
 
         memset(line->bytes, 0, sizeof(line->bytes));
@@ -204,26 +220,27 @@ void uart_rxchar(uint8_t ch, line *line) {
     }
 }
 
-void uart_exec(char *msg) {
+void uart_exec(const uart_inst_t *uart, char *msg) {
     char s[64];
 
     snprintf(s, sizeof(s), "%s", msg);
     debugf(LOGTAG, s);
 
     if (strncasecmp(msg, "swipe ", 6) == 0) {
-        uart_swipe(&msg[6]);
+        uart_swipe(uart, &msg[6]);
     } else if (strncasecmp(msg, "code ", 5) == 0) {
-        uart_keypad(&msg[5]);
+        uart_keypad(uart, &msg[5]);
     }
 }
 
-void uart_swipe(char *msg) {
+void uart_swipe(const uart_inst_t *uart, char *msg) {
     char *token = strtok(msg, " ,");
 
     if (token != NULL) {
         uint32_t u32;
 
         if (sscanf(msg, "%u", &u32) < 1) {
+            uart_write(uart, ERR_BAD_REQUEST);
             return;
         }
 
@@ -232,10 +249,12 @@ void uart_swipe(char *msg) {
         char *code;
 
         if (facility_code < 1 || facility_code > 255 || card > 65535) {
+            uart_write(uart, ERR_BAD_REQUEST);
             return;
         }
 
         if (!write_card(facility_code, card)) {
+            uart_write(uart, ERR_WRITE);
             debugf(LOGTAG, "card %u%05u error", facility_code, card);
             return;
         }
@@ -244,27 +263,39 @@ void uart_swipe(char *msg) {
             int N = strlen(code);
             for (int i = 0; i < N; i++) {
                 if (!write_keycode(code[i])) {
+                    uart_write(uart, ERR_WRITE);
                     debugf(LOGTAG, "keycode %c error", code[i]);
                     return;
                 }
             }
         }
+
+        uart_write(uart, ERR_OK);
     }
 }
 
-void uart_keypad(char *msg) {
+void uart_keypad(const uart_inst_t *uart, char *msg) {
     int N = strlen(msg);
 
-    for (int i = 0; i < N; i++) {
-        if (!write_keycode(msg[i])) {
-            debugf(LOGTAG, "keycode %c error", msg[i]);
-            return;
+    if (N > 0) {
+        for (int i = 0; i < N; i++) {
+            if (!write_keycode(msg[i])) {
+                uart_write(uart, ERR_WRITE);
+                debugf(LOGTAG, "keycode %c error", msg[i]);
+                return;
+            }
         }
+
+        uart_write(uart, ERR_OK);
     }
 }
 
-// bool uart0_write(const uint8_t *bytes, int N) {
-//     uart_write_blocking(uart0, bytes, N);
-//
-//     return true;
-// }
+void uart_write(const uart_inst_t *uart, const char *msg) {
+    int N = strlen(msg);
+
+    if (uart == uart0) {
+        uart_write_blocking(uart0, msg, N);
+    } else if (uart == uart1) {
+        uart_write_blocking(uart1, msg, N);
+    }
+}
diff --git a/m5-stack/Rev.1/NOTES.md b/m5-stack/Rev.1/NOTES.md
@@ -62,6 +62,8 @@
 26. Buzzer IO
 27. SMT headers
    - https://electronics.stackexchange.com/questions/415542/are-these-tiny-vertical-dual-row-pcb-mounted-connector-pins-standard/719876#719876
+28. PCB notch for CoreS3 power switch
+29. Slot in enclosure for USB cable
 
 - (?) https://www.ti.com/product/MSPM0C1104
 - (?) Add HWPR as optional power
