Files
slsDetectorPackage/docs/src/servers.rst
Dhanya Thattil 297c3752e3 Dev/remove gotthard i (#1108)
* slsSupportLib done, at receiver rooting out in implementation

* removed from receiver and client

* removed everywhere except gui, python and client(commands.yaml and Detector.h)

* updated python

* fixed autocomplete to print what the issue is if there is one with ToString when running the autocomplete script to generate fixed.json. updated readme.md in generator folder

* formatting

* removed enums for dacs

* udpating autocomplete and generating commands

* removed gotthard from docs and release notes

* removed dac test

* bug from removing g1

* fixed virtual test for xilinx, was minor. so in this PR

* gui done

* binary in merge fix

* formatting and removing enums

* updated fixed and dump.json

* bash autocomplete

* updated doc on command line generation

* removing increments in dac enums for backward compatibility. Not required

* removed ROI from rxParameters  (only in g1), not needed to be backward compatible

* removed the phase shift option from det server staruip
2025-03-10 14:24:33 +01:00

2.9 KiB

Getting Started

Detector Servers include:
  • Control server [default port: 1952]
    • Almost all client communication.
  • Stop server [default port: 1953]
    • Client requests for detector status, stop acquisition, temperature, advanced read/write registers.

When using a blocking acquire command (sls_detector_acquire or Detector::acquire), the control server is blocked until end of acquisition. However, stop server commands could be used in parallel.

Location

slsDetectorPackage/serverBin/ folder in every release.

Arguments

Possible arguments are:
   -v, --version            : Software version
   -p, --port <port>        : TCP communication port with client. 
   -g, --nomodule           : [Mythen3][Gotthard2] 
                              Generic or No Module mode. Skips detector type checks. 
   -d, --devel              : Developer mode. Skips firmware checks. 
   -u, --update             : Update mode. Skips firmware checks and initial detector setup. 
   -i, --ignore-config      : [Eiger][Jungfrau][Gotthard2][Moench] 
                              Ignore config file. 
   -m, --master <master>    : [Eiger][Mythen3][Gotthard2] 
                              Set Master to 0 or 1. Precedence over config file. Only for virtual servers except Eiger. 
   -t, --top <top>          : [Eiger] Set Top to 0 or 1. Precedence over config file. 
   -s, --stopserver         : Stop server. Do not use as it is created by control server 

Automatic start

One can start the on-board detector server automatically upon powering on the board.

  1. Create a soft link to the binary on board:
    ln -sf someDetectorServervx.x.x someDetectorServer
  2. Do the following depending on the detector type :
    Eiger
    # create script in rc5.d on the board
    vi /etc/rc5.d/S50board_com.sh
    
    # enter the following (edit server name)
    #! /bin/sh
    /home/root/executables/eigerDetectorServer &> /dev/null &
    exit 0
    Jungfrau | Moench | CTB
    # Edit inittab on board
    vi /etc/inittab
    
    # enter the following line
    ttyS0::respawn:/./xxxDetectorServer
    Gotthard II | Mythen III
    # create script in init.d on board
    vi /etc/init.d/S99detServer.sh
    
    # enter the following (edit server name)
    #! /bin/sh
    cd /root >> /dev/null
    /root/xxxDetectorServer >> /dev/null &
  3. Sync, reboot and verify:
    sync
    
    # physically reboot for Gotthard II or Mythen III
    reboot
    
    # verify
    ps -ef | grep xxxDetectorServer