Action Accessors (Invokes)


Introduction

Below is a database of all the primary and failsafe image actions that can be accessed via interaction with the spacecraft using MCS. The Operator will be able to call any of these actions/functions using MCS’s Invoke operation. Similar to functions defined in any coding language, some of these actions require input arguments. Details on the input arguments (if any) required for each action are also given in the below database.

Generic procedures for action Invoke operations that do and do not require an input argument have been provided below.


Procedure

A. Action Invoke - No Input Argument

A.1.

  • On MCS, navigate your way through the spacecraft database to the action of interest, e.g. the version.dumpVersion action.

  • Double click on the action name to open the action window, as demonstrated in Figure 1.

../../../_images/Action1Window.png

Figure 1 - Example of an action window where no input argument is required


A.2.

  • Click the Invoke button to call the action/function.

  • TM returned (i.e. the TC ACK) will be visible in MCS’s Packet Monitor.

TC Details

MCS Operation

Invoke

Action/Param Name

version.dumpVersion

Data Expected with TC

No

TM Details

Data Expected from TC

No ( + ACK )


B. Action Invoke - Input Argument Required

B.1.

  • On MCS, navigate your way through the spacecraft database to the action of interest, e.g. the core.storage.wipe action.

  • Double click on the action name to open the action window, as demonstrated in Figure 2.

../../../_images/Action2Window.png

Figure 2 - Example of an action window where an input argument is required


B.2.

  • Edit the data field of the action window with the desired input argument.

Tip

Details on the input argument, including its purpose and size (in bytes) are provided below but also appear in MCS when the action is selected.

  • In this example case:

    • The input argument is the 2-byte channelID of the storage channel that should be wiped.

    • Let’s consider that we wish to wipe channel 3.

    • Therefore, 0003 (in hex) should be the value inputted to the data field of the action window.


B.3.

  • With the data field filled in, click the Invoke button to call the action/function.

  • TM returned (i.e. the TC ACK) will be visible in MCS’s Packet Monitor.

TC Details

MCS Operation

Invoke

Action/Param Name

core.storage.wipe

Data Expected with TC

Yes

Data Size

2 bytes

Data Info

the ChannelID of the storage channel to wipe

Allowed Value(s)

1 to the maximum number of storage channels

Expected Value(s)

3

TM Details

Data Expected from TC

No ( + ACK )


Primary Image Actions (Failsafe Image Actions are further down!)

Tip

Scroll to the right to view the full table.

ID

ID (hex)

Action

Argument

0

0000

Version.dumpVersion

Dump version information to the debug console.

1

0001

Version.UpdateMessage

raw32 message

Update the contents of the messageString parameter.

2

0002

Version.UpdateLongMessage

raw64 longMessage

Update the contents of the LongMessageString parameter.

256

0100

platform.obc.OBC.reset

Reset the OBC (hard reset)

257

0101

platform.obc.OBC.watchdogKick

Kick the OBC watchdog

258

0102

platform.obc.OBC.markCurrentImageStable

Mark this image as stable

259

0103

platform.obc.OBC.clearImage

raw1 image

Clear (wipe) a software image

260

0104

platform.obc.OBC.updateImageCrc

raw1 image

Update the stored CRC for a software image

261

0105

platform.obc.OBC.resetGPS

Reset the GPS receiver, if it is enabled.

512

0200

platform.obc.GPIO.reset

Reset the GPIO peripheral

768

0300

platform.obc.MagnetometerI2C.resetStatistics

Reset all statistic parameters

1024

0400

platform.obc.I2CBusA.resetStatistics

Reset all statistic parameters

1280

0500

platform.obc.I2CBusB.resetStatistics

Reset all statistic parameters

1536

0600

platform.obc.I2CBusC.resetStatistics

Reset all statistic parameters

1792

0700

platform.obc.ADCSPI.resetIsrErrors

Reset the isrErrorCount and lastIsrError parameters.

2048

0800

platform.obc.TelemetryADCA.restoreCFR

Write the CFR value to the device

2304

0900

platform.obc.TelemetryADCB.restoreCFR

Write the CFR value to the device

2560

0A00

platform.obc.TelemetryADCC.restoreCFR

Write the CFR value to the device

2816

0B00

platform.EPS.reset

Soft reset the Telecommand and Telemetry node.

2817

0B01

platform.EPS.cycleBus

raw1 busBitMask

Power cycle the specified bus/buses.

2818

0B02

platform.EPS.resetWatchDog

Reset the watchdog timer.

2819

0B03

platform.EPS.resetSwitchStates

raw2 switchBitMask

Reset the specified switches to their initial state.

2820

0B04

platform.EPS.turnOnSwitches

varaw10 switchList

Turns on each listed switch.

2821

0B05

platform.EPS.turnOffSwitches

varaw10 switchList

Turns off each listed switch.

2822

0B06

platform.EPS.turnOffGMOD

Turns off the GMOD PDMs.

2823

0B07

platform.EPS.turnOnGMOD

Turns on the GMOD PDMs.

2824

0B08

platform.EPS.turnOffEMOD

Turns off the EMOD PDMs.

2825

0B09

platform.EPS.turnOnEMOD

Turns on the EMOD PDMs.

3072

0C00

platform.BAT.reset

Reset the hardware interface to the BAT3G device.

3328

0D00

platform.ADCS.clearBoardStatus

Clears the board’s status flags.

3329

0D01

platform.ADCS.resetAdcs

Hard reset of the ADCS motherboard.

3330

0D02

platform.ADCS.armReset

Arms the ADCS reset so that it can be held in reset.

3331

0D03

