nasa/fprime
1
0
Fork 0
mirror of https://github.com/nasa/fprime.git synced 2025-12-10 00:44:37 -06:00
Code Issues Packages Projects Releases 34 Wiki Activity

mstarch: removing outdated auto-dictionary documentation

Browse Source
This commit is contained in:
Michael D Starch 2020-08-26 09:52:05 -07:00
parent aea4fc316f
commit 9394aa2a2b
36 changed files with 0 additions and 992 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Drv/BlockDriver/docs/BlockDriver.md
View File

@ -1,10 +0,0 @@
<title>BlockDriver Component Dictionary</title>
# BlockDriver Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|BD_Cycles|0 (0x0)|U32|Driver cycle count|

28
Drv/LinuxGpioDriver/docs/LinuxGpioDriver.md
View File

@ -1,28 +0,0 @@
<title>LinuxGpioDriver Component Dictionary</title>
# LinuxGpioDriver Component Dictionary
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|GP_OpenError|0 (0x0)|Open error| | | | |
| | | |gpio|I32||The device|
| | | |error|I32||The error code|
| | | |msg|Fw::LogStringArg&|40|The error string|
|GP_ConfigError|1 (0x1)|GPIO configure error| | | | |
| | | |gpio|I32||The device|
| | | |error|I32||The error code|
|GP_WriteError|2 (0x2)|GPIO write error| | | | |
| | | |gpio|I32||The device|
| | | |error|I32||The error code|
|GP_ReadError|3 (0x3)|GPIO read error| | | | |
| | | |gpio|I32||The device|
| | | |error|I32||The error code|
|GP_PortOpened|4 (0x4)|GPIO opened notification| | | | |
| | | |gpio|I32||The device|
|GP_IntStartError|5 (0x5)|GPIO interrupt start error notification| | | | |
| | | |gpio|I32||The device|
|GP_IntWaitError|6 (0x6)|GPIO interrupt wait error notification| | | | |
| | | |gpio|I32||The device|

36
Drv/LinuxSerialDriver/docs/LinuxSerialDriver.md
View File

@ -1,36 +0,0 @@
<title>LinuxSerialDriver Component Dictionary</title>
# LinuxSerialDriver Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|DR_BytesSent|0 (0x0)|U32|Bytes Sent|
|DR_BytesRecv|1 (0x1)|U32|Bytes Received|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|DR_OpenError|0 (0x0)|UART open error| | | | |
| | | |device|Fw::LogStringArg&|40|The device|
| | | |error|I32||The error code|
| | | |name|Fw::LogStringArg&|40|error string|
|DR_ConfigError|1 (0x1)|UART config error| | | | |
| | | |device|Fw::LogStringArg&|40|The device|
| | | |error|I32||The error code|
|DR_WriteError|2 (0x2)|UART write error| | | | |
| | | |device|Fw::LogStringArg&|40|The device|
| | | |error|I32||The error code|
|DR_ReadError|3 (0x3)|UART read error| | | | |
| | | |device|Fw::LogStringArg&|40|The device|
| | | |error|I32||The error code|
|DR_PortOpened|4 (0x4)|UART port opened event| | | | |
| | | |device|Fw::LogStringArg&|40|The device|
|DR_NoBuffers|5 (0x5)|UART ran out of buffers| | | | |
| | | |device|Fw::LogStringArg&|40|The device|
|DR_BufferTooSmall|6 (0x6)|UART ran out of buffers| | | | |
| | | |device|Fw::LogStringArg&|40|The device|
| | | |size|U32||The provided buffer size|
| | | |needed|U32||The buffer size needed|

29
Drv/LinuxSpiDriver/docs/LinuxSpiDriver.md
View File

@ -1,29 +0,0 @@
<title>LinuxSpiDriver Component Dictionary</title>
# LinuxSpiDriver Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|SPI_Bytes|0 (0x0)|U32|Bytes Sent/Received|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|SPI_OpenError|0 (0x0)|SPI open error| | | | |
| | | |device|I32||The device|
| | | |select|I32||The chip select|
| | | |error|I32||The error code|
|SPI_ConfigError|1 (0x1)|SPI config error| | | | |
| | | |device|I32||The device|
| | | |select|I32||The chip select|
| | | |error|I32||The error code|
|SPI_WriteError|2 (0x2)|SPI write error| | | | |
| | | |device|I32||The device|
| | | |select|I32||The chip select|
| | | |error|I32||The error code|
|SPI_PortOpened|4 (0x4)|SPI open notification| | | | |
| | | |device|I32||The device|
| | | |select|I32||The chip select|

5
Drv/SocketIpDriver/docs/SocketIpDriver.md
View File

@ -1,5 +0,0 @@
<title>SocketIpDriver Component Dictionary</title>
# SocketIpDriver Component Dictionary

55
RPI/RpiDemo/docs/RpiDemo.md
View File

