Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
W
White Rabbit Trigger Distribution
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Wiki
Wiki
image/svg+xml
Discourse
Discourse
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Projects
White Rabbit Trigger Distribution
Commits
e4d1d546
Commit
e4d1d546
authored
Jul 19, 2019
by
Dimitris Lampridis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[doc] various minor fixes
parent
1d3f43d3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
5 additions
and
5 deletions
+5
-5
basic_concepts.rst
doc/basic_concepts.rst
+2
-2
introduction.rst
doc/introduction.rst
+3
-2
usage_clib.rst
doc/usage_clib.rst
+0
-1
No files found.
doc/basic_concepts.rst
View file @
e4d1d546
...
...
@@ -34,7 +34,7 @@ Input Events can be either a :ref:`local_channel`, an inbound network :ref:`mess
Output Events can be either a :ref:`local_channel`, or an outbound network :ref:`message`.
An Event is essentially a combination of an :ref:`event_id` (the "what") and a :ref:`timestamp` (the
An Event is essentially a combination of an :ref:`event_id` (the "what") and a
n
:ref:`timestamp` (the
"when").
.. _event_id:
...
...
@@ -148,7 +148,7 @@ Each Message is transmitted as a single Ethernet frame, with a UDP header and a
The contents of a WRTD Event Message are again based on LXI Event Messages, with the "Domain" and
"Flag" fields (octets 3 and 36 respectively) fixed to zero.
Each Message contains an :ref:`event_id`, a :ref:`timestamp` and a sequence number. The latter is a
Each Message contains an :ref:`event_id`, a
n
:ref:`timestamp` and a sequence number. The latter is a
counter that gets increased by one every time a new Event is generated.
.. hint:: The sequence counter can be used to detect lost or duplicate Messages.
...
...
doc/introduction.rst
View file @
e4d1d546
...
...
@@ -112,8 +112,9 @@ order).
(:numref:`hw_dev`), gateware (:numref:`gw_dev`) and firmware (:numref:`fw_dev`).
* Before you embark however on a new design, please have a look first at the existing reference
designs. :numref:`ref_nodes` presents the currently available reference WRTD Nodes that come
pre-programmed with their gateware and firmware.
designs; it could be that one of them is appropriate for your task. :numref:`ref_nodes` presents
the currently available reference WRTD Nodes that come pre-programmed with their gateware and
firmware.
* Whether you develop your own Node or use one of the reference Nodes, :numref:`usage` describes how
to access and control your Node. :numref:`clib` provides all the details on how to use the C
...
...
doc/usage_clib.rst
View file @
e4d1d546
...
...
@@ -15,7 +15,6 @@ The following specifications are relevant to and used by WRTD:
* `LXI Core Specification`_
* `LXI Event Messaging Extended Function`_
The remainder of this section presents the provided API, split in
.. _api_error:
Error Handling API
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment