Google Git
Sign in
pigweed / third_party / github / jimsch / cn-cbor / ac7da0997fe24a1b516c393ad6c7e8a9dd65e906
commitac7da0997fe24a1b516c393ad6c7e8a9dd65e906[log] [tgz]
authorCarlos Gomes Martinho <carlos.gomes_martinho@siemens.com>Wed Apr 15 15:13:50 2020 +0200
committerJim Schaad <ietf@augustcellars.com>Thu Apr 16 13:32:52 2020 -0700
tree344300d51554e6954e1bdf39a8769c9a6cbb9b61
parentef8a624f02790356d4210a646ffb9d756573a50f [diff]
refactor: change to use uppercase cmake options and add namespace
5 files changed
tree: 344300d51554e6954e1bdf39a8769c9a6cbb9b61
  1. cmake/
  2. include/
  3. src/
  4. test/
  5. .appveyor.yml
  6. .editorconfig
  7. .gitignore
  8. .mbedignore
  9. .travis.yml
  10. build.sh
  11. CMakeLists.txt
  12. cn-cbor.pc.in
  13. conanfile.py
  14. Doxyfile.in
  15. LICENSE
  16. README.md
  17. Simple-Makefile
README.md

Build Status

cn-cbor: A constrained node implementation of CBOR in C

This is a constrained node implementation of CBOR in C that I threw together in 2013, before the publication of RFC 7049, to validate certain implementability considerations.

Its API model was inspired by nxjson. It turns out that this API model actually works even better with the advantages of the CBOR format.

This code has been used in a number of research implementations on constrained nodes, with resulting code sizes appreciably under 1 KiB on ARM platforms.

I always meant to improve the interface some more with certain API changes, in order to get even closer to 0.5 KiB, but I ran out of time. So here it is. If I do get around to making these changes, the API will indeed change a bit, so please be forewarned.

Building

There is a Simple-Makefile for playing around, as well as a complete cmake-based build environment. (You can choose what fits your needs better.)

Building with cmake:

mkdir build
cd build
cmake ..
cmake --build . -- all

Generating a test coverage report (requires lcov[^1]; result in build/lcov/index.html):

rm -rf build
mkdir build
cd build
cmake .. -Dcoveralls_send=ON
cmake --build . -- all coveralls coverage_report

Consuming

With cmake

find_package

find_package(cn-cbor)
add_executable(myapp main.cpp)
target_link_libraries(myapp cn-cbor::cn-cbor)

add_subdirectory

add_subdirectory(vendor/cn-cbor)
add_executable(myapp main.cpp)
target_link_libraries(myapp cn-cbor::cn-cbor)

With Conan

This package is available in the conan center

add cn-cbor/1.0.0 to you conan file

License: MIT

[^1]: Installation with homebrew: brew install lcov