@ -1,55 +0,0 @@
<title>RpiDemo Component Dictionary</title>
# RpiDemo Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|RD_SendString|0 (0x0)|Command to send a string to the UART| | |
| | | |text|Fw::CmdStringArg|String to send|
|RD_SetLed|1 (0x1)|Sets LED state| | |
| | | |value|LedState|GPIO value|
|RD_SetLedDivider|2 (0x2)|Sets the divided rate of the LED| | |
| | | |divider|U32|Divide 10Hz by this number|
|RD_SetGpio|3 (0x3)|Sets a GPIO port value| | |
| | | |output|GpioOutNum|Output GPIO|
| | | |value|GpioOutVal|GPIO value|
|RD_GetGpio|4 (0x4)|Gets a GPIO port value| | |
| | | |input|GpioInNum|Input GPIO|
|RD_SendSpi|5 (0x5)|Sends SPI data, prints read data| | |
| | | |data|Fw::CmdStringArg|data to send|
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|RD_UartSentBytes|0 (0x0)|U32|Number of bytes sent on the UART|
|RD_UartRecvBytes|1 (0x1)|U32|Number of bytes sent on the UART|
|RD_LastMsg|2 (0x2)|string|Last received UART text message|
|RD_SpiBytes|3 (0x3)|U32|Number of bytes sent on SPI|
|RD_1HzTicks|4 (0x4)|U32|Ticks at 1Hz|
|RD_10HzTicks|5 (0x5)|U32|Ticks at 10Hz|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|RD_UartMsgOut|0 (0x0)|Message sent on UART| | | | |
| | | |msg|Fw::LogStringArg&|40|The message|
|RD_UartMsgIn|1 (0x1)|Message received on UART| | | | |
| | | |msg|Fw::LogStringArg&|40|The message|
|RD_GpioSetVal|2 (0x2)|GPIO set| | | | |
| | | |output|U32||The output number|
| | | |value|GpioOutValEv||GPIO value|
|RD_GpioGetVal|3 (0x3)|GPIO get| | | | |
| | | |output|U32||The output number|
| | | |value|GpioInValEv||GPIO value|
|RD_SpiMsgIn|4 (0x4)|Message received on SPI| | | | |
| | | |msg|Fw::LogStringArg&|40|The message bytes as text|
|RD_InvalidGpio|5 (0x5)|Invalid GPIO requested| | | | |
| | | |val|U32||The bad GPIO number|
|RD_InvalidDivider|6 (0x6)|Message received on UART| | | | |
| | | |val|U32||The bad divider value|
|RD_LedBlinkState|7 (0x7)|Blink state set to new value| | | | |
| | | |val|LedStatePrmEv||The blink state|

23
Ref/PingReceiver/docs/PingReceiver.md
View File

@ -1,23 +0,0 @@
<title>PingReceiver Component Dictionary</title>
# PingReceiver Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|PR_StopPings|0 (0x0)|Command to disable ping response| | |
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|PR_NumPings|0 (0x0)|U32|Number of pings received|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|PR_PingsDisabled|0 (0x0)|Disabled ping responses| | | | |
|PR_PingReceived|1 (0x1)|Got ping| | | | |
| | | |code|U32||Ping code|

24
Ref/RecvBuffApp/docs/RecvBuff.md
View File

@ -1,24 +0,0 @@
<title>RecvBuff Component Dictionary</title>
# RecvBuff Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|PktState|0 (0x0)|Ref::PacketStat|Packet Statistics|
|Sensor1|1 (0x1)|F32|Value of Sensor1|
|Sensor2|2 (0x2)|F32|Value of Sensor3|
|Parameter1|3 (0x3)|U32|Readback of Parameter1|
|Parameter2|4 (0x4)|I16|Readback of Parameter2|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|FirstPacketReceived|0 (0x0)|First packet received| | | | |
| | | |id|U32||The ID argument|
|PacketChecksumError|1 (0x1)|Packet checksum error| | | | |
| | | |id|U32||The ID argument|
|BuffRecvParameterUpdated|2 (0x2)|Report parameter update| | | | |
| | | |id|U32||The ID argument|

46
Ref/SendBuffApp/docs/SendBuff.md
View File

@ -1,46 +0,0 @@
<title>SendBuff Component Dictionary</title>
# SendBuff Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|SB_START_PKTS|0 (0x0)|Command to start sending packets| | |
|SB_INJECT_PKT_ERROR|1 (0x1)|Send a bad packet| | |
|SB_GEN_FATAL|2 (0x2)|Generate a FATAL EVR| | |
| | | |arg1|U32|First FATAL Argument|
| | | |arg2|U32|Second FATAL Argument|
| | | |arg3|U32|Third FATAL Argument|
|SB_GEN_ASSERT|3 (0x3)|Generate an ASSERT| | |
| | | |arg1|U32|First ASSERT Argument|
| | | |arg2|U32|Second ASSERT Argument|
| | | |arg3|U32|Third ASSERT Argument|
| | | |arg4|U32|Fourth ASSERT Argument|
| | | |arg5|U32|Fifth ASSERT Argument|
| | | |arg6|U32|Sixth ASSERT Argument|
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|PacketsSent|0 (0x0)|U64|Number of packets sent|
|NumErrorsInjected|1 (0x1)|U32|Number of errors injected|
|Parameter3|2 (0x2)|U8|Readback of Parameter3|
|Parameter4|3 (0x3)|F32|Readback of Parameter4|
|SendState|4 (0x4)|ActiveState|Readback of Parameter4|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|FirstPacketSent|0 (0x0)|First packet send| | | | |
| | | |id|U32||The ID argument|
|PacketErrorInserted|1 (0x1)|Packet checksum error| | | | |
| | | |id|U32||The ID argument|
|BuffSendParameterUpdated|2 (0x2)|Report parameter update| | | | |
| | | |id|U32||The ID argument|
|SendBuffFatal|3 (0x3)|A test FATAL| | | | |
| | | |arg1|U32||First FATAL argument|
| | | |arg2|U32||Second FATAL argument|
| | | |arg3|U32||Second FATAL argument|

29
Ref/SignalGen/docs/SignalGen.md
View File

@ -1,29 +0,0 @@
<title>SignalGen Component Dictionary</title>
# SignalGen Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|SignalGen_Settings|0 (0x0)|Signal Generator Settings| | |
| | | |Frequency|U32||
| | | |Amplitude|U32||
| | | |Phase|U32||
|SignalGen_Toggle|1 (0x1)|Toggle Signal Generator On/Off.| | |
|SignalGen_Skip|2 (0x2)|Skip next sample| | |
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|SignalGen_Output|0 (0x0)|F32|SignalGen Output|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|SignalGen_SettingsChanged|0 (0x0)|Signal Generator Settings Changed| | | | |
| | | |Frequency|U32|||
| | | |Amplitude|U32|||
| | | |Phase|U32|||

