man-0008 css installation and user's guide · 2020. 1. 22. · css installation and users guide...

Project Documentation

Document MAN-0008

Rev G

CSS Installation

and

User’s Guide

Chris Berst

Software Group

November 10, 2016

CSS Installation and Users Guide

MAN-0008, Rev G i

Revision History

1. Date: February 12, 2014 Version: Draft 1 Edited by: Chris Berst

Reason for / items changed: Initial Release

2. Date: June 24, 2014 Version: Draft 2 Edited by: Chris Berst

Reason for / items changed: Modified to outline steps required to use pkgDevel for installation and configuration.

Added section providing CSS Engineering GUI overview.

Added Advanced Topics section which includes details on the parameter-set database and creating simulation data files.

3. Date: June 30, 2014 Version: Draft 3 Edited by: Chris Berst

Reason for / items changed: Adds new cssSite.config option CSS_NAME. Description contained in Section 6.2.

Expands Section 8.7.4.2 in describing the total amount of shared memory needed.

4. Date: July 7, 2014 Version: Rev A Edited by: Chris Berst

Reason for / items changed: Title change: CSS User’s Guide CSS Installation and User’s Guide

Updated Table 1 and Section 4.1 for the Canary_7 branch of the CSS.

Removed Section 4.1.2 Installation using getAsdt.sh

5. Date: August 28, 2014 Version: Rev B (Prelim) Edited by: Chris Berst

Reason for / items changed: Section 3.1.3: Per JIRA CSS-75, removed requirement to set ATST_JNI_PACKAGES="SysShMem" in CSF

site.config file.

Per JIRA CSS-77, it is no longer required to run “make gcc_all” to get the CSS to link properly. The note to this effect has been removed from the build instructions.

Sections 3.1, 3.1, 3.4: Per JIRA ATCS-815, the order of installation steps for both the CSF and CSS have been modified to eliminate package dependencies during installation and build.

Section 4.2: Updated Figure 1 Main CSS Engineering GUI Screen. Main screen changed because of updates to Global Control Tab and this tab is visible when GUI is started.

Section 4.5: Updated Figure 4 BDT Publication Details. Instrument Supplied Meta-data now contains two columns: One for css.pub:metaData:fromDAT and one for css.pub:metaData:passThrough.

Section 4.7.1: Updated Figure 5 Global Control Tab and associated description due to re-layout and addition of Observation IDs and Pass-through Meta-data text entry fields.

Added Section 5 Data Acquisition Trees. “Understanding through an Analogous Example” and “Data Acquisition Trees by Example” was formerly contained in SPEC-0098. Use case examples were taken from TN-0158.

6. Date: October 19, 2014 Version: Rev A.1 Edited by: Chris Berst

Reason for / items changed: Section 5.3: Updates to use case drawings/descriptions and adjustments to parameters as needed to run.


Reason for / items changed: Section 4.7.4.4: Updated Figure 10 CSS Processing Meters and associated descriptions for re-layout of dialog box and

addition of the Sim Data Slice processing information. Section 4.7.5: Updated Figure 11 Simulation Control and associated description for addition of file load status raw

frame preparation status widgets. Added Section 4.7.5.2 File Load Status and Section 4.7.5.3 Preparation Status. Removed Section 6.2.2 Simulation Sub-directories. The CSS no longer requires a specific sub-directory format and no

longer requires a set of simulation data files that match the hardware applied windowing size as defined in a camera

configuration. The simulated frame-grabber now applies hardware applied windowing and binning to the source files


MAN-0008, Rev G ii

which should be sized according to the sensor size and bits per pixel of the camera hardware being simulated.

Remaining sections updated accordingly to reflect this modification.


Reason for / items changed: Section 3.2.3 Modification to site.config: Removed note regarding setting DHS parameters in the site.config file. DHS

and BDT configuration parameters are now configured via their respective pkgDevel site config files.

Moved: Section 6 Advanced Topics Section 7 Advanced Topics Added new Section 6 Java Utility Classes for Convenient Handling of CSS Metadata Updated: Section 4.2 Figure 1: Main CSS Engineering GUI Screen – Cosmetic Changes Updated: Section 4.7.1, Figure 5: Global Control Tab and associated discussion for addition of “Cancel All” and

“Abort All” control buttons in Acquisition Tree Control. Updated: Section 4.7.2, Figure 6 and Section 4.7.3 Figure 7 to reflect removal of Editors | Attribute Table tab.

Updated: Section 4.7.4, Figure 8: System Status - Cosmetic changes and addition of C++ Container Debug Slider.

Updated: Section 4.7.4.6 Debug Slider to include C++ Container debug slider.

9. Date: November 12, 2014 Version: Rev B Edited by: Chris Berst

Reason for / items changed: Updated Section 2.1 Table 1 CSS Compatibility Matrix

Updated Section 3.1 for Google Protocol Buffers 2.5.0 (Canary_8+)

Section 3.4 Completing CSF and CSS Installation – Updated steps adding pkgDevel for base and bdt.

Section 4.7.2 Editors Tab | Camera Configuration Editor – Updated Figure 6 illustrating new layout using a JesGeneralConfiguration widget for submitting camera configuration attributes.

Section 4.7.3 Editors Tab | Execution Block Editor – Updated Figure 7 illustrating new layout using a JesGeneralConfiguration widget for submitting execution block attributes.

Functionally, both editors now use their respective ID fields to enter the value of an ID to get rather than the previous separate input field. Descriptions for above Editor Tab sections have been updated accordingly.

Submitted for Approval as Rev B

10. Date: March 25, 2015 Version: Rev B.1 Edited by: Chris Berst

Reason for / items changed: This update applies to the Canary_8 branch and Canary_8-4 branch tag of the CSS repository.

Updated Section 2.1 Table 1 CSS Compatibility Matrix

Renamed Section 3.1 to “Third Party Packages: Pre CSF/CSS Installation”.

Section 3.3.2 cssSite.config Parameters – Added site config parameters CSS_CAMERA_NAME and CSS_SIM_ENABLE.

Section 3.4: Removed ‘make install_scripts’ removed from installation instructions. This is contained as part of ‘make build_all’

Section 3.4.1, Table 5: Added description for auto-generated file “sshConfigForRootCSS” placed in $ATST/admin/css/app when the

CSS is configured to run an Imperx Bobcat camera. Updated description for “cc_default.pset”.

Added Section 3.5: “Third Party Packages: Post CSF/CSS Installation” Section 3.5.1 contains instructions for installing the Imperx Bobcat GEV SDK, and for building and loading the

ebUniversalPro_x86_64.ko kernel module. Root access with passwordless ssh is now required. See Footnote #Error! Bookmark not defined.

Added Section 7.1.1 Default Camera Configuration. Existing section shift up in numbering by 1. Updated Section 7.1.3.4 regarding default Camera Configuration. Section3.3.2 cssSite.config Parameters, 3.6 CSS Camera Simulation Data Files, and 7.2 Simulation Data Files:

Updates throughout these sections to reflect the following change to the CSS simulation data file set:

Previously, the CSS_SimData.tgz file contained the directory and file structure of: /Andor/XxY/Andor_XyY.nn.raw

CSS_SimData.tgz has been updated to contain: /cssSimData/XxY/cssSim_XxY.nn.raw

Note that the default value for the cssSite.config parameter CSS_SIM_DATA_BASEFILENAME is now

“cssSim_2560x2160”.

Added Appendix A: DKIST Assigned Camera Names Added Appendix B: Imperx Bobcat Hardware Considerations


MAN-0008, Rev G iii

11. Date: April 1, 2015 Version: Rev C Edited by: Chris Berst

Reason for / items changed: Update to Rev B.1 as checked in on 3/25/2015 is not valid. Document requires revision change and approval. Document

submitted for official approval as Rev C.

See Revision History, Item #10, for all updates from Rev B Rev C.

12. Date: April 8, 2015 Version: Rev C Edited by: Chris Berst

Reason for / items changed: Corrected document error found by SEIC review. MS Word had replaced the text of a link with the entire text from the

linked section resulting in duplication of the text from one section of the document into another.

