Библиотека RF24

Включить модуль и выставить настройки по умолчанию: канал 76, 1 Мбит/с, 15 повторов по 1,5 мс, пакет 32 байта. Вызывают в setup() раньше любых других методов.

Возвращает: true — модуль ответил по SPI. false — не отвечает: питание не 3,3 В, перепутаны CE и CSN или отходит провод.

if (!radio.begin()) { Serial.println("Модуль не найден"); while (1); }

Проверить, что чип на месте, в любой момент работы — begin() смотрит только при запуске.

Возвращает: true — регистры чипа читаются.

if (!radio.isChipConnected()) Serial.println("Модуль отвалился");

Узнать, какой чип на модуле: nRF24L01+ или старый без плюса. От этого зависит, доступны ли 250 кбит/с и testRPD().

Возвращает: true — nRF24L01+ или совместимый клон.

Serial.println(radio.isPVariant() ? "nRF24L01+" : "без плюса");

Задать адрес получателя — туда уйдут все следующие write().

address

пять байт адреса. Удобно записать строкой: const byte address[6] = "NODE1" — шесть байт с нулём в конце, библиотека берёт первые пять. В старых скетчах адрес записан числом, 0xF0F0F0F0E1LL: так ещё работает, но в версии 1.6 этот вариант помечен устаревшим.

radio.openWritingPipe(address);

Слушать адрес на одной из труб. Труб шесть, поэтому один приёмник принимает до шести передатчиков сразу.

number

номер трубы 0–5. Трубу 0 модуль занимает под подтверждения, пока передаёт, но библиотека сама возвращает ей адрес приёма при каждом startListening() — так что открывать её на приём можно.

address

у трубы 1 — полный адрес из пяти байт. У труб 2–5 свой только первый байт, остальные четыре берутся от трубы 1: "1NODE", "2NODE" и так далее.

radio.openReadingPipe(1, address);

Перестать слушать трубу. Можно звать и для трубы, которая не открывалась, — ошибки не будет.

pipe

номер трубы 0–5; другие числа молча игнорируются.

radio.closeReadingPipe(2);

Длина адреса. Короче адрес — короче пакет в эфире, но выше шанс принять шум за свой пакет. Задаётся одинаково на обеих платах.

a_width

3, 4 или 5 байт, по умолчанию 5.

radio.setAddressWidth(4);

Перейти в приём. Только после него available() начинает видеть пакеты.

radio.startListening();

Выйти из приёма. Перед write() обязательно: модуль, который слушает, не передаёт.

radio.stopListening();

Отправить пакет и дождаться подтверждения от приёмника. Пока идут повторы, скетч стоит — до 60–70 мс при настройках по умолчанию.

buf

что отправить: &переменная или имя массива.

len

сколько байт — обычно sizeof(переменной), не больше 32.

Возвращает: true — приёмник подтвердил получение. false — подтверждения нет после всех повторов. Если подтверждения выключены setAutoAck(false), всегда true, даже когда никто не принял.

bool ok = radio.write(&p, sizeof(p));

Проверить, есть ли принятый пакет. Опрашивают в loop(); в очереди модуля помещается три пакета, дальше новые теряются.

Возвращает: true — в очереди есть пакет.

if (radio.available()) radio.read(&p, sizeof(p));

То же, плюс номер трубы, по которой пришёл пакет, — так приёмник узнаёт, от какого передатчика.

pipe_num

адрес переменной, куда записать номер трубы 0–5.

Возвращает: true — в очереди есть пакет, номер трубы записан.

uint8_t pipe;
if (radio.available(&pipe)) Serial.println(pipe);

Забрать пакет из очереди в переменную. Ничего не возвращает — есть ли пакет, проверяют заранее через available().

buf

куда положить: &переменная того же типа, что шлёт передатчик.

len

sizeof(переменной). Меньше пакета — пакет останется в очереди; больше — хвост заполнится повтором последнего байта.