43
Svc/ActiveLogger/docs/ActiveLogger.md
View File

@ -1,43 +0,0 @@
<title>ActiveLogger Component Dictionary</title>
# ActiveLogger Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|ALOG_SET_EVENT_REPORT_FILTER|0 (0x0)|Set filter for reporting events. Events are not stored in component.| | |
| | | |FilterLevel|InputFilterLevel|Filter level|
| | | |FilterEnable|InputFilterEnabled|Filter state|
|ALOG_SET_EVENT_SEND_FILTER|1 (0x1)|Set filter for sending events. Event will not be sent as a buffer.| | |
| | | |FilterLevel|SendFilterLevel|Filter level|
| | | |FilterEnable|SendFilterEnabled|Severity filter state|
|ALOG_DUMP_EVENT_LOG|2 (0x2)|Dump circular buffers of events to a file| | |
| | | |filename|Fw::CmdStringArg||
|ALOG_SET_ID_FILTER|3 (0x3)|Filter a particular ID| | |
| | | |ID|U32||
| | | |IdFilterEnable|IdFilterEnabled|ID filter state|
|ALOG_DUMP_FILTER_STATE|4 (0x4)|Dump the filter states via events| | |
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|ALOG_FILE_WRITE_ERR|0 (0x0)|Failed to write circular buffer| | | | |
| | | |stage|LogWriteError||The write stage|
| | | |error|I32||The error code|
|ALOG_FILE_WRITE_COMPLETE|1 (0x1)|Evemt log file write complete| | | | |
| | | |records|U32||number of records written|
|ALOG_SEVERITY_FILTER_STATE|2 (0x2)|Dump severity filter state| | | | |
| | | |severity|EventFilterState||The severity level|
| | | |recvEnabled|bool|||
| | | |sendEnabled|bool|||
|ALOG_ID_FILTER_ENABLED|3 (0x3)|Indicate ID is filtered| | | | |
| | | |ID|U32||The ID filtered|
|ALOG_ID_FILTER_LIST_FULL|4 (0x4)|Attempted to add ID to full ID filter ID| | | | |
| | | |ID|U32||The ID filtered|
|ALOG_ID_FILTER_REMOVED|5 (0x5)|Removed an ID from the filter| | | | |
| | | |ID|U32||The ID removed|
|ALOG_ID_FILTER_NOT_FOUND|6 (0x6)|ID not in filter| | | | |
| | | |ID|U32||The ID removed|

18
Svc/ActiveRateGroup/docs/ActiveRateGroup.md
View File

@ -1,18 +0,0 @@
<title>ActiveRateGroup Component Dictionary</title>
# ActiveRateGroup Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|RgMaxTime|0 (0x0)|U32|Max execution time rate group|
|RgCycleSlips|1 (0x1)|U32|Cycle slips for rate group|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|RateGroupStarted|0 (0x0)|Informational event that rate group has started| | | | |
|RateGroupCycleSlip|1 (0x1)|Warning event that rate group has had a cycle slip| | | | |
| | | |cycle|U32||The cycle where the cycle occurred|

5
Svc/ActiveTextLogger/docs/ActiveTextLogger.md
View File

@ -1,5 +0,0 @@
<title>ActiveTextLogger Component Dictionary</title>
# ActiveTextLogger Component Dictionary

55
Svc/AssertFatalAdapter/docs/AssertFatalAdapter.md
View File

@ -1,55 +0,0 @@
<title>AssertFatalAdapter Component Dictionary</title>
# AssertFatalAdapter Component Dictionary
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|AF_ASSERT_0|0 (0x0)|An assert happened| | | | |
| | | |file|Fw::LogStringArg&|80|The source file of the assert|
| | | |line|U32||Line number of the assert|
|AF_ASSERT_1|1 (0x1)|An assert happened| | | | |
| | | |file|Fw::LogStringArg&|80|The source file of the assert|
| | | |line|U32||Line number of the assert|
| | | |arg1|U32||First assert argument|
|AF_ASSERT_2|2 (0x2)|An assert happened| | | | |
| | | |file|Fw::LogStringArg&|80|The source file of the assert|
| | | |line|U32||Line number of the assert|
| | | |arg1|U32||First assert argument|
| | | |arg2|U32||Second assert argument|
|AF_ASSERT_3|3 (0x3)|An assert happened| | | | |
| | | |file|Fw::LogStringArg&|80|The source file of the assert|
| | | |line|U32||Line number of the assert|
| | | |arg1|U32||First assert argument|
| | | |arg2|U32||Second assert argument|
| | | |arg3|U32||Third assert argument|
|AF_ASSERT_4|4 (0x4)|An assert happened| | | | |
| | | |file|Fw::LogStringArg&|80|The source file of the assert|
| | | |line|U32||Line number of the assert|
| | | |arg1|U32||First assert argument|
| | | |arg2|U32||Second assert argument|
| | | |arg3|U32||Third assert argument|
| | | |arg4|U32||Fourth assert argument|
|AF_ASSERT_5|5 (0x5)|An assert happened| | | | |
| | | |file|Fw::LogStringArg&|80|The source file of the assert|
| | | |line|U32||Line number of the assert|
| | | |arg1|U32||First assert argument|
| | | |arg2|U32||Second assert argument|
| | | |arg3|U32||Third assert argument|
| | | |arg4|U32||Fourth assert argument|
| | | |arg5|U32||Fifth assert argument|
|AF_ASSERT_6|6 (0x6)|An assert happened| | | | |
| | | |file|Fw::LogStringArg&|80|The source file of the assert|
| | | |line|U32||Line number of the assert|
| | | |arg1|U32||First assert argument|
| | | |arg2|U32||Second assert argument|
| | | |arg3|U32||Third assert argument|
| | | |arg4|U32||Fourth assert argument|
| | | |arg5|U32||Fifth assert argument|
| | | |arg6|U32||Sixth assert argument|
|AF_UNEXPECTED_ASSERT|7 (0x7)|An unexpected assert happened| | | | |
| | | |file|Fw::LogStringArg&|80|The source file of the assert|
| | | |line|U32||Line number of the assert|
| | | |numArgs|U32||Number of unexpected arguments|

