Document update

epics/README.md

@@ -1,4 +1,5 @@
 # New ISTTOK Slow Control System
+
 ## Intro
 
 The new ISTTOK slow control system is designed to replace the former vacuum/power/slow timing system based is the EDWARDS controller.
@@ -12,58 +13,80 @@ At the present the software are installed in two IOC servers with the exception
 All software stored in IPFN GIT [server](https://git.ipfn.tecnico.ulisboa.pt/summary/ISTTOK.git)
 
 ## Team and responsabilities
-- **Horácio Fernandes** (ISTTOK Leader)
+
-- **Bernardo Carvalho** (Project Leader)
+* **Horácio Fernandes** (ISTTOK Leader)
-- **Humberto Figueiredo** (ISTTOK Session Leader)
+
-- **Hugo Alves** (ISTTOK Session Leader, State Machine development)
+* **Bernardo Carvalho** (Project Leader)
-- **Tiago Pereira** (dsPIC development, RS232 protocol/ Sensor Interface/ Wiring)
+
+* **Humberto Figueiredo** (ISTTOK Session Leader)
+
+* **Hugo Alves** (ISTTOK Session Leader, State Machine development)
+
+* **Tiago Pereira** (dsPIC development, RS232 protocol/ Sensor Interface/ Wiring)
 
 ## System description
+
 Presently there are two/three instances of EPICS IOC Server implemented.
 One responsible for the Temperature Node.
 And a second one, installed in a Raspberry Pi, implemented in the new control unit launched at ISTTOK for the remote control of the vacuum pumps, named Central Node.
 A third one is dedicated for readind the Vacuum Sensore through the RS484 Interface
 
 ### Temperature/Vacuum Node: Temperature Sensors and ELCO Voltage Measurement Systems
-- Thermocouple Sensor
+
-- ELCO voltage measurement
+* Thermocouple Sensor
-- For communication was used a fiber optic
+
+* ELCO voltage measurement
+
+* For communication was used a fiber optic
 
 The dsPic uses the internal ADC to read the voltage signal from the thermocouple.
 To measure the ELCO's voltage it was developed two boards one to read the ELCO's voltage and another to connect the fiber optic to dsPIC.
 
-
 #### Hardware Platform
-- Thermocouple Sensor
+
-- ELCO voltage measurement
+* Thermocouple Sensor
+
+* ELCO voltage measurement
 
 1. One PC Controller
 
 * Intel(R) Atom(TM) CPU330 1.60GHz, Dual Core, 1 Gbyte RAM, 4 RAM
+
 * 4 Serial Ports
+
 * IP addr: 192.168.1.152 ( ISTTOK private network)
+
 * Scientific [Linux CERN 6](http://linux.web.cern.ch/linux/scientific6) (SLC6)
   with MRG Realtime extensions
-  *Linux kernel 3.2.33-rt50.66.el6rt.x86_64
+  \*Linux kernel 3.2.33-rt50.66.el6rt.x86_64
+
 * NTP time conected to  IPFN Gps NTP/PPS server IP:10.136.236.255 and
   baco.ipfn.tecnico.ulisboa.pt (193.136.136.129)
 
-2. Local Control
+1. Local Control
+
 * One or more dsPic board running an embedded firmware
 
 Temperature Sensors and ELCO Voltage Measurement Systems
-   -For communication was used a fiber optic
+\-For communication was used a fiber optic
 
 The dsPic uses the internal ADC to read the voltage signal from the thermocouple.
 To measure the ELCO's voltage it was developed two boards one to read the ELCO's voltage and another to connect the fiber optic to dsPIC.
 
 #### Protocol for communication between dspics and PC
+
 * all bytes are readable ASCII
-   * all messages all terminated with two bytes: \r\n (13 10)
+
+* all messages all terminated with two bytes: \\r\\n (13 10)
+
 * messages have variable length
+
 * framing character for fields inside message is space (32)
+
 * individual fields inside each message have variable length
+
 * the last three characters before the terminator are the ASCII representation of the checksum of all other bytes, excluding the terminator
+
 * Messages are sent periodically (1s)
 
 Examples:
@@ -86,16 +109,27 @@ Table of word fields
 #### Software Platform
 
 1. EPICS V3.15.7 (instaled in `/opt/epics/base-3.15.7`)
+
    * IOC sources  (versioned) in `/home/codac-dev/ISTTOK/epics/iocs/ISTTOKdsPIC`
+
    * IOC binaries in `/opt/epics/apps/ISTTOK`
+
    * Init IOC script in `/etc/rc.local`
+
 2. Modules ( (instaled in `/opt/epics/modules`)
+
    * ASYN [git package](https://github.com/epics-modules/asyn.git)
+
    * STREAM [git](https://github.com/paulscherrerinstitute/StreamDevice.git)
+
 3. CS-Studio
-   * Archive [Engine] (http://cs-studio.sourceforge.net/docbook/ch11.html)
+
+   * Archive \[Engine\] (http://cs-studio.sourceforge.net/docbook/ch11.html)
+
    * Init script in `/etc/init.d/isttok-archive-engine`
+
    * MySQL server (user: report )
+
    * ArchiveConfigTool in `/home/bernardo/css/ArchiveConfigTool`
 
 Process Value in this IOC Server:
@@ -110,45 +144,70 @@ Process Value in this IOC Server:
 |ISTTOK:temperature:Temperature_3   |ai | no |
 |ISTTOK:temperature:Capbank_Voltage |   ai| no |
 |ISTTOK:temperature:VVessel-Temperature  | ai | yes |
-----------
+
+---
 
 ### Central Control/Vacuum Node
-- Vacuum Sensors
+
--  Pffeifer rotatory vacuum pumpa (*RPump1*)
+* Vacuum Sensors
-- Edwards electro valve
+
-- Seiko Seiki turbomolecular pump and control unit (model SCU-400)
+* Pffeifer rotatory vacuum pumpa (*RPump1*)
-- Main State Machine, see [source](https://git.ipfn.tecnico.ulisboa.pt/blob/ISTTOK.git/master/epics%2Fiocs%2FISTTOKrpi%2FISTTOKrpiApp%2Fsrc%2FIsttokSeqExec.stt)
+
+* Edwards electro valve
+
+* Seiko Seiki turbomolecular pump and control unit (model SCU-400)
+
+* Main State Machine, see [source](https://git.ipfn.tecnico.ulisboa.pt/blob/ISTTOK.git/master/epics%2Fiocs%2FISTTOKrpi%2FISTTOKrpiApp%2Fsrc%2FIsttokSeqExec.stt)
 
 #### Hardware Platform
+
 1. A Raspberry Pi  running a linux distribution..
+
 * Raspberry Pi 2 Model B Rev 1.1 hardware. `# cat /proc/cpuinfo | grep Model`
+
 * Has a USB/RS485 port for monitoring pressure (to be connected soon)
-2. Two Interface Boards, Velleman Model [k8000](https://www.velleman.eu/products/view/?id=9383)..
+
+1. Two Interface Boards, Velleman Model [k8000](https://www.velleman.eu/products/view/?id=9383)..
+
 * connected to raspberry Pi through I2C interface;
+
 * 8 isolated output connected to the relays (6 relays installed for the rotatory control)
+
 * 4 isolated outputs connected to SEIKO unit controller
+
 * Indicator leds for the relays in the front panel
+
 * 24 V power supply
 
 #### Software Platform
-[//]: # (This may be the most platform independent comment)
 
 1. Linux Raspian "Stretch"  (user :pi):
+
 * IP addr:192.168.1.110 ( ISTTOK private network)
+
 * NTP/timedatectl time conected to  IPFN Gps NTP/PPS server IP:10.136.227.237 193.136.136.129
   (this is mandatory, Rpi does not have a Real Time clock    see https://www.raspberrypi.org/forums/viewtopic.php?t=178763)
+
 * EPICS v7 base-7.0 from epics [github](https://github.com/epics-base)
+
   * (in /home/pi/Apps/epics7/epics-base) including modules:
+
   * asynDriver [asyn](https://github.com/epics-modules/asyn)
+
   * [StreamDevice](https://paulscherrerinstitute.github.io/StreamDevice)
+
   * State Notation Language and Sequence v.2.2 [seq](https://www-csr.bessy.de/control/SoftDist/sequencer)
+
   * [autosave](https://github.com/epics-modules/autosave)
+
   * IOC installed in '/home/pi/ISTTOK/epics/iocs/ISTTOKrpi'
+
     * Running in `screen deamon` (see `/etc/rc.local`)
 
 For installation EPICS in Linux/raspian see this [link](https://docs.epics-controls.org/projects/how-tos/en/latest/getting-started/installation.html)
 
 #### Process Variables
+
 Process Variables in this IOC Server:
 
 * State machine PVs
@@ -168,7 +227,8 @@ Process Variables in this IOC Server:
 |ISTTOK:central:CurrentTime |   stringin    |   no |
 |ISTTOK:central:TraceMessage |  stringout   |   yes |
 |ISTTOK:central:LogMessage |    stringout   |   yes |
-----------
+
+---
 
 * Connected to PCF8574 I2C Address = 56 (Bottom Valleman)
 
@@ -182,7 +242,8 @@ Process Variables in this IOC Server:
 |ISTTOK:central:TMPump1-Acceleration | bi | 5 |
 |ISTTOK:central:TMPump1-Emergency | bi | 6 |
 |ISTTOK:central:TMPump1-NormalOperation | bi | 7 |
-----------
+
+---
 
 * Connected to PCF8574 I2C Address = 57 (Bottom Valleman board)
 
@@ -193,7 +254,8 @@ Process Variables in this IOC Server:
 |ISTTOK:central:TMPump2-MotorOn | bo | 2 |
 |ISTTOK:central:Emergency-PhysButton| bi | 4 |
 |ISTTOK:central:TTSystem-tzero| bi | 7 |
-----------
+
+---
 
 * Connected to PCF8574 Address = 60 (Top Valleman Board)
 
@@ -204,8 +266,8 @@ Process Variables in this IOC Server:
 |ISTTOK:central:RPump2-Motor (Not Used/Disabled)| bo | 2 | |
 |ISTTOK:central:RPump2-Valve (Not Used/Disabled| bo | 3 | |
 |ISTTOK:central:VVessel-Filament| bo | 4 | 1 / NO|
-----------
 
+---
 
 * Connected to TDA8444 DAC  @ address 0x20=d32  (Bottom Valleman Board)
 
@@ -217,7 +279,8 @@ Process Variables in this IOC Server:
 | ISTTOK:central:TDA8444:32:DAC_CH3| longout | no |
 | ISTTOK:central:TDA8444:32:DAC_CH5| longout | no |
 | ISTTOK:central:TDA8444:32:DAC_CH6| longout | no |
-----------
+
+---
 
 * Connected to PCF8591  ADC  / DAC register @ address 0x48=d72
 
@@ -226,7 +289,8 @@ Process Variables in this IOC Server:
 | ISTTOK:central:TMPump2-Speed| ai | ch1 | no |
 | ISTTOK:central:TMPump2-Current| ai | ch2 | no |
 | ISTTOK:central:Shot-TorPSCurrentImage"| ai | ch3 | no |
-----------
+
+---
 
 * Connected to RS485 Bus (Using USB */dev/ttyUSB0*)
 
@@ -236,7 +300,8 @@ Process Variables in this IOC Server:
 |ISTTOK:central:RPump1-Pressure | ai | yes | out "0020074002=?107" |
 |ISTTOK:central:RPump2-Pressure (Disabled)  | ai | yes | |
 |ISTTOK:central:TMPump1-PressureAdmission | ai | yes | out "0030074002=?108" |
-----------
+
+---
 
 * Connected to [Seeeduino](https://wiki.seeedstudio.com/Grove-4-Channel_SPDT_Relay) Grove - 4-Channel
   SPDT Relay  Address = 17
@@ -257,7 +322,6 @@ SPDT Relay  Address = 17
 |ISTTOK:central:CapBank-Charge| bo | 2 | Relay NO/NC|
 |ISTTOK:central:Buzzer| bo | 3 | Relay NO/NC|
 
-
 * Connected to Seeeduino- 4-Channel SPDT Relay  Address = 19
 
 |PV Name    | PV Type   | Bit | Relay NO/NC|
@@ -265,15 +329,18 @@ SPDT Relay  Address = 17
 | ISTTOK:central:Shot-TorPSDisable| bo | 0 | NO |
 | ISTTOK:central:Lab-WarningLight| bo |1 | NO |
 
-
 ### Vacuum Node (**Not used, backup server only**)
-- Vacuum Pfeiffer Sensors (RS485)
+
+* Vacuum Pfeiffer Sensors (RS485)
 
 #### Hardware Platform
+
 1. A Raspberry Pi 2, running a raspian Buster distribution..
+
 * Has a USB/RS485 interface for monitoring pressure sensors
 
 #### Process Variables
+
 Process Variables in this IOC Server:
 
 * Connected to RS485 Bus
@@ -284,45 +351,64 @@ Process Variables in this IOC Server:
 |ISTTOK:vacuum:RPump2-Pressure (not used)  | ai | yes |
 |ISTTOK:vacuum:TMPump1-PressureAdmission  (not used)| ai | yes |
 |ISTTOK:vacuum:VVessel-Pressure   (not used) | ai | yes |
-----------
+
+---
 
 #### Software Platform
-[//]: # (This may be the most platform independent comment)
 
 1. Linux Raspian "buster"  (user :pi):
+
 * IP addr: 192.168.1.120 ( ISTTOK private network)
+
 * NTP/timedatectl time conected to  IPFN Gps NTP/PPS server IP:10.136.227.237 193.136.136.129
   (this is mandatory, Rpi does not have a Real Time clock    see https://www.raspberrypi.org/forums/viewtopic.php?t=178763)
-  * EPICS 7. To install follow [EPICS Docs](https://docs.epics-controls.org/projects/how-tos/en/latest/getting-started/installation.html) 
 
+* EPICS 7. To install follow [EPICS Docs](https://docs.epics-controls.org/projects/how-tos/en/latest/getting-started/installation.html)
 
 ## Download and configure CS-Studio
 
 * Install  JAVA JDK (version Java SE Development Kit 8) or
   openjdk-8-jre linux package
+
 * Download ISTTOK EPICS Files to a working folder
+
   * `git clone https://bernardo@git.ipfn.tecnico.ulisboa.pt/r/ISTTOK.git`
+
 * Goto site [CS-Studio](http://download.controlsystemstudio.org/release/4.5/) and download latest version to your OS
+
 * Uncompress folder
+
 * Run `cs-studio` executable
+
   * Choose a workplace folder
+
 * Goto to Menu EDIT->Preferences->CSS Core->Data Sources->Channel Access
+
   * On Address List replace `localhost` with `epics.ipfn.tecnico.ulisboa.pt`
+
   * Uncheck `Auto Address List`
+
   * Restart CS-Studio
+
 * Run File -> Import -> General-> Projects from folder
+
   * point to cloned folder
+
 * Navigate to `ISTTOK/epics/css/sys-mng-opi/CSS`
+
   * Open `SystemManagerIsttok.opi` with "OPI Display"
 
-
 ### EPICS Channel Access Configuration
-```
+
     export EPICS_CA_ADDR_LIST="192.168.1.110 192.168.1.152"
     export EPICS_CA_AUTO_ADDR_LIST="NO"
-```
+
+EPICS TOMCAT Channel Access
+
+http://epics.ipfn.tecnico.ulisboa.pt:8080/dbwr/view.jsp?display=http://localhost/displays/isttok.bob
 
 ### References
+
 *"EPICS IOC module development and implementation for the ISTTOK machine subsystem operation and control"*
 Paulo Carvalho, André Duarte, Tiago Pereira, Bernardo Carvalho, Jorge Sousa, Horácio Fernandes, Carlos Correia, Bruno Gonçalves, Carlos Varandas