RTC Toolkit Main Page

Table of Contents

• Introduction
• Component Framework
• Reusable Components
  • RTC Supervisor (rtcSupervisor)
  • Telemetry Republisher (telRepub)
  • Telemetry Subscriber (telSub)
  • Telemetry Recorder (telRec)
  • Metadata Collector (metadataCollector)
  • Data Task (dataTask)
  • Deployment Daemon (deploymentDaemon)
  • DDT Server (ddtServer)
• Clients
  • Client Application (ctrlClient)
  • Config Tool (configTool)
  • Control And Monitoring Tool (ctrlMonTool)
  • Service Discovery Client (serviceDiscoveryCli)
• Standalone Tools
  • Raw Recorder
  • DDS Publisher/Subscriber
  • SHM Publisher/Subscriber
  • MUDPI Publisher/Subscriber

Introduction

See RTCK API Contracts for how API is documented w.r.t. thread and exception safety.

Component Framework

Provides core functionality and common services that RTC components and related applications are based on.

Artefact

rtctk_componentFramework_rtcComponent_lib (library), wdep name: rtctk.componentFramework.rtcComponent

Reusable Components

RTC Supervisor (rtcSupervisor)

A single RTC Supervisor monitors all RTC components and acts as entry point for state control and error recovery.

Artefact

rtctkRtcSupervisor (application)

rtctk_reusableComponents_rtcSupervisor_lib (library), wdep name: rtctk.reusableComponents.rtcSupervisor.lib

Telemetry Republisher (telRepub)

Conveys Telemetry Data from HRTC to Telemetry Subscribers in the SRTC and controls the underlying protocols for transporting data to them.

Artefact

rtctkTelRepub (application)

Telemetry Subscriber (telSub)

Receives Telemetry Data from a Telemetry Republisher using a reliable communication pattern and makes data available to Data Tasks running on same machine via shared memory.

See Telemetry Subscriber page for additional details.

Artefact

rtctk_reusableComponents_telSub_lib (library), wdep name: rtctk.reusableComponents.telSub.lib

Telemetry Recorder (telRec)

Records Telemetry Data and events to FITS files.

Artefact

rtctk_reusableComponents_telRec (library), wdep name: rtctk.reusableComponents.telRec.lib

Metadata Collector (metadataCollector)

A library to implement a Metadata Collector component that can receive requests to produce FITS files containing keywords and binary tables.

Artefact

rtctk_reusableComponents_metadataCollector_lib (library), wdep name: reusableComponents.metadataCollector.lib

A specialised client application is provided for testing. It is used to send commands specific to a Metadata Collector component.

Artefact

rtctkMdcTestClient (application)

Data Task (dataTask)

Abstract base for concrete user-provided data processing components like Calibrator, Monitor and Optimiser. Data Tasks can ingest data from different sources like shared memory or the Runtime Configuration Repository.

Artefact

rtctk_reusableComponents_dataTask (library), wdep name: rtctk.reusableComponents.dataTask.lib

Deployment Daemon (deploymentDaemon)

Special component used to deploy all other RTC component and necessary services for a particular Deployment Set.

Artefact

rtctkDeploymentDaemon (application)

A command line client application is provided to send commands to the Deployment Daemon.

Artefact

rtctkDeploymentDaemonClient (application)

A helper utility is also provided for preparing the Nomad job files used by the Deployment Daemon.

Artefact

rtctkDeploymentGen (application)

DDT Server (ddtServer)

A library to implement a DDT server instance to publish DDT data streams from a shared memory super topic.

Artefact

rtctk_reusableComponents_ddtServer (library), wdep name: rtctk.reusableComponents.ddtServer.lib

Clients

Client Application (ctrlClient)

Command line tool for sending commands to RTC components and receiving replies.

Artefact

rtctkClient (application)

rtctk_clients_ctrlClient_lib (library), wdep name: rtctk.clients.ctrlClient.lib

Config Tool (configTool)

Provides a means to query, display and edit configuration data in the Persistent and Runtime Configuration Repositories.

Artefact

rtctkConfigTool (application)

Control And Monitoring Tool (ctrlMonTool)

A graphical tool used for monitoring the state of RTC components and sending standard commands to individual components. This is considered an engineering panel for power users.

Artefact

rtctkCtrlMonTool (application)

Service Discovery Client (serviceDiscoveryCli)

Used to query and retrieve URI endpoints for services and RTC components that are registered with the Service Discovery subsystem.

Artefact

rtctkServiceDiscoveryClient (application)

Standalone Tools

Raw Recorder

The Raw Data Recorder provides standalone tools delivered with the RTC Toolkit. The purpose is to facilitate the capture of raw network data from the WFS cameras, and then process the capture to extract FITS data with the appropriate and desired keywords e.g. PTP timestamp or frame ID for correlating with data from other sources.

Artefact

rtctkRawRecorderCapture (application)

rtctkRawRecorderExtractor (application)

DDS Publisher/Subscriber

DDS publisher and subscriber tools for agnostic (generic) topics used for testing.

Artefact

rtctkGenDdsPub (application)

rtctkGenDdsSub (application)

SHM Publisher/Subscriber

Shared memory publisher library for testing and debugging.

Artefact

rtctk_standaloneTools_shmPub (library), wdep name: rtctk.standaloneTools.shmPub

rtctk_standaloneTools_shmSub (library), wdep name: rtctk.standaloneTools.shmSub

MUDPI Publisher/Subscriber

A simple Linux socket based application which allows MUDPI packets to be generated and sent, which contain a well defined sample pattern.

Two programs are provided: mudpiPublisher and mudpiPublisherReceiver. The publisher does the sending and the receiver can be used to sanity check the publisher.

Artefact

rtctkMudpiPublisher (application)

rtctkMudpiPublisherReceiver (application)