https://pct.wiki.uib.no/api.php?action=feedcontributions&feedformat=atom&user=Hbi009pCT - User contributions [en]2026-05-25T04:26:42ZUser contributionsMediaWiki 1.44.2https://pct.wiki.uib.no/index.php?title=Using_IPbus&diff=952Using IPbus2021-09-24T14:22:00Z<p>Hbi009: /* Adding paths to envirorment */</p>
<hr />
<div>[[Main Page]] -> [[Control & Readout Software Documentation and Howto's]] -> [[Using IPbus]]<br />
<br />
== Use case ==<br />
IPbus is a control protocol that uses UDP/IP to send values into the registers on the readout unit (RU). The software on the host computer uses the Hardware Access Library (uHAL) to send the commands to the RU. <br />
[[File:ipbus-conect6.png|750px]]<br />
<br />
<br />
== Configuration files ==<br />
There is a main connection file (pRU-connections.xml), this file contains the address and port of the RU, for information on the content of the connection file please see the [[:Media:PRU Ethernet Configurations.pdf | pRU Ethernet Configurations]] document.<br />
<br />
Following there is a Module registers file (module-address.xml), this file contains a table with all the registers present in the RU.<br />
<br />
Finally, there are files for each register<br />
* global_regs.xml<br />
* trigger_manager.xml<br />
* offload.xml<br />
* alpide_control.xml<br />
* alpide_data.xml<br />
<br />
As of the writing of this page, these files can be found on the production_test repository in the ipbus branch under the BSP folder.<br />
<br />
WARNING: To prevent undefined behavior the register files MUST match the firmware version!<br />
<br />
<br />
== Smart Dummy Hardware ==<br />
To be able to read values from registers, a custom DummyHardwareUdp.exe can be built from this repository:<br />
[https://github.com/norscope/ipbus-software/tree/smartdummy IPbus Custom Repo]<br />
NOTE: Remember to switch to the smartdummy branch.<br />
<br />
This adds a file reader in the DummyHardware.cpp that reads a file in the directory of the executable, the file is called register-values.txt, an example file can be found here: [[:Media:register-values.txt | Example file]]<br />
<br />
<br />
=== How to Build on Ubuntu 20.04 LTS ===<br />
==== Requierd packages ====<br />
<syntaxhighlight lang="bash"><br />
$ sudo apt update<br />
$ sudo apt install git g++ make erlang python3 python-is-python3 libboost1.71-all-dev libpugixml-dev<br />
</syntaxhighlight> <br />
<br />
==== Building ==== <br />
In the directory where the repository have been downloaded:<br />
<br />
<syntaxhighlight lang="bash"><br />
$ make<br />
$ sudo make install prefix=/home/user/ipbus-install<br />
</syntaxhighlight> <br />
<br />
==== Adding paths to envirorment ====<br />
<syntaxhighlight lang="bash"><br />
$ export LD_LIBRARY_PATH=/home/user/ipbus-install/lib:$LD_LIBRARY_PATH<br />
$ export PYTHONPATH=/home/user/ipbus-install/lib/python3.8/site-packages:$PYTHONPATH<br />
</syntaxhighlight><br />
<br />
==== Running the hardware emulator ==== <br />
Change directory to ipbus-install/bin/uhal/tests<br />
NOTE: Make sure the register-values.txt file is present in this folder. Filename is in all lowercase.<br />
<br />
<syntaxhighlight lang="bash"><br />
./DummyHardwareUdp.exe -p 50001 -v 2 -V<br />
</syntaxhighlight><br />
<br />
==== Testing the emulator ====<br />
From the production_test repo, in the folder tests_vcu118 run:<br />
<br />
<syntaxhighlight lang="bash"><br />
$ python test_ipbus_emulator.py <br />
</syntaxhighlight><br />
<br />
This should output 0xfeedbeef<br />
<br />
<br />
== Additonal information ==<br />
For more information, please consult the IPbus wiki at: [https://ipbus.web.cern.ch/ipbus/doc/user/html/software/uhalQuickTutorial.html IPbus wiki]</div>Hbi009