RTC Toolkit
4.0.0

Table of Contents

  • Introduction
    • Scope
    • Overview
    • Source Code
    • Previous Release
  • Release Notes
    • Summary
      • What is the purpose of this release?
      • What is the scope of this version?
        • Component Framework
        • Reusable Components
        • Examples and Tutorials
        • Other Features
        • Documentation
      • Limitations and Constraints
    • Dependencies
      • Development Environment ELT DevEnv
      • Deployment
      • Core Integration Infrastructure CII
      • DDS Middleware FastDDS
      • Rapid Application Development RAD
      • Roadrunner
      • Data Display Tool DDT
      • Control UI Toolkit (CUT)
      • STD Interface (stdif)
      • METADAQ Interface (metadaqif)
      • Low-latency Networking Library (llnetio)
      • TAI Clock
      • Msgsend
      • Extensible Test Runner etr
  • Installation
    • Machine Preparation
    • ELT Development Environment
    • Install RTC Toolkit and Dependencies
    • Account Configuration
    • Configuration of Required Services
      • CII postinstall
      • Metadata Instances
      • Startup of Required Services
        • CII Service startup
        • Consul Agent Startup
        • Nomad Agent Startup
    • Install from Source Code - Optional
      • Installation of Dependencies
      • Installation of the RTC Toolkit
      • Verify Correct Installation
  • Tutorials
    • Creating a Simple RTC Component
      • Running the Example
      • Development Guide
        • Build Script
        • Business Logic Class
        • main.cpp
        • Config Files
    • Creating a Custom RTC Component
      • Running the Example
      • Development Guide
        • MAL Interface Definition
        • RTC Component Application
        • RTC Client Application
    • Telemetry Republisher Example
      • Provided Example
        • Example Location
        • Modules
        • Dependencies
        • The Example Components
        • Configuration
        • Running the Example
    • Customise a Telemetry Subscriber
      • Prerequisites
      • Running the Example
        • Initial Run
        • Deployment
        • Start the Component
        • Send State Steering Commands
        • Checking the State
        • Checking the Output
        • Stopping and Cleanup
      • Instantiating a Telemetry Subscriber
        • Overview
        • Adjusting the Blender Function
        • Add Additional Topics
    • Creating a Custom Data Task
      • Provided Examples
      • Periodic Telemetry Data Task
        • Source Code Location
        • Modules
        • Dependencies
        • Running the Periodic Telemetry Data Task Example
      • Data Task Development Guide
        • Business Logic Class
        • Computation Class
        • Configuration
      • Measure Telemetry Data Task
        • Source Code Location
        • Modules
        • Dependencies
        • Running the Measure Telemetry Data Task Example
      • Measure Interface Development Guide
        • Business Logic Class
      • Optimise Data Task
        • Source Code Location
        • Modules
        • Running the Optimise Data Task Example
      • Optimise Interface Development Guide
        • Business Logic Class
      • GPU and Python integration
        • GPU Support
        • Python Support
    • Creating a Custom Telemetry Recorder
      • Provided Example
        • Source Code Location
        • Modules
        • Dependencies
        • Running the Example Telemetry Recorder
      • Development Guide
        • Customisation
        • Configuration
    • Creating a Custom Metadata Collector
      • Provided Example
        • Source Code Location
        • Modules
        • Dependencies
        • Running the Example Telemetry Recorder
      • Development Guide
        • Recording Units
        • RecordingInfo
        • Business Logic Factory
    • Creating a Custom DDT Server
      • Provided Example
        • Source Code Location
        • Modules
        • Dependencies
        • Running the Example DDT Server
      • Development Guide
        • Customisation
        • Configuration
    • Creating a Custom RTC Widget
      • Provided Example
        • Source Code Location
        • Modules
        • Dependencies
        • Using the Widget
      • Development Guide
        • Item Factory
        • Widget Implementation
        • Project Definition and Wscript
    • GPU support
      • Overview
      • CUDA
        • Installation
        • Waf Support
        • Supported versions
      • Example Data Task GPU
        • Source Code Location
        • Modules
        • Classes
      • Limitations and Known Issues
    • Python support
      • Overview
        • Source Code Location
        • Modules
        • Running the Example
      • Using Provided Python Bindings
    • Putting Everything Together for a Minimalistic SRTC System
      • Prerequisites
      • Running the Example
      • Development Guide
        • Configuration of the Telemetry Data Path
        • Configuration of the RTC Supervisor
      • Distributed Scenario
        • CII Services
        • Consul and Nomad
        • Service Discovery Endpoint
        • Running the Example
  • Component Framework
    • RTC Component
      • Supported Functionality
      • Launching
      • Baisc Component Life-cycle
      • Instropection Commands
      • Update Command with Custom Payload
      • Custom Component Life-cycles
      • API Usage
      • Limitations and Known Issues
    • Logging
      • API Usage
      • Log Files
    • Service Discovery
      • Supported Service Queries
      • Service Discovery API
      • Example Code
      • Limitations and Known Issues
    • Runtime Configuration Repository
      • Data Access
        • Datapoint Paths
        • Datapoint Creation
        • Datapoint Reading
        • Datapoint Writing
        • Datapoint Querying
        • Datapoint Deletion
        • Commandline/Graphical Manipulation
      • Datapoint Subscription
        • Subscribing
        • Unsubscribing
      • Supported Data Types
      • Composite Datapoints
        • NUMA Policies
      • File Format
        • Scalar Types
        • Vector Types
        • Matrix Types
        • FITS Writing Threshold
      • Limitations and Known Issues
        • File Based Repository
        • Locking
        • Aliasing of Types
        • Span Performance
        • Subscription Deadlocks
        • Subscription Race Conditions
        • Other Bugs
    • Persistent Configuration Repository
      • Modifying the Configuration
        • Datapoint Paths
        • Datapoint Reading
        • Datapoint Writing
        • Datapoint Querying
      • Configuration Layout
        • Server Alias Table
      • Service Discovery Endpoint
      • Data Access Using the API
      • Supported Data Types
      • File Format
        • Layout and Directory Structure
        • External URIs
      • Limitations and Known Issues
    • Online Database
      • Data Access
      • Datapoint Subscription
      • Supported Data Types
      • File Format
      • Limitations and Known Issues
    • Event Service
      • Design Assumptions
      • Low-level API
      • High-level API
      • Predefined Event Types
      • Creating Custom Event Types
      • Limitations and Known Issues
    • Component Metrics
      • Usage
      • Configuration
      • Online Database Data Points
      • Supported Performance Counter Types
    • Alert Service
      • Introduction
      • Observability
      • Usage
    • Consul and Nomad usage
      • Nomad usage
        • Nomad job files
        • Nomad agent
      • Consul usage
        • Consul agent
    • Python Support
      • Guidelines
        • Interpreter Instantiation
        • Always Acquire The GIL
        • Python Exceptions
        • Python Code As Modules
      • Embedded Python Interpreter
      • Provided Python Bindings
      • Limitations and Known Issues
  • Reusable Components
    • RTC Supervisor
      • Overview
      • Launching
      • Commands
      • Customisation
      • Configuration
      • Monitoring
      • Behaviour
        • Populating the Runtime Configuration Repository
        • Handling Operational Modes
        • Writeback to Persistent Configuration Repository
        • State Guiding
        • Status Estimation
        • Component Monitoring
        • Error Recovery
      • Limitations and Known Issues
    • Telemetry Republisher
      • Overview
      • Prerequisites
      • Customisation
      • Running
      • Commands
      • Configuration
        • Common Configuration
        • Receivers Configuration
        • DDS Topic Configuration
      • Errors
        • Not Operational
        • Operational
      • Monitoring
        • Component Metrics
      • Limitations and Known Issues
    • Telemetry Subscriber
      • Overview
      • Prerequisites
      • Customisation
        • Shared Memory Super-Topic
        • The Blender Function
        • Instantiation
      • Configuration
        • DDS Parameters
        • Shared Memory Queue Parameters
        • Operational Logic Parameters
      • Commands
      • Errors
        • Not Operational
        • Operational
      • Alerts
      • Component Metrics
    • Telemetry Recorder
      • Overview
      • Commands
      • Customisation
      • Configuration
        • Recording Session Configuration
        • Recording Unit Configuration
        • Configuration Example
      • Monitoring
        • Recording Session Monitoring
        • Recording Unit Monitoring
      • Errors
        • Not Operational
        • Operational
      • Limitations and Known Issues
    • Metadata Collector
      • Overview
      • Commands
      • Customisation
      • Configuration
      • Monitoring
      • Limitations and Known Issues
    • Data Task
      • Overview
      • Prerequisites
      • Customisation
      • Telemetry-based Data Tasks
        • Structure
        • Behaviour
        • Configuration
        • Errors
      • Other Data Task Flavours
      • Limitations and Known Issues
    • Deployment Daemon
      • Overview
      • Prerequisites
      • Running
      • Configuration
      • Commands
      • Errors
      • Troubleshooting
    • DDT Server
      • Overview
      • Commands
      • Customisation
        • IPCQ DDT Forwarder
        • Custom DDT Forwarders
      • Configuration
        • IPCQ DDT Forwarder Configuration
        • Two Dimensional DDT Publishers
      • Monitoring
        • DDT Forwarder Monitoring
      • Errors
        • Not Operational
        • Operational
      • Limitations and Known Issues
    • MUDPI Publisher
      • Overview
      • Running
      • Commands
      • Configuration
        • Common Configuration
        • Publishers Configuration
      • Monitoring
        • Component Metrics
      • Limitations and Known Issues
  • Clients
    • Client Application
      • Overview
      • Configuration
      • Usage
      • Commands
        • Special Commands
        • Standard Interface stdif
        • Update Command Interface ucif
        • Function Control Interface fcif
        • Loop Control Interface lcif
        • Loop Suspension Interface lsif
        • Measure Command Interface mcif
        • Optimise Command Interface ocif
        • Set Modes Interface smif
        • Writeback Interface wbif
      • Customisation
      • Limitations and Known Issues
    • Configuration Tool
      • Metadata Initialisation
      • Tool Setup
      • Command Line Repository Operations
        • Get
        • Set
        • Delete
        • List
        • Read
        • Write
        • Validate
        • Populate
      • Graphical User Interface
      • Interactive Shell
      • Limitations and Known Issues
    • Control and Monitoring Tool
      • Starting the Application
      • Summary of the Control and Monitoring Tool
        • Menu
        • Deployment Overview
        • Standard Interface and Update Commands
        • Custom Commands
        • Logs
      • Errors
        • Limitations and Known Issues
    • Service Discovery Client
      • Usage
      • Limitations and Known Issues
  • Standalone Tools
    • Generic DDS publisher
      • Overview
      • Prerequisites
      • Running
      • Stopping
    • Generic DDS subscriber
      • Overview
      • Prerequisites
      • Running
      • Stopping
    • Shared Memory Publisher
      • Customisation
      • Operation
        • Repeat Mode
      • Troubleshooting
    • Raw Recorder
      • Overview
      • Raw Recorder Capture Tool
        • Usage
        • Example
      • Raw Recorder Extractor Tool
        • Usage
        • Example
    • Generic MUDPI publisher standalone tool
      • Overview
      • Running
      • Stopping
      • Limitations and Known Issues
    • MUDPI Publisher
      • Introduction
      • Running Multiple Instances with Triggering
      • Making a sample text file
      • Running with the TelRepub
    • Generic RTR Writer
      • Overview
      • Prerequisites
      • Running
      • Stopping
  • Developer Guides
    • ELT Development Environment Documentation
    • ELT Software Development Guides
    • CII Documentation
    • Data Display Tool (DDT)
    • Control UI Toolkit (CUT)
    • ICS Documentation
    • Third Party Documentation
  • API Documentation
  • Source Code
RTC Toolkit
  • »
  • Search

© Copyright 2024 ESO - European Southern Observatory.