13. Date: July 10, 2015 Version: Rev D Edited by: Chris Berst

Reason for / items changed: This update applies to the Canary_8 branch and Canary_8-4 branch tag of the CSS repository.

Updated all Canary_8-2 references to Canary_8-4. Added Section 3.1.3: Expat (XML Parser) and Qt Tools to Section 3. CSS Installation. Section 3.6 CSS Camera Simulation Data Files: Removed references to directories 128x128 and 512x512 as these are

unnecessary file sizes and have been removed from the CSS Simulation data tar-ball. Section 5: Updated all examples in section to use a size of 2560x2160 rather than 2048x2048. Section 7.2 Simulation Data Files: Updated introduction to include details on requirements for simulation data file size

and contents and removed references to unused file sizes of 128x128 and 512x512. Section 7.2.6: Changed example size of 2048x2048 to 2072x2072.

14. Date: September 3, 2015 Version: Rev E Edited by: Chris Berst

Reason for / items changed: Reformatted Revision History.

Section 3.4: Correct problem where inserted reference was including content of reference when file is printed to pdf. Added Section 3.5.1.5 Firewalls. Steps are necessary to disable firewalls when using the Imperx Bobcat hardware. Imperx Bobcat: Extensive edits to Appendix B, Section B.4.1 Windowing and Binning. Section now includes

discussion on hardware implementation, CSS adaptation, deriving windowing/binning limits, rules and restrictions,

summary, and Hardware applied ROI application notes for a couple of use cases. NOTE: The code implemented in correlation to the edits contained in Appendix B is only available on the

Canary_8 branch and CSS trunk. It does not apply to any Canary_8-n point release.

15. Date: September 26, 2015 Version: Rev E.1 Edited by: Chris Berst

Reason for / items changed: Updates for WCI support (CSS-83) – Feature available beginning with Canary_9:

Added WCI to Table 2 Common Acronyms Added Section 2.3 Related Documents and Drawings – References TN-0213 Section 3.3 Customizing the CSS Installation: Added defining source/update rate for wPos to list of actions that

are customized via execution of pkgDevel.

Section 3.3.2 cssSite.config Parameters, Table 4: Added World Coordinate Information related parameters CSS_WCI_WPOS_SOURCE and CSS_WCI_WPOS_UPD_INTERVAL.

Section 4.2 Main Screen, Figure 1: Main screen now includes input fields for CSS global attributes .global:wci:wPosSource and .global:wci:wPosUpdInterval.

Section 4.5 bdtStatus, Figure 4: System Status/Global Configuration for FPA now displays CSS meta-data for css.pub:global:wci:wPosSource and css.pub:global:wci:wPosUpdInterval. Instrument Supplied and WCI Meta-

data now contains a column for viewing WCI meta-data obtained from css.pub:metaData:wci, converted into a

table, and displayed one attribute per line.

Added Section 7.3 World Coordinate Information

16. Date: October 8, 2015 Version: Rev E.2 Edited by: Chris Berst

Reason for / items changed: Updates to remove macros from CSS JES Screens (CSS-144)

Section 3.3.2 cssSite.config Parameters: Modified CSS_NAME to indicate how value is used with respect to the CSS screen file location.

Section 3.4.1, Table 5: Shell Scripts: Removed warning on use of Restart script; Removed note that GUI script is used to define the macros used by the CSS JES screens based on the users .

Section 3.4.1, Table 4: Added “Resources” Section to outline expansion of JES screen .xml from CSS templates


MAN-0008, Rev G iv

into system specific production files.

17. Date: October 15, 2015 Version: Rev E.3 Edited by: Chris Berst

Reason for / items changed: Updates to fully qualify property tables cssCommon, cssGlobal, cssSimulatedCamId (CSS-146)

Section 3.4.1, Table 5: Property Databases: Modified to indicate that cssCommon, cssGlobal, and cssSimulatedCamId have fully qualified vcc prefixes.

18. Date: November 13, 2015 Version: Rev E.4 Edited by: Chris Berst

Reason for / items changed:

Section 4.5 bdtStatus, Figure 4: Updated screenshot due to cosmetic update of screen Updates to Section 4.2 CSS Engineering GUI Main screen (CSS-149, CSS-151)

Figure 1: Main screen layout cleaned up. Camera Name/ID background colors indicate sim/real hardware. Figure 1: Adds “Camera Is Simulated” along with BDT camera line, topic name, transport, and max buffer size to

vcStatus event display.

Updates to Section 4.7.1 Global Control Tab (CSS-83) Figure 5 Global Control Tab updated: Includes World Coordinate Info input fields for wPos Source and Update

Interval.

Added descriptions for World Coordinate Info fields as contained on the Global Control Tab. Updates to Section 4.7.5 Simulation Control (CSS-126, CSS-127)

Figure 11 Simulation Control updated: Simulation control attributes are now submitted to the VCC as .sim:baseDirectory, .sim:baseFilename, and .sim:numFiles.

Section 4.7.5.1 Camera Data Files: Updated discussion on new attributes referencing SPEC-0098 for details. Section 4.7.5.2 File Load Status: Clarification on “Buffer is Valid” flag and # Loaded regarding file validation.

19. Date: November 29, 2015 Version: Rev E.5 Edited by: Chris Berst

Reason for / items changed: CSS-125 Imperx Bobcat: Update drivers to 4.0.8.64

Updates to Sections 3.5.1.2 and 3.1.4: Change in Linux Kernel Module Name ebusUniversalPro_x86_64.ko ebusUniversalProForEthernet_x86_64.ko

CSS-155 Add support for 10, 12, 14, 16-bit simulation data files Updated Section 3.3.2, Table 4 Simulation Data Related Parameters: Added “/12-bit/2560x2160” to value listed

for CSS_SIM_DATA_PATH.

Corrected value of CSS_SIM_DATA_BASE_FILENAME to be “cssSim_2560x2160” for default CSS installation procedures.

Added content to Section 3.6 CSS Camera Simulation Data Files regarding new simulation data file organization. Added Table 6 which provides a cross reference between download file, bits-per-pixel, and sensor

sizes.

Section 4.7.5 Simulation Control, Figure 11: Simulation tab screenshot now shows bit-depth sub-directory. Updated Section 7.2 Simulation Data Files and 7.2.1 Simulation Data Path regarding CSS Simulation Data

Files.

Updated Appendix A to show Sensor Size for Dkist_Generic.01.

20. Date: December 1, 2015 Version: Rev F Edited by: Chris Berst

Reason for / items changed: Updated Table 1 CSS Compatibility Matrix with CSS_Beta_1.

Updated Section 3 to use Canary_9 and CSS_Beta_1 in installation examples.

Submitted for Approval as Rev F (See revision history Rev E.1 through E.5 for modifications since Rev E)

21. Date: March 8, 2016 Version: Rev F.1 Edited by: Chris Berst

Reason for / items changed: CSS-162 Add support for user configuration of camera hardware properties on startup

Section 3.3.2 cssSite.config Parameters, Table 4: Added CSS_CSH_CONFIG_FILE to “Camera Selection and Configuration Related Parameters”. Parameter is used to set the path/filename of a camera configuration file.

Parameter use is optional.

Section 3.4.1 What did PkgDevel just do for me?, Table 5: - Added new section “Default Camera Configuration”

- Added note to “Property Database” section re: use of CSS_CSH_CONFIG_FILE vs the default camera

configuration file.


MAN-0008, Rev G v

22. Date: November 10, 2016 Version: Rev F.2 Edited by: Chris Berst

Reason for / items changed: Removed any installation instructions or notes specific to anything older than CSF Canary_9.

Section 3 CSS Installation – Installation procedure has changed!

Added new Appendix A System Hardware Requirements. All other appendices shifted down one.

CSS-152 Configure BDT Publication using new BDT Interface – Feature available beginning with CSS_Beta_2: Section 2.3 Related Documents and Drawings – Added SPEC-0151 Data Handling System Bulk Data Transport

API

Section 3.3 Customizing the CSS Installation – Updated for BDT related topics. Section 3.3.2 cssSite.config Parameters, Table 4 – Under “Data Publication Related Parameters”, removed

