PC monitor example

Author: petesramek

examples/Basic_Duplex/ESPM3_Bridge.ino

@@ -1,5 +1,5 @@
-#include <../src/TinyLink.h>
-#include <../src/adapters/TinyArduinoAdapter.h>
+#include <../../src/TinyLink.h>
+#include <../../src/adapters/TinyArduinoAdapter.h>
 #include "SharedData.h"
 
 TinyArduinoAdapter adapter(Serial);

examples/PC_Monitor/README.md

@@ -0,0 +1,53 @@
+# PC Monitor: Desktop to MCU 🖥️
+
+This example demonstrates how to use *TinyLink* in a native C++ desktop environment. It allows your computer to act as a high-performance peer to your microcontrollers, enabling real-time monitoring and command injection via a standard USB-to-Serial adapter.
+
+## 🌟 Features
+
+*Cross-Platform*: Uses `TinyPosixAdapter` for Linux/macOS and `TinyWindowsAdapter` for Windows.
+*Bi-Directional*: Receives sensor data from the MCU and sends command packets back every 5 seconds.
+*Asynchronous*: Uses the `onReceive` callback to handle incoming COBS frames without blocking the main loop.
+
+## 🛠 Hardware Setup
+
+You will need a *USB-to-TTL Serial Adapter* (e.g., CP2102, FT232RL, or CH340).
+
+PC (via USB Adapter)	Connection	MCU (MH-Tiny88 / ESP)
+TX	──────────────	RX
+RX	──────────────	TX
+GND	──────────────	GND (Common)
+
+> ⚠️ Warning: If connecting to an *ESP-M3*, ensure your USB adapter is set to *3.3V mode*. If connecting to an *MH-Tiny88*, ensure it is in *5V mode*.
+
+## 🚀 How to Build & Run
+
+1. Identify your Port
+
+*Windows*: Check Device Manager (e.g., `COM3`).
+*Linux/macOS*: Run ls `/dev/tty*` (e.g., `/dev/ttyUSB0` or √/dev/cu.usbserial-xxx√).
+
+2. Compile
+
+Open a terminal in this directory and use any standard C++ compiler:
+
+### Linux / macOS:
+
+```bash
+bash
+g++ main.cpp -I../../src -o tiny_monitor
+./tiny_monitor
+```
+
+### Windows (MinGW/MSYS2):
+
+```bash
+bash
+g++ main.cpp -I../../src -o tiny_monitor.exe
+./tiny_monitor.exe
+```
+
+## 📂 Code Overview
+
+*SharedData.h*: Defines the struct MyData used by both devices. *Must be identical on both sides*.
+*PCAdapter*: A type-alias that automatically selects the correct OS-specific driver.
+*onMcuData*: The callback function triggered whenever a valid Fletcher-16 verified packet arrives.

examples/PC_Monitor/SharedData.h

@@ -0,0 +1,12 @@
+#ifndef SHARED_DATA_H
+#define SHARED_DATA_H
+
+#include <stdint.h>
+
+struct MyData {
+    uint32_t uptime;
+    float temperature;
+    uint8_t commandId;
+};
+
+#endif

examples/PC_Monitor/main.cpp

@@ -0,0 +1,55 @@
+#include <iostream>
+#include <iomanip>
+#include "../../src/TinyLink.h"
+
+// 1. Choose the correct adapter for your OS
+#ifdef _WIN32
+    #include "../../src/adapters/TinyWindowsAdapter.h"
+    typedef TinyWindowsAdapter PCAdapter;
+    const char* PORT = "COM3"; // Change to your COM port
+#else
+    #include "../../src/adapters/TinyPosixAdapter.h"
+    typedef TinyPosixAdapter PCAdapter;
+    const char* PORT = "/dev/ttyUSB0"; // Change to your TTY device
+#endif
+
+#include "../Basic_Duplex/SharedData.h" // Reuse our shared struct
+
+// 2. Callback for when the MCU sends data to the PC
+void onMcuData(const MyData& data) {
+    std::cout << "\n[INCOMING] "
+              << "Uptime: " << data.uptime << "ms | "
+              << "Temp: " << std::fixed << std::setprecision(2) << data.temperature << "°C | "
+              << "Cmd: " << (int)data.commandId << std::endl;
+}
+
+int main() {
+    // 3. Initialize Hardware Adapter
+    PCAdapter hw(PORT, 9600);
+    if (!hw.isOpen()) {
+        std::cerr << "Failed to open port " << PORT << std::endl;
+        return 1;
+    }
+
+    // 4. Initialize TinyLink
+    TinyLink<MyData, PCAdapter> link(hw);
+    link.onReceive(onMcuData);
+
+    std::cout << "TinyLink Monitor started on " << PORT << "..." << std::endl;
+    std::cout << "Press Ctrl+C to exit." << std::endl;
+
+    while (true) {
+        link.update(); // Continuous polling for COBS frames
+
+        // Example: Send a command from PC to MCU every 5 seconds
+        static auto lastSend = hw.millis();
+        if (hw.millis() - lastSend > 5000) {
+            MyData cmd = { (uint32_t)hw.millis(), 0.0f, 1 };
+            link.send(TYPE_DATA, cmd);
+            std::cout << "[SENT] Command 1 to MCU" << std::endl;
+            lastSend = hw.millis();
+        }
+    }
+
+    return 0;
+}