This is a port of eerimoq/bitstruct for micropython
For the documentation of the bitstruct module see here: readthedocs.
This port of eerimoq/bitstruct is designed for micropython
git clone --recurse-submodules https://github.com/micropython/micropython.git
to compile the project, make, gcc and arm-none-eabi-gcc is required, install them from your package manager
bitstruct-micropython should work on any micropython port.
First create a modules folder next to your copy of micropython.
project/
├── modules/
│ └──bitstruct-micropython/
│ ├──...
│ └──micropython.mk
└── micropython/
├──ports/
... ├──stm32/
...
And now put this project in the modules folder.
cd modules
git clone https://gitlab.com/peterzuger/bitstruct-micropython.git
Now that all required changes are made, it is time to build micropython, for this cd to the top level directory of micropython. From here, first the mpy-cross compiler has to be built:
make -C mpy-cross
once this is built, compile your port with:
make -C ports/your port name here/ USER_C_MODULES=../modules CFLAGS_EXTRA=-DMODULE_BITSTRUCT_ENABLED=1
and you are ready to use bitstruct.
The module is available by just importing bitstruct:
import bitstruct
The module documentation is available here: Documentation.
Keep in mind that this C port is Work in progress, while most features are working, there are still a few things missing.
For example the Bit and Byteorder format string options are not currently supported, they are parsed, but most of the packing/unpacking functions do not support them.
There is also the problem of exception types/messages, because of the implementation differences in python and micropython, it is not possible to raise the exact same exceptions.
The last unsupported feature is the fill_padding=bool kwarg in the pack_into methods.
The kwarg is parsed and passed to the padding functions,
but there is a unknown defect in the implementation.