Module: tamComm
Executive Summary
This module reads in a message of type TAMSensorBodyMsgPayload, outputs the magnetometer measurement vector in vehicle’s body coordinates tam_B to the output message tamOutMsg.
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 |
|---|---|---|
tamInMsg |
TAM sensor interface input message |
|
tamOutMsg |
TAM sensor interface output message |
User Guide
In order to transform the tam_S vector of TAMSensorMsgPayload 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
- Parameters:
configData – The configuration data associated with the TAM sensor interface
moduleID – The ID associated with the configData
- Returns:
void
-
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.
- Parameters:
configData – The configuration data associated with the TAM interface
callTime – The clock time at which the function was called (nanoseconds)
moduleID – The ID associated with the configData
- Returns:
void
-
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.
- Parameters:
configData – The configuration data associated with the guidance module
callTime – The clock time at which the function was called (nanoseconds)
moduleID – The ID associated with the configData
- Returns:
void
-
struct tamConfigData
- #include <tamComm.h>
module configuration message definition