Telemetry ANSI-C API

The Telemetry ANSI-C API provides a backward compatible thread-safe Telemetry API for user developed programs originally written for TReK Release 3.x. The API is provided to allow user applications that integrated TReK 3.x APIs an easy path to upgrade to the latest TReK release. It uses the Telemetry C++ API to provide its functions. A few functions from the Release 3.x API are not currently supported.
Information is provided about these functions further down this page.

Functions to Retrieve Raw Data

• GetOneNewestRawValue() - Retrieves the newest unprocessed value for the specified parameter.
• GetOneNextRawValue() - Retrieves the next unprocessed value for the specified parameter.
• GetOneSamePacketRawValue() - Retrieves the unprocessed value for the specified parameter from the same packet as another parameter.
• GetNewestRawValue() - Retrieves one or more newest unprocessed values for the specified parameter.
• GetNextRawValue() - Retrieves one or more next unprocessed values for the specified parameter.
• GetSamePacketRawValue() - Retrieves one or more unprocessed values for the specified parameter from the same packet as another parameter.

Functions to Retrieve Converted Data

• GetOneNewestConvertedIntegerValue() - Retrieves the newest integer value for the specified parameter.
• GetOneNewestConvertedUnsignedIntegerValue() - Retrieves the newest unsigned integer value for the specified parameter.
• GetOneNewestConvertedDoubleValue() - Retrieves the newest double value for the specified parameter.
• GetOneNewestConvertedStringValue() - Retrieves the newest string value for the specified parameter.
• GetOneNewestConvertedTimeValue() - Retrieves the newest time value for the specified parameter.
• GetOneNewestConvertedTimeStringValue() - Retrieves the newest time value as a string for the specified parameter.
  
  
• GetOneNextConvertedIntegerValue() - Retrieves the next integer value for the specified parameter.
• GetOneNextConvertedUnsignedIntegerValue() - Retrieves the next unsigned integer value for the specified parameter.
• GetOneNextConvertedDoubleValue() - Retrieves the next double value for the specified parameter.
• GetOneNextConvertedStringValue() - Retrieves the next string value for the specified parameter.
• GetOneNextConvertedTimeValue() - Retrieves the next time value for the specified parameter.
• GetOneNextConvertedTimeStringValue() - Retrieves the next time value as a string for the specified parameter.
  
  
• GetOneSamePacketConvertedIntegerValue() - Retrieves the integer value for the specified parameter from the same packet as another parameter.
• GetOneSamePacketConvertedUnsignedIntegerValue() - Retrieves the unsigned integer value for the specified parameter from the same packet as another parameter.
• GetOneSamePacketConvertedDoubleValue() - Retrieves the double value for the specified parameter from the same packet as another parameter.
• GetOneSamePacketConvertedStringValue() - Retrieves the string value for the specified parameter from the same packet as another parameter.
• GetOneSamePacketConvertedTimeValue() - Retrieves the time value for the specified parameter from the same packet as another parameter.
• GetOneSamePacketConvertedTimeStringValue() - Retrieves the time value as a string for the specified parameter from the same packet as another parameter.
  
  
• GetNewestConvertedIntegerValue() - Retrieves one or more newest integer values for the specified parameter.
• GetNewestConvertedUnsignedIntegerValue() - Retrieves one or more newest unsigned integer values for the specified parameter.
• GetNewestConvertedDoubleValue() - Retrieves one or more newest double values for the specified parameter.
• GetNewestConvertedStringValue() - Retrieves one or more newest string values for the specified parameter.
• GetNewestConvertedTimeValue() - Retrieves one or more newest time values for the specified parameter.
  
  
• GetNextConvertedIntegerValue() - Retrieves one or more next integer values for the specified parameter.
• GetNextConvertedUnsignedIntegerValue() - Retrieves one or more next unsigned integer values for the specified parameter.
• GetNextConvertedDoubleValue() - Retrieves one or more next double values for the specified parameter.
• GetNextConvertedStringValue() - Retrieves one or more next string values for the specified parameter.
• GetNextConvertedTimeValue() - Retrieves one or more next time values for the specified parameter.
  
  
• GetSamePacketConvertedIntegerValue() - Retrieves one or more integer values for the specified parameter from the same packet as another parameter.
• GetSamePacketConvertedUnsignedIntegerValue() - Retrieves one or more unsigned integer values for the specified parameter from the same packet as another parameter.
• GetSamePacketConvertedDoubleValue() - Retrieves one or more double values for the specified parameter from the same packet as another parameter.
• GetSamePacketConvertedStringValue() - Retrieves one or more string values for the specified parameter from the same packet as another parameter.
• GetSamePacketConvertedTimeValue() - Retrieves one or more time values for the specified parameter from the same packet as another parameter.

Functions to Retrieve Calibrated Data