CSS_BDT_CAMERALINE, CSS_BDT_TOPICNAME, and CSS_BDT_TRANSPORT. Added

CSS_BDT_TABLENAME.

4.3 Global Attributes, Table 4 – Removed global attributes .global:bdt:cameraLine, .global:bdt:topicName, .global:bdt:transport, and .gobal:bdt:maxBufSize. Added .global:bdt:tableName.

5.3 Instrument Specific Use Cases – Removed reference to camera ID, cameraLine, and topicName from overview of use case examples.

CSS-158 Imperx 4.0.8.64 libs require libudev.so.0 - Problem for CentOS 7 and Ubuntu 14.04+

CSS-159 Optimal Efficiency Unobtainable in General – Feature available beginning with CSS_Beta_2: Section 5.2 Data Acquisition Trees and Section 5.3 Instrument Specific Use Cases – Fixed up entire section to

include the new .global:triggerReference attribute.

CSS-167 MAN-0008: Installation instructions do not work for install with mixed tags

CSS-196 pkgDevel: Create C++ include file conditional compilation based on selected camera

CSS-197 Update Imperx Bobcat SDK to version 4.1.4.65

Section 3 CSS Installation - Installation procedure has changed. User is now responsible for installation of hardware support packages and any 3rd party dependencies. Camera SDK’s are no longer re-packaged with in.h

and .so files as a CSS tool.

Section 3.1.1.1 Installation using ‘cvs co’ – Updated with new procedure for mixed tag installation.

CSS-173 Removal of .global:camMode="preConfigure" – Modification effective beginning with CSS_Beta_2 Section 4.7.1 Global Control Tab: Removed “preConfigure” from list of Camera Mode options under Acquisition

Tree Control. Removed “preConfigure” from discussion on Execution Count.

Section 5.2.1.2 Using an Execution Block: Removed references to preConfigure. Section 7 – Updated Figure 42 for new meta-data additions. Section 7.3 Example 3 – Switch on Discrete States: Updated example code to remove “PRECONFIGURE” and

to use the modifications made to the meta-data class and use of atst.css.util.global.parts.CamMode. The class

atst.css.util.metadata.CamMode has been deprecated.

CSS-176 Update cssMasterListOfCameras.prop with currently known cameras Appendix B, Table 25: Added CryoNIRSP.01, CryoNIRSP.02, AndorZyla.01, AndorZyla.02, AndorZyla.03,

DL_NIRSP.01, DL_NIRSP.02, and AndorBalor.01 to table.

CSS-177 CamConfig and ExecBlock helper classes Added Section 6 Java Camera Configuration and Execution Block Utility Classes – Provides a brief overview of

the Camera Configuration and Execution Block utility classes. Complete documentation is available in the

JDoc’s that accompany the Java source for these classes.

CSS-181 BDT: Align required BDT meta-data names with current BDT Spec Section 4.2, Figure 1 – Updated Main CSS Engineering GUI screenshot showing change in default Observation

IDs values and addition of pass-through meta-data “Edit” button.

Section 4.5, Figure 4 – Updated BDT Publication Details screenshot showing change in labeling for BDT/DHS Attributes and Flags.

Section 4.7.1, Figure 5 – Updated Global Control Tab screenshot showing change in pass-through meta-data with addition of “Edit” button. Updated description of Pass-through Meta-data for JSON encoded attribute table.

CSS-188 Change .global:passThrough:metaData from array of simple strings to JSON encoded attribute table – Feature available beginning with CSS_Beta_2:

Section 2, Figure 1 – Updated Main CSS Engineering GUI screenshot Added Figure 6 Pass-through meta-data Attribute Table Editor.

CSS-189 Change .execBlock:metaData behavior to support JSON encoded attribute tables – Feature available beginning with CSS_Beta_2:

Section 4.7.3 – Updated Figure 7 Execution Block Editor and accompanying description as it relates to new JSON encoded attribute table meta-data sets.

Section 5.1.7 – Updated for removal of .execBlock:metaData:setSize and addition of .execBlock:metaData:enable.

Section 5.2.1.4 – Updated to discuss execution block meta-data change from simple strings to JSON encoded attribute tables. Includes updates for removal of .execBlock:metaData:setSize and addition of

.execBlock:metaData:enable. All example figures updated accordingly.


MAN-0008, Rev G vi

Section 5.2.1.4 – All instrument specific use cases updated for execution block meta-data change from simple strings to JSON encoded attribute tables. Includes updates for removal of .execBlock:metaData:setSize and

addition of .execBlock:metaData:enable. All example figures updated accordingly.

CSS-195 Add FPA meta-data for number-of-samples and sample-number needed by IR cameras Section 4.5, Figure 4 – Updated BDT Publication Details screenshot showing addition of Sample #M of N to

Current FPA section.

23. Date: November 10, 2016 Version: Rev G Edited by: Chris Berst

Reason for / items changed: Submitted for Approval as Rev G (See revision history Rev F.1 and F.2 for modifications since Rev F)


MAN-0008, Rev G vii

Table of Contents

REVISION HISTORY ................................................................................................................................................. I

TABLE OF CONTENTS ........................................................................................................................................ VII

1. INTRODUCTION .............................................................................................................................................. 1

GUIDE TO THIS DOCUMENT ........................................................................................................................... 1

2. REFERENCE ...................................................................................................................................................... 1

CSF COMPATIBILITY .................................................................................................................................... 1

COMMON ACRONYMS ................................................................................................................................... 2

RELATED DOCUMENTS AND DRAWINGS ....................................................................................................... 3

THIRD PARTY PACKAGES .............................................................................................................................. 3

2.4.1. Google Protocol Buffers, Google AutoValue, and Google Guava ...................................................... 3

2.4.2. Camera SDK/Driver Packages ............................................................................................................ 3

3. CSS INSTALLATION........................................................................................................................................ 4

CSF INSTALLATION ...................................................................................................................................... 4

3.1.1. Source Trees ........................................................................................................................................ 4 3.1.1.1. Installation using ‘cvs co’ ............................................................................................................................... 4 3.1.1.2. Installation with an existing ASDT ................................................................................................................. 6

3.1.2. $ATST environment variable ............................................................................................................... 6

3.1.3. Modifications to site.config ................................................................................................................. 6

3.1.4. Apply site.config .................................................................................................................................. 6

HARDWARE SUPPORT PACKAGE INSTALLATION ........................................................................................... 7

3.2.1. Imperx Bobcat GEV SDK .................................................................................................................... 7

CUSTOMIZING THE CSS INSTALLATION ........................................................................................................ 7

3.3.1. General steps to customizing the CSS ................................................................................................. 8

3.3.2. VCC Fully Qualified Name ................................................................................................................. 8

3.3.3. cssSite.config Parameters.................................................................................................................... 8

3.3.4. Modifications to bdtSite.config and baseSite.config .......................................................................... 11

COMPLETING CSF AND CSS INSTALLATION ............................................................................................... 11

3.4.1. What did pkgDevel just do for me? ................................................................................................... 12

POST CSF/CSS INSTALLATION SYSTEM CONFIGURATION .......................................................................... 14

3.5.1. Imperx Bobcat GEV SDK .................................................................................................................. 14 3.5.1.1. SSH as root ................................................................................................................................................... 15 3.5.1.2. Modifying system startup to load kernel module on boot ............................................................................. 16 3.5.1.3. Rebuilding kernel module following a kernel update ................................................................................... 16

CSS CAMERA SIMULATION DATA FILES ..................................................................................................... 17

CSS STARTUP ............................................................................................................................................. 18

3.7.1. Startup and Shutdown ....................................................................................................................... 18

4. CSS ENGINEERING GUI ............................................................................................................................... 19

TOOL TIPS ................................................................................................................................................... 19

MAIN SCREEN ............................................................................................................................................. 19

DATA ACQUISITION TREE STATUS (DATSTATUS) ....................................................................................... 20

MISCELLANEOUS DIALOGS ......................................................................................................................... 21

