ait.core.ccsds module

Consultative Committee for Space Data Systems (CCSDS)

The ait.core.ccsds module provides CCSDS header definitions and datatypes.

class ait.core.ccsds.CcsdsDefinition(*args, **kwargs)

Bases: ait.core.json.SlotSerializer, object

A CcsdsDefinition is analogous to a PacketDefinition, except it defines the expected values in a CCSDS header.

CcsdsDefinition`s are most often specified in a ``ccsds:` block within a YAML !Command or !Packet definition.

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

apid

length

secondary

seqflags

shflag

Indicates whether a CCSDS Secondary Header is present.

type

version

class ait.core.ccsds.CcsdsHeader(data=None)

Bases: ait.core.tlm.Packet

A CcsdsHeader is just like any other Packet, except that the CCSDS (primary) header FieldDefinition`s are already defined.  That is, there is no need to pass in a :class`PacketDefinition at initialization, only the underlying packet data to decode as a CCSDS header.

__init__(data=None)

Creates a new Packet based on the given Packet Definition and binary (raw) packet data.

Definition = PacketDefinition(ccsds=None, constants=None, desc=None, fields=[FieldDefinition(_bytes=0, desc=None, dntoeu=None, enum=None, expr=None, mask=224, name='version', shift=5, _type=PrimitiveType('U8'), units=None, when=None, _title=None, aliases=None), FieldDefinition(_bytes=0, desc=None, dntoeu=None, enum=None, expr=None, mask=16, name='type', shift=4, _type=PrimitiveType('U8'), units=None, when=None, _title=None, aliases=None), FieldDefinition(_bytes=0, desc=None, dntoeu=None, enum=None, expr=None, mask=8, name='shflag', shift=3, _type=PrimitiveType('U8'), units=None, when=None, _title=None, aliases=None), FieldDefinition(_bytes=[0, 1], desc=None, dntoeu=None, enum=None, expr=None, mask=2047, name='apid', shift=0, _type=PrimitiveType('MSB_U16'), units=None, when=None, _title=None, aliases=None), FieldDefinition(_bytes=2, desc=None, dntoeu=None, enum={0: 'Continuation Segment', 1: 'First Segment', 2: 'Last Segment', 3: 'Unsegmented'}, expr=None, mask=192, name='seqflags', shift=6, _type=PrimitiveType('U8'), units=None, when=None, _title=None, aliases=None), FieldDefinition(_bytes=[2, 3], desc=None, dntoeu=None, enum=None, expr=None, mask=16383, name='seqcount', shift=0, _type=PrimitiveType('MSB_U16'), units=None, when=None, _title=None, aliases=None), FieldDefinition(_bytes=[4, 5], desc=None, dntoeu=None, enum=None, expr=None, mask=None, name='length', shift=0, _type=PrimitiveType('MSB_U16'), units=None, when=None, _title=None, aliases=None)], fieldmap={'version': FieldDefinition(_bytes=0, desc=None, dntoeu=None, enum=None, expr=None, mask=224, name='version', shift=5, _type=PrimitiveType('U8'), units=None, when=None, _title=None, aliases=None), 'type': FieldDefinition(_bytes=0, desc=None, dntoeu=None, enum=None, expr=None, mask=16, name='type', shift=4, _type=PrimitiveType('U8'), units=None, when=None, _title=None, aliases=None), 'shflag': FieldDefinition(_bytes=0, desc=None, dntoeu=None, enum=None, expr=None, mask=8, name='shflag', shift=3, _type=PrimitiveType('U8'), units=None, when=None, _title=None, aliases=None), 'apid': FieldDefinition(_bytes=[0, 1], desc=None, dntoeu=None, enum=None, expr=None, mask=2047, name='apid', shift=0, _type=PrimitiveType('MSB_U16'), units=None, when=None, _title=None, aliases=None), 'seqflags': FieldDefinition(_bytes=2, desc=None, dntoeu=None, enum={0: 'Continuation Segment', 1: 'First Segment', 2: 'Last Segment', 3: 'Unsegmented'}, expr=None, mask=192, name='seqflags', shift=6, _type=PrimitiveType('U8'), units=None, when=None, _title=None, aliases=None), 'seqcount': FieldDefinition(_bytes=[2, 3], desc=None, dntoeu=None, enum=None, expr=None, mask=16383, name='seqcount', shift=0, _type=PrimitiveType('MSB_U16'), units=None, when=None, _title=None, aliases=None), 'length': FieldDefinition(_bytes=[4, 5], desc=None, dntoeu=None, enum=None, expr=None, mask=None, name='length', shift=0, _type=PrimitiveType('MSB_U16'), units=None, when=None, _title=None, aliases=None)}, uid=1, functions=None, globals={'__builtins__': {'__name__': 'builtins', '__doc__': "Built-in functions, exceptions, and other objects.\n\nNoteworthy: None is the `nil' object; Ellipsis represents `...' in slices.", '__package__': '', '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': ModuleSpec(name='builtins', loader=<class '_frozen_importlib.BuiltinImporter'>), '__build_class__': <built-in function __build_class__>, '__import__': <built-in function __import__>, 'abs': <built-in function abs>, 'all': <built-in function all>, 'any': <built-in function any>, 'ascii': <built-in function ascii>, 'bin': <built-in function bin>, 'breakpoint': <built-in function breakpoint>, 'callable': <built-in function callable>, 'chr': <built-in function chr>, 'compile': <built-in function compile>, 'delattr': <built-in function delattr>, 'dir': <built-in function dir>, 'divmod': <built-in function divmod>, 'eval': <built-in function eval>, 'exec': <built-in function exec>, 'format': <built-in function format>, 'getattr': <built-in function getattr>, 'globals': <built-in function globals>, 'hasattr': <built-in function hasattr>, 'hash': <built-in function hash>, 'hex': <built-in function hex>, 'id': <built-in function id>, 'input': <built-in function input>, 'isinstance': <built-in function isinstance>, 'issubclass': <built-in function issubclass>, 'iter': <built-in function iter>, 'len': <built-in function len>, 'locals': <built-in function locals>, 'max': <built-in function max>, 'min': <built-in function min>, 'next': <built-in function next>, 'oct': <built-in function oct>, 'ord': <built-in function ord>, 'pow': <built-in function pow>, 'print': <built-in function print>, 'repr': <built-in function repr>, 'round': <built-in function round>, 'setattr': <built-in function setattr>, 'sorted': <built-in function sorted>, 'sum': <built-in function sum>, 'vars': <built-in function vars>, 'None': None, 'Ellipsis': Ellipsis, 'NotImplemented': NotImplemented, 'False': False, 'True': True, 'bool': <class 'bool'>, 'memoryview': <class 'memoryview'>, 'bytearray': <class 'bytearray'>, 'bytes': <class 'bytes'>, 'classmethod': <class 'classmethod'>, 'complex': <class 'complex'>, 'dict': <class 'dict'>, 'enumerate': <class 'enumerate'>, 'filter': <class 'filter'>, 'float': <class 'float'>, 'frozenset': <class 'frozenset'>, 'property': <class 'property'>, 'int': <class 'int'>, 'list': <class 'list'>, 'map': <class 'map'>, 'object': <class 'object'>, 'range': <class 'range'>, 'reversed': <class 'reversed'>, 'set': <class 'set'>, 'slice': <class 'slice'>, 'staticmethod': <class 'staticmethod'>, 'str': <class 'str'>, 'super': <class 'super'>, 'tuple': <class 'tuple'>, 'type': <class 'type'>, 'zip': <class 'zip'>, '__debug__': True, 'BaseException': <class 'BaseException'>, 'Exception': <class 'Exception'>, 'TypeError': <class 'TypeError'>, 'StopAsyncIteration': <class 'StopAsyncIteration'>, 'StopIteration': <class 'StopIteration'>, 'GeneratorExit': <class 'GeneratorExit'>, 'SystemExit': <class 'SystemExit'>, 'KeyboardInterrupt': <class 'KeyboardInterrupt'>, 'ImportError': <class 'ImportError'>, 'ModuleNotFoundError': <class 'ModuleNotFoundError'>, 'OSError': <class 'OSError'>, 'EnvironmentError': <class 'OSError'>, 'IOError': <class 'OSError'>, 'EOFError': <class 'EOFError'>, 'RuntimeError': <class 'RuntimeError'>, 'RecursionError': <class 'RecursionError'>, 'NotImplementedError': <class 'NotImplementedError'>, 'NameError': <class 'NameError'>, 'UnboundLocalError': <class 'UnboundLocalError'>, 'AttributeError': <class 'AttributeError'>, 'SyntaxError': <class 'SyntaxError'>, 'IndentationError': <class 'IndentationError'>, 'TabError': <class 'TabError'>, 'LookupError': <class 'LookupError'>, 'IndexError': <class 'IndexError'>, 'KeyError': <class 'KeyError'>, 'ValueError': <class 'ValueError'>, 'UnicodeError': <class 'UnicodeError'>, 'UnicodeEncodeError': <class 'UnicodeEncodeError'>, 'UnicodeDecodeError': <class 'UnicodeDecodeError'>, 'UnicodeTranslateError': <class 'UnicodeTranslateError'>, 'AssertionError': <class 'AssertionError'>, 'ArithmeticError': <class 'ArithmeticError'>, 'FloatingPointError': <class 'FloatingPointError'>, 'OverflowError': <class 'OverflowError'>, 'ZeroDivisionError': <class 'ZeroDivisionError'>, 'SystemError': <class 'SystemError'>, 'ReferenceError': <class 'ReferenceError'>, 'MemoryError': <class 'MemoryError'>, 'BufferError': <class 'BufferError'>, 'Warning': <class 'Warning'>, 'UserWarning': <class 'UserWarning'>, 'DeprecationWarning': <class 'DeprecationWarning'>, 'PendingDeprecationWarning': <class 'PendingDeprecationWarning'>, 'SyntaxWarning': <class 'SyntaxWarning'>, 'RuntimeWarning': <class 'RuntimeWarning'>, 'FutureWarning': <class 'FutureWarning'>, 'ImportWarning': <class 'ImportWarning'>, 'UnicodeWarning': <class 'UnicodeWarning'>, 'BytesWarning': <class 'BytesWarning'>, 'ResourceWarning': <class 'ResourceWarning'>, 'ConnectionError': <class 'ConnectionError'>, 'BlockingIOError': <class 'BlockingIOError'>, 'BrokenPipeError': <class 'BrokenPipeError'>, 'ChildProcessError': <class 'ChildProcessError'>, 'ConnectionAbortedError': <class 'ConnectionAbortedError'>, 'ConnectionRefusedError': <class 'ConnectionRefusedError'>, 'ConnectionResetError': <class 'ConnectionResetError'>, 'FileExistsError': <class 'FileExistsError'>, 'FileNotFoundError': <class 'FileNotFoundError'>, 'IsADirectoryError': <class 'IsADirectoryError'>, 'NotADirectoryError': <class 'NotADirectoryError'>, 'InterruptedError': <class 'InterruptedError'>, 'PermissionError': <class 'PermissionError'>, 'ProcessLookupError': <class 'ProcessLookupError'>, 'TimeoutError': <class 'TimeoutError'>, 'open': <built-in function open>, 'quit': Use quit() or Ctrl-D (i.e. EOF) to exit, 'exit': Use exit() or Ctrl-D (i.e. EOF) to exit, 'copyright': Copyright (c) 2001-2020 Python Software Foundation. All Rights Reserved. Copyright (c) 2000 BeOpen.com. All Rights Reserved. Copyright (c) 1995-2001 Corporation for National Research Initiatives. All Rights Reserved. Copyright (c) 1991-1995 Stichting Mathematisch Centrum, Amsterdam. All Rights Reserved., 'credits': Thanks to CWI, CNRI, BeOpen.com, Zope Corporation and a cast of thousands for supporting Python development. See www.python.org for more information., 'license': Type license() to see the full license text, 'help': Type help() for interactive help, or help(object) for help about object.}, 'acos': <built-in function acos>, 'acosh': <built-in function acosh>, 'asin': <built-in function asin>, 'asinh': <built-in function asinh>, 'atan': <built-in function atan>, 'atan2': <built-in function atan2>, 'atanh': <built-in function atanh>, 'ceil': <built-in function ceil>, 'copysign': <built-in function copysign>, 'cos': <built-in function cos>, 'cosh': <built-in function cosh>, 'degrees': <built-in function degrees>, 'dist': <built-in function dist>, 'erf': <built-in function erf>, 'erfc': <built-in function erfc>, 'exp': <built-in function exp>, 'expm1': <built-in function expm1>, 'fabs': <built-in function fabs>, 'factorial': <built-in function factorial>, 'floor': <built-in function floor>, 'fmod': <built-in function fmod>, 'frexp': <built-in function frexp>, 'fsum': <built-in function fsum>, 'gamma': <built-in function gamma>, 'gcd': <built-in function gcd>, 'hypot': <built-in function hypot>, 'isclose': <built-in function isclose>, 'isfinite': <built-in function isfinite>, 'isinf': <built-in function isinf>, 'isnan': <built-in function isnan>, 'isqrt': <built-in function isqrt>, 'ldexp': <built-in function ldexp>, 'lgamma': <built-in function lgamma>, 'log': <built-in function log>, 'log1p': <built-in function log1p>, 'log10': <built-in function log10>, 'log2': <built-in function log2>, 'modf': <built-in function modf>, 'pow': <built-in function pow>, 'radians': <built-in function radians>, 'remainder': <built-in function remainder>, 'sin': <built-in function sin>, 'sinh': <built-in function sinh>, 'sqrt': <built-in function sqrt>, 'tan': <built-in function tan>, 'tanh': <built-in function tanh>, 'trunc': <built-in function trunc>, 'prod': <built-in function prod>, 'perm': <built-in function perm>, 'comb': <built-in function comb>, 'pi': 3.141592653589793, 'e': 2.718281828459045, 'tau': 6.283185307179586, 'inf': inf, 'nan': nan}, history=None, name='CCSDS_Header', derivations=[], derivationmap={})