platform.ADCS.holdResetValue

raw1 value

Holds the ADCS in reset using the passed in value.

3332

0D04

platform.ADCS.disarmReset

Disarms the ADCS reset so that it can’t be held in reset.

3333

0D05

platform.ADCS.update

raw38 data

Update the ADCS with a time and position data.

3334

0D06

platform.ADCS.updateWithCountCheck

raw40 data

Update the ADCS with a time and position data.

3584

0E00

platform.CMC.reset

Reset the CMC hardware.

3585

0E01

platform.CMC.resetBeacon

Reset the telemetry beacon back to the default.

3586

0E02

platform.CMC.resetRx

Reset the receive packet protocol state machine.

3587

0E03

platform.CMC.clearBeaconTimer

Clear the beacon watchdog timer back to zero.

3588

0E04

platform.CMC.send

varaw254 data

Send a packet using the CMC.

3589

0E05

platform.CMC.SetInactivityBeacon

raw2 paramId

Sets the inactivity beacon to the value of a parameter.

3590

0E06

platform.CMC.UpdateCMCParams

To be periodically called by the Periodic Watchdog Component to update the follow parameters on the CMC- u8_Mode, u16_TxFrequencyOffset, u8_TxPower, u16_RxFrequencyOffset

3591

0E07

platform.CMC.CMCAliveCheck

Poll the CMC firmware version to see if the CMC responds. If not, increment fail counter. Else, reset fail counter. If fail counter exceeds AliveCheckFailLim, raise an event that then triggers an event action. This function is implemented for FDIR purposes.

3840

0F00

platform.ADM.BurnPrimResists

raw1 resistorsBitMask

Start/Stop burn selected primary resistors.

3841

0F01

platform.ADM.BurnSecResists

raw1 burn

Start/Stop burn the secondary resistors.

3842

0F02

platform.ADM.ADMAliveCheck

Poll the ADM firmware version to see if the ADM responds. If not, increment fail counter. Else, reset fail counter. If fail counter exceeds AliveCheckFailLim, perform an MSP reset. This function will act as a watchdig and will be called by a periodic action while the Separation Sequence is on-going.

3843

0F03

platform.ADM.SwitchTimersReset

raw1 timersBitMask

Reset the running switch timers.

4096

1000

payload.FirmwareImageAccess.LoadImageFromStorage

This is an action that allows you to load an MSP image from a storage channel (with channelID = the ImageStorageChID parameter) into the ImageBuffer parameter such that the CRC can then be calculated and the image can be rewritten to the MSP.

4097

1001

payload.FirmwareImageAccess.ClearImageBuffer

Clear any data in the MSP Image Buffer.

4352

1100

platform.obc.GMODSerial.reset

Reset the component

4608

1200

payload.GMOD.writeRegToSIPHRA

Write the contents of the ASIC_REG_TABLE on the GMOD MCU to the SIPHRA registers.

4609

1201

payload.GMOD.readRegFromSIPHRA

Read the contents of the SIPHRA registers into the ASIC_REG_TABLE on the GMOD MCU.

4610

1202

payload.GMOD.pageSend

Request that the MSP send over the page of data stored in flash at the operator- defined memory address.

4611

1203

payload.GMOD.Stream16Enable

Request that the MSP start streaming pages of 16 channel TTEs from the operator- defined memory address.

4612

1204

payload.GMOD.Stream16Disable

Stop streaming pages of 16 channel TTEs.

4613

1205

payload.GMOD.StreamSumEnable

Request that the MSP start streaming pages of summed channel TTEs from the operator-defined memory address.

4614

1206

payload.GMOD.StreamSumDisable

Stop streaming pages of 16 channel TTEs.

4615

1207

payload.GMOD.ResetSerRxState

Reset the RxState for parsing of incoming serial data.

4616

1208

payload.GMOD.ResetTrigBuffer

Reset the trigger checks buffer.

4617

1209

payload.GMOD.ResetLCBuffer

Reset the LC buffer.

4618

120A

payload.GMOD.ResetSpecBuffer

Reset the Spec buffer.

4619

120B

payload.GMOD.ResetFoMChecks

Reset u32_CurrFoMSigSquared to 0. When this parameter is 0, the next trigger data will be used to update the beacon buffers regardless of what data is already in the buffers.

4620

120C

payload.GMOD.InitialiseGMOD

Initialise GMOD for experiment running. Currently this function: 1) Sets the ConstantCurrValue parameter (to the InitGMODConstantCurrValue parameter) 2) Sets the ConstantCurrEnable paramter to TRUE 3) Toggles the ASIC reset pin OFF and then ON 4) Writes the init ASIC reg buffer data to the ASIC reg on the GMOD MSP. Each of these steps will only proceed if the previous step suceeded.

4621

120D

payload.GMOD.MSPReset

Reset the MSP.

4622

120E

payload.GMOD.EraseFlash

Erase the MSP flash.This is expected to take ~40s to complete.

4623

120F

payload.GMOD.FirmwareReprogramme

This action is responsible for 1) erasing the firmware currently on the GMOD MSP. 2) reprogramming a new firware onto the MSP from the ImageBuffer in the FirmwareImageAccess component. This action will need to be called twice. After the action invocations, get the LineNoLastProgrammed parameter to confirm that the reprogramme is on-going.

4624

1210

payload.GMOD.CPLDReprogramme

This action is responsible for 1) putting GMOD into CPLD Reprogramme Mode. 2) sending CPDL reprogramme data to the MSP from the ImageBuffer in the FirmwareImageAccess component. After the action invocation, get the LineNoLastProgrammed parameter to confirm that the reprogramme data is being sent to the MSP. When LineNoLastProgrammed stops increasing, the CPLDReprogrammeStatus parameter should be checked.

