Tags

v4.4.2

v4.4.1

v4.4.0

New Features
============
- Support multiple length codecs for variable length array types (`VariableLenArrayCodec`, `StringCodec`, `BytesCodec`). (!42)
  - `length_mode`: Mode used to encode or infer the array length.  Options are `varint` (default), `egint`, and `fill_outer`.
- Add `VariableLenBitArrayCodec`, a `MultipleFieldCodec` which encodes an array of bits as a uint8/byte array with a separate integer field encoding the number of bits. (!41)
  - This allows encoding a bit array without needing to separately encode the length of the byte array containing it and the length in bits.
- Update documentation. (!41)
- Add new `ConstantFieldCodec`, which specifies field values during decode without any on-wire encoding. (!40)
- Add `inspect` module and `inspect_cli` utility to inspect codec files and check validity and sizes. (!39)
  - Installs CLI as `inspect_codec`.  Basic usage: `inspect_codec <path to codec.yaml>`

Bugfixes
========
- Add `.idea` to `.gitignore` (!41)
- Fix a bug with calculating checksums when using `MultipleFieldCodec`s (!41)

CI Improvements
===============
- Update CI templates to v3.2.0 (!41)

v4.3.1

v4.3.0

New Features
============
- Add `DictionaryCodec` that follows the same pattern as `RosMessageCodec`, but operates on generic Python dictionaries.  (!29)
  - (A less robust version of this used to be part of `ltcodecs` but was lost a while ago.) 

Bugfixes
========
- Fix a (functionally inconsequential) bug in the uint64 codec (it called `super()` on the wrong class, but one that still worked) (!33)
- Fix ROS2 array types (!30)

Testing
=======
- Fix some missing asserts in tests (!33)
- Use CI templates (!31)
- Pass the commit ref to the downstream `ros_acomms` pipeline so that the test uses this version. (!29, !31)

Documentation
=============
- Improved documentation.  Added quick start guides. (!32)

v4.2.0

New Features
============
- Add `DictionaryCodec` that follows the same pattern as `RosMessageCodec`, but operates on generic Python dictionaries.  (!29)
  - (A less robust version of this used to be part of `ltcodecs` but was lost a while ago.) 

Bugfixes
========
- Fix a (functionally inconsequential) bug in the uint64 codec (it called `super()` on the wrong class, but one that still worked) (!33)
- Fix ROS2 array types (!30)

Testing
=======
- Fix some missing asserts in tests (!33)
- Use CI templates (!31)
- Pass the commit ref to the downstream `ros_acomms` pipeline so that the test uses this version. (!29, !31)

Documentation
=============
- Improved documentation.  Added quick start guides. (!32)

v4.1.0

New Features
============
- Add Exponential-Golomb integer codec (!24)


Bugfixes
========
- Fixed issues with autodocs (missing package in builder image) (!24)

v4.0.1

Bugfixes
========
- Fixes rostime_codec use with non-native time types by adding an optional `ros_type` parameter that can be used to specify the field type.  This is needed if using custom time types, which you have to do if you want to try to handle both ROS1 and ROS2.
- Fixes CI test by installing `ros-noetic-dynamic-reconfigure` package

v4.0.0

Breaking Changes
================
- Requires `armw` (!21)

New Features / Improvements
===========================
- Added ROS2 support (!21)
- Switch to pyproject.toml setup with setuptools_scm versioning (!22)

Bugfixes
========
- Fixed a bug in an exception handler that could fail due to referencing a potentially-undefined variable in an error message. (!20)
- Misc cleanup, fixed formatting (!20)
- Removed unused imports in ROS message codecs (!20)

Documentation
=============
- Improved docstrings (!20)

v3.0.0

v2.0.1

v2.0.0

v1.1.0

v1.0.0

### Breaking changes since v0.2.0:
- Encoding can fail.  A new exception, `EncodingFailed` is raised when encoding fails.  (Encoding used to silently truncate output when overflow occurred.)

### New Features
- CI now uses pytest
- Added LZMA codec (for compressed bytes)
- Added Sphinx documentation