23
Svc/BufferAccumulator/docs/BufferAccumulator.md
View File

@ -1,23 +0,0 @@
<title>BufferAccumulator Component Dictionary</title>
# BufferAccumulator Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|BA_SetMode|0 (0x0)|Set the mode| | |
| | | |mode|OpState||
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|BufferAccumulator_NumQueuedBuffers|0 (0x0)|U32|The number of buffers queued|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|BA_BufferAccepted|0 (0x0)|The Buffer Accumulator instance accepted and enqueued a buffer. To avoid uncontrolled sending of events, this event occurs only when the previous buffer received caused a QueueFull error.| | | | |
|BA_QueueFull|1 (0x1)|The Buffer Accumulator instance received a buffer when its queue was full. To avoid uncontrolled sending of events, this event occurs only when the previous buffer received did not cause a QueueFull error.| | | | |

41
Svc/BufferLogger/docs/BufferLogger.md
View File

@ -1,41 +0,0 @@
<title>BufferLogger Component Dictionary</title>
# BufferLogger Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|BL_OpenFile|0 (0x0)|Open a new log file with specified name; also resets unique file counter to 0| | |
| | | |file|Fw::CmdStringArg||
|BL_CloseFile|1 (0x1)|Close the currently open log file, if any| | |
|BL_SetLogging|2 (0x2)|Sets the volatile logging state| | |
| | | |state|LogState||
|BL_FlushFile|3 (0x3)|Flushes the current open log file to disk; a no-op with fprime's unbuffered file I/O, so always returns success| | |
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|BufferLogger_NumLoggedBuffers|0 (0x0)|U32|The number of buffers logged|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|BL_LogFileClosed|0 (0x0)|The Buffer Logger closed a log file| | | | |
| | | |file|Fw::LogStringArg&|256|The file|
|BL_LogFileOpenError|1 (0x1)|The Buffer Logger encountered an error opening a log file| | | | |
| | | |errornum|U32||The error number returned from the open operation|
| | | |file|Fw::LogStringArg&|256|The file|
|BL_LogFileValidationError|2 (0x2)|The Buffer Logger encountered an error writing a validation file| | | | |
| | | |validationFile|Fw::LogStringArg&|256|The validation file|
| | | |status|U32||The Os::Validate::Status return|
|BL_LogFileWriteError|3 (0x3)|The Buffer Logger encountered an error writing to a log file| | | | |
| | | |errornum|U32||The error number returned from the write operation|
| | | |bytesWritten|U32||The number of bytes successfully written|
| | | |bytesToWrite|U32||The number of bytes attempted|
| | | |file|Fw::LogStringArg&|256|The file|
|BL_Activated|4 (0x4)|Buffer logger was activated| | | | |
|BL_Deativated|5 (0x5)|Buffer logger was deactivated| | | | |
|BL_NoLogFileOpenInitError|6 (0x6)|No log file open command was received by BufferLogger| | | | |

18
Svc/BufferManager/docs/BufferManager.md
View File

@ -1,18 +0,0 @@
<title>BufferManager Component Dictionary</title>
# BufferManager Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|BufferManager_NumAllocatedBuffers|0 (0x0)|U32|The number of buffers currently allocated|
|BufferManager_AllocatedSize|1 (0x1)|U32|The total size of all allocated buffers|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|ClearedErrorState|0 (0x0)|The Buffer Manager has cleared its error state| | | | |
|StoreSizeExceeded|1 (0x1)|The Buffer Manager received an allocation request that, if granted, would cause the storage buffer to overflow| | | | |
|TooManyBuffers|2 (0x2)|The Buffer Manager received an allocation request that, if granted, would result in too many buffers| | | | |

53
Svc/CmdDispatcher/docs/CommandDispatcher.md
View File

@ -1,53 +0,0 @@
<title>CommandDispatcher Component Dictionary</title>
# CommandDispatcher Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|CMD_NO_OP|0 (0x0)|No-op command| | |
|CMD_NO_OP_STRING|1 (0x1)|No-op string command| | |
| | | |arg1|Fw::CmdStringArg|The String command argument|
|CMD_TEST_CMD_1|2 (0x2)|No-op command| | |
| | | |arg1|I32|The I32 command argument|
| | | |arg2|F32|The F32 command argument|
| | | |arg3|U8|The U8 command argument|
|CMD_CLEAR_TRACKING|3 (0x3)|Clear command tracking info to recover from components not returning status| | |
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|CommandsDispatched|0 (0x0)|U32|Number of commands dispatched|
|CommandErrors|1 (0x1)|U32|Number of command errors|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|OpCodeRegistered|0 (0x0)|Op code registered event| | | | |
| | | |Opcode|U32||The opcode to register|
| | | |port|I32||The registration port|
| | | |slot|I32||The dispatch slot it was placed in|
|OpCodeDispatched|1 (0x1)|Op code dispatched event| | | | |
| | | |Opcode|U32||The opcode dispatched|
| | | |port|I32||The port dispatched to|
|OpCodeCompleted|2 (0x2)|Op code completed event| | | | |
| | | |Opcode|U32||The I32 command argument|
|OpCodeError|3 (0x3)|Op code completed with error event| | | | |
| | | |Opcode|U32||The opcode with the error|
| | | |error|ErrorResponse||The error value|
|MalformedCommand|4 (0x4)|Received a malformed command packet| | | | |
| | | |Status|CmdSerError||The deserialization error|
|InvalidCommand|5 (0x5)|Received an invalid opcode| | | | |
| | | |Opcode|U32||Invalid opcode|
|TooManyCommands|6 (0x6)|Exceeded the number of commands that can be simultaneously executed| | | | |
| | | |Opcode|U32||The opcode that overflowed the list|
|NoOpReceived|7 (0x7)|The command dispatcher has successfully recieved a NO-OP command| | | | |
|NoOpStringReceived|8 (0x8)|The command dispatcher has successfully recieved a NO-OP command from GUI with a string| | | | |
| | | |message|Fw::LogStringArg&|40|The NO-OP string that is generated|
|TestCmd1Args|9 (0x9)|This log event message returns the TEST_CMD_1 arguments.| | | | |
| | | |arg1|I32||Arg1|
| | | |arg2|F32||Arg2|
| | | |arg3|U8||Arg3|

