-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add NRZI encoding decoding #12
Conversation
Signed-off-by: Erik Buer <buer94@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok for this !
Many thanks Eric for this very complete and useful add of NRZI !
and the associated include in the core test suite (
Thank you very much for keeping DigitalComm such active and for contributing, I appreciate it a lot. |
Re @ErikBuer |
Hi professor Gerzaguet, hope everything is well.
I have added NRZI encoding decoding with some explanatory tests.
First, I thought the functions were suitable for the file bitMapping, as it is a mapping to the NRZI format.
But the file is in the documentation under something QAM-related, so I made a separate file for them.
I have also added some quality-of-life enhancements for building docs locally.
This will make it faster to build docs locally, and should not affect the docs build in CI. I have done similarly in my package radioPropagation.
In the documentation I see you have used the term "bit sequence" and "byte sequence". In other sources, I see people using the terms packed bits and unpacked bits, bit array and byte array.
I feel we should make a small write-up (example in the docs) to explain/visualize the terms and what they mean. Using the various terms will hopefully help the library appear in searches, helping others on their journey.
This must be in a separate PR, but I thought I'd mention it..
I have adopted the term bit sequence, to stay consistent in this library.