Installation Guide

This chapter is a guide for the installation of Software Devices in the VLT environments. It is built in 2 sections resp. for the WS and the LCU parts. The installation of the Software Device on the Workstation environment depends on the requirements, namely whether the database must be scanned from the LCU environment. In that case, the database shall contain the branch mirroring the LCU database branch for scanning.

It is assumed that the WS environment wsEnv  and LCU environment lcuEnv  have been successfully created and configured for lcuEnv  to report to wsEnv.

WS Environment

The configuration of the WS environment is made in 3 steps:

• Edit the file $VLTDATA/ENVIRONMENTS/wsEnv/dbl/DATABASE.db
  Add the following 2 lines outside any BEGIN ... END block:

  
        #define appDB_ROOT "<absolute path>"
        #include "app.db"
        

• Edit the file $VLTDATA/ENVIRONMENTS/wsEnv/dbl/Makefile
  Add the following directive:

  
        USER_INC = -I${INTROOT}/vw/include
        

• Generate the database, initiatialize and start the environment:

  
        > cd $VLTDATA/ENVIRONMENTS/wsEnv/dbl
        > make db
        > vccEnvInit -e wsEnv
        > vccEnvStart -e wsEnv
        >
        

LCU Environment

The configuration of the LCU environment is made in 4 steps:

• Edit the file $VLTDATA/ENVIRONMENTS/lcuEnv/dbl/DATABASE.db
  Add the following 2 lines outside any BEGIN ... END block:

  
        #define appDB_ROOT "<absolute path>"
        #include "app.db"
        

• Generate the database:

  
        > cd $VLTDATA/ENVIRONMENTS/lcuEnv/dbl
        > make db
        >
        

• Edit the file $VLTDATA/ENVIRONMENTS/lcuEnv/devicesFile
  1. Increment the number of devices in the line:

     
     <ATTRIBUTE>: deviceTable <TYPE>: Table <REC>: 0 - N <FIELDS>: 0 - 5
     	    

     where N  must be incremented
  2. Add the following entry:

     
     "app"  "appServer" 1 0 0 1
     	    

  
  IMPORTANT NOTE: Any Software Device that is to be controlled from another Software Device must not be registered in this list; the respect of this rule is essential for the system to behave correctly: since the standard commands are forwarded from the co-ordinating Software Device to the sub-ordinated ones, any standard command sent to LCC (process lccServer) would be forwarded to all the registered Software Devices found in this list, but as well from the co-ordinating Software Devices to the sub-ordinated ones resulting in non predictable effects.
  
  
• Configure the LCU bootScript and reboot the LCU:

  
        > vccConfigLcu lcuEnv &
        >
        

  In the LCU Configuration panel:
  1. Update the user module list that shall contain:
     lsf and app in this precedence order.
     For applications that do use motors, the module mcm must be added.
  2. Add the required driver devices,
  3. Add the process appServer.
  4. Click on the button Write Files to save the configuration
  5. Click on the button Reboot LCU to boot the LCU

Scan Links

After both environments have been successfully started, the scan links can be configured. Edit the file app/ws/config/app.scan to add all the links required by the application.

Example: 

> cd app/ws/config
> vi app.scan
 ...
> cd ../src
> make install
 ...
 . . . installation done
>
> scanLinks -f $INTROOT/config/app.scan -l wsEnv -e lcuEnv -c -E 
>

The WS database will now be kept aligned with the LCU database by means of the scan system. In particular, the module state and sub-state are updated on change (mode SRBX).

Verification

On the Workstation, invoke the panel appgui.

The fields State, Substate and Mode shall not be shaded (indication for bad data quality, hence scan troubles). They shall indicate LOADED (in Orange), IDLE (in Green) and NORMAL (in Green) resp.

Send the command VERSION.

The Software Device is ready for use, however it might be necessary to tune the configuration of the devices (e.g. motors or signals).

Database configuration

This last section is dedicated to the handling of the database configuration file of the application (app/ws/config/app.dbcfg).

As mentioned above, this file is generated by the utility lsfConfig(1). It contains then the minimum necessary configuration attributes for the software device to startup. After the tuning of the hardware has been completed, i.e. all devices are properly configured and initialize and perform as required, the database shall be saved into the file app/ws/config/app.dbcfg by means of the utility lsfBackup(1).

Example: 

> cd app/ws/config
> lsfBackup -e lcuEnv -m app
Generating input file './app.inp' ... done
Performing database backup into 'app.dbcfg' ... done
> cd ../src
> make install
 ...
 . . . installation done
>