4.4.1. Manage IDs ....................................................................................................................................... 21


MAN-0008, Rev G viii

4.4.2. Log Viewer ........................................................................................................................................ 21

4.4.3. Property Database Editor ................................................................................................................. 22

BDTSTATUS ................................................................................................................................................. 23

VCSTATUS ................................................................................................................................................... 23

TABS ........................................................................................................................................................... 24

4.7.1. Global Control Tab ........................................................................................................................... 24

4.7.2. Editors Tab | Camera Configuration Editor Tab .............................................................................. 28

4.7.3. Editors Tab | Execution Block Editor Tab ......................................................................................... 29

4.7.4. System Status ..................................................................................................................................... 29 4.7.4.1. Thread Status ................................................................................................................................................ 30 4.7.4.2. Shared Memory Status .................................................................................................................................. 30 4.7.4.3. Reload Camera HW Master on Init ............................................................................................................... 31 4.7.4.4. View Processing Time Info ........................................................................................................................... 32 4.7.4.5. Maximum Allowable # of Data-Tiers ........................................................................................................... 33 4.7.4.6. Debug Sliders ................................................................................................................................................ 33

4.7.5. Simulation Control ............................................................................................................................ 33 4.7.5.1. Camera Data Files ......................................................................................................................................... 34 4.7.5.2. File Load Status ............................................................................................................................................ 35 4.7.5.3. Preparation Status ......................................................................................................................................... 35 4.7.5.4. TRADS State ................................................................................................................................................ 36

5. DATA ACQUISITION TREES ....................................................................................................................... 37

UNDERSTANDING THROUGH AN ANALOGOUS EXAMPLE ............................................................................. 37

5.1.1. File Rules ........................................................................................................................................... 37

5.1.2. Folder Rules ...................................................................................................................................... 37

5.1.3. Reading Assignment #1 – A File........................................................................................................ 39

5.1.4. Reading Assignment #2 – A Folder ................................................................................................... 39

5.1.5. Reading Assignment #3 ..................................................................................................................... 41

5.1.6. Reading Assignment #4 ..................................................................................................................... 42

5.1.7. CSS Execution Blocks ........................................................................................................................ 44

DATA ACQUISITION TREES BY EXAMPLE .................................................................................................... 45

5.2.1. Accumulations Disabled .................................................................................................................... 46 5.2.1.1. Simple Camera Configuration Execution ...................................................................................................... 47 5.2.1.2. Using an Execution Block ............................................................................................................................. 49 5.2.1.3. Using Time-slices ......................................................................................................................................... 52 5.2.1.4. Defining Instrument Supplied Meta-data ...................................................................................................... 56

5.2.2. Accumulations Enabled ..................................................................................................................... 58 5.2.2.1. Example #6a – Multiple Accumulators ......................................................................................................... 59 5.2.2.2. Example #6b – Multiple Accumulators......................................................................................................... 63 5.2.2.3. Example #7 – Multiple Accumulators .......................................................................................................... 67

INSTRUMENT SPECIFIC USE CASES ............................................................................................................. 71

5.3.1. VBI Use Cases ................................................................................................................................... 71 5.3.1.1. VBI Use Case #1 ........................................................................................................................................... 72 5.3.1.2. VBI Use Case #2 ........................................................................................................................................... 73 5.3.1.3. VBI Use Case #3 ........................................................................................................................................... 75 5.3.1.4. VBI Use Case #4 ........................................................................................................................................... 77 5.3.1.5. VBI Use Case #5 – Modulator Synchronization ........................................................................................... 79 5.3.1.6. VBI Use Case #6 – Modulator Synchronization ........................................................................................... 81


MAN-0008, Rev G ix

5.3.2. 2-D Tunable Instrument - Spectroscopy Use Cases .......................................................................... 84 5.3.2.1. Spectroscopy Use Case #1 ............................................................................................................................ 86 5.3.2.3. Spectroscopy Use Case #2 ............................................................................................................................ 89

5.3.4. 2-D Tunable Instrument - Spectropolarimetry Scenarios .................................................................. 92 5.3.4.1. Modulation Scenario #1 – No accumulations ............................................................................................... 94 5.3.4.2. Modulation Scenario #1a – No accumulations, Variation on Scenario #1 .................................................... 96 5.3.4.3. Modulation Scenario #1 with M accumulations – Option #1 ........................................................................ 99 5.3.4.4. Modulation Scenario #1 with M accumulations – Option #2 ...................................................................... 102

6. JAVA CAMERA CONFIGURATION AND EXECUTION BLOCK UTILITY CLASSES ................... 104

GOOGLE AUTOVALUE AND GUAVA PRECONDITIONS ............................................................................... 104

CAMERA CONFIGURATION UTILITY CLASSES ........................................................................................... 104

6.2.1. Deferred validation ......................................................................................................................... 105

EXECUTION BLOCK UTILITY CLASSES ...................................................................................................... 107

7. JAVA UTILITY CLASSES FOR CONVENIENT HANDLING OF CSS METADATA ........................ 109

EXAMPLE 1 – SCRUB DETECTION AND PROCESSING ................................................................................. 110

EXAMPLE 2 – BURST INDEX MANAGEMENT.............................................................................................. 110

EXAMPLE 3 – SWITCH ON DISCRETE STATES ............................................................................................ 110

8. ADVANCED TOPICS .................................................................................................................................... 111

PARAMETER-SET DATABASE..................................................................................................................... 111

8.1.1. Default Camera Configuration ........................................................................................................ 111

8.1.2. Creating your own parameter-set.................................................................................................... 111

8.1.3. Parameter-set Database Category, Name, and ID .......................................................................... 112 8.1.3.1. In-file parameters ........................................................................................................................................ 112 8.1.3.2. Command-line Options ............................................................................................................................... 112 8.1.3.3. Inserting into the Parameter-set Database ................................................................................................... 112 8.1.3.4. Defining Your Own Default Camera Configuration ................................................................................... 113 8.1.3.5. Verifying Database Contents ...................................................................................................................... 113

SIMULATION DATA FILES ......................................................................................................................... 114

8.2.1. Simulation Data Path ...................................................................................................................... 114

8.2.2. Base Filename ................................................................................................................................. 115

8.2.3. # of Files Per Set ............................................................................................................................. 115

8.2.4. Final Filename Format ................................................................................................................... 115

8.2.5. File Sizes ......................................................................................................................................... 115

8.2.6. Example ........................................................................................................................................... 115

WORLD COORDINATE INFORMATION ........................................................................................................ 116

8.3.1. Configuring via cssSite.config ......................................................................................................... 116

8.3.2. Configuring programmatically ........................................................................................................ 116

8.3.3. WCI Acquisition and publication .................................................................................................... 116

APPENDIX A SYSTEM HARDWARE REQUIREMENTS ......................................................................... 118

APPENDIX B DKIST ASSIGNED CAMERA NAMES ................................................................................. 119

APPENDIX C IMPERX BOBCAT HARDWARE CONSIDERATIONS .................................................... 121

C.1 NETWORK INTERFACE ADAPTOR .............................................................................................................. 121

C.2 NETWORK CONNECTION ........................................................................................................................... 121

C.3 CONNECTING THE CAMERA TO YOUR COMPUTER ...................................................................................... 121

C.4 OPERATIONAL NOTES ............................................................................................................................... 122


MAN-0008, Rev G x

C.4.1 Windowing and Binning ....................................................................................................................... 122

C.4.1.1 Bobcat implementation and CSS adaptation ................................................................................... 122

C.4.1.2 Deriving limits ................................................................................................................................. 123

C.4.1.3 Additional rules and restrictions ..................................................................................................... 124

C.4.1.4 Binning and Windowing Summary .................................................................................................. 124

C.4.1.5 Hardware applied ROI Application Notes ...................................................................................... 125

Table of Tables Table 1: CSS Compatibility Matrix .............................................................................................................. 2

Table 2: Common Acronyms ........................................................................................................................ 3

Table 3: CVSROOT Export Commands ....................................................................................................... 4

Table 4: cssSite.config File Parameters ...................................................................................................... 11