4625

1211

payload.GMOD.MSPBaudRate

raw3 Baud

Change the serial baud at which GMOD transfers data over to the OBC.

4626

1212

payload.GMOD.UpdateChAndARLOffset

Manually move logging of summed TTE data to the next channel. This command may be particularly useful if the channel hopping logic experiences a fault.

4627

1213

payload.GMOD.SyncTime

Syncronise GMOD’s coarse time clock with the OBC time.

4864

1300

platform.obc.EMODSerial.reset

Reset the component

5120

1400

payload.EMOD.SetModeSyncTime

Set the EMOD Mode, where… 0x00 = Idle Mode 0x01 = Experiment Mode If experiment mode is on-going, the mode value will change only when the current page of data being filled has completed. An additional 4-byte timestamp (in seconds) must sent with this command. This timestamp will be used by the MSP to set/sync the timestamp used for the experiment data. Note: this command primarily exists for test purposes and/or to handle a failure case where the OBC’s time cannot be read. If the mode is to be set using this command, the operator should also ensure that SyncTimePeriodMultiplier = 0 to ensure that the OBC doesnt try to send the OBT to EMOD for syncing.

5121

1401

payload.EMOD.ReadJIDFromFlash

Causes the MSP to read the JEDEC identity bytes from the flash memory IC, over the SPI interface.

5122

1402

payload.EMOD.ReadRTDs

Causes the MSP to perform a read of the ADC ICs defined in the RTDMask over the SPI interface.

5123

1403

payload.EMOD.ReadBoardTemp

Causes the MSP to read the temperature of the EMOD MSP. The read value is in 100th’s of DegreesC and so a value of 1856 in decimal is 18.56DegreeC.

5124

1404

payload.EMOD.pageSend

Request that the MSP send over the page of data stored in flash at the operator- defined memory address.

5125

1405

payload.EMOD.ResetSerRxState

Reset the RxState for parsing of incoming serial data.

5126

1406

payload.EMOD.EraseFlash

Erase the MSP flash. This is expected to take ~20-40s to complete. During this 20-40 seconds, the status will return 0x02 (busy) until the erase is complete, as which point status = 0x01 (idle). This action will fail if invoked while Experiment Mode is on-going.

5127

1407

payload.EMOD.MSPReset

Reset the MSP.

5128

1408

payload.EMOD.FirmwareReprogramme

This action is responsible for 1) erasing the firmware currently on the EMOD MSP. 2) reprogramming a new firware onto the MSP from the ImageBuffer in the FirmwareImageAccess component. This action may need to be called twice. After the first action invocation, get the LineNoLastProgrammed parameter. If it is increasing, the firmware reprogramme is on-going. However, if it is 0, this action should be invoked a second time. Get the LineNoLastProgrammed again to confirm that the reprogramme is on-going.

5376

1500

payload.WBC.initialiseController

TODO

5632

1600

platform.obc.Time.reset

Reset the onboard time to zero.

5633

1601

platform.obc.Time.refresh

Force a refresh of the onboard time from the time-keeping hardware.

5888

1700

core.Storage.wipe

raw2 channelID

Wipe the specified channel.

5889

1701

core.Storage.getParamToChannel

raw11 paramAndChannel

Get the value of a parameter into a storage provider channel

5890

1702

core.Storage.setParamFromChannel

raw11 paramAndChannel

Set the value of a parameter from the contents of a storage provider channel

6144

1800

core.ConfigurationManager.resetAll

Reset all component instances to their default configuration.

6145

1801

core.ConfigurationManager.loadAll

Load the configuration data for all of the component instances.

6146

1802

core.ConfigurationManager.storeAll

Store the configuration data for all of the component instances.

6147

1803

core.ConfigurationManager.loadProfile

raw1 profileId

Loads the provided profile

6148

1804

core.ConfigurationManager.storeProfile

raw1 profileId

Stores the current system state to the provided profile

6149

1805

core.ConfigurationManager.load

varaw128 componentIdList

Load configuration data for a list of components.

6150

1806

core.ConfigurationManager.store

varaw128 componentIdList

Store configuration data for a list of components.

6151

1807

core.ConfigurationManager.erase

raw1 configurationId

Erase a specified configuration.

6152

1808

core.ConfigurationManager.eraseAll

Erase all stored configuration for all components.

6400

1900

platform.obc.FlashDevice.erase

raw2 eraseBadBlocks

Erase the flash device

6401

1901

platform.obc.FlashDevice.blockErase

Erase the flash block indicated by the pageAddress” parameter”

6656

1A00

platform.obc.FileSystem.format

Formats the file system.

6912

1B00

core.FileSystemManager.delete

varaw64 name

Delete a file

6913

1B01

core.FileSystemManager.copy

varaw129 files

Copy a file

6914

1B02

core.FileSystemManager.move

varaw129 files

Move a file

6915

1B03

core.FileSystemManager.makeDirectory

varaw64 name

Create a directory

6916

1B04

core.FileSystemManager.deleteDirectory

varaw64 name

Delete a directory

6917

1B05

core.FileSystemManager.listDirectory

varaw64 name

List directory contents

6918

1B06

core.FileSystemManager.createFile

varaw132 sizeAndName

Creates a test file with data bytes that increment from 0.

6919

1B07

core.FileSystemManager.getParamToFile

varaw136 paramAndName

Get the value of a parameter into a file, replacing an existing file

6920

1B08

core.FileSystemManager.setParamFromFile

varaw134 paramAndName

