EIR-OPS-015: Configure Data Logging


Objective

To set-up the OBSW to aggregate the desired data, which is then set up for logging.


Introduction

Using this procedure, the Operator can set-up an ‘Aggregator’ to collect parameter values and aggregate them into a single packedOutput parameter. This procedure also details how to set-up a ‘Logger’ to log the packedOutput data to storage.

Note

The SCDB name/path used for all Loggers and Aggregators follow the same structure (i.e. cdh.logging.XXXXLogger and cdh.telemtry.XXXXAggregator, respectively), where XXXX = HK, ADCS, TED, GMODLC, etc.


Procedure

This procedure contains the following sub-procedures:

A. Pre-Pass Preparations
B. Setting Up the Aggregator
C. Linking the Aggregator to a Logger

Note

Communication with the spacecraft is required for Sections B and C of this procedure.


A. Pre-Pass Preparations

A.1.

  • First create a list of the parameters that you wish to aggregate.

    E.g. I wish to aggregate:

    • the version.majorVersion parameter

    • the version.minorVersion parameter

    • the 2nd and 3rd rows of the core.Storage.isCircular parameter


A.2.

  • Then, using the SCDB in MCS, note the 2-byte parameter ID (in hex) for each of these parameters.

    E.g. I wish to aggregate:

    • the version.majorVersion parameter - Param ID: 0x0001

    • the version.minorVersion parameter - Param ID: 0x0002

    • the 2nd and 3rd rows of the core.Storage.isCircular parameter - Param ID: 0x0101


A.3.

  • Note the First row and Last row of the parameter you wish to aggregate. For parameters that are single-valued, First row = Last row = 0.

    E.g. I wish to aggregate:

    • the version.majorVersion parameter - Param ID: 0x0001 - First row = Last row = 0

    • the version.minorVersion parameter - Param ID: 0x0002 - First row = Last row = 0

    • the 2nd and 3rd rows of the core.Storage.isCircular parameter - Param ID: 0x0101 - First row = 1, Last row = 2


A.4.

  • Using the information gathered in the previous three steps, create an 8-byte description for each parameter according to the format given in Figure 1.

    E.g. The 8-byte descriptions for the parameters I wish to aggregate are:

    • 0001 0000 0000 0000

    • 0002 0000 0000 0000

    • 0101 0001 0002 0000

../../../_images/ParamPacked.png

Figure 1


A.5.

  • Open a new text file (using any text editor) and add the information from Step A.4. to the file, as demonstrated in Figure 2. Note that whitespaces in the text file are added for readability but are ignored on uplink to the spacecraft.

../../../_images/texhexinputfile.png

Figure 2


A.6.

  • The format of this file must now be converted to hex for uplink to the spacecraft. To do this, on the operator’s computer, open the textHex.py python file and edit the input/output fields to match the name of your text file from Step A.5. (as demonstrated in Figure 3), before running the python textHex.py command.

Note

If you do not have this python file on your computer, it can be accessed from the EIRSAT-1 Team Drive, in the Files>OPS directory.

../../../_images/hextext.png

Figure 3


A.7.

  • Using the SCDB in MCS, now note the Parameter ID (in hex) of the the cdh.telemetry.XXXXAggregator.packedOutput parameter belonging to the XXXXAggregator being configured in this procedure.



B. Setting Up the Aggregator

Important

You are about to send the first TC of this procedure - Have you completed the EIR-OPS-003: Start a Communication Pass procedure? A Communication Pass must be started prior to carrying out the operations planned for the pass. Don’t forget to open and set up the parameters/actions that will be used during the pass in MCS before the pass begins!

B.1.

  • To determine if the Aggregator you intend to use has previously been set-up to aggregate data, Query the cdh.telemetry.XXXXAggregator.paramListPacked parameter.

  • If 0 is returned, proceed immediately to Step B.2.

  • Else, the Operator should consult with the Systems and/or Software Engineers before proceeding to determine whether it is safe or not (we could lose data!) to reconfigure this Aggregator.

