From f5974568bb15027c0a654c4ac6515840811124f6 Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Thu, 7 Oct 2021 23:25:10 +0200
Subject: [PATCH] L2SS-434: Added instructions for station-specific
configurations
---
docs/source/configure_station.rst | 40 +++++++++++++++++++++++++++++++
docs/source/index.rst | 1 +
docs/source/installation.rst | 2 ++
3 files changed, 43 insertions(+)
create mode 100644 docs/source/configure_station.rst
diff --git a/docs/source/configure_station.rst b/docs/source/configure_station.rst
new file mode 100644
index 000000000..f8e2049bb
--- /dev/null
+++ b/docs/source/configure_station.rst
@@ -0,0 +1,40 @@
+Enter your Station Configuration
+=====================================
+
+The software will need to be told various aspects of your station configuration, for example, the hostnames of the station hardware to control. The following settings are installation specific, and are stored as *properties* in the :ref:`tangodb`. The format used here is ``device.property``:
+
+:RECV.OPC_Server_Name: Hostname of RECVTR
+
+ :type: ``string``
+
+:UNB2.OPC_Server_Name: Hostname of UNB2TR
+
+ :type: ``string``
+
+:SDP.OPC_Server_Name: Hostname of SDPTR
+
+ :type: ``string``
+
+:SST.OPC_Server_Name: Hostname of SDPTR
+
+ :type: ``string``
+
+:SST.FPGA_sst_offload_hdr_eth_destination_mac_RW_default: MAC address of the network interface on the host running this software stack, on which the SSTs are to be received. This network interface must be capable of receiving Jumbo (MTU=9000) frames.
+
+ :type: ``string[N_fpgas]``
+
+:SST.FPGA_sst_offload_hdr_ip_destination_address_RW_default: IP address of the network interface on the host running this software stack, on which the SSTs are to be received.
+
+ :type: ``string[N_fpgas]``
+
+:XST.OPC_Server_Name: Hostname of SDPTR
+
+ :type: ``string``
+
+:XST.FPGA_xst_offload_hdr_eth_destination_mac_RW_default: MAC address of the network interface on the host running this software stack, on which the XSTs are to be received. This network interface must be capable of receiving Jumbo (MTU=9000) frames.
+
+ :type: ``string[N_fpgas]``
+
+:XST.FPGA_xst_offload_hdr_ip_destination_address_RW_default: IP address of the network interface on the host running this software stack, on which the XSTs are to be received.
+
+ :type: ``string[N_fpgas]``
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 0f3d3488c..97640a9b7 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -21,6 +21,7 @@ Even without having access to any LOFAR2.0 hardware, you can install the full st
devices/using
devices/devices
devices/configure
+ configure_station
Indices and tables
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
index 40cfa5402..d0f4d3331 100644
--- a/docs/source/installation.rst
+++ b/docs/source/installation.rst
@@ -26,6 +26,8 @@ If you lack access to LOFAR station hardware, load additional configurations to
../sbin/update_ConfigDb.sh ../CDB${sim}-config.json
done
+If you do have access to LOFAR station hardware, you will have to :doc:`configure_station`.
+
Now we are ready to start the other containers::
make start
--
GitLab