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

implement nRF24L01 driver #1

Draft
wants to merge 49 commits into
base: main
Choose a base branch
from
Draft

implement nRF24L01 driver #1

wants to merge 49 commits into from

Commits on Jul 9, 2024

  1. push work in progress

    2bndy5 committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    281707d View commit details
    Browse the repository at this point in the history
  2. add .github folder

    includes
    - CI workflow
    - funding info
    - dependabot config
    2bndy5 committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    76b9d59 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    7c32533 View commit details
    Browse the repository at this point in the history
  4. mark crate with ![no_std]

    2bndy5 committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    a397862 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    2a571e1 View commit details
    Browse the repository at this point in the history
  6. doc updates

    2bndy5 committed Jul 9, 2024
    Configuration menu
    Copy the full SHA
    541e3c2 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    f3d23af View commit details
    Browse the repository at this point in the history

Commits on Jul 10, 2024

  1. refactor modules

    - prefer to `use rf24_rs::radio::prelude::*` in user code to pull in all the required radio traits.
    - support LNA_CUR bit in non-plus/clones
    - prefer to `use rf24_rs::radio::{RF24 Nrf24Error}` in user code
      because namespaces will be very important in the future
    2bndy5 committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    0d613e3 View commit details
    Browse the repository at this point in the history
  2. add unit tests for most API

    2bndy5 committed Jul 10, 2024
    Configuration menu
    Copy the full SHA
    75db3d4 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    a68b6de View commit details
    Browse the repository at this point in the history
  4. Create codecov config

    2bndy5 authored Jul 10, 2024
    Configuration menu
    Copy the full SHA
    aa274b0 View commit details
    Browse the repository at this point in the history

Commits on Jul 11, 2024

  1. update README

    - add badges
    - tick first milestone in roadmap
    2bndy5 committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    7051e01 View commit details
    Browse the repository at this point in the history
  2. complete unit tests 🎉

    2bndy5 committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    0edefdd View commit details
    Browse the repository at this point in the history
  3. ignore doc snippet in tests

    2bndy5 committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    3c62d56 View commit details
    Browse the repository at this point in the history
  4. add package metadata

    2bndy5 committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    fbd92ff View commit details
    Browse the repository at this point in the history

Commits on Jul 12, 2024

  1. use macro to reduce duplicated code in unit tests

    rust is so cool!
    
    This new macro generates rust code at compile time and then compiles everything with the generated code in place of the macro calls.
    2bndy5 committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    53a4137 View commit details
    Browse the repository at this point in the history

Commits on Jul 18, 2024

  1. cast bool input as u8 when clearing status flags

    removes the need to construct a mutable byte
    2bndy5 committed Jul 18, 2024
    Configuration menu
    Copy the full SHA
    8cf3280 View commit details
    Browse the repository at this point in the history

Commits on Aug 1, 2024

  1. Configuration menu
    Copy the full SHA
    14c41ee View commit details
    Browse the repository at this point in the history
  2. some code review

    2bndy5 committed Aug 1, 2024
    Configuration menu
    Copy the full SHA
    f6df82a View commit details
    Browse the repository at this point in the history
  3. review write()

    2bndy5 committed Aug 1, 2024
    Configuration menu
    Copy the full SHA
    f0d0fb2 View commit details
    Browse the repository at this point in the history

Commits on Aug 2, 2024

  1. Configuration menu
    Copy the full SHA
    961bc5d View commit details
    Browse the repository at this point in the history

