RTC Toolkit
1.0.0
Table of Contents
Introduction
Scope
Overview
Source Code
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
FastDDS
dds
Rapid Application Development
rad
Extensible Test Runner
etr
Roadrunner
Installation
Machine Preparation
ELT Development Environment
Account configuration
Installation of Dependencies
Installation of the RTC Toolkit
Configuration of Required Services
CII postinstall
Metadata Instances
Startup of Required Services
CII Service startup
Nomad agent startup
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
Customising the RTC Supervisor
Configuration of the RtcSupervisor
Running RtcSupervisor
Creating a Custom Data Task
Provided Examples
Periodic Telemetry Data Task
Source Code Location
Modules
Dependencies
Running the Example Data Task
Development Guide
Business Logic Class
Computation Class
ReaderThread Class
Configuration
OLDB
Measure Telemetry Data Task
Source Code Location
Modules
Dependencies
Running the Example Data Task
Development Guide
Business Logic Class
Optimise Data Task
Source Code Location
Modules
Running the Example
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
FitsRecorder
Business Logic Class
RecordingThread
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
Limitations and Known Issues
Putting Everything Together for a Minimalistic SRTC System
Running the Example
Development Guide
Configuration of the Telemetry Data Path
Configuration of the RTC Supervisor
Distributed Minimalistic SRTC System
Prerequisites
Setup
The Example Components and deployment
Nomad set-up
Simple SRTC Computation
Simple HRTC Gateway
Modifications
Configuration
Nomad job files
Running the Example
Component Framework
RTC Component
Supported Functionality
Custom Component Life-cycles
API Usage
Limitations and Known Issues
Logging
API Usage
Limitations and Known Issues
Service Discovery
Supported Service Types
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
Persistent Configuration Repository
Modifying the Configuration
Datapoint Paths
Datapoint Reading
Datapoint Writing
Datapoint Querying
Service Discovery Endpoint
Data Access Using the API
Supported Data Types
File Format
Limitations and Known Issues
Online Database
Data Access
Datapoint Subscription
Supported Data Types
File Format
Limitations and Known Issues
Nomad usage in the Toolkit
Reusable Components
RTC Supervisor
Introduction
Launching the Server
Populating the Runtime Configuration Repository
State Guiding
Commanding
State Evaluation
Asynchronous Detection of Component Failure
Error Notification
Mutex Usage
Configuration
Deployment and Other Scripts
Todo
Telemetry Republisher
Overview
Prerequisites
Customisation
Running
Commands
Configuration
Common configuration
Receivers configuration
DDS Topic configuration
Errors
Limitations and Known Issues
Telemetry Subscriber
Overview
Prerequisites
Customisation
Shared Memory Queue Topic
The Blender Function
Instantiation
Configuration
DDS Parameters
Shared Memory Queue Parameters
Operational Logic Parameters
Commands
Errors
Not Operational
Operational
Limitations and Known Issues
Telemetry Recorder
Overview
Basic Operation
TelemetryRecorderBusinessLogic
RecordingThread
RecorderIf
FitsRecorder
Data Task
Overview
Prerequisites
Customisation
Reference Design
Outline
Structure
Interaction
Behaviour
Configuration
ReaderThread configuration
Computation configuration
Errors
ReaderThread
Computation
Other Data Tasks
Limitations and Known Issues
Single ReaderThread
Client Application
Overview
Configuration
Usage
Customisation
Limitations and Known Issues
Configuration Tool
Metadata Initialisation
Operations
Get
Set
Delete
List
Read
Write
Get-type
Populate-from
Differences From the Design Document
Standalone Tools
MUDPI Publisher
Introduction
Running Multiple Instances with Triggering
Making a sample text file
Running with the TelRepub
Generic DDS subscriber
Overview
Prerequisites
Running
Shared Memory Publisher
Customisation
Operation
Repeat Mode
Troubleshooting
Raw Recorder
Overview
Raw Recorder Capture Tool
Usage
Raw Recorder Extractor Tool
Usage
Developer Guides
ELT Development Environment Documentation
ELT Software Development Guides
CII MAL Documentation
Third Party Documentation
API Documentation
Source Code
RTC Toolkit
Docs
»
Welcome to RTC Toolkit documentation!
Welcome to RTC Toolkit documentation!
ΒΆ
Table of Contents
Introduction
Release Notes
Installation
Tutorials
Component Framework
Reusable Components
Standalone Tools
Developer Guides
API Documentation
Source Code