skruecken/esp_alox
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Fixed Readme Layout

Browse Source
This commit is contained in:
simon 2025-08-10 13:03:40 +02:00
parent 1c9120a197
commit 400d308f4a
1 changed files with 45 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
readme.md
View File

@ -34,23 +34,27 @@ Command:
Grundlegend sind alle Zahlenwerte im LittleEndian format!
#### UART_ECHO:
Send Message: AA 01 01 CC
Message Received: AA 01 01 CC
- Send Message: AA 01 01 CC
- Message Received: AA 01 01 CC
Sendet zurück was geschickt wird.
#### UART_VERSION:
Offset Länge (Bytes) Bezeichnung Beschreibung
0 2 Version Software Version
2 7 BuildHash Git Hash
| Offset | Länge (Bytes) | Bezeichnung | Beschreibung |
|--------|---------------|-------------|------------------|
| 0 | 2 | Version | Software Version |
| 2 | 7 | BuildHash | Git Hash |
- Send Message: AA 02 02 CC
- Message Received: AA 02 01 00 33 62 35 36 30 37 39 6F CC
Send Message: AA 02 02 CC
Message Received: AA 02 01 00 33 62 35 36 30 37 39 6F CC
┌─────────────────────┐
| Version | Buildhash |
| 1 | 3b56079 |
└─────────────────────┘
|---------|-----------|
| 1 | 3b56078 |
Sendet die Version und den Buildhash vom Master zurück.
@ -59,31 +63,34 @@ Sendet die Version und den Buildhash vom Master zurück.
Das erste Datenbyte nach dem Commando gibt an wie viele Client Infos in dieser Nachricht vorhanden sind.
Danach teilt sich ein Eintrag wie Folgt auf:
Offset Länge (Bytes) Bezeichnung Beschreibung
0 1 Client ID Eindeutige ID des Clients.
1 1 Ist verfügbar Boolean-Wert (0 = nein, 1 = ja), ob der Client verfügbar ist.
2 1 Slot genutzt Boolean-Wert (0 = nein, 1 = ja), ob der Slot belegt ist.
3 6 MAC-Adresse Die Hardware-Adresse des Clients.
9 4 Letzter Ping Zeit in Millisekunden seit dem letzten Ping.
13 4 Letzter erfolgreicher Ping Zeit in Millisekunden seit dem letzten erfolgreichen Ping.
17 2 Version Versionsnummer des Clients.
| Offset | Länge (Bytes) | Bezeichnung | Beschreibung |
|--------|---------------|----------------------------|---------------------------------------------------------------|
| 0 | 1 | Client ID | Eindeutige ID des Clients. |
| 1 | 1 | Ist verfügbar | Boolean-Wert (0 = nein, 1 = ja), ob der Client verfügbar ist. |
| 2 | 1 | Slot genutzt | Boolean-Wert (0 = nein, 1 = ja), ob der Slot belegt ist. |
| 3 | 6 | MAC-Adresse | Die Hardware-Adresse des Clients. |
| 9 | 4 | Letzter Ping | Zeit in Millisekunden seit dem letzten Ping. |
| 13 | 4 | Letzter erfolgreicher Ping | Zeit in Millisekunden seit dem letzten erfolgreichen Ping. |
| 17 | 2 | Version | Versionsnummer des Clients. |
##### Ein Client
Send Message: AA 03 03 CC
Message Received: AA 03 01 00 01 01 50 78 7D 18 89 F8 34 00 00 00 61 1F 00 00 02 00 76 CC
┌─────────────────────────────────────────────────────────────────────────────────────────────────┐
| Client ID | Verfügbar | Genutzt | MAC-Adresse | Last Ping | Letzter Erfolg Ping | Version |
- Send Message: AA 03 03 CC
- Message Received: AA 03 01 00 01 01 50 78 7D 18 89 F8 34 00 00 00 61 1F 00 00 02 00 76 CC
| Client ID | Verfügbar | Genutzt | MAC-Adresse | Last Ping | Last Successful Ping | Version |
|-----------|-----------|---------|-------------------|-----------|----------------------|---------|
| 0 | 1 | 1 | 50:78:7D:18:89:F8 | 52 | 8033 | 2 |
└─────────────────────────────────────────────────────────────────────────────────────────────────┘
##### Zwei Clients
Send Message: AA 03 03 CC
Message Received: AA 03 02 00 01 01 50 78 7D 18 89 F8 22 00 00 00 F4 2A 01 00 02 00 01 01 01 50 78 7D 18 0C B4 10 00 00 00 F1 2A 01 00 02 00 FE CC
┌─────────────────────────────────────────────────────────────────────────────────────────────────┐
| Client ID | Verfügbar | Genutzt | MAC-Adresse | Last Ping | Letzter Erfolg Ping | Version |
- Send Message: AA 03 03 CC
- Message Received: AA 03 02 00 01 01 50 78 7D 18 89 F8 22 00 00 00 F4 2A 01 00 02 00 01 01 01 50 78 7D 18 0C B4 10 00 00 00 F1 2A 01 00 02 00 FE CC
| Client ID | Verfügbar | Genutzt | MAC-Adresse | Last Ping | Last Successful Ping | Version |
|-----------|-----------|---------|-------------------|-----------|----------------------|---------|
| 0 | 1 | 1 | 50:78:7D:18:89:F8 | 34 | 76532 | 2 |
| 1 | 1 | 1 | 50:78:7D:18:C:B4 | 16 | 76529 | 2 |
└─────────────────────────────────────────────────────────────────────────────────────────────────┘
#### UART_CLIENT_INPUT:
@ -92,12 +99,13 @@ Die Identifizierung wird hier anhand der vorher gesendeten ClientID gemacht also
Das erste Datenbyte nach dem Commando gibt an wie viele Client Infos in dieser Nachricht vorhanden sind.
Danach teilt sich ein Eintrag wie Folgt auf:
Offset Länge (Bytes) Bezeichnung Beschreibung
0 1 Client ID Eindeutige ID des Clients.
1 4 LageX Float Wert von der X Lage.
5 4 LageY Float Wert von der Y Lage.
9 4 LageZ Float Wert von der Z Lage.
13 4 InputMaske Int32 Wert der als Bitmaske genutzt wird um bis zu 32 Boolische Werte anzugeben.
| Offset | Länge (Bytes) | Bezeichnung | Beschreibung |
|--------|---------------|-------------|----------------------------------------------------------------------------------|
| 0 | 1 | Client ID | Eindeutige ID des Clients. |
| 1 | 4 | LageX | Float Wert von der X Lage. |
| 5 | 4 | LageY | Float Wert von der Y Lage. |
| 9 | 4 | LageZ | Float Wert von der Z Lage. |
| 13 | 4 | InputMaske | Int32 Wert der als Bitmaske genutzt wird um bis zu 32 Boolische Werte anzugeben. |
# Machbarkeits-Studie