User Tools

Site Tools


de:doc:rfc_firmware_syntax

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

de:doc:rfc_firmware_syntax [2014/09/22 21:13]
wsauer created
de:doc:rfc_firmware_syntax [2014/09/22 21:57] (current)
wsauer
Line 18: Line 18:
 ===== Einleitung ===== ===== Einleitung =====
  
-Under the assumptionthat it will be mostly other software which talks to the interfacethe command structure was made simple, but flexible.+Unter der Vorraussetzungdaß es manch andere Software gibt die zum Interface Kontakt aufnimmt und Botschaften sendetist die Kommandostruktur einfach aber flexibel gestaltet worden.
  
-To archive thisthe interface knows only two different kind of inputsdata or parametersthe so called ​P- Commands+Um dies zu erreichenkennt die Schnittstelle nur zwei Arten von EingabenDaten und Parameterdie sogenannten ​P-Kommandos
  
-where the values are defined as (in EBNF- Syntax)+In der die Werte definiert sind wie folgt (in EBNF- Syntax)
  
   data = hex , { hex };   data = hex , { hex };
Line 30: Line 30:
  
  
-==== P- Commands ​====+==== P- Kommandos ​====
  
-input+Eingabe
-  p functionblock ​command ​value , {value} <CR>+  p Funktionsblock ​Kommando ​Wert , {Wert} <CR>
   ​   ​
-where the definion is as follows+die Definition ist wie folgt
  
   p = "​p"​ | "​P"​ ;   p = "​p"​ | "​P"​ ;
-  ​functionblock ​number ​+  ​Funktionsblock ​Nummer ​
-  ​command ​number ​+  ​Kommando ​Nummer ​
-  ​value number ​+  ​Wert Nummer ​
-  ​number ​digit  {digit } | "​$"​ , hex , { hex } ;+  ​Nummer ​Ziffer ​ {Ziffer ​} | "​$"​ , hex , { hex } ;
   ​   ​
  
  
-==== Data Input ====+==== Dateneingabe ​====
  
-input+Eingabe
-  ​data <CR>+  ​Daten <CR>
  
  
-==== Feedback ​==== +==== Rückmeldung ​==== 
-if the p-command or the data input were successfully proccededthe firmware answers with optional ​additional output and always with a trailing line containing a "​."​, which signals the successful execution of the command.+Wenn das p-Kommando oder die Dateneingabe erfolgreich verarbeitet worden istantwortet die Firmware mit optional ​zusätzlichen Ausgaben und immer mit einer Linie die aus "​." ​Zeichen sich aufbaut.
  
-  ​someoutput+  ​Irgendeine Ausgabe
   .   .
  
  
-==== Errors ​==== +==== Fehler ​==== 
-In case of an errorthe firmware answers with a ":​error:", ​the functional block idan error number and optional ​more error codes and Text+Falls ein Fehler auftrittantwortet die Firmware mit ":​error:", ​der funktionalen Block IDeiner Fehlernummer und optional ​mehreren Fehlerkodes und Text
  
-  :error: 8 3 out of mem+  :error: 8 3 Kein Speicher mehr
  
  
-==== Other Unrequested Outputs ​==== +==== Andere nicht angeforderte Ausgaben ​==== 
-All other outputs from the firmwarewhich are not an answer on a p- or data commandhave to be started with a leading ​"#"​+Alle anderen Ausgaben der Firmwarewelche keine Antwort auf ein p- Datenkommando sindmüssen mit einem führenden ​"#" ​Zeichen starten
  
-  #some firmware message+  #Eine Firmware Nachricht
  
-==== Examples ​====+==== Beispiele ​====
  
-Sending ​11 bytes of data+Sende 11 Bytes Daten
  
-input:+Eingabe:
    ​112233445566778899AABB    ​112233445566778899AABB
  
-if the number of input chars is not eventhe last char is handled as MSB of the last byteso+Falls die Anzahl von Eingabewerten nicht gerade istwird das letzte Zeichen als MSB des letzten Bytes betrachtetalso
  
    ​112233445566778899AAB    ​112233445566778899AAB
  
-is send as +wird gesendet als 
  
    ​112233445566778899AAB0    ​112233445566778899AAB0
  
  
-Set the parameter ​127 to 64:+Setze den Parameter ​127 auf 64:
  
   p 127 64   p 127 64
   ​   ​
-the samebut with hexadecimal notation:+das Gleicheaber nun in der Hexadezimalen Notation lautet:
  
   p $7F $40   p $7F $40
Line 95: Line 95:
  
  
-==== Implementation Details ​==== +==== Implementationsdetail ​==== 
-Sending ​''​data'' ​locks the input until the receive tasks times out+Das Senden von ''​data'' ​sperrt die Eingabe bis der Empfangstask auf einen Timeout läuft
  
-==== Security Considerations ​====+==== Sicherheitsüberlegungen ​====
    
  
-This RFC has no security issues+Dieses ​RFC hat keine Sicherheitsaspekte
    
-==== References ​====+==== Referenzen ​====
    
  
-==== Authors'​ Addresses ​====+==== Adresse des Autors ​====
    
  
 Steffen Koehler Steffen Koehler
  
-Phone: +49 172 410 35 98+Telefon: +49 172 410 35 98
  
 EMail:​steffen@koehlers.de ​ EMail:​steffen@koehlers.de ​
-==== Appendix ​====+==== Anhang ​====
   ​   ​
  
Line 144: Line 144:
    
  
-==== Distribution Lists ====+==== Verteilerlisten ​====
    
 +Die OOBD-RFC Ankündigungen werden durch die oobd-commit-messages@googlegroups.com mailingliste verteilt.
  
- The OOBD-RFC announcements are distributed via the oobd-commit-messages@googlegroups.com mailing list.+Um diese zu nutzen (oder sich davon abzumelden) benutze https://​groups.google.com/​forum/?​hl=de&​fromgroups=#​!forum/​oobd-commit-messages
  
- To join (or quit) the list goto https://​groups.google.com/​forum/?​hl=de&​fromgroups=#​!forum/​oobd-commit-messages 
de/doc/rfc_firmware_syntax.txt · Last modified: 2014/09/22 21:57 by wsauer