Table 5: pkgDevel output for the CSS ........................................................................................................ 14

Table 6: Simulation Data Download Files .................................................................................................. 17

Table 7: Examples – Fixed Global Attributes ............................................................................................. 46

Table 8: Camera Configurations with a Single Accumulator ..................................................................... 47

Table 9: DAT "Take a Picture" Meta-data (execCount0=1) ....................................................................... 48

Table 10: DAT "Take a Picture" Meta-data (execCount0=3) ..................................................................... 49

Table 11: DAT Example #1 Meta-data ....................................................................................................... 50



Table 14: DAT Example #4a Meta-data ..................................................................................................... 54

Table 15: DAT Example #4b Meta-data ..................................................................................................... 56


Table 17: Camera Configurations with Multiple Accumulators ................................................................. 59

Table 18: Accumulation Examples – Fixed Global Attributes ................................................................... 59


Table 20: DAT Example #6b Meta-data ..................................................................................................... 67


Table 22: Camera Configuration Related Classes .................................................................................... 104

Table 23: Camera Configuration Related Classes .................................................................................... 107

Table 24 List of Camera Names ............................................................................................................... 119

Table 24: Imperx Bobcat B2021M ROI Origin/Size X Limits ................................................................. 125

Table 25: Imperx Bobcat B2021M ROI Origin/Size Y Limits ................................................................. 125

Table of Figures Figure 1: Main CSS Engineering GUI Screen ............................................................................................ 20

Figure 2: Manage IDs ................................................................................................................................. 21

Figure 3: Log Viewer .................................................................................................................................. 22

Figure 4: BDT Publication Details.............................................................................................................. 23

Figure 5: Global Control Tab ...................................................................................................................... 24

Figure 6: Pass-through meta-data Attribute Table Editor ........................................................................... 25

Figure 7: Camera Configuration Editor ...................................................................................................... 28


MAN-0008, Rev G xi

Figure 8: Execution Block Editor ............................................................................................................... 29

Figure 9: System Status .............................................................................................................................. 30

Figure 10: Shared Memory Info.................................................................................................................. 31

Figure 11: CSS Processing Meters ............................................................................................................. 32

Figure 12: Simulation Control .................................................................................................................... 34

Figure 13: Data Acquisition Tree Analogy – Folder Contents ................................................................... 38

Figure 14: Reading Assignment #2 ............................................................................................................. 40



Figure 17: DAT - "Take a picture" ............................................................................................................. 47

Figure 18: DAT Example #1 – Simple Execution Block ............................................................................ 49

Figure 19: DAT Example #2 - Simple Execution Block ............................................................................ 50

Figure 20: DAT Example #3 – Execution Block with :exec:count[i] > 1................................................... 51

Figure 21: DAT Example #4a - Execution Block with :timeSlice[i]>0.0, :timeSliceRepeats=true ........... 53

Figure 22: DAT Example #4b - Execution Block with :timeSlice[i]>0.0, :timeSliceRepeats=false .......... 54

Figure 23: DAT Example #5a – Execution Block with Instrument Supplied Meta-data ........................... 57

Figure 24: DAT Example #5b – Execution Block with Instrument Supplied Meta-data ........................... 58

Figure 25: DAT Example #6a - Multiple Accumulators ............................................................................ 60

Figure 26: DAT Example #6b - Multiple Accumulators ............................................................................ 64

Figure 27: DAT Example #7 - Multiple Accumulators .............................................................................. 67

Figure 28: DAT - VBI Use Case #1 ............................................................................................................ 73




Figure 32: DAT - VBI Use Case #5 – Modulator Synchronization ............................................................ 81

Figure 33: DAT - VBI Use Case #6 – Modulator Synchronization ............................................................ 83

Figure 34: DAT - 2-D Tunable Instrument, Spectroscopy Use Case #1..................................................... 88

Figure 35: DAT - 2-D Tunable Instrument, Spectroscopy Use Case #2..................................................... 91

Figure 36: DAT - 2-D Tunable Instrument, Spectropolarimetry Scenario #1 ............................................ 96

Figure 37: DAT - 2-D Tunable Instrument, Spectropolarimetry Scenario #1a .......................................... 98

Figure 38: DAT - 2-D Tunable Instrument, Spectropolarimetry Scenario #1, Option #1 ........................ 101

Figure 39: DAT - 2-D Tunable Instrument, Spectropolarimetry Scenario #1, Option #2 ........................ 103

Figure 40: Camera Configuration Utility Classes ..................................................................................... 106

Figure 41: Execution Block Utility Classes .............................................................................................. 108

Figure 42: CSS Metadata Class Diagram ................................................................................................. 109

Figure 43: Aligning the Imperx Bobcat with Spectral Lines .................................................................... 126


MAN-0008, Rev G 1

1. Introduction

This serves as an installation and users guide to the CSS. Complete installation details are documented.

An overview of the CSS Engineering GUI is presented following which is a “tutorial and examples”

section on use of CSS Data Acquisition Trees. Additionally, advanced topics including creation and

storage of CSS parameter sets and details on creating your own camera simulation data files are

presented.

Guide to this Document

The following provides a summary overview of this document:

Section 1: Introduction

Section 2: Reference contains a reference to related DKIST materials and a glossary of acronyms. CSS Terminology is also defined.

Section 3: CSS Installation contains complete details on installation of the CSS in conjunction with the CSF.

Section 4: CSS Engineering GUI contains an overview of the various aspects of the CSS Engineering GUI.

Section 5: Data Acquisition Trees presents data acquisition trees both through the use of an analogous example and then using a progressive set of examples that builds from the simple to

complex. As examples progress, various elements of execution blocks are introduced and

illustrated.

Section 6: Java Camera Configuration and Execution Block Utility Classes introduces a set of classes for working with CSS Camera Configurations and Execution Blocks.

Section 7: Java Utility Classes for Convenient Handling of CSS Metadata introduces a set of utilities for working with CSS metadata.

Section 8: Advanced Topics presents creation of camera configuration and execution block parameter sets for storage in the Parameter Set Database, creating camera simulation data files

that are compatible with the CSS, and World Coordinate Information support features.

Appendix A: System Hardware Requirements contains the complete CSS computer specification.

Appendix B: DKIST Assigned Camera Names contains the complete list of cameras supported by the CSS

Appendix C: Imperx Bobcat Hardware Considerations contains system installation, configuration, and operational information specific to the Imperx Bobcat camera.

2. Reference

CSF Compatibility

Table 1 provides a compatibility cross reference between releases of the CSS and the tags/versions of

other elements of the ASDT.

CVS Repository Branch/Tags

CSS CS Base BDT CSS CVS Type

1 Canary_7 Canary_7 Canary_7 Canary_7 Branch

2 Canary_8 Canary_8 Canary_8 Canary_8 Branch


MAN-0008, Rev G 2

CVS Repository Branch/Tags

CSS CS Base BDT CSS CVS Type

3 Canary_8-0 Canary_8-0 Canary_8-0 Canary_8-0 Tag on Canary_8 Branch





8 CSS_Beta_1 Canary_9 Canary_9 Canary9 Branch

9 CSS_Beta_2 Canary_10 Canary_10 Canary_10 Branch

Table 1: CSS Compatibility Matrix

Common Acronyms

The following table provides a brief description of some of the acronyms used in this document:

Acronym Definition

ASDT ATST Software Development Tree – An installation of the DKIST provided software packages

and development tools.

BDT Bulk Data Transport – The DKIST 10 Gigabit Ethernet data transport layer.

CSF Common Services Framework – The ATST software framework.

CSH Camera Systems Hardware – All camera hardware including the physical detector, camera

mount and motion stages, and all inter-connects to the CSS.

CSS

Camera Systems Software – The system consisting of the software, computer, frame grabber,

and timing interface which is responsible for configuring and acquiring data from the CSH and

then processing, and publishing that data according to a supplied set of attributes as defined by

this document.

cssDevel A short-cut term for execution of “$ATST/admin/pkgDevel css”

CSV Comma Separated Values – A list of values where individual values are separated from each

other by a comma.

