HadCon2 Apfel Controls

Introduction

This projects objective is the control of the slow control parameters of an APFEL ASIC with the HadCon2 controller board, which itself could be connected to a computer (here a Raspberry Pi (1) Model B) running an EPICS IOC. The EPICS IOCs data are visualized using the Control System Studio CSS.

Thus the project comprises

• The implementation of the APFEL specific procotol on HadCon2's AVR
• The implementation of an APFEL specific API command on HadCon2's AVR
• The implementation of the EPICS IOC able to access the HadCon2's APFEL API command
• The implementation of an CSS based GUI set to operate the APFEL
• optional: the preparation of a Raspberry Pi Image

Sources

APFEL Controls git repository with git submodules:

• https://git.gsi.de/HadCon2/Applications/APFEL/APFEL_Hadcon
  • HadCon2 APFEL µC
  • EPICS "APFEL" IOC
  • CSS GUI

alternatively: the single repositories

• HadCon2 APFEL µC (branch: APFEL )
  • https://git.gsi.de/HadCon2/Firmware/HadCon2/tree/APFEL
• EPICS "APFEL" IOC
  • https://git.gsi.de/HadCon2/Applications/APFEL/APFEL_Hadcon_IOC
• CSS GUI
  • https://git.gsi.de/HadCon2/Applications/APFEL/APFEL_Hadcon_CSS

Raspberry Pi Image, 3GB,

• https://sf.gsi.de/d/215c097937/
  • contains complete EPICS installation (user:panda (normal) and epics (sudo))
  • needs updates via git for EPICS IOC
  • includes crontab and procServ support for the EPICS IOC

Documentation

Setup

HadCon2 + Raspi + Apfel connection

ApfelHadCon2 Connection

Apfelmatrix STL

Apfelmatrix

Apfel Apd

Apfel + Apfelmatrix

---

APFEL Asic

• → APFEL

---

HadCon2

→ HadCon2
→ HadCon2MultipurposeControlsApi

HadCon2 Multipurpose Controls Protocol

→ HadCon2MultipurposeControlsProtocol

APFEL command

General Operation Principles and Physical Layout

The APFEL command set allows to talk to (several instances of) the APFEL ASIC. It uses a subset of the the I/O-Ports of the ATMEL μController to facilitate the communication to the proprietary protocol (q.v.Decoder.pdf) of the asic, sending a 22bit sequence for command, value, and chipId. ( → Apfel protocol code sequences)
• Logically
  • Output:
    • CLK
      • quasi clock, only the level changes are important
    • DOUT
      • data out
    • Side Select
      • position
  • Input:
    • DIN
      • data in
  • GND
• Electrical:
  • 3.3 Volt
• Physically:
  • per default:
    • JDINOUT1/2, JADC
      • I/O ports:
        

        I/O port	A		C		F
        Connector	JDINOUT1		JDINOUT2		JADC
        pins	DIN1	1	DIN1	1	DIN1	1
        	DOUT1	2	DOUT1	2	DOUT1	2
        	CLK1	3	CLK1	3	CLK1	3
        	SS1	4	SS1	4	SS1	4
        	DIN2	5	DIN2	5	DIN2	5
        	DOUT2	6	DOUT2	6	DOUT2	6
        	CLK2	7	CLK2	7	CLK2	7
        	SS2	8	SS2	8	SS2	8

---

more see:
• → HadCon2MultipurposeControlsProtocolCmndApfel
• → HadConMultipurposeControlsProtocolCmndApfelDetailsOfTheProtocol

---

---

---

EPICS IOC

• https://git.gsi.de/HadCon2/Applications/APFEL/APFEL_Hadcon_IOC

---

CSS GUI

• https://git.gsi.de/HadCon2/Applications/APFEL/APFEL_Hadcon_CSS

---

Installation

HadCon2 + Firmware

• usually already done, see → HadCon2MultipurposeControlsApi for more informations on additional hardware (JTAG) requirements

