ICS Framework
3.0.0

Table of Contents

  • Introduction
    • Scope
    • Acronyms
    • Overview
  • Release Notes
    • Summary
      • What is the scope of this version?
      • What is new in this release?
      • What is the purpose of the IFW release?
    • Development Environment
    • Instrument Specifics Packages
    • Components
      • Rapid Application Development (RAD)
      • Extensible Test Runner (ETR)
      • Sequencer
      • Function Control Framework (FCF)
        • Device Manager
        • Device Simulators
        • Engineering Graphical Interfaces
        • PLC Libraries
        • PLC Related Incompatibility Issues and Improvements
    • Known Problems
  • Installation
    • Machine Preparation
    • Requirements
    • ELT Development Environment (DevEnv)
    • Operational User
    • Environment Variables
    • Getting Started
    • Start nomad and consul services
    • Manual installation
    • Project Template
  • Getting Started
    • Creating a Project Configuration
    • Starting/Stopping the ICS Software
    • Introduction to Nomad/Consul
      • Basic Configuration and Assumptions
      • Nomad Jobs
      • Nomad GUI
      • Consul Service Discovery
      • Consul GUI
      • Nomad Templates
      • How to start/stop a job from the command line
      • How to get the Job standard output
    • Startup/Shutdown Contents
    • Executing Startup/Shutdown Script
      • Starting Redis Server
      • Starting Sequencer Server
      • Starting Sequencer GUI
      • Running the Startup Script
      • Troubleshooting
      • Validating the Software with a sample OB
      • Updating Sample Configuration
  • User Manuals
    • ELT ICS Common Tools & Definitions (CTD)
      • Introduction
        • Introduction
        • Common Tools & Definitions - C++ Utilities
        • Common Tools & Definitions - Python Utilities
      • Indices and tables
    • ELT ICS Data Interface Tools (DIT)
      • Introduction
        • Introduction
        • Data Interface Dictionary
        • FITS Library
        • Testing
      • Indices and tables
    • ELT ICS Function Control Framework (FCF)
      • Introduction
        • Scope
        • Acronyms
        • Main Components
        • Top Directory Structure
        • Device Manager (devmgr)
        • Device Simulators (devsim)
        • Graphical Interfaces (gui)
        • PLC Libraries (controllers)
      • Device Manager
        • Supported Devices
        • Device Manager State Machine
        • Configuration
        • Database Attributes
        • Commands
        • Troubleshooting
      • PLC Libraries
        • Common Attributes and Functionality
        • Lamp Library (lamp.library)
        • Shutter Library (shutter.library)
        • Time Library (timer.library)
        • Motor Library (motor.library)
        • CCS Simulator (motor.library)
        • Drot Controller (motor.library)
        • ADC Controller (motor.library)
        • I/O Device Library (ioDev.library)
        • Communication Libraries (rsComm*.library)
        • Piezo Library (piezo.library)
        • Actuator Library (actuator.library)
      • Creating PLC Applications with MakeTcProject Utility
        • Configuration File MakeTcProject.cfg
        • Utility Specifics
        • Summary of Main Steps
        • Building PLC Application
        • Testing PLC Application on Windows PC
        • Customizing PLC Application to match Instrument Project
        • PLC Application deployment to PLC
      • Client Application
        • List of Commands
      • Python Client Library
        • Error Handling
        • Classes
        • Examples
      • FCF CLI
        • Command Line Parameters
        • Shell History
        • Shell Completion
        • Supported Shell Commands
      • JSON Schema
      • Simple Parameter Format (SPF)
      • Device Simulator
        • Device Simulator - Command Line Options
        • Device Simulator - Base Application
        • Generation of the SCXML State Machine Model
        • Generation of the OPC UA Namespace Profile
        • Device Simulators for Standard Devices
        • Developing a Device Simulator
      • Engineering Interfaces
        • Device Manager GUI
        • Motor Engineering GUI
      • Programming Guide
        • Device Manager Extensions
        • Extending JSON schema
      • Getting Started
        • Log-in
        • IFW Software
        • Database Server
        • FCS Configuration
        • Device Manager Logs
        • Using the DeviceManager GUI
        • Using the Motor Engineering GUI
        • Working with a PLC
        • Stopping the Software
      • Indices and tables
    • ELT ICS Online Data Processing (ODP)
      • Introduction
        • Scope
        • Acronyms
        • ODP Tree
      • Common Library for Image Processing (CLIPM)
        • Image Analysis Routines
      • C++ library (CppCPL)
        • Error Handling
        • Classes
        • Testing
        • Examples
      • Python Binding (PyCPL)
        • Error Handling
        • PyCPL Constants
        • PyCPL Enumerations
        • PyCPL Classes
        • Buffer Protocol
        • Testing
        • Examples
        • Instrument Extensions
      • Getting Started
        • Log-in
        • Retrieve and build the ODP Software
      • Indices and tables
    • ELT ICS Data Display Tool (DDT)
      • Introduction
        • Delivery Scope
      • Indices and tables
    • ELT ICS Camera Control Framework (CCF)
      • Introduction
        • Scope
        • Main Deliverables
        • Disclaimer
        • Acronyms
        • Nomenclature
      • Overview
        • Architecture
        • State Machine
        • Online Database
        • Example & Template Files
      • Configuration
        • Main Configuration
        • Initialisation Setup
        • Camera Name Mapping
        • Metadata Name Mapping
        • Dictionaries
        • Simulation Data File
      • Setup
        • Exposure Control Parameters
        • Simulation Parameters
        • Pipeline Processing
      • Request & Pub/Sub Interfaces
      • Adapters
        • The Communication Adapter
        • The Processing Recipe Adapter
        • The Data Publisher Adapter
      • Standard Adapters
        • Standard Communication Adapters
        • Standard Processing Recipe Adapters
        • Standard Data Publisher Adapters
      • Installation & Deployment
        • Installation
        • Deployment Module
        • CCF Control - Execution - Example
        • CCF Generate FITS Cube Tool (“ccfGenFitsCube”)
        • System Tuning
        • Performance & Statistics
      • Indices and tables
    • ELT ICS Supervisor
      • Introduction
        • Scope
        • Acronyms
        • Main Components
        • Top Directory Structure
        • System Supervisor (syssup)
        • Subsystem Simulators (subsim)
      • System Supervisor
        • System Supervisor State Machine
        • Configuration
        • Commands
        • Subscriptions
        • Publishing
        • Signal Handling
        • Troubleshooting
      • Subsystem Simulator
        • Simulator State Machine
        • Configuration
        • Commands
        • Publishing
        • Troubleshooting
        • C++ Simulator Client
      • Python Client Library
        • Error Handling
        • Classes
        • Examples
      • Simulator CLI
      • Client Application
        • List of Commands
      • Python Client Library
        • Error Handling
        • Classes
        • Examples
        • Supervisor CLI
      • Getting Started
        • Log-in
        • IFW Software
        • SysSup Configuration
        • System Supervisor Logs
        • Interacting with the Server
        • Stopping the Software
      • Indices and tables
    • ELT ICS Data Acquisition (DAQ)
    • ELT ICS Rapid Application Development (RAD)
    • ELT ICS Extensible Test Runner (ETR)
    • ELT ICS Sequencer (SEQ)
    • Doxygen documentation
  • Developer Guides
    • ELT Dev Environment documentation
  • Abbreviations and Acronyms
  • Terminology
ICS Framework
  • Docs »
  • User Manuals

User Manuals¶

ICS User manuals

  • ELT ICS Common Tools & Definitions (CTD)
  • ELT ICS Data Interface Tools (DIT)
  • ELT ICS Function Control Framework (FCF)
  • ELT ICS Online Data Processing (ODP)
  • ELT ICS Data Display Tool (DDT)
  • ELT ICS Camera Control Framework (CCF)
  • ELT ICS Supervisor
  • ELT ICS Data Acquisition (DAQ)
  • ELT ICS Rapid Application Development (RAD)
  • ELT ICS Extensible Test Runner (ETR)
  • ELT ICS Sequencer (SEQ)

Doxygen documentation¶

  • core (ctd, dit and stoo)

  • fcf

  • odp

  • ccf

  • sup

  • daq

  • rad

  • etr

  • seq

Next Previous

© Copyright 2021 ESO - European Southern Observatory.