96
Svc/CmdSequencer/docs/CmdSequencer.md
View File

@ -1,96 +0,0 @@
<title>CmdSequencer Component Dictionary</title>
# CmdSequencer Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|CS_RUN|0 (0x0)|Run a command sequence file| | |
| | | |fileName|Fw::CmdStringArg|The name of the sequence file|
|CS_VALIDATE|1 (0x1)|Validate a command sequence file| | |
| | | |fileName|Fw::CmdStringArg|The name of the sequence file|
|CS_CANCEL|2 (0x2)|Cancel a command sequence| | |
|CS_START|3 (0x3)|Start running a command sequence| | |
|CS_STEP|4 (0x4)|Perform one step in a command sequence. Valid only if CmdSequencer is in MANUAL run mode.| | |
|CS_AUTO|5 (0x5)|Set the run mode to AUTO.| | |
|CS_MANUAL|6 (0x6)|Set the run mode to MANUAL.| | |
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|CS_LoadCommands|0 (0x0)|U32|The number of Load commands executed|
|CS_CancelCommands|1 (0x1)|U32|The number of Cancel commands executed|
|CS_Errors|2 (0x2)|U32|The number of errors that have occurred|
|CS_CommandsExecuted|3 (0x3)|U32|The number of commands executed across all sequences.|
|CS_SequencesCompleted|4 (0x4)|U32|The number of sequences completed.|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|CS_SequenceLoaded|0 (0x0)|Sequence file was successfully loaded.| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
|CS_SequenceCanceled|1 (0x1)|A command sequence was successfully canceled.| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
|CS_FileReadError|2 (0x2)|The Sequence File Loader could not read the sequence file.| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
|CS_FileInvalid|3 (0x3)|The sequence file format was invalid.| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
| | | |stage|FileReadStage||The read stage|
| | | |error|I32||The error code|
|CS_RecordInvalid|4 (0x4)|The format of a command record was invalid.| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
| | | |recordNumber|U32||The record number|
| | | |error|I32||The error code|
|CS_FileSizeError|5 (0x5)|The sequence file was too large.| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
| | | |size|U32||Inavalid size|
|CS_FileNotFound|6 (0x6)|The sequence file was not found| | | | |
| | | |fileName|Fw::LogStringArg&|60|The sequence file|
|CS_FileCrcFailure|7 (0x7)|The sequence file validation failed| | | | |
| | | |fileName|Fw::LogStringArg&|60|The sequence file|
| | | |storedCRC|U32||The CRC stored in the file|
| | | |computedCRC|U32||The CRC computed over the file|
|CS_CommandComplete|8 (0x8)|The Command Sequencer issued a command and received a success status in return.| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
| | | |recordNumber|U32||The record number of the command|
| | | |opCode|U32||The command opcode|
|CS_SequenceComplete|9 (0x9)|A command sequence successfully completed.| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
|CS_CommandError|10 (0xa)|The Command Sequencer issued a command and received an error status in return.| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
| | | |recordNumber|U32||The record number|
| | | |opCode|U32||The opcode|
| | | |errorStatus|U32||The error status|
|CS_InvalidMode|11 (0xb)|The Command Sequencer received a command that was invalid for its current mode.| | | | |
|CS_RecordMismatch|12 (0xc)|Number of records in header doesn't match number in file| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
| | | |header_records|U32||The number of records in the header|
| | | |extra_bytes|U32||The number of bytes beyond last record|
|CS_TimeBaseMismatch|13 (0xd)|The running time base doesn't match the time base in the sequence files| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
| | | |time_base|U16||The current time|
| | | |seq_time_base|U16||The sequence time base|
|CS_TimeContextMismatch|14 (0xe)|The running time base doesn't match the time base in the sequence files| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the sequence file|
| | | |currTimeBase|U8||The current time base|
| | | |seqTimeBase|U8||The sequence time base|
|CS_PortSequenceStarted|15 (0xf)|A local port request to run a sequence was started| | | | |
| | | |filename|Fw::LogStringArg&|60|The sequence file|
|CS_UnexpectedCompletion|16 (0x10)|A command status came back when no sequence was running| | | | |
| | | |opcode|U32||The reported opcode|
|CS_ModeSwitched|17 (0x11)|Switched step mode| | | | |
| | | |mode|SeqMode||The new mode|
|CS_NoSequenceActive|18 (0x12)|A sequence related command came with no active sequence| | | | |
|CS_SequenceValid|19 (0x13)|A sequence passed validation| | | | |
| | | |filename|Fw::LogStringArg&|60|The sequence file|
|CS_SequenceTimeout|20 (0x14)|A sequence passed validation| | | | |
| | | |filename|Fw::LogStringArg&|60|The sequence file|
| | | |command|U32||The command that timed out|
|CS_CmdStepped|21 (0x15)|A commmand in a sequence was stepped through| | | | |
| | | |filename|Fw::LogStringArg&|60|The sequence file|
| | | |command|U32||The command that was stepped|
|CS_CmdStarted|22 (0x16)|A manual sequence was started| | | | |
| | | |filename|Fw::LogStringArg&|60|The sequence file|