Commits on Oct 8, 2024

  1. switch to monorepo

    introduce supplemental docs (using mkdocs) and WIP examples (incomplete at this time)
    
    migrate to using [just](https://just.systems) as a task runner and utilize it in CI jobs.
    2bndy5 committed Oct 8, 2024
    Configuration menu
    Copy the full SHA
    e8c4717 View commit details
    Browse the repository at this point in the history
  2. add python binding

    2bndy5 committed Oct 8, 2024
    Configuration menu
    Copy the full SHA
    984252c View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    eb4bbd8 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    8460599 View commit details
    Browse the repository at this point in the history

Commits on Oct 10, 2024

  1. add node binding

    2bndy5 committed Oct 10, 2024
    Configuration menu
    Copy the full SHA
    7cdf02f View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    f762264 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    f2d6c64 View commit details
    Browse the repository at this point in the history

Commits on Oct 11, 2024

  1. Configuration menu
    Copy the full SHA
    6c1c577 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    96d51e0 View commit details
    Browse the repository at this point in the history

Commits on Oct 14, 2024

  1. Configuration menu
    Copy the full SHA
    a8abb14 View commit details
    Browse the repository at this point in the history
  2. reviewing interrupt example

    2bndy5 committed Oct 14, 2024
    Configuration menu
    Copy the full SHA
    a8fee94 View commit details
    Browse the repository at this point in the history

Commits on Oct 16, 2024

  1. another folder refactor

    - implements print_details()
    - adds 1 example in typescript
    - more WIP on rust example
    - rename enums.rs to types.rs
    - move all bindings to bindings folder
    - rename lib folder to library (for gitignore reasons)
    - add a new CI related to examples only
    2bndy5 committed Oct 16, 2024
    Configuration menu
    Copy the full SHA
    b572ade View commit details
    Browse the repository at this point in the history
  2. some fixes for node example

    send() doesn't work in a loop?
    2bndy5 committed Oct 16, 2024
    Configuration menu
    Copy the full SHA
    62a7e9c View commit details
    Browse the repository at this point in the history
  3. format TS and JS

    2bndy5 committed Oct 16, 2024
    Configuration menu
    Copy the full SHA
    5b52620 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    49bb77c View commit details
    Browse the repository at this point in the history
  5. rename CI workflow

    2bndy5 committed Oct 16, 2024
    Configuration menu
    Copy the full SHA
    dbb5d33 View commit details
    Browse the repository at this point in the history

Commits on Oct 19, 2024

  1. Configuration menu
    Copy the full SHA
    7478aa2 View commit details
    Browse the repository at this point in the history

Commits on Oct 20, 2024

  1. more node examples

    fix node gettingStarted example
    2bndy5 committed Oct 20, 2024
    Configuration menu
    Copy the full SHA
    8ef7171 View commit details
    Browse the repository at this point in the history

Commits on Oct 24, 2024

  1. document bindings' API

    also check radio is in TX mode before send() executes to prevent infinite loops
    
    avoid using binding generators' object renaming behavior; uses rust namespacing instead
    2bndy5 committed Oct 24, 2024
    Configuration menu
    Copy the full SHA
    2d43231 View commit details
    Browse the repository at this point in the history

Commits on Oct 25, 2024

  1. docs review

    2bndy5 committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    25f26c8 View commit details
    Browse the repository at this point in the history
  2. add more node examples

    review python examples too
    2bndy5 committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    adb9e1b View commit details
    Browse the repository at this point in the history
  3. add to tests for coverage

    2bndy5 committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    2d38464 View commit details
    Browse the repository at this point in the history

Commits on Oct 26, 2024

  1. Configuration menu
    Copy the full SHA
    40db4c9 View commit details
    Browse the repository at this point in the history
  2. review available_pipe()

    2bndy5 committed Oct 26, 2024
    Configuration menu
    Copy the full SHA
    02ac2d4 View commit details
    Browse the repository at this point in the history
  3. rename listen methods

    ref #3
    2bndy5 committed Oct 26, 2024
    Configuration menu
    Copy the full SHA
    9fc47fc View commit details
    Browse the repository at this point in the history

Commits on Oct 30, 2024

  1. another refactor

    considering we might be distributing multiple rust crates from 1 repo.
    
    also review rust docs
    - added API layout to landing page
    - filled in some missing info in functions' docs
    
    review `print_details()` output
    - show pipe information in `print_details()`
    - show TX address in `print_details()`
    - fix IRQ settings' output
    2bndy5 committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    06f1b25 View commit details
    Browse the repository at this point in the history
  2. add tests

    improves some line and region coverage
    2bndy5 committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    9d4b6ed View commit details
    Browse the repository at this point in the history
  3. implicitly cast to bool in bindings

    Only the node binding's `StatusFlags` and `WriteConfig` interfaces must use explicit boolean values.
    To implicitly cast those interfaces' values to boolean would
    - incur much more overhead
    - lose precise typing information
    
    See napi-rs docs about Env and Context.
    2bndy5 committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    29581f2 View commit details
    Browse the repository at this point in the history