Tool: is_ccsds
Description
This tool checks to see if a file contains plain, unannotated
CCSDS telemetry packets. It does this by attempting to read the first few
packets from a file and checking header values like the version field.
It exits with status 0 if the fiel appears to contain CCSDS telemetry,
and exits with status 1 if the file does not. Status > 1 indicates an error.
Option Summary
| Option | Argument Type | Default Value |
|---|
| -annotated |
Boolean |
false |
| -command_check |
Boolean |
false |
| -head2_check |
Boolean |
true |
| -infile |
String |
- |
| -npackets |
Integer |
3 |
| -telemetry_check |
Boolean |
true |
| -version |
Integer |
0 |
Only the initial unique characters of each option are
significant. Each option must be followed by an argument
of the given type. Boolean "true" and "false" are indicated
with "y" and "n" respectively. A boolean option without a
value is assumed to be "true".
For filename arguments, "-" means either stdin or stdout
as appropriate.
Each option is described in detail below.
Parameters
- annotated Boolean (default = false)
- If true, assume the packets have 12 byte ITOS annotation
headers.
- command_check Boolean (default = false)
- Check that the packet type bit is set to "command".
This parameter is ignored if telemetry_check=true.
- head2_check Boolean (default = true)
- Check that the header indicates the packet contains a
secondary header.
- infile String (default = -)
- The file to be checked.
- npackets Integer (default = 3)
- Number of packets to verify at the beginning of the file.
If the file contains fewer than this number of packets, it is not
considered an error. An empty file will be called CCSDS.
- telemetry_check Boolean (default = true)
- Check that the packet type bit is set to "telemetry".
- version Integer (default = 0)
- The value of the CCSDS version number to expect. Currently, this
should always be the default, 0.