29
Svc/ComLogger/docs/ComLogger.md
View File

@ -1,29 +0,0 @@
<title>ComLogger Component Dictionary</title>
# ComLogger Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|CloseFile|0 (0x0)|Forces a close of the currently opened file.| | |
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|FileOpenError|0 (0x0)|The ComLogger encountered an error opening a file| | | | |
| | | |errornum|U32||The error number returned from open file|
| | | |file|Fw::LogStringArg&|240|The file|
|FileWriteError|1 (0x1)|The ComLogger encountered an error writing to a file| | | | |
| | | |errornum|U32||The error number returned from write file|
| | | |bytesWritten|U32||The number of bytes successfully written to file|
| | | |bytesToWrite|U32||The number of bytes attempted to write to file|
| | | |file|Fw::LogStringArg&|240|The file|
|FileValidationError|2 (0x2)|The ComLogger encountered an error writing the validation file| | | | |
| | | |validationFile|Fw::LogStringArg&|240|The validation file|
| | | |file|Fw::LogStringArg&|240|The file|
| | | |status|U32||The Os::Validate::Status return|
|FileClosed|3 (0x3)|The ComLogger successfully closed a file on command.| | | | |
| | | |file|Fw::LogStringArg&|240|The file|

5
Svc/FatalHandler/docs/FatalHandler.md
View File

@ -1,5 +0,0 @@
<title>FatalHandler Component Dictionary</title>
# FatalHandler Component Dictionary

35
Svc/FileDownlink/docs/FileDownlink.md
View File

@ -1,35 +0,0 @@
<title>FileDownlink Component Dictionary</title>
# FileDownlink Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|FileDownlink_SendFile|0 (0x0)|Read a named file off the disk. Divide it into packets and send the packets for transmission to the ground.| | |
| | | |sourceFileName|Fw::CmdStringArg|The name of the on-board file to send|
| | | |destFileName|Fw::CmdStringArg|The name of the destination file on the ground|
|FileDownlink_Cancel|1 (0x1)|Cancel the downlink in progress, if any| | |
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|FileDownlink_FilesSent|0 (0x0)|U32|The total number of files sent|
|FileDownlink_PacketsSent|1 (0x1)|U32|The total number of packets sent|
|FileDownlink_Warnings|2 (0x2)|U32|The total number of warnings|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|FileDownlink_FileOpenError|0 (0x0)|An error occurred opening a file| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the file|
|FileDownlink_FileReadError|1 (0x1)|An error occurred reading a file| | | | |
| | | |fileName|Fw::LogStringArg&|60|The name of the file|
|FileDownlink_FileSent|2 (0x2)|The File Downlink component successfully sent a file| | | | |
| | | |sourceFileName|Fw::LogStringArg&|60|The source file name|
| | | |destFileName|Fw::LogStringArg&|60|The destination file name|
|FileDownlink_DownlinkCanceled|3 (0x3)|The File Downlink component canceled downlink of a file| | | | |
| | | |sourceFileName|Fw::LogStringArg&|60|The source file name|
| | | |destFileName|Fw::LogStringArg&|60|The destination file name|

50
Svc/FileManager/docs/FileManager.md
View File

@ -1,50 +0,0 @@
<title>FileManager Component Dictionary</title>
# FileManager Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|CreateDirectory|0 (0x0)|Create a directory| | |
| | | |dirName|Fw::CmdStringArg|The directory to create|
|MoveFile|1 (0x1)|Move a file| | |
| | | |sourceFileName|Fw::CmdStringArg|The source file name|
| | | |destFileName|Fw::CmdStringArg|The destination file name|
|RemoveDirectory|2 (0x2)|Remove a directory, which must be empty| | |
| | | |dirName|Fw::CmdStringArg|The directory to remove|
|RemoveFile|3 (0x3)|Remove a file| | |
| | | |fileName|Fw::CmdStringArg|The file to remove|
|ShellCommand|4 (0x4)|Perform a Linux shell command and write the output to a log file.| | |
| | | |command|Fw::CmdStringArg|The shell command string|
| | | |logFileName|Fw::CmdStringArg|The name of the log file|
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|CommandsExecuted|0 (0x0)|U32|The total number of commands successfully executed|
|Errors|1 (0x1)|U32|The total number of errors|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|DirectoryCreateError|0 (0x0)|An error occurred while attempting to create a directory| | | | |
| | | |dirName|Fw::LogStringArg&|256|The name of the directory|
| | | |status|U32||The error status|
|DirectoryRemoveError|1 (0x1)|An error occurred while attempting to remove a directory| | | | |
| | | |dirName|Fw::LogStringArg&|256|The name of the directory|
| | | |status|U32||The error status|
|FileMoveError|2 (0x2)|An error occurred while attempting to move a file| | | | |
| | | |sourceFileName|Fw::LogStringArg&|256|The name of the source file|
| | | |destFileName|Fw::LogStringArg&|256|The name of the destination file|
| | | |status|U32||The error status|
|FileRemoveError|3 (0x3)|An error occurred while attempting to remove a file| | | | |
| | | |fileName|Fw::LogStringArg&|256|The name of the file|
| | | |status|U32||The error status|
|ShellCommandFailed|4 (0x4)|The File System component executed a shell command that returned status non-zero| | | | |
| | | |command|Fw::LogStringArg&|256|The command string|
| | | |status|U32||The status code|
|ShellCommandSucceeded|5 (0x5)|The File System component executed a shell command that returned status zero| | | | |
| | | |command|Fw::LogStringArg&|256|The command string|