---

Computer + EPICS IOC

1. requires installation of EPICS Base 3.14.12.4 (or higher) and streamDevice module, optional but recommended procServ
2. Get IOC code from github: https://git.gsi.de/HadCon2/Applications/APFEL/APFEL_Hadcon_IOC
   git clone https://git.gsi.de/HadCon2/Applications/APFEL/APFEL_Hadcon_IOC
3. and change to protocol_v0 branch
   
   git checkout protocol_v0
4. cd TOP directory
   
   cd APFEL_Hadcon_IOC
5. adjust RELEASE files in sub directory configure, i.e. correct paths to EPICS base and modules * be aware, that you might have to change instead RELEASE.linux-arm.Common RELEASE.linux-x86_64.Common, which are included in RELEASE, but allows several architectures to be supported
6. make
   
   make
7. Depending on your target architecture
   
   cd iocBoot/iocapfel
   or
   cd iocBoot/iocapfel_linux-x86_64
8. Start IOC:
   1. Manually start IOC:
      
      ../../bin/linux-arm/apfel st.cmd
      and you must not background 'bg' this process, better use procServ
   2. procServ:
      • needs procServ installed
      1. edit <TOP>/startup/procServ/start_apfel_IOC_procServ.sh and change myIOCBOOT and myARCH to your needs
      2. call procServ:
         
         procServ -q -n apfelControlIOC -l 4814 4813 <absolute path to TOP>/procServ/start_apfel_IOC_procServ.sh
      3. the EPICS IOC runs now inside the procServ environment:
         1. login:
            telnet localhost 4813
            (4814: read-only)
            • type CTRL+T to toggle automatic restart
            • type CTRL+X to kill child process (IOC)
            • type exit to end the EPICS session 2. leave session: type CTRL+] and
              telnet> quit
   3. crontab + procServ
      • to restart automatically 60 seconds after reboot use crontab features
      1. edit <TOP>/startup/crontab/start_procServ_EPICS_apfel.sh and adjust myProcServScript to your needs
      2. to simplify: create a directory and softlink at your home directory, e.g.
         
         mkdir -p ~/crontab/ && ln -s <TOP>/startup/crontab/start_procServ_EPICS_apfel.sh
      3. add the content of <TOP>/startup/crontab/crontab.entry to your crontab:
         (just a help xclip: puts the content to the clipboard)
         cat <TOP>/startup/crontab/start_procServ_EPICS_apfel.sh | xclip -sel clip && crontab -e
      4. reboot or start IOC via procServ only.

---

CS-Studio

• the GUI is based on CSS 3.2.16 doesn't matter if Windows / Linux / MAC
1. Download CSS 3.2.16 and open a new workspace
2. Install Apfel HadCon Control GUIs
   1. open perspective GIT Repository Exploring
      
      
   2. Clone git repository
      
      1. Enter URI: https://git.gsi.de/HadCon2/Applications/APFEL/APFEL_Hadcon_CSS==
         
          and click ==NEXT
      2. Get all Branches
         
         and click NEXT
      3. Set Initial Branch to v2.1
         
         and click FINISH
   3. Import Project
      1. choose Import Projects from __Working Directory__'s context menu
         
         
      2. choose __Import existing projects__
         
         
      3. select Apfel
         
         
      4. 
         
         
   4. Import Preferences
      1. In settings/ you find the file apfel-basic-preferences.epf, right click to get via Properties its physical Location and remember it.
         
         
      2. In the Navigator choose Import from the context menu
         
         
      3. Select __Preferences__
         
         
      4. and insert the Location you should have just remembered
         
         
      5. Restart CSS
   5. Start
      1. Open a new window
         
         
      2. Select open Perspectives and select OPI Runtime
         
         
      3. By clicking the Top Files button:
         
         
      4. You should get the Main Controls Window: (Press F8 for compact mode)
         
         

---

-- PeterZumbruch - 2017-05-29