DAT Data Acquisition Tree – The overall controlling data structure for execution of one or more

validated camera configurations.

DHS Data Handling System – The general term applied to the DKIST data system responsible for

transport, display, and storage of data generated by various subsystems of the DKIST.

FPA Fully Processed Accumulator – A CSS accumulator which has completed the CSS data-

acquisition and processing pipeline and is ready for data publication on the BDT.

IC

Instrument Controller – An element of the Instrument Control System which is built by an

ATST Instrument team using building blocks supplied by the DKIST and is responsible for the

control of the instrument using DKIST conventions.

ICS

Instrument Control System – A major software system of the DKIST which interfaces between

the Observatory Control System and the Instrument Controllers. The ICS is responsible for

disseminating commands from the OCS to one or more IC’s, collecting responses from the IC’s

and returning status information to the OCS.

IS

Instrument Sequencer – A tool of the Instrument Controller used to execute a sequence of

instrument specific commands to control electro-mechanical components of the instrument and

to command/control the cameras associated with the instrument.

MC Mechanism Controller – A controller within an IC used to command/control electro-

mechanical or electro-optical devices.

ms Milli-seconds

OCS Observatory Control System – The OCS manages, controls, and monitors all observatory

operations through other system components of the DKIST.


MAN-0008, Rev G 3

Acronym Definition

TCS

Telescope Control System – The TCS provides precise pointing and guiding of the sun and

delivers a specified optical light beam down to the coudé platform based on the required target

location and tracking system, spectral region, polarization characteristics, wave front quality,

pin-holes, occulting devices, and other light beam qualities.

VC Virtual Camera – A general term applied to the entire camera system including the CSS and the

CSH.

VCC Virtual Camera Controller – The top level CSF controller of the CSS which provides the CSF

interface to 1) The DC of an IC 2) The Engineering GUI for a specific VC.

WCI World Coordinate Information

Table 2: Common Acronyms

Related Documents and Drawings

1) SPEC-0022, Common Services Framework Reference Guide

2) SPEC-0098, Camera Systems Software Functional Interface Specification

3) SPEC-0122, DKIST Data Model

4) SPEC-0151 Data Handling System Bulk Data Transport API

5) TN-0213, World Coordinate Information and the DKIST Bulk Data Transport

Third Party Packages

The CSS uses a number of 3rd party packages. Third party packages must be installed before attempting

to build your ASDT. This section provides a brief overview of the 3rd party packages and the basic steps

that will be used to install them. Complete installation steps are contained in Section 3.

2.4.1. Google Protocol Buffers, Google AutoValue, and Google Guava

The CSS uses the Google Protocol Buffers, Google AutoValue, and Google Guava packages in various

capacities. All three packages are provided as tool sets within the CSF/CSS frame-work. After

successfully installing an ASDT, but prior to building, these tools must be installed in the ASDT. Later

installation instructions will include this step but in short, once all packages have been downloaded from

the repositories you will need to do the following:

$ cd $ATST

$ ./admin/createDevel --init-tools

Note that the flag “--init-tools” is included when “createDevel --make-all” is run. The “--make-all” flag is

used later on in this document.

2.4.2. Camera SDK/Driver Packages

Installation of the CSS in an ASDT includes the manufacturer SDK and driver installation files and

documentation for the each of the supported cameras. These installation files and supporting

documentation are provided as tool sets within the CSF/CSS frame-work. If you intend to run real camera

hardware and not just a simulator then, after successfully installing an ASDT but prior to building, you

must install the SDK/driver for the camera hardware you intend to run. Later installation instructions will

include this step but in short, once all packages have been downloaded from the repositories you will need

to do the following:

$ cd $ATST

$ ./admin/createDevel --init-tools

$ cd $ATST/tools/x86_64//install/linux

Follow the directions in the .pdf to install the

SDK and kernel driver module.


MAN-0008, Rev G 4

Note that the flag “--init-tools” is included when “createDevel --make-all” is run. The “--make-all” flag is

used later on in this document.

3. CSS Installation

The following steps are required to install the CSS:

1. Section 3.1: CSF Installation

Section 3.1.1: Download cs, base, bdt, and css from CVS repositories.

Section 3.1.2: Set ATST environment variable.

Section 3.1.3: Customize $ATST/admin/site.config

Section 3.1.4: Apply site.config to ASDT.

2. Section 3.2: Install hardware support packages and 3rd party dependencies.

3. Section 3.3: Customize the CSS installation using $ATST/admin/css/cssSite.config.

4. Section 3.4: Complete CSF and CSS installation using pkgDevel and make.

5. Section 3.5: Modify any system files based on selected camera (only required for installations where real camera hardware will be run).

6. Section 3.6: Install CSS camera simulation data files.

7. Section 3.7: Startup and execute the CSS.

This section details each of these steps.

CSF Installation

The CSS requires the following repositories for installation and execution: cs, base, bdt, css.

In general, the installation steps as detailed in SPEC-0022-2, Section 6 apply. The following sections

provide additional guidance specific to the CSS installation in conjunction with CSF.

3.1.1. Source Trees

This section outlines the step required to download and install a complete ASDT along with the CSS.

Section 3.1.1.1 provides the steps as detailed in SPEC-0022-2, Section 6 specifically for CSS installation.

Instructions provided assume you will be installing:

The most current officially released branch of cs, base.

The most current officially released branch of bdt.

The most current officially released branch of css.

3.1.1.1. Installation using ‘cvs co’

This section outlines the steps used to check-out source code from each of the repositories required for

CSS installation and building. Table 3 lists the export commands needed during this process to set the

repository to check out. NOTE: Follow the order listed when installing.

Repository Export Command Order

cs export CVSROOT=":pserver:[email protected]:/home/atst/src/cs"

base export CVSROOT=":pserver:[email protected]:/home/atst/src/base"

bdt export CVSROOT=":pserver:[email protected]:/home/atst/src/bdt"

css export CVSROOT=":pserver:[email protected]:/home/atst/src/css"

Table 3: CVSROOT Export Commands


MAN-0008, Rev G 5

The following sequence is required for checking out an ASDT where different tags are being used

between various software elements of an ASDT. In this case, cs, base, and bdt use the Canary_N

convention while the css is using a CSS_XXX_YYY convention for its tags.

1. Change directories to your desired installation directory.

$ cd /path/to/install/directory

2. Set the environment variable CVSROOT to point to the cs source repository (See Table 3). Substitute “user-name” with your user name:

$ export CVSROOT=":pserver:[email protected]:/home/atst/src/cs"

3. Login to CVS:

$ cvs login

4. Checkout the code in the currently exported repository. By default, checking out an ATST repository will result in the items from that repository being placed into the current directory

under the sub-directory “atst”. Substitute with a tag value from Table 1:

$ cvs co –r atst

5. Repeat steps 2, 3, and 4 for the base and bdt source repositories. Note that you must use the same tag from Step 4 for all repositories.

6. Set the environment variable CVSROOT to point to the css source repository (See Table 3).

Substitute “user-name” with your user name:

$ export CVSROOT=":pserver:[email protected]:/home/atst/src/cs"

7. After setting the repository login to CVS:

$ cvs login

8. Perform the following series of code check-outs. Substitute with a tag value from

Table 1:

$ cvs co -P -r atst/admin/css

$ cvs co -P -r atst/doc/guides/css

$ cvs co -P -r atst/resources/css

$ cvs co -P -r atst/resources/screens/css

$ cvs co -P -r atst/src/java/atst/css

$ cvs co -P -r atst/src/c++/atst/css

$ cvs co -P -r atst/tools/css

Here is the complete sequence of steps:

$ cd /path/to/install/directory

$ export CVSROOT=":pserver:user-name @maunder.tuc.noao.edu:/home/atst/src/cs"

$ cvs login

$ cvs co -P -r atst

$ export CVSROOT=":pserver:user-name @maunder.tuc.noao.edu:/home/atst/src/base"

$ cvs login

$ cvs co -P -r atst

$ export CVSROOT=":pserver:user-name @maunder.tuc.noao.edu:/home/atst/src/bdt"

$ cvs login