36
Svc/FileUplink/docs/FileUplink.md
View File

@ -1,36 +0,0 @@
<title>FileUplink Component Dictionary</title>
# FileUplink Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|FileUplink_FilesReceived|0 (0x0)|U32|The total number of complete files received|
|FileUplink_PacketsReceived|1 (0x1)|U32|The total number of packets received|
|FileUplink_Warnings|2 (0x2)|U32|The total number of warnings issued|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|FileUplink_BadChecksum|0 (0x0)|During receipt of a file, the computed checksum value did not match the stored value| | | | |
| | | |fileName|Fw::LogStringArg&|40|The file name|
| | | |computed|U32||The computed value|
| | | |read|U32||The value read|
|FileUplink_FileOpenError|1 (0x1)|An error occurred opening a file| | | | |
| | | |fileName|Fw::LogStringArg&|40|The name of the file|
|FileUplink_FileReceived|2 (0x2)|The File Uplink component successfully received a file| | | | |
| | | |fileName|Fw::LogStringArg&|40|The name of the file|
|FileUplink_FileWriteError|3 (0x3)|An error occurred writing to a file| | | | |
| | | |fileName|Fw::LogStringArg&|40|The name of the file|
|FileUplink_InvalidReceiveMode|4 (0x4)|The File Uplink component received a packet with a type that was invalid for the current receive mode| | | | |
| | | |packetType|U32||The type of the packet received|
| | | |mode|U32||The receive mode|
|FileUplink_PacketOutOfBounds|5 (0x5)|During receipt of a file, the File Uplink component encountered a packet with offset and size out of bounds for the current file| | | | |
| | | |packetIndex|U32||The sequence index of the packet|
| | | |fileName|Fw::LogStringArg&|40|The name of the file|
|FileUplink_PacketOutOfOrder|6 (0x6)|The File Uplink component encountered an out-of-order packet during file receipt| | | | |
| | | |packetIndex|U32||The sequence index of the out-of-order packet|
| | | |lastPacketIndex|U32||The sequence index of the last packet received before the out-of-order packet|
|FileUplink_UplinkCanceled|7 (0x7)|The File Uplink component received a CANCEL packet| | | | |

10
Svc/GroundInterface/docs/GroundInterface.md
View File

@ -1,10 +0,0 @@
<title>GroundInterface Component Dictionary</title>
# GroundInterface Component Dictionary
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|GroundInterfaceError|0 (0x0)|An error in the ground interface, here to make the UTs happy.| | | | |

50
Svc/Health/docs/Health.md
View File

@ -1,50 +0,0 @@
<title>Health Component Dictionary</title>
# Health Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|HLTH_ENABLE|0 (0x0)|A command to enable or disable health checks| | |
| | | |enable|HealthEnabled|whether or not health checks are enabled|
|HLTH_PING_ENABLE|1 (0x1)|Ignore a particular ping entry| | |
| | | |entry|Fw::CmdStringArg|The entry to enable/disable|
| | | |enable|PingEnabled|whether or not a port is pinged|
|HLTH_CHNG_PING|2 (0x2)|Change ping value| | |
| | | |entry|Fw::CmdStringArg|The entry to modify|
| | | |warningValue|U32|Ping warning threshold|
| | | |fatalValue|U32|Ping fatal threshold|
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|PingLateWarnings|0 (0x0)|U32|Number of overrun warnings|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|HLTH_PING_WARN|0 (0x0)|Warn that a ping target is longer than the warning value| | | | |
| | | |entry|Fw::LogStringArg&|40|The entry passing the warning level|
|HLTH_PING_LATE|1 (0x1)|Declare FATAL since task is no longer responding| | | | |
| | | |entry|Fw::LogStringArg&|40|The entry passing the warning level|
|HLTH_PING_WRONG_KEY|2 (0x2)|Declare FATAL since task is no longer responding| | | | |
| | | |entry|Fw::LogStringArg&|40|The entry passing the warning level|
| | | |badKey|U32||The incorrect key value|
|HLTH_CHECK_ENABLE|3 (0x3)|Report checking turned on or off| | | | |
| | | |enabled|HealthIsEnabled||If health checking is enabled|
|HLTH_CHECK_PING|4 (0x4)|Report a particular entry on or off| | | | |
| | | |enabled|HealthPingIsEnabled||If health pinging is enabled for a particular entry|
| | | |entry|Fw::LogStringArg&|40|The entry passing the warning level|
|HLTH_CHECK_LOOKUP_ERROR|5 (0x5)|Entry was not found| | | | |
| | | |entry|Fw::LogStringArg&|40|The entry passing the warning level|
|HLTH_PING_UPDATED|6 (0x6)|Report changed ping| | | | |
| | | |entry|Fw::LogStringArg&|40|The entry changed|
| | | |warn|U32||The new warning value|
| | | |fatal|U32||The new FATAL value|
|HLTH_PING_INVALID_VALUES|7 (0x7)|Report changed ping| | | | |
| | | |entry|Fw::LogStringArg&|40|The entry changed|
| | | |warn|U32||The new warning value|
| | | |fatal|U32||The new FATAL value|

5
Svc/LinuxTimer/docs/LinuxTimer.md
View File

@ -1,5 +0,0 @@
<title>LinuxTimer Component Dictionary</title>
# LinuxTimer Component Dictionary