radio.read(&p, sizeof(p));

Проверить, не забита ли очередь приёма. Когда заняты все три места, новые пакеты модуль отбрасывает — значит, loop() читает медленнее, чем шлют.

Возвращает: true — все три места заняты.

if (radio.rxFifoFull()) Serial.println("Не успеваю читать");

Разрешить приёмнику класть данные в подтверждение. Так передатчик получает ответ, не переключая обе платы между приёмом и передачей. Вызывают на обеих платах в setup().

radio.enableDynamicPayloads();
radio.enableAckPayload();

Зарядить ответ на приёмнике. Он уйдёт со следующим принятым пакетом, поэтому первый ответ заряжают заранее, в setup(), а после каждого приёма заряжают новый. Передатчик читает ответ обычными available() и read() сразу после write().

pipe

труба, по которой придёт пакет от передатчика, — та же, что в openReadingPipe().

buf

что ответить: &переменная.

len

sizeof(переменной), до 32 байт.

Возвращает: true — ответ встал в очередь. false — очередь занята (ждать отправки могут не больше трёх ответов) или не вызван enableAckPayload().

radio.writeAckPayload(1, &reply, sizeof(reply));

Пакеты переменной длины на всех трубах: в эфир уходит столько байт, сколько передано в write(), а не всегда 32. Для ответов приёмника обязательно. Включают на обеих платах.

radio.enableDynamicPayloads();

Длина пришедшего пакета — когда включены пакеты переменной длины. Зовут после available() и до read().

Возвращает: число байт в пакете, 1–32.

uint8_t n = radio.getDynamicPayloadSize();

Мощность передатчика. Для отладки на столе — минимальная: на максимальной модули в полуметре друг от друга глушат приём. Для дальности — максимальная, но тогда без конденсатора по питанию модуль сбрасывается.

level

RF24_PA_MIN (−18 дБм), RF24_PA_LOW (−12), RF24_PA_HIGH (−6), RF24_PA_MAX (0 дБм). Если не задать — остаётся та, с которой чип включился, обычно максимальная.

lnaEnable

усилитель приёма. Влияет только на клоны на чипе Si24R1, обычно не указывают.

radio.setPALevel(RF24_PA_LOW);

Скорость в эфире. Чем медленнее, тем дальше: при той же мощности 250 кбит/с бьёт заметно дальше 2 Мбит/с.

speed

RF24_1MBPS — по умолчанию, RF24_2MBPS — быстрее и ближе, RF24_250KBPS — медленнее и дальше.

Возвращает: true — скорость принята. false — модуль её не умеет: 250 кбит/с есть только у nRF24L01 с плюсом.

radio.setDataRate(RF24_250KBPS);

Частота: 2400 МГц плюс номер канала. Wi-Fi занимает нижнюю часть диапазона, поэтому помехи уходят на каналах от 100.

channel

0–125, по умолчанию 76 (2476 МГц).

radio.setChannel(108);

Сколько раз повторять пакет без подтверждения и с какой паузой. Больше повторов — надёжнее, но write() дольше держит скетч.

delay

0–15, пауза (delay + 1) × 250 мкс. По умолчанию 5 — 1,5 мс.

count

0–15, по умолчанию 15. 0 — не повторять вовсе.

radio.setRetries(5, 15);

Размер пакета. Короче пакет — быстрее доходит. Должен совпадать на передатчике и приёмнике, иначе пакеты не принимаются.

size

1–32 байта, по умолчанию 32.

radio.setPayloadSize(sizeof(Packet));

Включить или выключить подтверждения на всех трубах. Без подтверждений нет повторов и ответов приёмника, а write() всегда отвечает true. Выключают для широковещания на много приёмников и в сканере эфира.

enable

true — подтверждать, по умолчанию; false — не подтверждать. Должно совпадать на обеих платах.

radio.setAutoAck(false);