$ cvs co -P -r atst

$ export CVSROOT=":pserver:user-name @maunder.tuc.noao.edu:/home/atst/src/css"

$ cvs login

$ cvs co -P -r atst/admin/css

$ cvs co -P -r atst/doc/guides/css

$ cvs co -P -r atst/resources/css

$ cvs co -P -r atst/resources/screens/css

$ cvs co -P -r atst/src/java/atst/css

$ cvs co -P -r atst/src/c++/atst/css

$ cvs co -P -r atst/tools/css


MAN-0008, Rev G 6

3.1.1.2. Installation with an existing ASDT

Installation of the css in conjunction with an existing ASDT depends on your current installation:

If you are installing CSS in conjunction with an existing ASDT then you need only install the css and BDT repositories. Follow the steps as outlined in Section 3.1.1.1 but only for the CSS and

BDT repositories.

If your existing installation already contains the BDT and the tag for the BDT in your ASDT is not compatible with the version of css you are installing (See Table 1) you will need to perform a

complete installation (See Section 3.1.1.1).

3.1.2. $ATST environment variable

The following steps assume you are using bash as your shell.

1. Set the ATST environment variable to match the installed ASDT:

a. For the current session do:

$ cd /path/to/install/directory/atst

$ export ATST=$(pwd)

b. To make this export permanent for the current user, add the following to the users .bashrc file:

export ATST=/path/to/install/directory/atst

c. To make this export permanent for the entire system, add the following to /etc/rc.local (NOTE: Using this option will require a re-boot for the change to take effect):

export ATST=/path/to/install/directory/atst

2. Add $ATST/bin to your path:

PATH=$PATH:$ATST/bin

3. Don’t forget to source the .bashrc file after editing.

$ source .bashrc

3.1.3. Modifications to site.config

In conjunction with the steps contained in SPEC-0022-2, Section 6.7 regarding the site.config file, a few

of the site.config parameters require specific values to be added.

$ cd $ATST/admin

$ vi site.config

baseDir=/path/to/install/directory/atst

ATST_RELEASE_FLAG=

ATST_PACKAGE_LIST=”base bdt css” Your install may have additional packages

USE_CPP=yes

Save the file and exit the editor.

3.1.4. Apply site.config

Once modifications to site.config are complete apply them to your ASDT as follows:

$ cd $ATST

$ ./admin/createDevel --make-all

If you are installing the CSS and intend to run actual camera hardware proceed to Section 3.2.

Otherwise, you may skip Section 3.3 “Customizing the CSS Installation”.


MAN-0008, Rev G 7

Hardware Support Package Installation

This section contains instructions for any hardware support and 3rd party packages that you may need to

install on your system in order to run the CSS. Installation of any of these party packages is contingent on

the hardware configuration of your system and whether or not you intend to run real camera hardware.

The current list of hardware support packages is:

1. Imperx Bobcat GEV SDK Only necessary if using camera hardware!

Note: Hardware support packages must be installed before attempting to build your ASDT.

All supported packages/installers are packaged with the CSS as “tools” and are located in

$ATST/tools/x86_64/.

If you are not going to run any camera hardware then you may skip to Section 3.3 “Customizing the CSS

Installation”.

3.2.1. Imperx Bobcat GEV SDK

Included within the tools portion of your CSS installation is the complete Imperx Bobcat GEV SDK. This

SDK must be installed following the manufacturer instructions and is required for building the CSS with

Imperx Bobcat hardware support and to build and load the “ebUniversalProForEthernet_x86_64.ko"

kernel module.

Installation instructions and SDK installer are located in $ATST/tools/x86_64/bobcat/gev/install/linux:

The SDK installer will have a name of the form: “bobcat_gev_vX.Y.Z.run”.

Follow all installation instructions contained in “Bobcat_GEV_Linux_Installer_Manual.pdf”.

During the course of installation you will execute “bobcat_gev_vX.Y.Z.run”. Answer “yes” to all

questions.

NOTE: By default, firewalls are disabled on CentOS 6. By default, firewalls are enabled On CentOS 7.

Once installation is complete verify that the ebUniversalProForEthernet_x86_64 kernel module is loaded

in the kernel:

# lsmod | grep ebUniversalPro

ebUniversalProForEthernet_x86_64 nnnnn 0

Customizing the CSS Installation

In a manner similar to customizing your ASDT installation through the use of the createDevel utility and

a site.config file the CSS is customized to your particular installation through the use of the pkgDevel

utility and a cssSite.config file. Customization of the CSS installation includes the following:

Define the Host that the CSS containers, controllers and components will be deployed on.

Set the Fully Qualified Name of your top level Virtual Camera Controller and its workers.

Set the path to your simulation data file installation (as performed in Section 3.4)

Define the Parameter-set Database Category and Name for your system.

Define a default Camera Configuration ID (optional).

Define the property table name which contains properties used to configure the BDT camera line of the DHS that will be used by the CSS for data publication on the BDT.

Selecting the camera and whether it will be simulated.

Defining the source of the wPos event and the update interval the CSS will use to monitor the wPos event for gathering WCI meta-data.


MAN-0008, Rev G 8

Details on the flags associated with each of these topics are contained in Section 3.3.3 below. Section

3.3.4 outlines the steps necessary to configure cssSite.config. Section 3.4.1 outlines the results of

executing pkgDevel with your customized cssSite.config file.

NOTE: Actual execution of pkgDevel to complete the ASDT and CSS installation process is deferred to

Section 3.4 as execution of pkgDevel must be broken into a couple of steps and interleaved with

building your ASDT.

3.3.1. General steps to customizing the CSS

The following steps are required to customize the CSS installation:

1. Copy cssSite.config.template to cssSite.config:

$ cd $ATST/admin/css

$ cp cssSite.config.template cssSite.config

2. Edit cssSite.config and set parameters according to your installation and requirements. The cssSite.config file parameters are described in Section 3.3.3 below.

3.3.2. VCC Fully Qualified Name

During the course of setting parameters in cssSite.config you will be required to provide the fully

qualified name of the Virtual Camera Controller (VCC). The VCC is a Java management controller that is

part of the CSS and is responsible for receiving commands, providing responses, and managing the

actions of all additional controllers in a single instance of a Virtual Camera. Your system will be sending

commands and receiving responses from the VCC. Each instance of a VCC is ultimately responsible for

the actions of a single camera. There is a one-to-one relationship between a VCC and a camera.

The Fully Qualified Name of the top level VCC for a single instance of a DKIST Virtual Camera is

named a.b.c.vcc where:

a.b.c = Fully qualified name of your Controller that is responsible for communicating with a single

instance of a DKIST Virtual Camera.

.vcc = The CSS top level Virtual Camera Controller

By convention, the top level Virtual Camera Controller is referred to as a vcc. Therefore, a.b.c.vcc is the

fully qualified name of a single Virtual Camera Controller. If your system will be communicating with

more than one camera it is recommended that you add a numerical designator to your VCC’s Fully

Qualified Name (i.e. a.b.c.vcc1).

3.3.3. cssSite.config Parameters

Table 4 below describes the parameters contained in cssSite.config:

cssSite.config Parameters

$ATST/admin/css/cssSite.config

Option Description

Application Database Related Parameters

CSS_HOST

The name of the host (computer) from which the CSS containers, controllers, and components will be deployed. Typically, the value assigned to this option is the value reported when executing “hostname” from the command line of the target system.

CSS_HOST_DESCRIPTION

A description of the host.

NOTE: If the host definition already exists in the Application Database,

this description will overwrite the current value.


MAN-0008, Rev G 9



Option Description

CSS_CPP_CONTAINER_NAME

The name of the CSF C++ container to be used for CSS controllers and components. It is good practice to add some type of identifier to the name to designate this as the C++ container.

Example: CB.ATST.C

See the NOTE in the next option description.

CSS_JAVA_CONTAINER_NAME

The name of the CSF Java container to be used for CSS controllers and components. It is good practice to add some type of identifier to the name to designate this as the Java container.

Example: CB.ATST.J

NOTE: If the container name you choose for the C++ and/or Java

