Back to Fprime

BufferAccumulator Component Dictionary

Svc/BufferAccumulator/docs/sdd.md

4.2.21.7 KB
Original Source

BufferAccumulator Component Dictionary

Command List

MnemonicIDDescriptionArg NameArg TypeComment
BA_SetMode0 (0x0)Set the mode
modeOpState
BA_DrainBuffers1 (0x1)Drain the commanded number of buffers
numToDrainU32
blockModeBlockMode

Telemetry Channel List

Channel NameIDTypeDescription
BA_NumQueuedBuffers0 (0x0)U32The number of buffers queued

Event List

Event NameIDDescriptionArg NameArg TypeArg SizeDescription
BA_BufferAccepted0 (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_QueueFull1 (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.
BA_StillDraining2 (0x2)Got DrainBuffers command while executing DrainBuffers command
numDrainedU32
numToDrainU32
BA_AlreadyDraining3 (0x3)Got DrainBuffers command while in DRAIN mode
BA_DrainStalled4 (0x4)Ran out of buffers while executing DrainBuffers command
numDrainedU32
numToDrainU32
BA_PartialDrainDone5 (0x5)Finished DrainBuffers command
numDrainedU32
BA_NonBlockDrain6 (0x6)Not enough buffers to complete requested drain, and NOBLOCK was set; will only drain what we have
numWillDrainU32
numReqDrainU32