• GetOneNewestCalibratedDoubleValue() - Retrieves the newest calibrated double value for the specified parameter.
• GetOneNewestCalibratedStringValue() - Retrieves the newest calibrated string value for the specified parameter.
  
  
• GetOneNextCalibratedDoubleValue() - Retrieves the next calibrated double value for the specified parameter.
• GetOneNextCalibratedStringValue() - Retrieves the next calibrated string value for the specified parameter.
  
  
• GetOneSamePacketCalibratedDoubleValue() - Retrieves the calibrated value for the specified parameter from the same packet as another parameter.
• GetOneSamePacketCalibratedStringValue() - Retrieves the calibrated string value for the specified parameter from the same packet as another parameter.
  
  
• GetNewestCalibratedDoubleValue() - Retrieves one or more newest calibrated double values for the specified parameter.
• GetNewestCalibratedStringValue() - Retrieves one or more newest calibrated string values for the specified parameter.
  
  
• GetNextCalibratedDoubleValue() - Retrieves one or more next calibrated double values for the specified parameter.
• GetNextCalibratedStringValue() - Retrieves one or more next calibrated string values for the specified parameter.
  
  
• GetSamePacketCalibratedDoubleValue() - Retrieves one or more calibrated double values for the specified parameter from the same packet as another parameter.
• GetSamePacketCalibratedStringValue() - Retrieves one or more calibrated string values for the specified parameter from the same packet as another parameter.

General API Functions

• GetAPIReturnCodeAsString() - Converts an integer return code to a string.
• GetParameterInformation() - Retrieves information about a parameter.
• GetPacketArrivalEventName() - Gets a packet arrival event name that can be used with WaitForPacketArrival().
• GetNewestDatazone() - Gets the latest data zone for a packet.
• GetNextDatazone() - Get the next data zone for a packet.
• InitializeMultipleParameters() - This function was used for on demand processing. All release 5.x processing is on demand. Function immediately returns SUCCESS.
• SetMonitorLogFile() - Sets a log file for monitoring messages
• StartMonitorLogging() - Start monitor logging.
• StopMonitorLogging() - Stops monitor logging.

New Release 3 Compatible Functions

• UnregisterPacketArrivalEvent() - removes the packet arrival event created with GetPacketArrivalEventName().
• WaitForPacketArrival() - blocks until a packet arrives or a timeout is reached.

Removed Functions
These functions are not supported in this release of the Telemetry ANSI-C API. All of the APIs that have no planned support are related to the pseudo telemetry capability within TReK for Release 3.x. If you use unsupported functions and need the to continue using them in the future, please contact the TReK help desk.

• CreatePseudo - No planned support in release 5.x
• RemovePseudo – No planned support in release 5.x
• UpdateOneBinaryPseudo - No planned support in release 5.x
• UpdateOneIntegerPseudo - No planned support in release 5.x
• UpdateOneUnsignedIntegerPseudo - No planned support in release 5.x
• UpdateOneDoublePseudo - No planned support in release 5.x
• UpdateOneStringPseudo - No planned support in release 5.x
• UpdateBinaryPseudo - No planned support in release 5.x
• UpdateIntegerPseudo - No planned support in release 5.x
• UpdateUnsignedIntegerPseudo - No planned support in release 5.x
• UpdateDoublePseudo - No planned support in release 5.x
• UpdateStringPseudo - No planned support in release 5.x
• GetOneNewestBinaryPseudo - No planned support in release 5.x
• GetOneNewestIntegerPseudo - No planned support in release 5.x
• GetOneNewestUnsignedIntegerPseudo - No planned support in release 5.x
• GetOneNewestDoublePseudo - No planned support in release 5.x
• GetOneNextStringPseudo - No planned support in release 5.x
• GetOneNextBinaryPseudo - No planned support in release 5.x
• GetOneNextIntegerPseudo - No planned support in release 5.x
• GetOneNextUnsignedIntegerPseudo - No planned support in release 5.x
• GetOneNextDoublePseudo - No planned support in release 5.x
• GetOneNextStringPseudo - No planned support in release 5.x
• GetOverallStatus - No planned support in release 5.x
• GetNewestBinaryPseudo - No planned support in release 5.x
• GetNewestIntegerPseudo - No planned support in release 5.x
• GetNewestUnsignedIntegerPseudo - No planned support in release 5.x
• GetNewestDoublePseudo - No planned support in release 5.x
• GetNextStringPseudo - No planned support in release 5.x
• GetNextBinaryPseudo - No planned support in release 5.x
• GetNextIntegerPseudo - No planned support in release 5.x
• GetNextUnsignedIntegerPseudo - No planned support in release 5.x
• GetNextDoublePseudo - No planned support in release 5.x
• GetNextStringPseudo - No planned support in release 5.x

Examples
The following examples are provided to show how to use Telemetry APIs:

Telemetry ANSI-C Newest Data
Uses the Telemetry ANSI-C to get the latest version of several parameter values. The technique used to retrieve data in this example is useful for applications such as displays.
Source File:
tlm_api_r3_newest/r3_newest_main.c

Telemetry ANSI-C Next Data
Uses the Telemetry ANSI-C to get ever data zone from a packet. This example also shows how you can set up your code to wait for new packets to arrive and then retrieve the data.
Source File:
tlm_api_r3_next/r3_next_main.c

Telemetry ANSI-C Same Packet Data
Uses the Telemetry ANSI-C API to get multiple parameters from the same packet. This example shows using a "newest" function as controlling the packet, but the same techniques can be used with a "next" function.
Source File:
tlm_api_r3_same_pkt/r3_same_pkt_main.c


Additional Dependencies
The TReK Telemetry ANSI-C API (trek_user_api) is also dependent on the following libraries. See the Libraries main help page for more information.

trek_telemetry_api
trek_toolkit_common_api
trek_toolkit_data_api
trek_toolkit_utilities_api
xerces-c_3_1