Set the value of a parameter from the contents of a file

6921

1B09

core.FileSystemManager.decompress

varaw129 files

Decompress file compressed with RLE.

7168

1C00

core.OBT.reset

Reset the uptime to zero.

7169

1C01

core.OBT.update

Update the uptime using the system time.

7424

1D00

core.EventDispatcher.reset

Reset the Event Dispatcher.

7680

1E00

platform.obc.PPS.reset

Reset the peripheral hardware

7936

1F00

comms.Serial.reset

Reset the component

8192

2000

comms.TMTCBuffer.reset

Reset TMTCBuffer transmit and receive enable flags to defaults.

8193

2001

comms.TMTCBuffer.clear

Clear all packets pending in the TMTCBuffer.

8448

2100

comms.HMAC.setKey

varaw128 key

Reset the key used to generate the MAC.

8704

2200

comms.pus.PUSLDT.txAbort

varaw1 transactionId

Forces an abort of the specified transmit transaction

8705

2201

comms.pus.PUSLDT.txSuspend

varaw1 transactionId

Suspends the specified transmit transaction

8706

2202

comms.pus.PUSLDT.txResume

varaw1 transactionId

Resume the specified transmit transaction

8707

2203

comms.pus.PUSLDT.txReset

varaw1 transactionId

Forcibly reset the specified transmit transaction

8708

2204

comms.pus.PUSLDT.rxAbort

varaw1 transactionId

Forces an abort of the specified receive transaction

8709

2205

comms.pus.PUSLDT.rxSuspend

varaw1 transactionId

Suspends the specified receive transaction

8710

2206

comms.pus.PUSLDT.rxResume

varaw1 transactionId

Resume the specified receive transaction

8711

2207

comms.pus.PUSLDT.rxReset

varaw1 transactionId

Forcibly reset the specified receive transaction

8960

2300

cdh.tmtc.TMBeacon.reset

Reset the beacon frame’s transmission schedule.

8961

2301

cdh.tmtc.TMBeacon.send

raw1 frame

Attempt to send a single beacon frame.

9216

2400

cdh.tmtc.TMDebug.reset

Reset the message statistics.

9472

2500

cdh.tmtc.TMTCEvent.reset

Reset the state of the TMTCEvent to its default state.

9473

2501

cdh.tmtc.TMTCEvent.forwardEvent

raw6 event

Forward the specified event into the system.

9728

2600

cdh.tmtc.TMTCTransfer.clearGetTransfer

raw1 transferId

Clear all record of the identified get transfer.

9729

2601

cdh.tmtc.TMTCTransfer.clearSetTransfer

raw1 transferId

Clear all record of the identified set transfer.

9984

2700

cdh.telemetry.DataPool.reset

Reset the pooled values for all parameters.

9985

2701

cdh.telemetry.DataPool.refresh

varaw254 indexList

Refresh one or more parameters.

10240

2800

cdh.telemetry.ParamStats.refreshAll

Force an update of all of the statistics.

10241

2801

cdh.telemetry.ParamStats.refreshList

varaw32 rowList

Force an update of each listed statistic.

10242

2802

cdh.telemetry.ParamStats.resetAll

Reset all the statistics.

10243

2803

cdh.telemetry.ParamStats.resetList

varaw32 rowList

Resets each listed statistic.

10244

2804

cdh.telemetry.ParamStats.clear

Clears the list of parameters to evaluate.

10496

2900

cdh.telemetry.BaseSampler.sample

Sample all parameters associated with this sampler

10752

2A00

cdh.telemetry.ADCSHighResSampler.sample

Sample all parameters associated with this sampler

11008

2B00

cdh.telemetry.HighResSampler.sample

Sample all parameters associated with this sampler

11264

2C00

cdh.monitoring.BaseMonitor.restartChecks

Restarts all the enabled checks.

11265

2C01

cdh.monitoring.BaseMonitor.refresh

Refresh the Monitor.

11520

2D00

cdh.monitoring.BeaconRateMonitor.restartChecks

Restarts all the enabled checks.

11521

2D01

cdh.monitoring.BeaconRateMonitor.refresh

Refresh the Monitor.

11776

2E00

cdh.monitoring.CriticalMonitor.restartChecks

Restarts all the enabled checks.

11777

2E01

cdh.monitoring.CriticalMonitor.refresh

Refresh the Monitor.

12032

2F00

cdh.monitoring.WBCMonitor.restartChecks

Restarts all the enabled checks.

12033

2F01

cdh.monitoring.WBCMonitor.refresh

Refresh the Monitor.

12288

3000

cdh.logging.ADMLogger.reset

Reset the logger, discarding any queued, un-stored data.

12289

3001

cdh.logging.ADMLogger.flush

Flush all queued, un-stored data to the storage channel.

12290

3002

cdh.logging.ADMLogger.log

Log the parameter data to the queue ready for storage.

12544

3100

cdh.logging.EventLogger.reset

Reset the logger, discarding any queued, un-stored data.

12545

3101

cdh.logging.EventLogger.flush

Flush all queued, un-stored data to the storage channel.

12546

3102

cdh.logging.EventLogger.log

raw8 event

Log the specified event to the queue ready for storage.

12800

3200

cdh.logging.HKLogger_MRAM.reset

Reset the logger, discarding any queued, un-stored data.

12801

3201

cdh.logging.HKLogger_MRAM.flush

Flush all queued, un-stored data to the storage channel.

12802

3202

cdh.logging.HKLogger_MRAM.log

Log the parameter data to the queue ready for storage.

13056

3300

cdh.logging.HKLogger_Flash.reset