5
Svc/PassiveConsoleTextLogger/docs/PassiveTextLogger.md
View File

@ -1,5 +0,0 @@
<title>PassiveTextLogger Component Dictionary</title>
# PassiveTextLogger Component Dictionary

5
Svc/PolyDb/docs/PolyDb.md
View File

@ -1,5 +0,0 @@
<title>PolyDb Component Dictionary</title>
# PolyDb Component Dictionary

35
Svc/PrmDb/docs/PrmDb.md
View File

@ -1,35 +0,0 @@
<title>PrmDb Component Dictionary</title>
# PrmDb Component Dictionary
## Command List
|Mnemonic|ID|Description|Arg Name|Arg Type|Comment
|---|---|---|---|---|---|
|PRM_SAVE_FILE|0 (0x0)|Command to save parameter image to file. Uses file name passed to constructor| | |
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|PrmIdNotFound|0 (0x0)|Parameter ID not found in database.| | | | |
| | | |Id|U32||The parameter ID|
|PrmIdUpdated|1 (0x1)|Parameter ID updated in database| | | | |
| | | |Id|U32||The parameter ID|
|PrmDbFull|2 (0x2)|Parameter database is full| | | | |
| | | |Id|U32||The parameter ID|
|PrmIdAdded|3 (0x3)|Parameter ID added to database| | | | |
| | | |Id|U32||The parameter ID|
|PrmFileWriteError|4 (0x4)|Failed to write parameter file| | | | |
| | | |stage|PrmWriteError||The write stage|
| | | |record|I32||The record that had the failure|
| | | |error|I32||The error code|
|PrmFileSaveComplete|5 (0x5)|Save of parameter file completed| | | | |
| | | |records|U32||The number of records saved|
|PrmFileReadError|6 (0x6)|Failed to read parameter file| | | | |
| | | |stage|PrmReadError||The write stage|
| | | |record|I32||The record that had the failure|
| | | |error|I32||The error code|
|PrmFileLoadComplete|7 (0x7)|Load of parameter file completed| | | | |
| | | |records|U32||The number of records loaded|

5
Svc/RateGroupDriver/docs/RateGroupDriver.md
View File

@ -1,5 +0,0 @@
<title>RateGroupDriver Component Dictionary</title>
# RateGroupDriver Component Dictionary

5
Svc/Time/docs/Time.md
View File

@ -1,5 +0,0 @@
<title>Time Component Dictionary</title>
# Time Component Dictionary

5
Svc/TlmChan/docs/TlmChan.md
View File

@ -1,5 +0,0 @@
<title>TlmChan Component Dictionary</title>
# TlmChan Component Dictionary

30
Svc/UdpReceiver/docs/UdpReceiver.md
View File

@ -1,30 +0,0 @@
<title>UdpReceiver Component Dictionary</title>
# UdpReceiver Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|UR_PacketsReceived|0 (0x0)|U32|Number of packets received|
|UR_BytesReceived|1 (0x1)|U32|Number of bytes received|
|UR_PacketsDropped|2 (0x2)|U32|Number of packets dropped|
|UR_DecodeErrors|3 (0x3)|U32|Number of packet decode errors|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|UR_PortOpened|0 (0x0)|Connection opened| | | | |
| | | |port|U32|||
|UR_SocketError|1 (0x1)|UDP port socket error| | | | |
| | | |error|Fw::LogStringArg&|80||
|UR_BindError|2 (0x2)|UDP port socket error| | | | |
| | | |error|Fw::LogStringArg&|80||
|UR_RecvError|3 (0x3)|UDP receive error| | | | |
| | | |error|Fw::LogStringArg&|80||
|UR_DecodeError|4 (0x4)|Port decode error| | | | |
| | | |stage|DecodeStage|||
| | | |error|I32|||
|UR_DroppedPacket|5 (0x5)|Dropped packet was detected| | | | |
| | | |diff|U32|||

22
Svc/UdpSender/docs/UdpSender.md
View File

@ -1,22 +0,0 @@
<title>UdpSender Component Dictionary</title>
# UdpSender Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|US_PacketsSent|0 (0x0)|U32|Number of packets sent|
|US_BytesSent|1 (0x1)|U32|Number of bytes sent|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|US_PortOpened|0 (0x0)|Connection opened| | | | |
| | | |server|Fw::LogStringArg&|80||
| | | |port|U32|||
|US_SocketError|1 (0x1)|UDP port socket error| | | | |
| | | |error|Fw::LogStringArg&|80||
|US_SendError|2 (0x2)|UDP send error| | | | |
| | | |error|Fw::LogStringArg&|80||

23
Svc/UdpSender/docs/ZmqPub.md
View File

@ -1,23 +0,0 @@
<title>ZmqPub Component Dictionary</title>
# ZmqPub Component Dictionary
## Telemetry Channel List
|Channel Name|ID|Type|Description|
|---|---|---|---|
|ZP_PacketsSent|0 (0x0)|U32|Number of packets sent|
## Event List
|Event Name|ID|Description|Arg Name|Arg Type|Arg Size|Description
|---|---|---|---|---|---|---|
|ZP_PublishConnectionOpened|0 (0x0)|Connection opened| | | | |
|ZP_ContextError|1 (0x1)|Zmq publisher context open error| | | | |
| | | |error|Fw::LogStringArg&|80||
|ZP_SocketError|2 (0x2)|Zmq publisher socket error| | | | |
| | | |error|Fw::LogStringArg&|80||
|ZP_BindError|3 (0x3)|Zmq publisher bind error| | | | |
| | | |error|Fw::LogStringArg&|80||
|ZP_SendError|4 (0x4)|Zmq publisher send error| | | | |
| | | |error|Fw::LogStringArg&|80||