Google Git
Sign in
pigweed / third_party / github / jimsch / cn-cbor / 9757f9f867869bb404d1df3f23484c42608ca48d
commit9757f9f867869bb404d1df3f23484c42608ca48d[log] [tgz]
authorJim Schaad <ietf@augustcellars.com>Mon May 04 09:27:37 2020 -0700
committerJim Schaad <ietf@augustcellars.com>Mon May 04 11:19:27 2020 -0700
treefc4ba77fccaac7c2ab8b7a3f775ee891d36a9b92
parent47f09befc0a1faae1c1470a6fafe0d43175617f0 [diff]
Add more testing
4 files changed
tree: fc4ba77fccaac7c2ab8b7a3f775ee891d36a9b92
  1. .github/
  2. cmake/
  3. include/
  4. src/
  5. test/
  6. .appveyor.yml
  7. .clang-format
  8. .clang-tidy
  9. .editorconfig
  10. .gitignore
  11. .mbedignore
  12. .travis.yml
  13. build.sh
  14. cmake-format.yaml
  15. CMakeLists.txt
  16. cn-cbor.pc.in
  17. conanfile.py
  18. Doxyfile.in
  19. LICENSE
  20. README.md
  21. Simple-Makefile
README.md

Build Status

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

Below is the original README for cn-cbor, a Proof of Concept implementation of CBOR that I wrote in 2013. People have been sending me fixes and updates to make this implementation more useful for actual use, and for a while I have occasionally integrated them. Jim Schaad now is so far ahead of this repo that you are most likely better off using his repo as your upstream.

If you are here looking for experimental CBOR implementations for constrained nodes, there are many, some of which are listed at cbor.io. One more: I have recently extracted the implementation from ARM-mbed's SUIT manifest generator (Apache 2.0). SUIT implementers report (CBOR-specific) code sizes in the low hundreds of bytes. Thank you, ARM.

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 .. -DCN_CBOR_COVERALLS_SEND=ON
cmake --build . -- all coveralls coverage_report

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

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