Reset the logger, discarding any queued, un-stored data.

13057

3301

cdh.logging.HKLogger_Flash.flush

Flush all queued, un-stored data to the storage channel.

13058

3302

cdh.logging.HKLogger_Flash.log

Log the parameter data to the queue ready for storage.

13312

3400

cdh.logging.TEDLogger_MRAM.reset

Reset the logger, discarding any queued, un-stored data.

13313

3401

cdh.logging.TEDLogger_MRAM.flush

Flush all queued, un-stored data to the storage channel.

13314

3402

cdh.logging.TEDLogger_MRAM.log

Log the parameter data to the queue ready for storage.

13568

3500

cdh.logging.TEDLogger_Flash.reset

Reset the logger, discarding any queued, un-stored data.

13569

3501

cdh.logging.TEDLogger_Flash.flush

Flush all queued, un-stored data to the storage channel.

13570

3502

cdh.logging.TEDLogger_Flash.log

Log the parameter data to the queue ready for storage.

13824

3600

cdh.logging.ADCSHKLogger_MRAM.reset

Reset the logger, discarding any queued, un-stored data.

13825

3601

cdh.logging.ADCSHKLogger_MRAM.flush

Flush all queued, un-stored data to the storage channel.

13826

3602

cdh.logging.ADCSHKLogger_MRAM.log

Log the parameter data to the queue ready for storage.

14080

3700

cdh.logging.ADCSHKLogger_Flash.reset

Reset the logger, discarding any queued, un-stored data.

14081

3701

cdh.logging.ADCSHKLogger_Flash.flush

Flush all queued, un-stored data to the storage channel.

14082

3702

cdh.logging.ADCSHKLogger_Flash.log

Log the parameter data to the queue ready for storage.

14336

3800

cdh.logging.ADCSDebugLogger.reset

Reset the logger, discarding any queued, un-stored data.

14337

3801

cdh.logging.ADCSDebugLogger.flush

Flush all queued, un-stored data to the storage channel.

14338

3802

cdh.logging.ADCSDebugLogger.log

Log the parameter data to the queue ready for storage.

14592

3900

cdh.logging.PASCALLogger_MRAM.reset

Reset the logger, discarding any queued, un-stored data.

14593

3901

cdh.logging.PASCALLogger_MRAM.flush

Flush all queued, un-stored data to the storage channel.

14594

3902

cdh.logging.PASCALLogger_MRAM.log

Log the parameter data to the queue ready for storage.

14848

3A00

cdh.logging.PASCALLogger_Flash.reset

Reset the logger, discarding any queued, un-stored data.

14849

3A01

cdh.logging.PASCALLogger_Flash.flush

Flush all queued, un-stored data to the storage channel.

14850

3A02

cdh.logging.PASCALLogger_Flash.log

Log the parameter data to the queue ready for storage.

15104

3B00

cdh.logging.TCLogger.reset

Reset the logger, discarding any queued, un-stored data.

15105

3B01

cdh.logging.TCLogger.flush

Flush all queued, un-stored data to the storage channel.

15106

3B02

cdh.logging.TCLogger.log

varaw255 data

Log the specified data to the queue ready for storage.

15360

3C00

cdh.logging.GPSLogger.reset

Reset the logger, discarding any queued, un-stored data.

15361

3C01

cdh.logging.GPSLogger.flush

Flush all queued, un-stored data to the storage channel.

15362

3C02

cdh.logging.GPSLogger.log

Log the parameter data to the queue ready for storage.

15616

3D00

cdh.logging.EMODLogger.reset

Reset the logger, discarding any queued, un-stored data.

15617

3D01

cdh.logging.EMODLogger.flush

Flush all queued, un-stored data to the storage channel.

15618

3D02

cdh.logging.EMODLogger.log

varaw255 data

Log the specified data to the queue ready for storage.

15872

3E00

cdh.logging.WBCLogger.reset

Reset the logger, discarding any queued, un-stored data.

15873

3E01

cdh.logging.WBCLogger.flush

Flush all queued, un-stored data to the storage channel.

15874

3E02

cdh.logging.WBCLogger.log

varaw255 data

Log the specified data to the queue ready for storage.

16128

3F00

cdh.logging.GMODLCLogger.reset

Reset the logger, discarding any queued, un-stored data.

16129

3F01

cdh.logging.GMODLCLogger.flush

Flush all queued, un-stored data to the storage channel.

16130

3F02

cdh.logging.GMODLCLogger.log

varaw255 data

Log the specified data to the queue ready for storage.

16384

4000

cdh.logging.GMODSpecLogger.reset

Reset the logger, discarding any queued, un-stored data.

16385

4001

cdh.logging.GMODSpecLogger.flush

Flush all queued, un-stored data to the storage channel.

16386

4002

cdh.logging.GMODSpecLogger.log

varaw255 data

Log the specified data to the queue ready for storage.

16640

4100

cdh.logging.GMODTTELogger.reset

Reset the logger, discarding any queued, un-stored data.

16641

4101

cdh.logging.GMODTTELogger.flush

Flush all queued, un-stored data to the storage channel.

16642

4102

cdh.logging.GMODTTELogger.log

varaw255 data

Log the specified data to the queue ready for storage.

16896

4200

cdh.logging.GMODTTETimeIndexLogger.reset

Reset the logger, discarding any queued, un-stored data.

16897

4201

cdh.logging.GMODTTETimeIndexLogger.flush

Flush all queued, un-stored data to the storage channel.

16898

4202

cdh.logging.GMODTTETimeIndexLogger.log

varaw255 data

Log the specified data to the queue ready for storage.

