Module: tamComm¶
Executive Summary¶
This module reads in a message of type tamSensorBodyFswMsg, outputs the magnetometer measurement vector in vehicle’s body coordinates tam_B
with the name of tamOutMsgName
.
Module Assumptions and Limitations¶
No assumptions are made.
Message Connection Descriptions¶
The following table lists the module input and output messages. The module msg variable name 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 |
---|---|---|
tamInMsgName |
TAM sensor interface input message |
|
tamOutMsgName |
TAM sensor interface output message |
User Guide¶
In order to transform the tam_S
vector of tamSensorIntMsg from sensor to body frame, dcm_BS
should be defined.
Functions
-
void
SelfInit_tamProcessTelem
(tamConfigData *configData, int64_t moduleID)¶ This method initializes the configData for the TAM sensor interface. It checks to ensure that the inputs are sane and then creates the output message
- Return
void
- Parameters
configData
: The configuration data associated with the TAM sensor interface
-
void
CrossInit_tamProcessTelem
(tamConfigData *configData, int64_t moduleID)¶ This method performs the second stage of initialization for the TAM sensor interface. It’s primary function is to link the input messages that were created elsewhere.
- Return
void
- Parameters
configData
: The configuration data associated with the TAM interface
-
void
Update_tamProcessTelem
(tamConfigData *configData, uint64_t callTime, int64_t moduleID)¶ This method takes the sensor data from the magnetometers and converts that information to the format used by the TAM nav.
- Return
void
- Parameters
configData
: The configuration data associated with the TAM interfacecallTime
: The clock time at which the function was called (nanoseconds)
-
void
Reset_tamProcessTelem
(tamConfigData *configData, uint64_t callTime, int64_t moduleID)¶ This method performs a complete reset of the module. Local module variables that retain time varying states between function calls are reset to their default values.
- Return
void
- Parameters
configData
: The configuration data associated with the guidance module
-
struct
tamConfigData
¶ - #include <tamComm.h>
module configuration message definition
Public Members
-
double
dcm_BS
[9]¶ [T] Row - Sensor to Body DCM
-
char
tamInMsgName
[MAX_STAT_MSG_LENGTH
]¶ [-] The name of the TAM interface input message
-
char
tamOutMsgName
[MAX_STAT_MSG_LENGTH
]¶ [-] The name of the TAM interface output message
-
int32_t
tamSensorMsgID
¶ [-] TAM sensor IDs tied to the input name
-
int32_t
tamOutMsgID
¶ [-] TAM message ID for the output port
-
TAMSensorBodyFswMsg
tamLocalOutput
¶ [-] TAM output data structure
-
double