onboardapi  9.10.0
by Rheinmetall
Interfaces

The following interfaces are part of the library.

M_ActuationCtrl

Client and Service classes:

Operations:

Description:

Types used by the actuation control service and client. Interfaces used by the actuation control service and client.

M_Alert

Client and Service classes:

Operations:

Description:

Types used by the Alert Service/Client. An Alert service generates Alerts (Alarms and Threat Alerts) from resource clients. It manages the lifetime of these generates Alerts.

Start Alert Service
Raise Alarm
Resolve Alarm
Acknowledge Alarm
Auto Acknowledge Alarm
Override Alarm Condition
Unoverride Alarm Condition
Clear Alarm
Raise Threat Alert
Cancel Threat Alert

M_Alignment

Client and Service classes:

Operations:

Description:

Types used by the alignment service and client. Interfaces used by the coordinate frame service and client. The service can be used to manage positions, attitudes and motion across different reference frames. It also enables aligning a component's line of sight with a target.

Alignment Overview

M_AnalogueIo

Client and Service classes:

Operations:

Description:

Types used by the analogue input/output service and client. An analogue input/output interface is used to set or retrieve analogue signals in/from devices.

M_Auth

Client and Service classes:

Operations:

Description:

Types used by the Auth Service and Client. A auth service.

M_BuiltInTest

Client and Service classes:

Operations:

Description:

Types used by the BITE Service and Client. A BITE (Built-In Test Equipment) service is used to perform PBIT, CBIT and IBIT and report results and failures.

Built-In Test Start
Built-In Test Stop

M_BuiltInTestCtrl

Client and Service classes:

Operations:

Description:

Types used by the BITE (Built-In Test Equipment) Control Service and Client. A BITE (Built-In Test Equipment) Control service is used to control the Built-In Test subsystem.

BITE Control Test
Historical BITE records

M_Camera

Client and Service classes:

Operations:

Description:

Types used by the Camera Service. A Camera service is used to control the various image controls of a camera.

Camera Information

M_CameraManager

Client and Service classes:

Operations:

Description:

A camera manager to dynamically create, update and delete cameras.

M_CoordinateFrame

Client and Service classes:

Operations:

Description:

Types used by the coordinate frame service and client. Interfaces used by the coordinate frame service and client. The service can be used to manage positions, attitudes and motion across different reference frames. It also enables aligning a component's line of sight with a target.

Coordinate Overview

M_Device

Client and Service classes:

Operations:

Description:

Types used by the Device Service and Client. A device service represents a resource or application. It can be used to report general information such as version info and device mode.

Device Information

M_Dialogue

Client and Service classes:

Operations:

Description:

Types used by the dialogue service and client. A dialogue service is used to control user dialogues and other text-based messages (e.g. used for logging).

M_ErrorMemory

Client and Service classes:

Operations:

M_FileTransfer

Client and Service classes:

Operations:

Description:

Interfaces and types used by the FileTransfer Service and Client. Interfaces and types used by the FileTransfer Service and Client.

M_GenericInputOutput

Client and Service classes:

Operations:

Description:

Types used by the GenericInputOutput Service and Client A generic input output service represents any IO interface. It can be used to report any information about the IO interface.

M_HidCoordInput

Client and Service classes:

Operations:

Description:

Types used by the Coord Input Service. A Coord Input service represents an input device such as a touch screen or a mouse which can generate input coordinates (2D pixel points) representing a mouse button or touch screen press.

Coordinate Input

M_HidDisplay

Client and Service classes:

Operations:

Description:

Types used for input devices, for example Joystick axis and buttons. A HID Display service can be used to represent an HID Display.

HID Display Information

M_HidJoystick

Client and Service classes:

Operations:

Description:

Types used for input devices, for example Joystick axis and buttons. Interfaces used to handle Joysticks. A HID Joystick service is used to represent inputs from a Joystick.

HID Joystick Information

M_HidManager

Client and Service classes:

Operations:

Description:

Data types used by the HID Manager. Interfaces used by the HID Manager.

M_HmiAppCtrl

Client and Service classes:

Operations:

Description:

Data types used by the HMI application control service. An HMI application control service manages external application views for the HMI.

HMI Application Control Information

M_ImageComposer

Client and Service classes:

Operations:

Description:

Interfaces used by the ImageComposer Service and Client. An Image Composer service represents is used to configure view ports for video streams.

