Module: dvGuidance¶
Executive Summary¶
This module creates a time varying attitude reference frame message that allows the orbit correction burn direction to rotate at a constant rate.
A message is read in containing the base f$Deltamathbf{v}f$ direction, the burn duration, as well as a nominal rotation axis. A base burn frame is created relative to which a constant rotation about the 3rd frame axis is performed. The output message contains the full reference frame states including the constant angular velocity vector and a zero angular acceleration vector. More information can be found in the
PDF Description.
Message Connection Descriptions¶
The following table lists all the module input and output messages. The module msg connection is set by the user from python. The msg type contains a link to the message structure definition, while the description provides information on what this message is used for.
Msg Variable Name |
Msg Type |
Description |
|---|---|---|
attRefOutMsg |
attitude reference output message |
|
burnDataInMsg |
Input message that configures the vehicle burn |
Functions
-
void SelfInit_dvGuidance(dvGuidanceConfig *configData, int64_t moduleID)¶
This method initializes the configData for the nominal delta-V maneuver guidance. It checks to ensure that the inputs are sane and then creates the output message
- Parameters
configData – The configuration data associated with the delta-V maneuver guidance
moduleID – The unique module identifier
- Returns
void
-
void Update_dvGuidance(dvGuidanceConfig *configData, uint64_t callTime, int64_t moduleID)¶
This method takes its own internal variables and creates an output attitude command to use for burn execution. It also flags whether the burn should be happening or not.
- Parameters
configData – The configuration data associated with the delta-V maneuver guidance
callTime – The clock time at which the function was called (nanoseconds)
moduleID – The unique module identifier
- Returns
void
-
void Reset_dvGuidance(dvGuidanceConfig *configData, uint64_t callTime, int64_t moduleID)¶
This resets the module.
- Parameters
configData – The configuration data associated with this module
callTime – The clock time at which the function was called (nanoseconds)
moduleID – The unique module identifier
- Returns
void
-
struct dvGuidanceConfig¶
- #include <dvGuidance.h>
Top level structure for the nominal delta-V guidance.