TC Details

MCS Operation

Query

Action/Param Name

cdh.telemetry.XXXXAggregator.paramListPacked

Data Expected with TC

No

TM Details

Data Expected from TC

Size/rows of paramListPacked ( + ACK )

Data Size

1 byte

Data Info

The current number of parameters being aggregated by this Aggregator

Allowed Value(s)

00 - FF (Hex)

B.2.

  • Uplink the file from Step A.6 to the paramPackedList parameter of the Aggregator with:

    • First row = 0,

    • Last row = the number of parameters being aggregated (from Step A.1) - 1, and

    • Resize ticked.

    TC Details

    MCS Operation

    Uplink

    Action/Param Name

    cdh.telemetry.XXXXAggregator.paramListPacked

    Data Expected with TC

    Yes

    Data Size

    Many bytes

    Data Info

    the data file, First row = 0, Last row = (the no. of params being aggregated - 1), resize =enabled/ticked

    Allowed Value(s)

    Many allowed variations of these input

    TM Details

    Data Expected from TC

    No ( + ACK )

B.3.

  • Again, Query the cdh.telemetry.XXXXAggregator.paramListPacked parameter.

  • Confirm that the number of parameters being aggregated now matches the number of parameters listed in Step A.1.

TC Details

MCS Operation

Query

Action/Param Name

cdh.telemetry.XXXXAggregator.paramListPacked

Data Expected with TC

No

TM Details

Data Expected from TC

Size/rows of paramListPacked ( + ACK )

Data Size

1 byte

Data Info

The current number of parameters being aggregated by this Aggregator

Allowed Value(s)

00 - FF (Hex)

Expected Value(s)

Number of parameters listed in Step A.1


C. Linking the Aggregator to a Logger

C.1.

  • To determine if the Logger you intend to use has previously been set-up to log data, Get the cdh.logging.XXXXLogger.paramId parameter for the XXXXLogger.

  • If 0 is returned, proceed immediately to Step C.2.

  • Else, the Operator should consult with the Systems and/or Software Engineers before proceeding to determine whether it is safe or not (we could lose data!) to reconfigure this Logger.

TC Details

MCS Operation

Get

Action/Param Name

cdh.logging.XXXXLogger.paramId

Data Expected with TC

No

TM Details

Data Expected from TC

paramId ( + ACK )

Data Size

2 bytes

Data Info

The ID of the parameter being logged

Allowed Value(s)

0000 - FFFF (Hex)

C.2.

  • To set-up the Logger to log the aggregated parameters from the XXXXAggregator, Set the cdh.logging.XXXXLogger.paramId parameter of the XXXXLogger to the value determined in Step A.7 (i.e. the parameter ID in hex of the cdh.telemetry.XXXXAggregator.packedOutput parameter for the XXXXAggregator).

TC Details

MCS Operation

Set

Action/Param Name

cdh.logging.XXXXLogger.paramId

Data Expected with TC

Yes

Data Size

2 bytes

Data Info

the parameter ID of the packedOutput parameter

Allowed Value(s)

0000 - FFFF (Hex)

Expected Value(s)

Parameter ID from Step A.7

TM Details

Data Expected from TC

No ( + ACK )

C.3.

  • Confirm the Set in the previous step with a Get (i.e. confirm the value was set successfully).


C.4.

  • To enable this logger, Set the Logger’s cdh.logging.XXXXLogger.enabled parameter to 1.

TC Details

MCS Operation

Set

Action/Param Name

cdh.logging.XXXXLogger.enabled

Data Expected with TC

Yes

Data Size

boolean

Data Info

enable (01) or disable (00) logging

Allowed Value(s)

0 - 1

Expected Value(s)

1

TM Details

Data Expected from TC

No ( + ACK )

C.5.

  • Confirm the Set in the previous step with a Get (i.e. confirm the value was set successfully).

Note

It can take up to ~1 minute for a logger to enable/disable.


END OF PROCEDURE