Codec Aliases

Contents

Codec Aliases#

Codec configurations use short aliases instead of Python class names. Some codec classes have more than one alias for readability or compatibility with existing configs.

Alias	Codec Class
`integer`	`VarintCodec`
`fixedint`	`FixedIntCodec`
`varint`	`VarintCodec`
`float`	`FloatCodec`
`linspace_float`	`LinspaceFloatCodec`
`linspace`	`LinspaceFloatCodec`
`uint8`	`UInt8Codec`
`uint16`	`UInt16Codec`
`uint32`	`UInt32Codec`
`uint64`	`UInt64Codec`
`int8`	`Int8Codec`
`int16`	`Int16Codec`
`int32`	`Int32Codec`
`int64`	`Int64Codec`
`egint`	`ExponentialGolombIntegerCodec`
`float32`	`IeeeFloat32Codec`
`float64`	`IeeeFloat64Codec`
`bool`	`BoolCodec`
`boolean`	`BoolCodec`
`string`	`AsciiStringCodec`
`ascii`	`AsciiStringCodec`
`bytes`	`BytesCodec`
`dict`	`DictFieldCodec`
`dictionary`	`DictFieldCodec`
`msg`	`RosMsgFieldCodec`
`ros_msg`	`RosMsgFieldCodec`
`variable_len_array`	`VariableLenArrayCodec`
`fixed_len_array`	`FixedLenArrayCodec`
`ccl_latlon`	`CclLatLonCodec`
`ccl_latlon_bcd`	`CclLatLonBcdCodec`
`pad`	`PaddingCodec`
`padding`	`PaddingCodec`
`time`	`RosTimeCodec`
`rostime`	`RosTimeCodec`
`string_enum`	`StringEnumCodec`
`lzma`	`LzmaCodec`
`optional`	`OptionalFieldCodec`

Metadata Aliases#

Metadata decoder aliases read values from packet metadata during decoding. They do not consume bits from the payload.

Alias	Metadata attribute
`src`	`packet.src`
`dest`	`packet.dest`
`dest_decoder`	`packet.dest`
`toa`	`cst.toa`
`snr_in`	`cst.snr_in`

The metadata encoder alias currently supported by top-level codecs is dest. During encoding, it copies the configured field into the metadata dictionary returned with the encoded bits.