17152

4300

cdh.logging.GMOD16TTELogger.reset

Reset the logger, discarding any queued, un-stored data.

17153

4301

cdh.logging.GMOD16TTELogger.flush

Flush all queued, un-stored data to the storage channel.

17154

4302

cdh.logging.GMOD16TTELogger.log

varaw255 data

Log the specified data to the queue ready for storage.

17408

4400

cdh.logging.GMODTTEBufferLogger.reset

Reset the logger, discarding any queued, un-stored data.

17409

4401

cdh.logging.GMODTTEBufferLogger.flush

Flush all queued, un-stored data to the storage channel.

17410

4402

cdh.logging.GMODTTEBufferLogger.log

varaw255 data

Log the specified data to the queue ready for storage.

17664

4500

cdh.logging.GMODTriggLogger.reset

Reset the logger, discarding any queued, un-stored data.

17665

4501

cdh.logging.GMODTriggLogger.flush

Flush all queued, un-stored data to the storage channel.

17666

4502

cdh.logging.GMODTriggLogger.log

varaw255 data

Log the specified data to the queue ready for storage.

17920

4600

cdh.scheduling.EventAction.clear

Completely clear all event-action entries.

18176

4700

cdh.scheduling.EileEventAction.clear

Completely clear all event-action entries.

18432

4800

cdh.scheduling.TimeAction.clear

Completely clear the schedule of all entries.

18433

4801

cdh.scheduling.TimeAction.timeShift

varaw255 timeAndRows

Shifts the listed rows by the given amount.

18434

4802

cdh.scheduling.TimeAction.restartRelativeEntries

varaw255 rows

Restarts the listed relative entries.

18688

4900

cdh.scheduling.WatchdogPeriodicAction.clear

Clear the list of actions.

18689

4901

cdh.scheduling.WatchdogPeriodicAction.reset

Reset the component to it’s initial state.

18944

4A00

cdh.scheduling.PeriodicAction.clear

Clear the list of actions.

18945

4A01

cdh.scheduling.PeriodicAction.reset

Reset the component to it’s initial state.

19200

4B00

cdh.scheduling.CriticalEventAction.clear

Completely clear all event-action entries.

19456

4C00

mission.SeparationSequence.SeparationSequenceRestart

Function to set the sequence back to the start.

19457

4C01

mission.SeparationSequence.SeparationSequenceFinish

Function to end the sequence and put the state machine into finished state.

19712

4D00

mission.ADCSManager.reset

Reset the state of state vector handling

19713

4D01

mission.ADCSManager.requestModeState

raw4 modeState

Request the ADCSManager to set the ADCS mode and state

19968

4E00

mission.ModeManager.TransitionToSeparationMode

Function to put the satellite into separation mode.

19969

4E01

mission.ModeManager.TransitionToCommissioningMode

Function to put the satellite into commissioning mode.

19970

4E02

mission.ModeManager.TransitionToNominalMode

Function to put the satellite into nominal mode.

19971

4E03

mission.ModeManager.TransitionToWBCMode

Function to put the satellite into WBC mode.

19972

4E04

mission.ModeManager.TransitionToSafeMode

Function to put the satellite into safe mode.

19973

4E05

mission.ModeManager.UpdateTCCount

Function that regularly updates the persisted number of TCs recieved from the GS and monitors the time since a TC was last received. If X days pass by with no TC, reboots the spacecraft X is set by the NoTCWatchdogTimeout parameter. This action is to be called by the periodic wathdog action component.

19974

4E06

mission.ModeManager.startPass

Start a communications pass

19975

4E07

mission.ModeManager.endPass

End a communications pass.


Failsafe Image Actions

Tip

Scroll to the right to view the full table.

ID

ID (hex)

Action

Argument

0

0000

Version.dumpVersion

Dump version information to the debug console.

1

0001

Version.UpdateMessage

raw32 message

Update the contents of the messageString parameter.

2

0002

Version.UpdateLongMessage

raw64 longMessage

Update the contents of the LongMessageString parameter.

256

0100

platform.obc.OBC.reset

Reset the OBC (hard reset)

257

0101

platform.obc.OBC.watchdogKick

Kick the OBC watchdog

258

0102

platform.obc.OBC.markCurrentImageStable

Mark this image as stable

259

0103

platform.obc.OBC.clearImage

raw1 image

Clear (wipe) a software image

260

0104

platform.obc.OBC.updateImageCrc

raw1 image

Update the stored CRC for a software image

261

0105

platform.obc.OBC.resetGPS

Reset the GPS receiver, if it is enabled.

512

0200

platform.obc.GPIO.reset

Reset the GPIO peripheral

768

0300

platform.obc.MagnetometerI2C.resetStatistics

Reset all statistic parameters

1024

0400

platform.obc.I2CBusA.resetStatistics

Reset all statistic parameters

1280

0500

platform.obc.I2CBusB.resetStatistics

Reset all statistic parameters

1536

0600

platform.obc.I2CBusC.resetStatistics

Reset all statistic parameters

1792

0700

platform.EPS.reset

Soft reset the Telecommand and Telemetry node.

1793

0701

platform.EPS.cycleBus

raw1 busBitMask

Power cycle the specified bus/buses.

1794

0702

platform.EPS.resetWatchDog

Reset the watchdog timer.

1795

0703

platform.EPS.resetSwitchStates

raw2 switchBitMask

Reset the specified switches to their initial state.

1796

0704

platform.EPS.turnOnSwitches

varaw10 switchList

Turns on each listed switch.

1797

0705

platform.EPS.turnOffSwitches

varaw10 switchList

