jappel/VersaMCU
1
0
Fork 1
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Update firmware documentation and agent guidance

Browse source
This commit is contained in:
Julian Appel 2026-07-24 09:27:07 +02:00
parent ac3b2aa90f
commit 50dbf8fbee
26 changed files with 592 additions and 196 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/hal/usb_hid.cpp
View file

@ -3,7 +3,7 @@
#include <HID.h>
// ── HID Report Descriptor: Keyboard + Consumer Control ───────────────────────
// Vendor-Kommunikation läuft über CVendorHID (eigenes PluggableUSBModule).
// Host-Kommunikation außerhalb von HID läuft separat über USB CDC (SerialUSB).
static const uint8_t k_hid_descriptor[] = {

7
src/hal/usb_serial.cpp
View file

@ -6,7 +6,7 @@
// alle verfügbaren Bytes in einen internen Ring-Buffer und gibt ein vollständiges
// 8-Byte-Paket zurück sobald genug Bytes akkumuliert sind.
// Der Ring-Buffer (256 Bytes = 32 Pakete) verhindert Datenverlust wenn mehrere
// Pakete auf einmal ankommen (Config-Transfer: 30 Pakete).
// Pakete auf einmal ankommen. Größere Transfers werden fortlaufend geleert.
//
// Senden (Board → PC):
// Direkt via SerialUSB.write() – kein eigener Puffer nötig, da der Arduino-CDC-
@ -16,8 +16,9 @@
#include <Arduino.h>
// Ring-Buffer für eingehende Bytes – CDC kann jederzeit Bytes liefern.
// Größe: 32 Pakete × 8 Bytes = 256 Bytes – reicht für eine vollständige
// Config-Übertragung (30 Pakete) ohne Überlauf.
// Größe: 32 Pakete × 8 Bytes = 256 Bytes. Der Puffer ist nur ein
// Zwischenpuffer; ein vollständiger Config-Transfer umfasst 126 Pakete
// einschließlich BEGIN und COMMIT.
static uint8_t s_buf[SERIAL_PKT_SIZE * 32];
static uint16_t s_head = 0;
static uint16_t s_count = 0;

12
src/hal/usb_serial.h
View file

@ -8,10 +8,8 @@
// Byte-Layout aller Pakete:
// [0] Command/Event-ID
// [1] key_id (Button 0–24 oder Encoder 0–3)
// [2] r / Daten-Byte A
// [3] g / Daten-Byte B
// [4] b
// [5..7] reserviert (0x00)
// [2..7] kommandospezifische Daten
// LED-Kommandos nutzen [2..4] als RGB; Config-/Makro-DATA nutzt [2..7].
//
// Richtungen:
// PC → Board (Commands, 0x01–0x7F): poll_vendor() in CMainController
@ -44,9 +42,9 @@
// ── Events: Board → PC ────────────────────────────────────────────────────────
#define USB_EVT_KEY_DOWN 0x81 // key_id → HOST_COMMAND-Button gedrückt
#define USB_EVT_KEY_UP 0x82 // key_id → HOST_COMMAND-Button losgelassen
#define USB_EVT_ENC_CW 0x83 // enc_id → Encoder Schritt CW (HOST_COMMAND)
#define USB_EVT_ENC_CCW 0x84 // enc_id → Encoder Schritt CCW (HOST_COMMAND)
#define USB_EVT_KEY_UP 0x82 // Reserviert; vom Controller aktuell nicht gesendet
#define USB_EVT_ENC_CW 0x83 // Reserviert; vom Controller aktuell nicht gesendet
#define USB_EVT_ENC_CCW 0x84 // Reserviert; vom Controller aktuell nicht gesendet
#define USB_EVT_PONG 0x85 // Antwort auf USB_CMD_PING
#define USB_EVT_CONFIG_ACK 0x90 // Config erfolgreich in NVM geschrieben
#define USB_EVT_CONFIG_NACK 0x91 // Config CRC/Magic ungültig – nicht geschrieben