EVENTDISTR.mw

   1 {{Projekt|kontakt=[[Benutzer:Daniel Bohrer|Daniel Bohrer]], [[Benutzer:chrissi^|chrissi^]]|status=aktiv|beschreibung=Paketspezifikation für Events aller Art|bild=Beispiel UDP-Paket.jpg|bildbeschreibung=Beispiel-Paket in Wireshark}}
   2
   3 Im Space gibt es ein standardisiertes Protokoll, wie Events über das Netzwerk verteilt werden. Das Protokoll baut auf UDP auf und benutzt Port 31337. Die Pakete können sowohl als Unicast als auch als Broadcast oder Multicast gesendet werden.
   4
   5 == Format ==
   6 Der Payload der UDP-Pakete hat folgenden Aufbau:
   7
   8 {| class="prettytable"
   9 ! Offset (Byte) !! Inhalt !! Bemerkung
  10 |-
  11 | 0 || <tt>EVENTDISTR</tt> || Magic String zur Erkennung des Protokolls
  12 |-
  13 | 10 || <tt>v</tt> || Trennzeichen
  14 |-
  15 | 11 || Protokollversion || Version des Protokolls in ASCII. Zur Zeit wird Version 2 eingesetzt: ASCII "<tt>2</tt>" == 50 == 0x32. (Siehe auch [[#Changelog]])
  16 |-
  17 | 12 || <tt>;</tt> || Trennzeichen
  18 |-
  19 | 13-… || <tt><i>Event</i>=<i>Wert</i></tt> || Name des Events, optional gefolgt von einem Trennzeichen (ASCII "<tt>=</tt>" == 61 == 0x3D) und einem zusätzlichem Wert. Es ist zu beachten, dass einige Implementierungen unter Umständen nicht das komplette Event verarbeiten, sondern auf eine bestimmte Länge beschränkt sind. Generell wird gebeten, RFC 3514 zu beachten.
  20 |}
  21
  22 == Events ==
  23 Es folgt eine vollständige Auflistung der zur Zeit verwendeten Events.
  24
  25 === DingDong ===
  26 Die Klingel an einer der beiden Haustüren wurde betätigt. Wird vom [[Doorbell Extender]] im Frickelraum verarbeitet. Das Event kann optional die Werte <tt>RISING</tt> oder <tt>FALLING</tt> annehmen, um die steigende oder fallende Flanke zu kennzeichnen.
  27
  28 Beispiel:
  29  0000000: 4556 454e 5444 4953 5452 7631 3b44 696e  EVENTDISTRv1;Din
  30  0000010: 6744 6f6e 673d 5249 5349 4e47            gDong=RISING
  31
  32 === DoorUnten ===
  33 Der Türoffnungsknopf am Doorbell Extender wurde betätigt. Wird vom [[Doorbell Extender]] an der Tür oben verarbeitet. Das Event kann optional die Werte <tt>RISING</tt> oder <tt>FALLING</tt> annehmen, um die steigende oder fallende Flanke zu kennzeichnen.
  34
  35 Beispiel:
  36  0000   4556 454e 5444 4953 5452 7631 3b44 6f6f    EVENTDISTRv1;Doo
  37  0010   7255 6e74 656e 3d52 4953 494e 47           rUnten=RISING
  38
  39 === SpaceOpened ===
  40 Wird vom [[statusberry]] gesendet, wenn der Space-Öffnungsstatus auf „offen“ gesetzt wird. Es wird kein Wert gesendet.
  41
  42 Beispiel:
  43  0000000: 4556 454e 5444 4953 5452 7631 3b53 7061  EVENTDISTRv1;Spa
  44  0000010: 6365 4f70 656e 6564                      ceOpened
  45
  46 === SpaceClosed ===
  47 Wird vom [[statusberry]] gesendet, wenn der Space-Öffnungsstatus auf „geschlossen“ gesetzt wird. Es wird kein Wert gesendet.
  48
  49 Beispiel:
  50  0000000: 4556 454e 5444 4953 5452 7631 3b53 7061  EVENTDISTRv1;Spa
  51  0000010: 6365 436c 6f73 6564                      ceClosed
  52
  53 === NowPlaying ===
  54 Dient zur Ankündigung von aktuell gespielten Songtitel/Interpreten im Space. Der Wert besteht aus folgenden Feldern, die jeweils durch Nullbytes abgeschlossen sind:
  55 ;Area: Teilbereich des Spaces, für den das Event gilt. Kann folgende Werte annehmen:
  56 :*<tt>A</tt> für den Teilbereich [[Frickelraum]]
  57 :*<tt>B</tt> für den Teilbereich [[Lounge]]
  58 :*<tt>0</tt> für den Teilbereich [[Bad]]
  59 :*<tt>K</tt> für den Teilbereich [[Küche]]
  60 ;Interpret: Der Interpret des Musikstücks, das zur Zeit im Teilbereich des Spaces gespielt wird, kodiert im UTF-8-Zeichensatz (RFC 3629, ISO/IEC 10646-1:2000 Annex D)
  61 ;Title: der Titel des Musikstücks, das zur Zeit im Teilbereich des Spaces gespielt wird, kodiert im UTF-8-Zeichensatz (RFC 3629, ISO/IEC 10646-1:2000 Annex D)
  62
  63 Falls durch Implementierungen eine Begrenzung der Paketgröße vorgenommen wird, wird empfohlen, längere Zeichenketten von <em>Interpret</em> und <em>Title</em> an geeigneten Stellen durch „<tt>...</tt>“ abzukürzen.
  64
  65 Das Versenden eines NowPlaying-Events macht alle vorher gesendeten NowPlaying-Events ungültig. Alternativ kann in diesem Fall auch ein NowPlaying-Event gesendet werden, in dem die Felder ''Interpret'' und ''Title'' die leere Zeichenkette enthalten (z.B. wenn das Ende einer Playlist erreicht wurde und kein neuer Titel folgt).
  66
  67 Beispiel: Im Frickelraum wird gerade „J. S. Bach: St Matthew Passion, Part I: No. 1. Chorus: Kommt, ihr Töchter, helft mir klagen (Chorus, Soprano in ripieno)“ von „Cologne Chamber Orchestra“ gespielt.
  68
  69  0000000: 4556 454e 5444 4953 5452 7632 3b4e 6f77  EVENTDISTRv2;Now
  70  0000010: 506c 6179 696e 673d 4100 436f 6c6f 676e  Playing=A.Cologn
  71  0000020: 6520 4368 616d 6265 7220 4f72 6368 6573  e Chamber Orches
  72  0000030: 7472 6100 4a2e 2053 2e20 4261 6368 3a20  tra.J. S. Bach:
  73  0000040: 5374 204d 6174 7468 6577 2050 6173 7369  St Matthew Passi
  74  0000050: 6f6e 2c20 5061 7274 2049 3a20 4e6f 2e20  on, Part I: No.
  75  0000060: 312e 2043 686f 7275 733a 204b 6f6d 6d74  1. Chorus: Kommt
  76  0000070: 2c20 6968 7220 54c3 b663 6874 6572 2e2e  , ihr T..chter..
  77  0000080: 2e00
  78
  79 Beispiel: Die Wiedergabe im Frickelraum wurde beendet und es folgt kein weiteres Lied.
  80
  81  0000000: 4556 454e 5444 4953 5452 7632 3b4e 6f77  EVENTDISTRv2;Now
  82  0000010: 506c 6179 696e 673d 4100 0000            Playing=A...
  83
  84 === VirtualMsg ===
  85 Zum Ankündigungen von Nachrichten aus dem virtuellen Raum im Space. Die Nachricht kann z.&nbsp;B. aus dem IRC kommen und im Space auf einer LED-Leiste angezeigt werden. Der Wert des Events besteht aus der entsprechenden Nachricht, die angezeigt werden soll.
  86
  87 Beispiel:
  88  0000000: 4556 454e 5444 4953 5452 7631 3b56 6972  EVENTDISTRv1;Vir
  89  0000010: 7475 616c 4d73 673d 3c6a 7261 6e64 6f6d  tualMsg=<jrandom
  90  0000020: 6861 636b 6572 3e20 6772 6164 206a 656d  hacker> grad jem
  91  0000030: 616e 6420 696d 2073 7061 6365 3f         and im space?
  92
  93 :''siehe auch [[StratumPing]]''
  94
  95 == Changelog ==
  96 {| class="prettytable"
  97 ! Version !! Datum !! Änderung
  98 |-
  99 | v2 || 2013-06-19 || 100-Byte-Beschränkung aufgehoben, Größe ist jetzt implementierungsspezifisch. --[[Benutzer:Daniel Bohrer|Daniel Bohrer]] 02:06, 19. Jun. 2013 (CEST)
 100 |}
 101
 102 == Implementierungen ==
 103 * [https://github.com/stratum0/pyEventdistr pyEventdistr]: Python-Paket mit einigen Scripts um EVENTDISTR-Pakete zu generieren und empfangen (von {{Benutzer|comawill}})
 104
 105 [[Kategorie:Dokumentation]]
 106 [[Kategorie:Infrastruktur]]