Turns off each listed switch.

1798

0706

platform.EPS.turnOffGMOD

Turns off the GMOD PDMs.

1799

0707

platform.EPS.turnOnGMOD

Turns on the GMOD PDMs.

1800

0708

platform.EPS.turnOffEMOD

Turns off the EMOD PDMs.

1801

0709

platform.EPS.turnOnEMOD

Turns on the EMOD PDMs.

2048

0800

platform.BAT.reset

Reset the hardware interface to the BAT3G device.

2304

0900

platform.ADCS.clearBoardStatus

Clears the board’s status flags.

2305

0901

platform.ADCS.resetAdcs

Hard reset of the ADCS motherboard.

2306

0902

platform.ADCS.armReset

Arms the ADCS reset so that it can be held in reset.

2307

0903

platform.ADCS.holdResetValue

raw1 value

Holds the ADCS in reset using the passed in value.

2308

0904

platform.ADCS.disarmReset

Disarms the ADCS reset so that it can’t be held in reset.

2309

0905

platform.ADCS.update

raw38 data

Update the ADCS with a time and position data.

2310

0906

platform.ADCS.updateWithCountCheck

raw40 data

Update the ADCS with a time and position data.

2560

0A00

platform.CMC.reset

Reset the CMC hardware.

2561

0A01

platform.CMC.resetBeacon

Reset the telemetry beacon back to the default.

2562

0A02

platform.CMC.resetRx

Reset the receive packet protocol state machine.

2563

0A03

platform.CMC.clearBeaconTimer

Clear the beacon watchdog timer back to zero.

2564

0A04

platform.CMC.send

varaw254 data

Send a packet using the CMC.

2565

0A05

platform.CMC.SetInactivityBeacon

raw2 paramId

Sets the inactivity beacon to the value of a parameter.

2566

0A06

platform.CMC.UpdateCMCParams

To be periodically called by the Periodic Watchdog Component to update the follow parameters on the CMC- u8_Mode, u16_TxFrequencyOffset, u8_TxPower, u16_RxFrequencyOffset

2567

0A07

platform.CMC.CMCAliveCheck

Poll the CMC firmware version to see if the CMC responds. If not, increment fail counter. Else, reset fail counter. If fail counter exceeds AliveCheckFailLim, raise an event that then triggers an event action. This function is implemented for FDIR purposes.

2816

0B00

platform.ADM.BurnPrimResists

raw1 resistorsBitMask

Start/Stop burn selected primary resistors.

2817

0B01

platform.ADM.BurnSecResists

raw1 burn

Start/Stop burn the secondary resistors.

2818

0B02

platform.ADM.ADMAliveCheck

Poll the ADM firmware version to see if the ADM responds. If not, increment fail counter. Else, reset fail counter. If fail counter exceeds AliveCheckFailLim, perform an MSP reset. This function will act as a watchdig and will be called by a periodic action while the Separation Sequence is on-going.

2819

0B03

platform.ADM.SwitchTimersReset

raw1 timersBitMask

Reset the running switch timers.

3072

0C00

platform.obc.Time.reset

Reset the onboard time to zero.

3073

0C01

platform.obc.Time.refresh

Force a refresh of the onboard time from the time-keeping hardware.

3328

0D00

core.Storage.wipe

raw2 channelID

Wipe the specified channel.

3329

0D01

core.Storage.getParamToChannel

raw11 paramAndChannel

Get the value of a parameter into a storage provider channel

3330

0D02

core.Storage.setParamFromChannel

raw11 paramAndChannel

Set the value of a parameter from the contents of a storage provider channel

3584

0E00

core.ConfigurationManager.resetAll

Reset all component instances to their default configuration.

3585

0E01

core.ConfigurationManager.loadAll

Load the configuration data for all of the component instances.

3586

0E02

core.ConfigurationManager.storeAll

Store the configuration data for all of the component instances.

3587

0E03

core.ConfigurationManager.loadProfile

raw1 profileId

Loads the provided profile

3588

0E04

core.ConfigurationManager.storeProfile

raw1 profileId

Stores the current system state to the provided profile

3589

0E05

core.ConfigurationManager.load

varaw128 componentIdList

Load configuration data for a list of components.

3590

0E06

core.ConfigurationManager.store

varaw128 componentIdList

Store configuration data for a list of components.

3591

0E07

core.ConfigurationManager.erase

raw1 configurationId

Erase a specified configuration.

3592

0E08

core.ConfigurationManager.eraseAll

Erase all stored configuration for all components.

3840

0F00

platform.obc.FlashDevice.erase

raw2 eraseBadBlocks

Erase the flash device

3841

0F01

platform.obc.FlashDevice.blockErase

Erase the flash block indicated by the pageAddress” parameter”

4096

1000

core.OBT.reset

Reset the uptime to zero.

4097

1001

core.OBT.update

Update the uptime using the system time.

4352

1100

core.EventDispatcher.reset

Reset the Event Dispatcher.

4608

1200

comms.Serial.reset

Reset the component

4864

1300

comms.TMTCBuffer.reset

Reset TMTCBuffer transmit and receive enable flags to defaults.

4865

1301

comms.TMTCBuffer.clear

Clear all packets pending in the TMTCBuffer.

5120

1400

comms.HMAC.setKey

varaw128 key

Reset the key used to generate the MAC.

5376

1500

comms.pus.PUSLDT.txAbort

varaw1 transactionId

Forces an abort of the specified transmit transaction

5377

1501

comms.pus.PUSLDT.txSuspend

varaw1 transactionId

Suspends the specified transmit transaction

5378

1502

comms.pus.PUSLDT.txResume

varaw1 transactionId

Resume the specified transmit transaction

5379

1503

comms.pus.PUSLDT.txReset

varaw1 transactionId

Forcibly reset the specified transmit transaction

5380

1504

comms.pus.PUSLDT.rxAbort

varaw1 transactionId

Forces an abort of the specified receive transaction

5381

1505

comms.pus.PUSLDT.rxSuspend

varaw1 transactionId

Suspends the specified receive transaction

5382

1506

comms.pus.PUSLDT.rxResume

varaw1 transactionId

Resume the specified receive transaction

5383

1507

comms.pus.PUSLDT.rxReset

varaw1 transactionId

Forcibly reset the specified receive transaction

5632

1600

cdh.tmtc.TMBeacon.reset

Reset the beacon frame’s transmission schedule.

5633

1601

cdh.tmtc.TMBeacon.send

raw1 frame

Attempt to send a single beacon frame.

5888

1700

cdh.tmtc.TMDebug.reset

Reset the message statistics.

6144

1800

cdh.tmtc.TMTCEvent.reset

Reset the state of the TMTCEvent to its default state.

6145

1801

cdh.tmtc.TMTCEvent.forwardEvent

raw6 event

Forward the specified event into the system.

6400

1900

cdh.tmtc.TMTCTransfer.clearGetTransfer

raw1 transferId

Clear all record of the identified get transfer.

6401

1901

cdh.tmtc.TMTCTransfer.clearSetTransfer

raw1 transferId

Clear all record of the identified set transfer.

6656

1A00

cdh.telemetry.ParamStats.refreshAll

Force an update of all of the statistics.

6657

1A01

cdh.telemetry.ParamStats.refreshList

varaw32 rowList

Force an update of each listed statistic.

6658

1A02

cdh.telemetry.ParamStats.resetAll

Reset all the statistics.

6659

1A03

cdh.telemetry.ParamStats.resetList

varaw32 rowList

Resets each listed statistic.

6660

1A04

cdh.telemetry.ParamStats.clear

Clears the list of parameters to evaluate.

6912

1B00

cdh.logging.ADMLogger.reset

Reset the logger, discarding any queued, un-stored data.

6913

1B01

cdh.logging.ADMLogger.flush

Flush all queued, un-stored data to the storage channel.

6914

1B02

cdh.logging.ADMLogger.log

Log the parameter data to the queue ready for storage.

7168

1C00

cdh.logging.EventLogger.reset

Reset the logger, discarding any queued, un-stored data.

7169

1C01

cdh.logging.EventLogger.flush

Flush all queued, un-stored data to the storage channel.

7170

1C02

cdh.logging.EventLogger.log

raw8 event

Log the specified event to the queue ready for storage.

7424

1D00

cdh.logging.HKLogger.reset

Reset the logger, discarding any queued, un-stored data.

7425

1D01

cdh.logging.HKLogger.flush

Flush all queued, un-stored data to the storage channel.

7426

1D02

cdh.logging.HKLogger.log

Log the parameter data to the queue ready for storage.

7680

1E00

cdh.logging.TEDLogger.reset

Reset the logger, discarding any queued, un-stored data.

7681

1E01

cdh.logging.TEDLogger.flush

Flush all queued, un-stored data to the storage channel.

7682

1E02

cdh.logging.TEDLogger.log

Log the parameter data to the queue ready for storage.

7936

1F00

cdh.logging.ADCSHKLogger.reset

Reset the logger, discarding any queued, un-stored data.

7937

1F01

cdh.logging.ADCSHKLogger.flush

Flush all queued, un-stored data to the storage channel.

7938

1F02

cdh.logging.ADCSHKLogger.log

Log the parameter data to the queue ready for storage.

8192

2000

cdh.logging.ADCSDebugLogger.reset

Reset the logger, discarding any queued, un-stored data.

8193

2001

cdh.logging.ADCSDebugLogger.flush

Flush all queued, un-stored data to the storage channel.

8194

2002

cdh.logging.ADCSDebugLogger.log

Log the parameter data to the queue ready for storage.

8448

2100

cdh.logging.PASCALLogger.reset

Reset the logger, discarding any queued, un-stored data.

8449

2101

cdh.logging.PASCALLogger.flush

Flush all queued, un-stored data to the storage channel.

8450

2102

cdh.logging.PASCALLogger.log

Log the parameter data to the queue ready for storage.

8704

2200

cdh.scheduling.EventAction.clear

Completely clear all event-action entries.

8960

2300

cdh.scheduling.TimeAction.clear

Completely clear the schedule of all entries.

8961

2301

cdh.scheduling.TimeAction.timeShift

varaw255 timeAndRows

Shifts the listed rows by the given amount.

8962

2302

cdh.scheduling.TimeAction.restartRelativeEntries

varaw255 rows

Restarts the listed relative entries.

9216

2400

cdh.scheduling.WatchdogPeriodicAction.clear

Clear the list of actions.

9217

2401

cdh.scheduling.WatchdogPeriodicAction.reset

Reset the component to it’s initial state.

9472

2500

mission.SeparationSequence.SeparationSequenceRestart

Function to set the sequence back to the start.

9473

2501

mission.SeparationSequence.SeparationSequenceFinish

Function to end the sequence and put the state machine into finished state.

9728

2600

mission.NoTCWatchdogManager.UpdateTCCount

Function that regularly updates the persisted number of TCs recieved from the GS and monitors the time since a TC was last received. If X days pass by with no TC, reboots the spacecraft X is set by the NoTCWatchdogTimeout parameter. This action is to be called by the periodic watchdog action component.