uWire

Компактная обёртка на AVR TWI (I2C) с Arduino Wire-подобным API

Совместимость

• AVR TWI

Содержание

• Использование
• Версии
• Установка
• Баги и обратная связь

Использование

Инициализация

Объявлен глобальный объект uWire.

Описание классов

void begin();
void end();
static void setClock(uint32_t clock);

void beginTransmission(uint8_t address);
uint8_t endTransmission(bool sendStop = true);

size_t write(uint8_t data);
size_t write(const uint8_t* data, size_t len);

uint8_t requestFrom(uint8_t address, uint8_t length, bool sendStop = true);
uint8_t requestFrom(uint8_t address, uint8_t quantity, uint32_t iaddress, uint8_t isize, uint8_t sendStop);
int read();
size_t read(uint8_t* data, size_t len);

uint8_t available();
Error getError();

enum Error {
    ERROR_NONE = 0,
    ERROR_ADDRESS_NACK = 2,
    ERROR_DATA_NACK = 3,
    ERROR_OTHER = 4,
};

Примеры

#include <Arduino.h>
#include <uWire.h>

void setup() {
    Serial.begin(115200);
    uWire.begin();
}

void loop() {
    Serial.println("Begin scan");

    for (uint8_t addr = 1; addr <= 127; addr++) {
        uWire.beginTransmission(addr);
        if (!uWire.endTransmission()) {
            Serial.print("0x");
            Serial.println(addr, HEX);
        }
    }

    Serial.println("End scan");
    Serial.println();
    delay(1000);
}

Версии

• v1.0

Установка

• Библиотеку можно найти по названию uWire и установить через менеджер библиотек в:
  • Arduino IDE
  • Arduino IDE v2
  • PlatformIO
• Скачать библиотеку .zip архивом для ручной установки:
  • Распаковать и положить в C:\Program Files (x86)\Arduino\libraries (Windows x64)
  • Распаковать и положить в C:\Program Files\Arduino\libraries (Windows x32)
  • Распаковать и положить в Документы/Arduino/libraries/
  • (Arduino IDE) автоматическая установка из .zip: Скетч/Подключить библиотеку/Добавить .ZIP библиотеку… и указать скачанный архив
• Читай более подробную инструкцию по установке библиотек здесь

Обновление

• Рекомендую всегда обновлять библиотеку: в новых версиях исправляются ошибки и баги, а также проводится оптимизация и добавляются новые фичи
• Через менеджер библиотек IDE: найти библиотеку как при установке и нажать "Обновить"
• Вручную: удалить папку со старой версией, а затем положить на её место новую. "Замену" делать нельзя: иногда в новых версиях удаляются файлы, которые останутся при замене и могут привести к ошибкам!

Баги и обратная связь

При нахождении багов создавайте Issue, а лучше сразу пишите на почту alex@alexgyver.ru
Библиотека открыта для доработки и ваших Pull Request'ов!

При сообщении о багах или некорректной работе библиотеки нужно обязательно указывать:

• Версия библиотеки
• Какой используется МК
• Версия SDK (для ESP)
• Версия Arduino IDE
• Корректно ли работают ли встроенные примеры, в которых используются функции и конструкции, приводящие к багу в вашем коде
• Какой код загружался, какая работа от него ожидалась и как он работает в реальности
• В идеале приложить минимальный код, в котором наблюдается баг. Не полотно из тысячи строк, а минимальный код