Package org.yamcs.pus

Class PusEventDecoder

java.lang.Object
com.google.common.util.concurrent.AbstractService
org.yamcs.AbstractYamcsService
org.yamcs.pus.PusEventDecoder
All Implemented Interfaces:
com.google.common.util.concurrent.Service, YamcsService
public class PusEventDecoder extends AbstractYamcsService
Generates Yamcs events from PUS event packets (PUS service 5).

This class reads a JSON configuration file that defines text templates for Yamcs events, each corresponding to a specific PUS event ID. The configuration file should contain entries in the following format: 

 {
   "eventId": 1234,
   "template": "Event occurred: {parameter_name; format}"
 }

The template string can include free text and placeholders in the format {parameter_name; format}. The format is optional. The parameter_name can be absolute or relative and may end with .raw, in which case the raw value is used instead of the engineering value.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

    com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

  • Field Summary

    Fields inherited from class org.yamcs.AbstractYamcsService

    config, log, serviceName, yamcsInstance

  • Constructor Summary

    Constructors
    Constructor
    Description
    PusEventDecoder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doStart()
     
    protected void
    doStop()
     
    Spec
    getSpec()
    Returns the valid configuration options for this service.
    void
    init(String yamcsInstance, String serviceName, YConfiguration config)
    Initialize this service.

    Methods inherited from class org.yamcs.AbstractYamcsService

    findStream, getConfig, getYamcsInstance

    Methods inherited from class com.google.common.util.concurrent.AbstractService

    addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.common.util.concurrent.Service

    addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

  • Constructor Details

    • PusEventDecoder

      public PusEventDecoder()

  • Method Details

    • init

      public void init(String yamcsInstance, String serviceName, YConfiguration config) throws InitException
      Description copied from interface: YamcsService
      Initialize this service. This is called before the service is started. All operations should finish fast.
      Specified by:
      init in interface YamcsService
      Overrides:
      init in class AbstractYamcsService
      Parameters:
      yamcsInstance - The yamcs instance, or null if this is a global service.
      serviceName - The service name.
      config - The configured arguments for this service. If YamcsService.getSpec() is implemented then this contains the arguments after being validated (including any defaults).
      Throws:
      InitException - When something goes wrong during the execution of this method.

    • getSpec

      public Spec getSpec()
      Description copied from interface: YamcsService
      Returns the valid configuration options for this service.
      Returns:
      the argument specification, or null if the args should not be validated.

    • doStart

      protected void doStart()
      Specified by:
      doStart in class com.google.common.util.concurrent.AbstractService

    • doStop

      protected void doStop()
      Specified by:
      doStop in class com.google.common.util.concurrent.AbstractService