Image Composer Information

M_ImageFusion

Client and Service classes:

Operations:

Description:

Interfaces used by the ImageFusion Service and Client. An Image Fusion service is used to blend two video channels together.

Image Fusion Information

M_ImageProcessing

Client and Service classes:

Operations:

Description:

Types used by the image processing service and client. Interfaces used by image processing devices.

M_KinematicChain

Client and Service classes:

Operations:

Description:

Types used by the kinematic chain service and client. Interfaces used by the kinematic chain service and client.

M_LanguageManager

Client and Service classes:

Operations:

Description:

Types used by the language manager service and client. Interfaces used by the language manager service and client.

M_LaserRangeFinder

Client and Service classes:

Operations:

Description:

Interfaces used to handle Laser Range Finder. A Laser Range Finder (LRF) service represents a Laser Range Finder. It extends a Sensor service with information specific to a Laser Range Finder (LRF) Sensor.

Laser Range Finder

M_Logging

Client and Service classes:

Operations:

Description:

Types used by the Logging Service and Client. A logging service represents a resource or application. It can be used to send or request log messages and change the runtime log level.

M_Manipulator

Client and Service classes:

Operations:

Description:

Types used by the manipulator service and client. Interfaces used by the manipulator service and client.

M_MetSensor

Client and Service classes:

Operations:

Description:

Types used by the Meteorological Sensor Service. Interfaces used by the Meteorological Sensor Service and Client.

M_MissionCtrl

Client and Service classes:

Operations:

Description:

Types used by the mission control service and client. Interfaces used by the mission control service and client.

M_Mount

Client and Service classes:

Operations:

Description:

Types used by the Mount Service. Interfaces used by the Mount Service and Client.

M_MultiMount

Client and Service classes:

Operations:

Description:

Types used by the Mount Service. Interfaces used by the Mount Service and Client.

MultiMount Overview

The following conventions may apply for the given operations:

  • IService::CmdMode:
  • Mode.Name = "Mode", Mode.TextualValue[0] = "Stab"
  • Mode.Name = "Mode", Mode.TextualValue[0] = "Unstab"
  • Mode.Name = "Mode", Mode.TextualValue[0] = "Deselect"
  • Mode.Name = "Mode", Mode.TextualValue[0] = "MotorOff"
  • Mode.Name = "Mode", Mode.TextualValue[0] = "Lock"
  • Mode.Name = "Mode", Mode.TextualValue[0] = "Assignment"
  • Mode.Name = "Mode", Mode.TextualValue[0] = "SlavedToLeading"
  • Mode.Name = "HorizontalAiming", Mode.EnumeratedValue[0] = On or Off
  • Mode.Name = "RateAid", Mode.EnumeratedValue[0] = On or Off
  • IClient::ReportMountStatus with Status.OperationStatus.Mode:
  • Status.OperationStatus.Mode = "Mode", Status.OperationStatus.TextualValue is given by diagram above.
  • IClient::ReportMountStatus with Status.OperationStatus.Mode.SubmodeList:
  • Status.OperationStatus.SubmodeList[x].Name = "CtrlState", Status.OperationStatus.SubmodeList[x].TextualValue[0] is given by diagram above.
  • Status.OperationStatus.SubmodeList[x].Name = "PositionState", Status.OperationStatus.SubmodeList[x].TextualValue[0] = "PositioningOff" or "PositionReached" or "PositionNotReached"
  • Status.OperationStatus.SubmodeList[x].Name = "RateAid", Status.OperationStatus.SubmodeList[x].EnumeratedValue[0] = On or Off
  • Status.OperationStatus.SubmodeList[x].Name = "HorizontalAiming", Status.OperationStatus.SubmodeList[x].EnumeratedValue[0] = On or Off
  • AxisId in IService::NotifyAxisRotations, IService::ConfigAxisRotationConstraints, IService::ConfigStoreAxisRotations and IClient::ReportAxisRotations:
  • Azimuth
  • Elevation
  • AzimuthNorth
  • ElevationHorizon
  • AzimuthRelative (typical for commands only, e.g. rate on top of coasting rate)
  • ElevationRelative (typical for commands only, e.g. rate on top of coasting rate)
  • AzimuthInertial (typical for report, alternative is M_CoordinateFrame)
  • ElevationInertial (typical for report, alternative is M_CoordinateFrame)
  • AzimuthPlumb
  • ElevationPlumb
  • CantPlumb
  • AzimuthAssignmentOffset (report only, applicable for scan ctrl)
  • ElevationAssignmentOffset (report only, applicable for scan ctrl)

