Skip to content

W
White Rabbit Trigger Distribution
Commit 916e12d9 authored by Dimitris Lampridis's avatar Dimitris Lampridis
Browse files
Options

doc: added section on WRTD event message format

parent 2fdc327f
Hide whitespace changes
Inline Side-by-side
Showing with 36 additions and 0 deletions
doc/graphics/wrtd_message.drawio 0 → 100644
View file @ 916e12d9
<mxfile modified="2019-07-01T15:27:43.901Z" host="www.draw.io" agent="Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/60.0" etag="1Kv_cjGmrVUlLd7wc4Uf" version="10.8.4" type="device"><diagram id="ks2UuWJj-qZBEqacDeH4" name="Page-1">7Z1db9s2FIZ/jdHuYoC+LV/GaZMVW9YN3rB2N4MqUbEwWfRkOnb660fZoiP7MPowUPEUOM5FJOrDEh/x1eF7RHni3q7292W0Xj7whOUTx0r2E/fdxHFs23blv6rk+Vgytb1jwWOZJfVKLwWL7CurC626dJslbHO2ouA8F9n6vDDmRcFicVYWlSXfna+W8vz8W9fRIwMFizjKYelfWSKW6ryC2cuCn1j2uKy/OnSmxwWrSK1cn8lmGSV81yhy30/c25JzcZxa7W9ZXlWeqpfjdnevLD0dWMkK0WeDz0+L38XC+uOfPx9+Dm7S/O/fZvc/1nt5ivKtOuGgPlzxrOqg5NsiYdVurIk73y0zwRbrKK6W7iR1WbYUq1zO2XLyiZUik/V3k2ePhSxbZUlS7Wie8kIs6p3a9fxdtMry6sq45dsyY6X83l+ZrKP5RpT8X3bLc14ejsG1Dp9qsyzPG+WpX/3Vu2uUHz+nPSl21RfXpyyPk+1frUv7REhe2oyvmCif5Sr1Br6CWl/V8vCO87uXa0StsmxcHaosqq/Kx9OeX8DJiZrdAI4O5Dgljt0cPWQcXcgxJI7dHANkHD3IcUYcuzmGyDj6gOPpdk4cX+cYWMg4BpCjTRy7OWKLc6aQo0Mcuzlii3NCyNEljt0cscU5M8jRI47dHLHFOcpuaYL0CWQnyCm2QMeGjo5Djk4PkNgiHRtaOg5ZOj1AYgt1bOjpOOTp9ACJLdaxoanjkKnTAyS6YAe6Oi65Ot0gQ3TBDrR1XLJ1eoBEF+xAX4caZDdHB12DhL4OtcceHNG1R42vQxy7OWLre6gdN2+QxLGbI7auhwNdHbJZe3DE1vNQKtrgSC5rN0cXW5zjQE+HTNYeHLHFOQ60dMhj7cERXZwDHR2yWHtwRBfnQEOHHNYeHNHFOdDPURlmAtkC0kMX6GgMHXJ0eoBEF+lAR0dlmAlkG0hsoY7KVDVBkqfTAyS2WMeFno5Npk4PkNiCHReaOja5Ot0gfWzBjgtdne8raPX86g9yvDt8vpnLesHx5Lo2ONrBqCA1w68IZCfISzsAAUjN+CsC2a2sDjqQmid1CGQnyMtxAghAQmfnYyyYIJidMO0erTIclSU0dz6m6YaJDdHspOlhgwkNHmqYV6HU9UNGRamOp4FynhHI4QprniT0eKy9F8uSt29+efPDCEitLqSXVkAYszhuRT3Oo6yO6UjHg7aOtffDA7tPxK4tjWyencbJ2XuzA7sPxK7tTVbm2UHzxtordUDFjNmJz6bjMwOjx80zgz7N9+WcmnHAQbyiATluvAJtGuI4vANhHCM0ad4/VefiWB/kjDXx57LubtyJ/w6hrKZp6qAIQT2I8fQinXE4QoNGJRupPQ7RVQ3JcRskNGco1T9cV01j9KExc6mrntTVKelqq64GpnXVh7ZMQO3xCl3VkBy3QUKPhp77H66rxjFCu+ZSV0Opq7ZNwtoqrJoc1MjCCr2bGQ2Mu0JYTWcTfWjo0OPiVyircY7Q0LlUVslVSqtP0tomrZ4mkziytGqGVFGwc4W26lCO2yY1Y6roJjlYW81zhKbOgv23ZYWE5FjFdvWlqlt0kppELEwxSKrGJR9XUlW356whUr7jCkk1nfAING89JpDDJdU4R+jnqHBVZCu2EdFqXTFlMS+SjZx6W+VDrJzvDnX+JRMbjA93JD4LEw+B5BrPaAWaH7iaUcfyCsk1nQsJNG9DJg99uOQa5widHp3kFlHBT7JLAvuawBpPbQWaX7qidnmNwJpOigSa37oiv2e4wBrnCO0encCmZRSLjBdRTmrbV2017vrp2btx2Grek+yTl3eF2ppOlEyhF0SP2l2htsY5Qieow0GovHdru16Tg9BjeIh5yZ1qhhrQ8JC24SG+JlEy7vCQqaZTElIsO/w2qUM5rrzCTolL8c7g26R5jrBTQiraeudDoKKws0HMWgcim2emGjUx69up/5bM5GzJuWgsu5eVu3zgCavW+B8=</diagram></mxfile>
\ No newline at end of file
doc/index.rst
View file @ 916e12d9
......@@ -12,6 +12,7 @@ White Rabbit Trigger Distribution documentation
:caption: Contents
introduction
wrtd_message
wrtd_api
.. todolist::
......
doc/wrtd_message.rst 0 → 100644
View file @ 916e12d9
.. _wrtd_message:
-------------------
WRTD Event Messages
-------------------
WRTD Event messages follow the LXI Event Messaging format, as defined in the "LXI Event Messaging
Extended Function" specification, revision 1.0.
To ensure compatibility with LXI devices, WRTD Event messages are transmitted using multicast UDP on
address 224.0.23.159, port 5044 (Rule 3.3.1 of the LXI Event Messaging Extended Function).
Each Event message is transmitted as a single Ethernet frame, with a UDP header and a payload as
shown in :numref:`fig-wrtd-message`.
.. figure:: graphics/wrtd_message.png
:name: fig-wrtd-message
:align: center
:alt: alternate text
:figclass: align-center
Contents of a WRTD Event message
The contents of a WRTD Event message are again based on LXI Event messages, with the "Domain" and
Flag bytes (octets 3 and 36 respectively) fixed to zero.
Altough there are currently no "Data Fields" defined (octets 37 and beyond), it should be
highlighted that the LXI Event message format supports an arbitrary number of data fields, in the
form of Type/Length/Value (TLV) triplets, which could be used to provide additional functionality to
WRTD in the future.
Please refer to Section 4.3 of the "LXI Event Messaging Extended Function" specification for more
details.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment