Crate nrf24l01_commands

source
Expand description
Requires Rust Nightly

Latest Version Documentation Github Actions

§nRF24L01 Commands

This crate provides:

  • Bitfield definitions for nRF24L01 registers
  • A friendly API for generating SPI byte sequences for nRF24L01 commands

§Examples

§Command to write CONFIG register

use nrf24l01_commands::{registers, commands};

const CONFIG: registers::Config = registers::Config::new()
    .with_mask_rx_dr(true)
    .with_mask_tx_ds(false)
    .with_mask_max_rt(false)
    .with_en_crc(false)
    .with_crco(true)
    .with_pwr_up(true)
    .with_prim_rx(false);
const WRITE_COMMAND: commands::WRegister<registers::Config> = commands::WRegister(CONFIG);

// Generate SPI byte sequence
const SPI_BYTES: [u8; 2] = WRITE_COMMAND.bytes();
assert_eq!(SPI_BYTES, [0b0010_0000, 0b0100_0110]);

§Command to read FIFO_STATUS register

use nrf24l01_commands::{registers, commands};

// Generate SPI byte sequence
const SPI_BYTES: [u8; 2] = commands::RRegister::<registers::FifoStatus>::bytes();
assert_eq!(SPI_BYTES, [0 | 0x17, 0]);

§Command to write TX payload

use nrf24l01_commands::commands;

const PAYLOAD: [u8; 9] = [1, 2, 3, 4, 5, 6, 7, 8, 9];
// Generate SPI byte sequence
const SPI_BYTES: [u8; 10] = commands::WTxPayload(PAYLOAD).bytes();
assert_eq!(SPI_BYTES, [0b1010_0000, 9, 8, 7, 6, 5, 4, 3, 2, 1]);

Modules§

  • Generate SPI byte sequences for nRF24L01 commands.
  • Register bitfields for the nRF24L01.