M_ObjectManager

Client and Service classes:

Operations:

Description:

Types used by the Object Manager Service/Client. Interfaces used by the ObjectManager Service and Client.

ObjectManager Overview

M_OverlayCtrl

Client and Service classes:

Operations:

Description:

Types used by the Overlay Ctrl Client and Service. An Overlay Control service is used to handle graphical overlays.

Overlay Control

M_RecordingCtrl

Client and Service classes:

Operations:

Description:

Interfaces and types used by the Recording Control Service and Client. Interfaces and types used by the Recording Control Service and Client.

Recording Start
Recording
Recording Shutdown

M_ReplayCtrl

Client and Service classes:

Operations:

Description:

Interfaces and types used by the Replay Control Service and Client. Interfaces and types used by the Replay Control Service and Client.

ReplayCtrl Startup
ReplayCtrl Replay
ReplayCtrl Periodical Status Update
ReplayCtrl Shutdown

M_ScanCtrl

Client and Service classes:

Operations:

Description:

Types used by the ScanCtrl Service/Client. Interfaces used by the Scan Control Service and Client.

ScanCtrl Information

M_SectorSelection

Client and Service classes:

Operations:

Description:

Types used by the Sector Selection Service. A Sector Selection service is used to select sectors from an HMI.

Sector Selection

M_Sensor

Client and Service classes:

Operations:

Description:

Interfaces used to handle a sensor. The sensor interface contains general information common to different tactical sensors.

Sensor 1
Sensor 2

M_SignalGenerator

Client and Service classes:

Operations:

Description:

Types used by the signal generator service and client. Interfaces used by the signal generator service and client.

M_SignalProcessing

Client and Service classes:

Operations:

Description:

Types used by the signal processing service and client. Interfaces used by signal processing devices.

M_Teleoperation

Client and Service classes:

Operations:

Description:

Types used by the teleoperation service and client. Interfaces used by the teleoperation service and client.

M_TerminalCtrl

Client and Service classes:

Operations:

Description:

Types used by the Terminal Control interfaces. Interfaces used by the Terminal Control Service and Client. The Terminal Control Service can be used to control a Terminal host node, by commanding it to do things such as changing the display brightness.

M_TimeManager

Client and Service classes:

Operations:

Description:

Types used by the time manager service and client. Interfaces used by a time service and client.

M_VideoManager

Client and Service classes:

Operations:

Description:

Types used by the Video Manager Service. Interfaces used by the Video Manager Service and Client. The Video Manager handles the switching between Cameras (e.g. TV/IR) and coupling the Field of View.

M_VideoMetadata

Client and Service classes:

Operations:

Description:

Types used by the Video Metadata Interface. Interfaces used by the video metadata service and client.

M_VideoObjectExport

Client and Service classes:

Operations:

Description:

Types used by the Video Object Export Service and Client. Interfaces used by the Video Object Export Service and Client.

Video Object Export Startup
Video Object Export Vehicle Movement
Video Object Export Mount Movement
Video Object Export Camera Field of View Change
Video Object Export Marker Object

M_VideoTrackerAtr

Client and Service classes:

Operations:

Description:

Interfaces used by the Automatic Track Recognition (ATR) Service and Client. This tracking mode establishes tracks automatically based on expected object characteristics.

M_VideoTrackerCommon

Client and Service classes:

Operations:

Description:

Interfaces used by the Multi-Mode Tracker Service and Client.

Multi-Mode Tracker Overview

M_VideoTrackerLosCtrl

Client and Service classes:

Operations:

Description:

Interfaces used by the Line-of-Sight Control (LOS) Service and Client. VideoTracker LOS-Control module holds the Line-of-Sight onto objects for Line-of-Sight tracking. The units of this interface are angular. The LOS-Control module needs information from the system to perform LOS-Control tasks, see M_VideoTrackerCommon interface description.

M_VideoTrackerLot

Client and Service classes:

Operations:

Description:

Interfaces used by the Lock-On Tracking (LoT) Service and Client. This tracking mode is active for objects, that are locked-on by the operator.

M_Watchdog

Client and Service classes:

Operations:

Description:

Types used by the watchdog service and client. Interfaces used by the watchdog service and client.