RTC Toolkit Main Page

Table of Contents

• Introduction
• Component Framework
• Reusable Components
  • Telemetry Republisher (telRepub)
  • Telemetry Subscriber (telSub)
  • Telemetry Recorder (telRec)
  • RTC Supervisor (rtcSupervisor)
  • Data Task (dataTask)
  • Config Tool (configTool)
  • Client (client)
• 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:

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

Reusable Components

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:

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

Telemetry Recorder (telRec)

Records Telemetry Data and events to FITS files.

Artefact:

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

RTC Supervisor (rtcSupervisor)

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

Artefact:

rtctkRtcSupervisor (application)

Artefact:

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

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:

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

Config Tool (configTool)

Provides means to query, display and edit configuration data. An application is provided by the toolkit at this time.

Artefact:

rtctkConfigTool (application)

Client (client)

Command line tool for sending requests and receiving replies.

Artefact:

rtctkClient (application)

Artefact:

Library (library), wdep name: rtctk.reusableComponents.client.lib

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)

Artefact:

rtctkRawRecorderExtractor (application)

DDS Publisher/Subscriber

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

Artefact:

rtctkGenDdsPub (application)

Artefact:

rtctkGenDdsSub (application)

SHM Publisher/Subscriber

Shared memory publisher library for testing and debugging.

Artefact:

SHM Publisher (library), wdep name: rtctk.standaloneTools.shmPub

Artefact:

SHM Subscriber (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, the receiver can be used to sanity check the publisher. An additional two python programs are provided which allow FITS binary tables to be created and converted to the form used by the publisher.

Artefact:

rtctkMudpiPublisher (application)

Artefact:

rtctkMudpiPublisherReceiver (application)