Skip to content
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

feat: atchops refactor, ESP-IDF build static libraries, ESP-IDF project examples, repl example, lots of docs #33

Merged
merged 26 commits into from
Aug 28, 2023

Conversation

JeremyTubongbanua
Copy link
Member

@JeremyTubongbanua JeremyTubongbanua commented Aug 16, 2023

- What I did

  • Made function headers formal by:
    1. pass by value, if we are not editing the struct itself
    1. function headers are in this general format: a. provide settings (like key, IV, etc,), b. provide src (the thing you are encrypting, decrypting, or haashing, etc,), c. provide buffer, buffer length, and buffer output length
  • lots of documentation (READMEs in every package and example)
  • lots of examples

image

  • package: atclient_espidf, allows people to use this package to build static libraries of atclient and atchops for ESP-IDF projects. (NOT MbedTLS, you will have to get the MbedTLS ESP-IDF static libraries elsewhere, ESP-IDF comes with them already).

- How I did it

  • fixed up function headers in atchops

- How to verify it

Tests Passing

- Description for the changelog

@JeremyTubongbanua JeremyTubongbanua self-assigned this Aug 16, 2023
@JeremyTubongbanua JeremyTubongbanua marked this pull request as ready for review August 22, 2023 14:37
@JeremyTubongbanua JeremyTubongbanua changed the title refactor: atchops refactor feat: atchops refactor, ESP-IDF build static libraries, ESP-IDF project examples, repl example, lots of docs Aug 22, 2023
@JeremyTubongbanua JeremyTubongbanua merged commit f7faf50 into trunk Aug 28, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants