From 24435040e147a4df190ae42aa2f1b1f5044bc5b3 Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Mon, 12 Oct 2015 15:29:47 +0200 Subject: [PATCH] added missing example configurations to other node types --- documentation/clients/GTFPGA.md | 10 +++++++++- documentation/clients/OPAL.md | 12 ++++++++++++ documentation/clients/Socket.md | 18 +++++++++++++++++- 3 files changed, 38 insertions(+), 2 deletions(-) diff --git a/documentation/clients/GTFPGA.md b/documentation/clients/GTFPGA.md index 1a5db6722..9eda5944c 100644 --- a/documentation/clients/GTFPGA.md +++ b/documentation/clients/GTFPGA.md @@ -20,5 +20,13 @@ Every `gtfpga` node support the following special settings: ### Example -@todo Add excerpt from example.conf + gtfpga_node = { + type = "gtfpga", + + ### The following settings are specific to the gtfpga node-type!! ### + slot = "01:00.0", # The PCIe slot location (see first column in 'lspci' output) + id = "1ab8:4005", # The PCIe vendor:device ID (see third column in 'lspci -n' output) + + rate = 1 + } diff --git a/documentation/clients/OPAL.md b/documentation/clients/OPAL.md index e115f38f5..692019ad9 100644 --- a/documentation/clients/OPAL.md +++ b/documentation/clients/OPAL.md @@ -15,6 +15,18 @@ Every `opal` node supports the following special settings: #### `reply` *(boolean)* +### Example + + opal_node = { # The server can be started as an Asynchronous process + type = "opal", # from within an OPAL-RT model. + + ### The following settings are specific to the opal node-type!! ### + + send_id = 1, # It's possible to have multiple send / recv Icons per model + recv_id = 1, # Specify the ID here. + reply = true + } + ## Arguments for OPAL-RT block RT-LAB already provides a block to establish simple TCP/IP communication: ??? diff --git a/documentation/clients/Socket.md b/documentation/clients/Socket.md index 2748cb0e8..4d7817a72 100644 --- a/documentation/clients/Socket.md +++ b/documentation/clients/Socket.md @@ -27,7 +27,23 @@ Every `socket` node supports the following special settings: ### Example -@todo Add excerpt from example.conf + udp_node = { # The dictionary is indexed by the name of the node. + type = "socket", # Type can be one of: socket, opal, file, gtfpga, ngsi + # Start the server without arguments for a list of supported node types. + + ### The following settings are specific to the socket node-type!! ### + + layer = "udp" # Layer can be one of: + # udp Send / recv UDP packets + # ip Send / recv IP packets + # eth Send / recv raw Ethernet frames (IEEE802.3) + + + local = "127.0.0.1:12001", # This node only received messages on this IP:Port pair + remote = "127.0.0.1:12000" # This node sents outgoing messages to this IP:Port pair + + combine = 30 # Receive and sent 30 samples per message (multiplexing). + } ## Packet Format