JeremyTubongbanua / at_c

Experimental cross-platform C sdk for SOC & embedded devices

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The Atsign FoundationThe Atsign Foundation

OpenSSF Scorecard OpenSSF Best Practices

at_c

at_c is the alpha C implementation of the atSDK

Packages

  • atchops stands for "Cryptographic and Hashing Operations" catered for the atProtocol. atchops uses MbedTLS crypto and other MbedTLS crypto libraries as a dependency.
  • atclient implements the atProtocol and will be the core dependency for most applications. atclient depends on atchops and MbedTLS.
  • atclient_espidf is a package for helping you build atclient for ESP-IDF (Espressif IoT Development Framework) based projects.
  • atlogger is a tiny logging package.

Building Source

Learn how to build atsdk from source code to be used as a library in your projects.

Installing on Linux/MacOS

  1. Get ahold of the source code either via git clone or from downloading the source from our releases:
git clone https://github.com/atsign-foundation/at_c.git
cd at_c
  1. CMake configure
cmake -S . -B build
  1. Install

This will run the install step and install the static libraries and include headers on your system. You may need to use sudo.

cmake --build build --target install
  1. Building the source code will allow you to use the atclient library in your own CMake projects:
# myproj is a target in your CMake project that depends on atsdk
find_package(atsdk REQUIRED CONFIG)
target_link_libraries(myproj PRIVATE atsdk::atclient)

The target atsdk::atclient is the atclient library that you can link to your project. It includes atchops and atlogger as dependencies already with it.

Examples

Check out the examples directory for examples on how to implement and use the C SDK.

Contributing

Read CONTRIBUTING.md for information on how to properly fork and open a pull request.

When creating source files, include headers, or tests to certain packages, please follow the documentation in their according README files (for example atclient Contributing).

Maintainers

Atsign maintains this repository. Feel free to contact us about anything at info@atsign.com

About

Experimental cross-platform C sdk for SOC & embedded devices

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:C 96.5%Language:CMake 3.0%Language:Shell 0.4%