Skip to content

Commit 40ff8be

Browse files
pebondkostorr
authored andcommitted
Update README.md
1 parent 694743f commit 40ff8be

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@
44
ALF(Alice Low-level Frontend) spawns DIM services as an interface with detector FEEs(Front-End Electronics). The DIM services can be accessed through DCS's [FRED](https://gitlab.cern.ch/alialfred/FREDServer).
55

66
## Requirements
7-
In order to run ALF a DIM Nameserver has to be up and running.
7+
In order to run ALF a DIM Nameserver has to be up and running. For performance reasons, it is recommended to run the DIM Nameserver on the host running the FRED server.
88

99
## Usage
1010

1111
### o2-alf
1212
o2-alf is the binary of the ALF server. The only option it expects is the address of the DIM Nameserver. It can be passed either as a command-line argument or as an environmental variable.
1313

1414
`
15-
o2-alf --dim-dns-node thedimdns
15+
o2-alf --dim-dns-node thedimdns.cern.ch
1616
`
1717

1818
`
19-
DIM_DNS_NODE=thedimdns o2-alf
19+
DIM_DNS_NODE=thedimdns.cern.ch o2-alf
2020
`
2121

2222
### o2-alf-client
2323
o2-alf-client is the binary of an ALF client used solely for testing purposes. On top of the DIM Nameserver it expects the hostname of the node hosting the ALF server, the card's serial and the link number as command-line arguments.
2424

2525
`
26-
o2-alf-client --dim-dns-node thedimdns --alf-id thealfserver --serial 0 --link 4
26+
o2-alf-client --dim-dns-node thedimdns.cern.ch --alf-id thealfserver --serial 0 --link 4
2727
`
2828

2929
## Services
@@ -80,13 +80,13 @@ The services are DIM RPC services. Every RPC is called with a string and expects
8080
* Parameters:
8181
* Sequence of SWT word and operation pairs as follows:
8282
* Operations may be:
83-
* SWT word with `write`
84-
* `reset` (no SWT word)
85-
* `read` (no SWT word)
83+
* SWT word with suffix `,write`
84+
* `reset` (without SWT word)
85+
* `read` (without SWT word)
8686
* Returns:
8787
* Sequence of SWT output as follows:
8888
* `write` always retuns `0`
89-
* `read` returns an SWT word
89+
* `read` returns the SWT words present in the CRU SWT FIFO
9090
* `reset` returns nothing
9191

9292
* Example:
@@ -120,7 +120,3 @@ The services are DIM RPC services. Every RPC is called with a string and expects
120120
* Example:
121121
* DIM input `0x3\n`
122122
* DIM output ` `
123-
124-
#### Examples
125-
126-
Examples on making the RPC calls can be seen under [ProgramAlfClient.cxx](apps/ProgramAlfClient.cxx) and [AlfClient.h](src/AlfClient.h).

0 commit comments

Comments
 (0)