container already exists in the Application Database then Application Database entries for your VC controllers and components will be added to those containers.

CSS_VCC_FQNAME

The Fully Qualified Name of the top level Virtual Camera Controller for a single instance of a DKIST Virtual Camera (see Section 3.3.1).

Example: If the fully qualified name of your system is atst.foo.bar then the fully qualified name of your VCC would be named atst.foo.bar.vcc.

Therefore, CSS_VCC_FQNAME=atst.foo.bar.vcc.

CSS_NAME

A name to assign to a single instance of a Virtual Camera. Use this option if your system controls multiple cameras or if you want a more descriptive prefix for the CSS management scripts.

Leaving this option blank will result in the CSS management scripts, written to $ATST/bin being named:

cssUp, cssDown, cssResart, cssManage, and cssGui.

This will also result in the CSS screen files being written to:

$ATST/resources/screens/css/css/*.xml

Supplying a value to this option will replace 'css' in the aforementioned script names with the value entered.

Example:

CSS_NAME=foo will result in the following scripts being written to

$ATST/bin:

fooUp, fooDown, fooRestart, fooManage, and fooGui

This will also result in the CSS screen files being written to:

$ATST/resources/screens/css/foo/*.xml

Camera Selection and Configuration Related Parameters

CSS_CAMERA_NAME

The DKIST defined name of the camera that will be controlled by this

instance of the CSS. See Appendix A, “Table 25 List of Camera Names” for a list of currently supported cameras.


MAN-0008, Rev G 10



Option Description

CSS_CSH_CONFIG_FILE

(Optional)The path and filename of a camera hardware configuration file.

Leaving this field blank will result in the CSS using the contents of the auto-generated “$ATST/admin/css/prop/.default.config” file to set the values of user configurable properties when generating the camera property file from the camera property template file.

NOTE:

If you don't have a “$ATST/admin/css/prop/.default.config“ file

but want to configure hardware parameters then initially leave this field blank. A “.default.config” file is auto-generated each time 'pkgDevel css --load-prop' successfully completes.

Once successfully completed, copy the default configuration file for your camera to a location of your choosing and edit to set the desired values. When done editing, set the value of this parameter to the path/filename of your .config file and then re-load properties using:

$ATST/admin/pkgDevel css --load-prop)

See Section 3.4.1, Table 5, “Default Camera Configuration” for additional information.

Simulation Data Related Parameters

CSS_SIM_ENABLE

Enable/Disable camera simulation.

“yes” Configure the CSS to simulate data acquisition and processing for the camera identified by CSS_CAMERA_NAME.

“no” Configure the CSS to run the physical hardware for the camera selected by CSS_CAMERA_NAME.

CSS_SIM_DATA_PATH

The path to your simulation data files. If you followed the step outlined in Section 3.6 then this option should be set to: CSS_SIM_DATA_PATH=/your/sim/data/path/cssSimData/12-bit/2560x2160

NOTE: This parameter is only required if CSS_SIM_ENABLE=yes. However, it is recommended that you provide a valid path to facilitate switching between simulation and real camera hardware.

CSS_SIM_DATA_BASE_FILENAME

The base filename for your simulation data files. The base filename is defaulted to “cssSim_2560x2160” in the cssSite.config file and should not be changed during the course of default CSS installation procedures.

NOTE: This parameter is only required if CSS_SIM_ENABLE=yes. However, it is recommended that you provide a valid base filename to facilitate switching between simulation and real camera hardware.

CSS_SIM_DATA_FILES_PER_SET

The number of files-per-set of simulation data. By default, the CSS ships with 100 files per set. The files-per-set is defaulted to ‘100’ in the cssSite.config file and should not be changed during the course of normal CSS installation procedures.

NOTE: This parameter is only required if CSS_SIM_ENABLE=yes. However, it is recommended that you provide a valid number of files per set to facilitate switching between simulation and real camera hardware.

Parameter-set Database Related Parameters

CSS_PSETDB_CATEGORY

The Parameter-set Database Category to be used with your system. This is the system that ‘owns’ the parameter-sets. By convention, and to avoid collisions with other systems, the Parameter-set Database Category should be set to the same value as the Fully Qualified Name of your system and should be equal to a.b.c as described in Section 3.3.1.

CSS_PSETDB_NAME

The initial identifying name for the parameter-sets within your category. The parameter-set name is used to group sets of camera configuration and execution blocks by task such as “default”, “observe”, “setup”, “focus”, etc. This is the default “name” that the CSS will initially use to retrieve parameter-sets from the database.


MAN-0008, Rev G 11



Option Description

CSS_DEFAULT_CCID

The ID of the default camera configuration that will be executed when this VCC enters the ‘running’ state. If you set this value to something other than ‘cc_default’, then a camera configuration with that ID must

exist in the Parameter-set database under the Category and Name defined above.

See Section 8.1.1 for details on the CSS default camera configuration and Section 8.1.3.4 for details on defining your own default camera configuration.

Data Publication Related Parameters

CSS_BDT_TABLENAME The name of a property table in the Property Database that contains the parameters required by SPEC-0151 to configure a data publisher.

World Coordinate Information Related Parameters

CSS_WCI_WPOS_SOURCE

The source name of the wPos event that this instance of the CSS will monitor. The name provided must match the name supplied to WciWatch by the system controlling this camera in order for this camera to monitor the proper source.

Example: If the fully qualified name of your system is atst.foo.bar then

you may choose to use that name as the wPos event source name. Therefore, CSS_WCI_WPOS_SOURCE=atst.foo.bar.

NOTE: DO NOT INCLUDE .wPos as part of the supplied name.

NOTE: By default, the CSS uses a source name that does not exist in

the system and therefore will not be able to monitor a wPos event. The not collect and publish WCI meta-data.

CSS_WCI_WPOS_UPD_INTERVAL The interval (in ms) that the CSS will use to monitor the wPos source as defined in CSS_WCI_WPOS_SOURCE.

Table 4: cssSite.config File Parameters

3.3.4. Modifications to bdtSite.config and baseSite.config

The CSF components base and bdt both come with their own “site.config” file. Be sure that both files are

configured per their respective installation instructions. Installation instructions for these components can

be found in $ATST/docs/guides.

Completing CSF and CSS Installation

Once the steps outlined in Sections 3.1 CSF Installation, 3.2 Hardware Support Package Installation, and

3.3 Customizing the CSS Installation are complete follow these steps to complete the installation process:

If installing the CSS in conjunction with a fresh ASDT:

$ cd $ATST

$ ./admin/pkgDevel base bdt css --init-data --init-bin

$ make build_all docs

$ ./admin/pkgDevel base bdt css --load-db --init-resources

If installing the CSS on top of an existing ASDT:

$ cd $ATST

$ ./admin/pkgDevel base bdt css --init-data --init-bin

$ make ice_clean class_clean gcc_clean jni_clean

$ make build_all docs

$ ./admin/pkgDevel base bdt css --load-db --init-resources


MAN-0008, Rev G 12

3.4.1. What did pkgDevel just do for me?

Upon completion of execution of pkgDevel, a number of files will be automatically generated and

installed per the parameters defined in cssSite.config. The following table outlines the files that are either

generated or simply operated on during the course of execution of pkgDevel.

WARNING: If you are re-executing pkgDevel to effect some change to cssSite.config all properties that

were previously installed will be removed and re-installed. If for some reason you have modified any

properties in the CSS property tables those modifications will be lost.

WARNING: Each time a parameter-set is inserted into the parameter-set database a new “version” is

assigned to it. Parameter-set database version numbers are a monotonically increasing integer that is

incremented each time any parameter-set is inserted in the database. Version numbers are not

incremented based on a unique Category/Name/ID combination.

NOTE: in this table refers to the Fully Qualified Name of your VCC as defined by the

CSS_VCC_FQNAME option in the cssSite.config file.

CSS results from execution of pkgDevel

Filename Description

Application Database

Output directory: $ATST/admin/css/app NOTE: The contents of any *.app file are automatically written to the Application DB using $ATST/bin/AppReader

.app Contains the Host, Container, and Contro