То же для одной трубы. Трубу 0 модуль использует при передаче, поэтому, если передатчику нужны подтверждения, на ней их не выключают.

pipe

номер трубы 0–5.

enable

true — подтверждать, false — нет.

radio.setAutoAck(2, false);

Длина контрольной суммы пакета. По ней модуль отбрасывает пакеты, испорченные помехой.

length

RF24_CRC_16 — по умолчанию, RF24_CRC_8 — пакет на байт короче, RF24_CRC_DISABLED — без проверки. Выключить не получится, пока включены подтверждения.

radio.setCRCLength(RF24_CRC_8);

Прочитать канал из чипа. Удобно сверить две платы, когда связи нет.

Возвращает: 0–125.

Serial.println(radio.getChannel());

Прочитать мощность из чипа.

Возвращает: RF24_PA_MIN, RF24_PA_LOW, RF24_PA_HIGH или RF24_PA_MAX — числа 0–3.

if (radio.getPALevel() == RF24_PA_MAX) Serial.println("Максимум");

Прочитать скорость из чипа.

Возвращает: RF24_1MBPS, RF24_2MBPS или RF24_250KBPS.

if (radio.getDataRate() != RF24_250KBPS) Serial.println("Скорость не та");

Прочитать размер пакета, заданный setPayloadSize().

Возвращает: 1–32.

Serial.println(radio.getPayloadSize());

Усыпить модуль. В сне он берёт около 0,9 мкА вместо 13,5 мА в режиме приёма. Настройки при этом не теряются.

radio.powerDown();

Разбудить модуль после powerDown(). Просыпается до 5 мс — библиотека выжидает это время сама.

radio.powerUp();

Есть ли на канале сигнал сильнее −64 дБм — чей угодно, не только наш. Так строят сканер эфира: слушают канал 128 мкс и проверяют. Только у nRF24L01+.

Возвращает: true — на канале кто-то есть.

radio.setChannel(ch);
radio.startListening();
delayMicroseconds(128);
radio.stopListening();
bool busy = radio.testRPD();

То же для старого чипа без плюса: была ли несущая за время последнего прослушивания.

Возвращает: true — несущая была.

bool busy = radio.testCarrier();

Поставить пакет в очередь передачи и не ждать подтверждения — пока в очереди есть место, скетч не стоит. Для потока данных; после серии обязательно txStandBy().

buf

что отправить: &переменная.

len

sizeof(переменной), до 32 байт.

Возвращает: true — пакет в очереди. false — предыдущий пакет так и не доставлен; зовите txStandBy().

for (int i = 0; i < 10; i++) radio.writeFast(&p, sizeof(p));
bool ok = radio.txStandBy();

Дождаться, пока очередь передачи опустеет, и перевести модуль в покой. Вариант txStandBy(1000) повторяет недоставленное до тайм-аута в миллисекундах.

Возвращает: true — все пакеты доставлены. false — какой-то не подтверждён.

if (!radio.txStandBy()) Serial.println("Часть не дошла");

Очистить очередь передачи — все три места. Нужно, если пакет застрял и мешает следующим.

Возвращает: регистр состояния чипа; обычно не нужен.

radio.flush_tx();

Очистить очередь приёма: выбросить непрочитанные пакеты, например накопившиеся за время настройки.

Возвращает: регистр состояния чипа; обычно не нужен.

radio.flush_rx();

Напечатать все регистры чипа. Печатает через printf, поэтому без #include <printf.h> и printf_begin() в setup() молчит. Нули или FF во всех строках — чип не отвечает.

printf_begin();
radio.printDetails();

То же словами: канал, скорость, мощность, адреса труб. Удобнее для чтения, но занимает больше памяти. Условие то же — printf_begin().

radio.printPrettyDetails();

Сколько повторов понадобилось последнему write(). Грубая оценка связи: 0 — отлично, под 15 — на пределе.

Возвращает: 0–15.

radio.write(&p, sizeof(p));
Serial.println(radio.getARC());