Skip to content

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

[doc] wip

parent e0b366cb
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 221 additions and 37 deletions
doc/basic_concepts.rst
View file @ 87509f75
......@@ -72,8 +72,8 @@ All other Event IDs are considered to refer to network :ref:`messages <message>`
.. _timestamp:
Timestamp
---------
Event Timestamp
---------------
Every :ref:`event` has an associated Timestamp.
......@@ -94,6 +94,16 @@ nanoseconds (where every "tick" represents 2\ :sup:`-16`\ ns).
be zero. A 32-bit seconds counter that was started on ``00:00:00 Thursday, 1 January 1970`` will
overflow on ``06:26:16 Sunday, 7 February 2106``.
.. _event_log:
Event Log
=========
The Event Log records information about all received and transmitted :ref:`Events <event>`, as well
as information regarding any discarded :ref:`event`, along with the reason for discarding it.
The Event Log has a limited storage buffer. Newer entries will overwrite older, unread ones.
.. _local_channel:
Local Channel
......
doc/usage_clib.rst
View file @ 87509f75
This diff is collapsed.
doc/usage_index.rst
View file @ 87509f75
......@@ -4,8 +4,14 @@
Usage
-----
There are three options offered for accessing a WRTD Node (in decreasing order of flexibility and complexity):
* By writing your own application using the provided :ref:`clib`.
* By writing your own application using the provided :ref:`pywrap`.
* By using the provided :ref:`tools`.
.. toctree::
:maxdepth: 2
:hidden:
usage_clib
usage_pywrap
......
software/lib/libwrtd.c
View file @ 87509f75
......@@ -734,7 +734,9 @@ wrtd_status wrtd_set_attr_string(wrtd_dev *wrtd,
* @param[in] id ID (#wrtd_attr) of concerned attribute.
* @param[in] value_buffer_size Size of pre-allocated `value` buffer.
* @param[out] value Retrieved attribute value.
* @return #wrtd_status. See also IVI-3.2, section 3.1.2.1.
* @return #wrtd_status. However, if the buffer size parameter is 0, then this function returns
* instead a positive value, indicating the minimum buffer size necessary to fit the full message.
* See also IVI-3.2, section 3.1.2.1.
*/
wrtd_status wrtd_get_attr_string(wrtd_dev *wrtd,
const char *rep_cap_id,
......@@ -983,7 +985,9 @@ wrtd_status wrtd_get_attr_tstamp(wrtd_dev *wrtd,
* @param[in] wrtd Device token.
* @param[in] log_entry_buffer_size Size of pre-allocated `log_entry` buffer.
* @param[out] log_entry Buffer to store the log message string.
* @return #wrtd_status. See also IVI-3.2, section 3.1.2.1.
* @return #wrtd_status. However, if the buffer size parameter is 0, then this function returns
* instead a positive value, indicating the minimum buffer size necessary to fit the full message.
* See also IVI-3.2, section 3.1.2.1.
*/
wrtd_status wrtd_get_next_event_log_entry(wrtd_dev *wrtd,
int32_t log_entry_buffer_size,
......
software/lib/libwrtd.h
View file @ 87509f75
......@@ -30,7 +30,7 @@ typedef enum wrtd_status {
/** No error. */
WRTD_SUCCESS = 0,
/** Same as *IVI_INHERENT_ERROR_BASE* */
/** Same as *IVI_INHERENT_ERROR_BASE*. */
__WRTD_ERROR_BASE = 0xBFFA0000,
/** Invalid/unknown attribute. */
WRTD_ERROR_INVALID_ATTRIBUTE = __WRTD_ERROR_BASE + 0x0C,
......@@ -55,25 +55,25 @@ typedef enum wrtd_status {
/** Incorrect repeated capability selector. */
WRTD_ERROR_BADLY_FORMED_SELECTOR = __WRTD_ERROR_BASE + 0x66,
/** Same as *IVI_LXISYNC_ERROR_BASE* */
/** Same as *IVI_LXISYNC_ERROR_BASE*. */
__WRTD_LXISYNC_ERROR_BASE = 0xBFFA3000,
/** The alarm already exists. */
WRTD_ERROR_ALARM_EXISTS = __WRTD_LXISYNC_ERROR_BASE + 0x07,
/** The specified alarm has not been defined. */
WRTD_ERROR_ALARM_DOES_NOT_EXIST = __WRTD_LXISYNC_ERROR_BASE + 0x08,
/** Same as *IVI_VENDOR_SPECIFIC_ERROR_BASE* */
/** Same as *IVI_VENDOR_SPECIFIC_ERROR_BASE*. */
__WRTD_SPECIFIC_ERROR_BASE = 0xBFFA6000,
/** Version mismatch */
/** Version mismatch. */
WRTD_ERROR_VERSION_MISMATCH = __WRTD_SPECIFIC_ERROR_BASE + 0x00,
/** Internal error */
/** Internal error. */
WRTD_ERROR_INTERNAL = __WRTD_SPECIFIC_ERROR_BASE + 0x01,
/** Unknown event log type/reason */
/** Unknown event log type/reason. */
WRTD_ERROR_UNKNOWN_LOG_TYPE = __WRTD_SPECIFIC_ERROR_BASE + 0x02,
/** Resource is not disabled and cannot be changed. */
WRTD_ERROR_RESOURCE_ACTIVE = __WRTD_SPECIFIC_ERROR_BASE + 0x03,
/** Attempt to access a global attribute without
using the global attribute selector */
using the global attribute selector. */
WRTD_ERROR_ATTR_GLOBAL = __WRTD_SPECIFIC_ERROR_BASE + 0x04,
/** The device has no more resources to allocate. */
WRTD_ERROR_OUT_OF_RESOURCES = __WRTD_SPECIFIC_ERROR_BASE + 0x05,
......@@ -82,7 +82,7 @@ typedef enum wrtd_status {
/** The specified rule has not been defined. */
WRTD_ERROR_RULE_DOES_NOT_EXIST = __WRTD_SPECIFIC_ERROR_BASE + 0x07,
/** always last entry in this enum */
/** Always last entry in this enum. */
__WRTD_ERROR_MAX_NUMBER,
} wrtd_status;
......
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