Documentation ¶
Index ¶
- Constants
- Variables
- type PacketSequenceControl
- type SourcePackageContinuationFlagType
- type SourcePackageServiceSubtype
- type SourcePackageServiceType
- type SourcePacketAPIDType
- type SourcePacketHeader
- type SourcePacketHeaderType
- type TMHeader
- func (header *TMHeader) CSVHeaders() []string
- func (header *TMHeader) CSVRow() []string
- func (header *TMHeader) IsHousekeeping() bool
- func (header *TMHeader) IsTCVerification() bool
- func (header *TMHeader) IsTransparentData() bool
- func (header *TMHeader) MarshalJSON() ([]byte, error)
- func (header *TMHeader) Nanoseconds() int64
- func (header *TMHeader) SetParquet(row *parquetrow.ParquetRow)
- func (header *TMHeader) Time(epoch time.Time) time.Time
Constants ¶
const Specification string = "IS-OSE-ICD-0005:1"
Specification describes what version the current implementation follows
Variables ¶
Epoch is the CUC Epoch of the platform, GPS Time
Functions ¶
This section is empty.
Types ¶
type PacketSequenceControl ¶
type PacketSequenceControl uint16
PacketSequenceControl is the encoding of the sequence value
func (*PacketSequenceControl) GroupingFlags ¶
func (psc *PacketSequenceControl) GroupingFlags() SourcePackageContinuationFlagType
GroupingFlags ...
func (*PacketSequenceControl) SequenceCount ¶
func (psc *PacketSequenceControl) SequenceCount() uint16
SequenceCount ...
type SourcePackageContinuationFlagType ¶
type SourcePackageContinuationFlagType uint
SourcePackageContinuationFlagType type for continuation groups
const ( // SPCont Continuation packet SPCont SourcePackageContinuationFlagType = iota // SPStart start sequence of continuation packets SPStart // SPStop end of continuation packets SPStop // SPStandalone a single packet SPStandalone )
func (*SourcePackageContinuationFlagType) String ¶
func (continuationFlag *SourcePackageContinuationFlagType) String() string
type SourcePackageServiceSubtype ¶ added in v0.1.0
type SourcePackageServiceSubtype uint8
SourcePackageServiceSubtype service subtype type (different meaning for each service)
const ( // TCExecFailure subtype for Telecommand Execution Report - Failure TCExecFailure SourcePackageServiceSubtype = 8 // TCAcceptSuccess subtype for Telecommand Failure Report - success TCAcceptSuccess SourcePackageServiceSubtype = 1 // TCAcceptFailure subtype for Telecommand Failure Report - Failure TCAcceptFailure SourcePackageServiceSubtype = 2 // TCExecSuccess subtype for Telecommand Execution Report - Success TCExecSuccess SourcePackageServiceSubtype = 7 )
type SourcePackageServiceType ¶
type SourcePackageServiceType uint8
SourcePackageServiceType service type types
const ( // TelecommandVerification ... TelecommandVerification SourcePackageServiceType = 1 // DeviceCommandDistribution ... DeviceCommandDistribution SourcePackageServiceType = 2 // HousekeepingDiagnosticDataReporting ... HousekeepingDiagnosticDataReporting SourcePackageServiceType = 3 // ParameterStatisticsReporting ... ParameterStatisticsReporting SourcePackageServiceType = 4 // EventReporting ... EventReporting SourcePackageServiceType = 5 // MemoryManagement ... MemoryManagement SourcePackageServiceType = 6 // FunctionManagement ... FunctionManagement SourcePackageServiceType = 8 // TimeManagement ... TimeManagement SourcePackageServiceType = 9 // OnboardOperationsScheduling ... OnboardOperationsScheduling SourcePackageServiceType = 11 // OnboardMonitoring ... OnboardMonitoring SourcePackageServiceType = 12 // LargeDataTransfer ... LargeDataTransfer SourcePackageServiceType = 13 // PacketForwardingControl ... PacketForwardingControl SourcePackageServiceType = 14 // OnboardStorageandRetrieval ... OnboardStorageandRetrieval SourcePackageServiceType = 15 // Test ... Test SourcePackageServiceType = 17 // OnboardOperationsProcedure ... OnboardOperationsProcedure SourcePackageServiceType = 18 // EventAction ... EventAction SourcePackageServiceType = 19 // TransparentDataTransfer ... TransparentDataTransfer SourcePackageServiceType = 128 // OnBoardParameterManagement ... OnBoardParameterManagement SourcePackageServiceType = 129 )
type SourcePacketAPIDType ¶
type SourcePacketAPIDType uint8
SourcePacketAPIDType for service type
const ( // TimeAPID Time Reporting (reserved) TimeAPID SourcePacketAPIDType = 0 // ScmAPID Spacecraft Control Module (SCM) Handler (HW and BSW) ScmAPID SourcePacketAPIDType = 10 // RwAPID Reaction Wheel Equipment Handler RwAPID SourcePacketAPIDType = 11 // StrAPID Star Tracker Equipment Handler StrAPID SourcePacketAPIDType = 12 // MagAPID Magnetometer Equipment Handler MagAPID SourcePacketAPIDType = 13 // MtqAPID Magnetorquer Equipment Handler MtqAPID SourcePacketAPIDType = 14 // GpsAPID GPS Equipment Handler GpsAPID SourcePacketAPIDType = 15 // MpduAPID MPDU Equipment Handler MpduAPID SourcePacketAPIDType = 16 // TcmAPID TCM Equipment Handler TcmAPID SourcePacketAPIDType = 17 // DpcuAPID DPCU Equipment Handler DpcuAPID SourcePacketAPIDType = 18 // SttqAPID Spacecraft Telecommand Scheduler SttqAPID SourcePacketAPIDType = 30 // SysAPID System Core SysAPID SourcePacketAPIDType = 31 // PowAPID Power Core PowAPID SourcePacketAPIDType = 32 // TcsAPID Thermal Core TcsAPID SourcePacketAPIDType = 33 // AcsAPID ACS Core AcsAPID SourcePacketAPIDType = 34 // SfdirAPID Spacecraft FDIR Core SfdirAPID SourcePacketAPIDType = 35 // McmAPID Mission Control Module (MCM) Handler (HW and BSW) McmAPID SourcePacketAPIDType = 50 // MttqAPID Mission Telecommand Scheduler MttqAPID SourcePacketAPIDType = 70 // OrbAPID Orbit Estimation OrbAPID SourcePacketAPIDType = 71 // PlmAPID Payload Management PlmAPID SourcePacketAPIDType = 72 // MainAPID Payload-specific APIDs (TBD) MainAPID SourcePacketAPIDType = 100 // IdleAPID Idle Packet? IdleAPID SourcePacketAPIDType = 255 )
type SourcePacketHeader ¶
type SourcePacketHeader struct { PacketID packetID PacketSequenceControl PacketSequenceControl PacketLength uint16 }
SourcePacketHeader Source Packet Header
func NewSourcePacketHeader ¶ added in v0.2.1
func NewSourcePacketHeader(buf io.Reader) (*SourcePacketHeader, error)
NewSourcePacketHeader reads a SourcePacketHeader from buffer
func (*SourcePacketHeader) CSVHeaders ¶
func (sph *SourcePacketHeader) CSVHeaders() []string
CSVHeaders returns the header row
func (*SourcePacketHeader) CSVRow ¶
func (sph *SourcePacketHeader) CSVRow() []string
CSVRow returns the data row
func (*SourcePacketHeader) CSVSpecifications ¶
func (sph *SourcePacketHeader) CSVSpecifications() []string
CSVSpecifications returns the version of the spec used
func (*SourcePacketHeader) MarshalJSON ¶
func (sph *SourcePacketHeader) MarshalJSON() ([]byte, error)
MarshalJSON makes a custom json of what is of interest in the struct
func (*SourcePacketHeader) SetParquet ¶ added in v1.0.0
func (sph *SourcePacketHeader) SetParquet(row *parquetrow.ParquetRow)
SetParquet sets the parquet representation of the SourcePacketHeader
type SourcePacketHeaderType ¶
type SourcePacketHeaderType uint
SourcePacketHeaderType is the type of the source packet (TM/TC)
const ( //TM is the source package type for telemetry TM SourcePacketHeaderType = 0 //TC is the source package type for telecommand TC SourcePacketHeaderType = 1 )
func (*SourcePacketHeaderType) String ¶
func (headerType *SourcePacketHeaderType) String() string
type TMHeader ¶ added in v0.1.0
type TMHeader struct { PUS pus ServiceType SourcePackageServiceType ServiceSubType SourcePackageServiceSubtype CUCTimeSeconds uint32 CUCTimeFraction uint16 }
TMHeader (9 octets)
func NewTMHeader ¶ added in v0.2.1
NewTMHeader reads a TMHeader from buffer
func (*TMHeader) CSVHeaders ¶ added in v0.1.0
CSVHeaders returns the header row
func (*TMHeader) IsHousekeeping ¶ added in v0.1.0
IsHousekeeping returns true if payload contains housekeeping data
func (*TMHeader) IsTCVerification ¶ added in v0.1.0
IsTCVerification returns true if payload contains TC verification data
func (*TMHeader) IsTransparentData ¶ added in v0.1.0
IsTransparentData can be either CCD or Photometer data
func (*TMHeader) MarshalJSON ¶ added in v0.1.0
MarshalJSON makes a custom json of what is of interest in the struct
func (*TMHeader) Nanoseconds ¶ added in v0.1.0
Nanoseconds returns the telemetry data time in nanoseconds since its epoch
func (*TMHeader) SetParquet ¶ added in v1.0.0
func (header *TMHeader) SetParquet(row *parquetrow.ParquetRow)
SetParquet returns the parquet representation of the TMHeader