Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
review migration guide
  • Loading branch information
2bndy5 committed May 2, 2025
commit 11f97d85d5d7bca041be51b940fc48a6beb66908
7 changes: 4 additions & 3 deletions docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

@tableofcontents

<!-- markdownlint-disable MD033 MD031 -->

This is a collection of snippets that highlight preferred API over the deprecated original API.

## isAckPayloadAvailable()
Expand Down Expand Up @@ -41,7 +43,7 @@ There are overloaded functions that use a buffer instead:
- `RF24::openReadingPipe(uint8_t, const uint8_t*)`
- `RF24::openWritingPipe(const uint8_t*)`

These eliminates the unnecessary 24 bits by only using the length of the buffer (`uint8_t*`)
These eliminate the unnecessary 24 bits by only using the length of the buffer (`uint8_t*`)
specified by `RF24::setAddressWidth()`.

> [!CAUTION]
Expand Down Expand Up @@ -163,7 +165,6 @@ radio.setStatusFlags();

</td></tr></table>


## whatHappened()

> **Deprecated since v1.5**
Expand All @@ -176,7 +177,7 @@ The aptly named `RF24::clearStatusFlags()` is designed to be a replacement for `
Like `RF24::clearStatusFlags()`, `RF24::setStatusFlags()` takes 1 parameter whose value is defined by
the `rf24_irq_flags_e` enumerated constants. These constant values specify individual flags;
they can also be OR'd together to specify multiple flags.
Additionally, `RF24::setStatusFlags()` returns the STATUS byte containing the flags that
Additionally, `RF24::clearStatusFlags()` returns the STATUS byte containing the flags that
caused the IRQ pin to go active LOW.
This allows the user code to allocate less memory when diagnosing the IRQ pin's meaning.

Expand Down