Skip to content
Snippets Groups Projects
Commit eed88d87 authored by Jan David Mol's avatar Jan David Mol
Browse files

L2SS-434: Added instructions for station-specific configurations

parent f5974568
No related branches found
No related tags found
1 merge request!150L2SS-434: Add sphinx documentation content
......@@ -3,19 +3,24 @@ 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
Mandatory settings
-------------------
Without these settings, you will not obtain the associated functionality:
:RECV.OPC_Server_Name: Hostname of RECVTR.
:type: ``string``
:UNB2.OPC_Server_Name: Hostname of UNB2TR
:UNB2.OPC_Server_Name: Hostname of UNB2TR.
:type: ``string``
:SDP.OPC_Server_Name: Hostname of SDPTR
:SDP.OPC_Server_Name: Hostname of SDPTR.
:type: ``string``
:SST.OPC_Server_Name: Hostname of SDPTR
:SST.OPC_Server_Name: Hostname of SDPTR.
:type: ``string``
......@@ -27,7 +32,7 @@ The software will need to be told various aspects of your station configuration,
:type: ``string[N_fpgas]``
:XST.OPC_Server_Name: Hostname of SDPTR
:XST.OPC_Server_Name: Hostname of SDPTR.
:type: ``string``
......@@ -38,3 +43,28 @@ The software will need to be told various aspects of your station configuration,
: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]``
Optional settings
-------------------
These settings make life nicer, but are not strictly necessary to get your software up and running:
:RECV.Ant_mask_RW_default: Which antennas are installed.
:type: ``bool[N_RCUs][N_antennas_per_RCU]``
:SDP.RCU_mask_RW_default: Which RCUs are installed.
:type: ``bool[N_RCUs]``
:UNB2.UNB2_mask_RW_default: Which Uniboard2s are installed in SDP.
:type: ``bool[N_unb]``
:SDP.TR_fpga_mask_RW_default: Which FPGAs are installed in SDP.
:type: ``bool[N_fpgas]``
:SDP.FPGA_sdp_info_station_id_RW_default: Numeric identifier for this station.
:type: ``uint32[N_fpgas]``
......@@ -57,9 +57,9 @@ The ``recv == DeviceProxy("LTS/RECV/1")`` device controls the RCUs, the LBA ante
:Ant_mask_RW: Controls which antennas will actually be configured when attributes referring to antennas are written.
:type: ``bool[N_RCUs][N_Antennas_per_RCU]``
:type: ``bool[N_RCUs][N_antennas_per_RCU]``
Typically, ``N_RCUs == 32``, and ``N_Antennas_per_RCU == 3``.
Typically, ``N_RCUs == 32``, and ``N_antennas_per_RCU == 3``.
SDP
-----------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment