LwPKT latest-develop documentation
Welcome to the documentation for version latest-develop.
LwPKT is a generic packet protocol library optimized for embedded systems.
Download library Getting started Open Github Donate
Features
Written in C (C11), compatible with
size_t
for size data typesPlatform independent, no architecture specific code
Uses LwRB library for data read/write operations
Support for events on packet ready, read or write operation
Optimized for embedded systems, allows high optimization for data transfer
Configurable settings for packet structure and variable data length
Allows multiple notes in network with from and to addresses
Separate optional field for command data type
Variable data length to support theoretically unlimited packet length
CRC check to handle data transmission errors
User friendly MIT license
Applications
To name a few:
Communication in RS-485 network between various devices
Low-level point to point packet communication (UART, USB, ethernet, …)
Requirements
C compiler
Few
kB
of non-volatile memory
Contribute
Fresh contributions are always welcome. Simple instructions to proceed:
Fork Github repository
Respect C style & coding rules used by the library
Create a pull request to
develop
branch with new features or bug fixes
Alternatively you may:
Report a bug
Ask for a feature request
License
MIT License
Copyright (c) 2024 Tilen MAJERLE
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.