В процесі розробки читалки розумних батарейок DJI утворилась така штука як UART-to-I2C адаптер на Arduino. Одразу скажу, що подібні речі в природі існують. Дивився ще на cp2112, але там величезна обв'язка з USB HID. І $40. І доставка 2-3 тижні (tm) І є Coptonix #020101 по $25, в нього все в ascii, навіть руками з консолі можна щось робити (але не зручно, бо нема local echo), в нього якось мутно описано отримання відповіді, а статус шини взагалі ніяк не передається. І він Slave

Маємо прошивку, що вміє в режимі I2C Master

• 3 протоколи на USB UART (115200 8N1)
  • RAW (довжина даних + адреса (1 чи 2 байти) і самі дані у форматі шини I2C)
  • Coptonix #020101, тільки Master, див. нижче
  • manual: local echo, команди вручну, дані в HEX, є сканер шини
• 7/10 біт адресація на шині I2C
• пакети до 255 байт
• python adapter class, що імітує i2c_msg з smbus2.SMBus що спрощує інтеграцію з готовими програмами, що працюють з I2C/smbus або портування з Raspbery ui2c.py
• можливість надсилати debug messages не порушуючи роботу в режимі RAW

• Write UART -> I2C
• Read I2C -> UART
• I2C Bus management
• Reply format
• UI2C Erros
• Addressed read, e.g. Write CMD + Read
• Python API with Example
• C/C++ API with Example

 WRITE RD=0

 * 8bit data length (doesn't include address)

 *  7bit address: adr7+R/W
 *     xxxxxxx r/w 
 * 10bit address: 11110 adr2+R/W Ack adr8
 *     11110xx r/w xxxxxxxx

 * data bytes

READ  RD=1

 * 8bit data length (doesn't include address), always 1 since data contains requested length

 *  7bit address: adr7+RD
 *     xxxxxxx r/w 
 * 10bit address: 11110 adr2+RD Ack adr8
 *     11110xx r/w xxxxxxxx

 * requested length (1 byte)

для керування використовується недійсна адреса 0xff address зя якою передаються послыдовнысть внутрышных комеад

Mode - 0xff
0x01 0xff 0xff mode
  mode: 0 - RAW
        1 - Coptonix
        2 - Manual

Transaction - 0xfe
0x01 0xff 0xfe on/off
        0 - end transaction
        1 - begon transaction

Log level - 0xfd
0x01 0xff 0xfd level
        0 - disabled
        1 - enabled (2 and higher reserved)

Конвертор очикує 1й байт з довжиною пакету data length. Зчитує перший байт адреси і, якщо треба, 2й. Далі йде очикування даних. Після отримання повного пакету дані передаються на вказаний I2C пристрій. Якщо протягом CMD_TIMEOUT (1сек) не поступає наступний байт, вважається, що траписась помилка і буфер прийому очищуються.

Існує можливість перевести контролер в інший режим вручну. Для цього в момент настання таймауту вхідний буфер перевіряється на наявність наступних команд. В решті випадуів отримані дані ігноруються.

mode=coptonix
mode=manual
version?

 * 8bit data length for packets of 1-0xef bytes
 *     or
 * 0xff length for packets of 0xf0-0xff bytes
 *     or
 * 0xff error code (see below)

 * data bytes (for READ requests only)

1:  data too long  (should not happen)
2:  NACK addr      (no such device)
3:  NACK data      (data transmission aborted)
4:  unknown
5:  timeout

Часто використовується режим, у якому до I2C пристрою відправляється команда (чи адреса), після чого очикується відповідь. При цьому Master device не звільняє шину між WRITE та READ. Оскільки за замовчанням шина звільняється, використовуються додаткова послідовність begin/end transaction

> 0x01 0xff 0xfe 0x01     begin transaction
< no reply

> 0x01 0x16 0x3f                        send 1 byte (0x3f) to device 0x0b (=0x16/2)
< 0x01                                  1 byte sent

> 0x01 0x17 0x20                        request read up to 0x20 bytes from device 0x0b 
                                                           (=0x17/2, lower bit means READ)
< 0x20 0xXX 0xXX .... 0xXX              0x20 bytes received + data itself

> 0x01 0xff 0xfe 0x00     end transaction
< no reply

> 0x01 0xff 0xfe 0x01     begin transaction
< no reply

> 0x02 0x16 0x22 0x3e                   send 2 byte (0x22 0x3e) to device 0x0b (=0x16/2)
< 0xff 0x03                             Error (0xff) NACK data (0x03) - device rejected request

> 0x01 0xff 0xfe 0x00     end transaction
< no reply

Режим Manual відрізняється розширеним набором команд і local echo

version?                request version and wait ~1 sec
UI2C v1.0
mode=manual             switch to manual mode
UI2C v1.0 Manual mode
a                       get selected device
Dst Address: fe
w223e                   send bytes 0x22 0x3e
Status: 2 NACK addr
?                       scan bus
Scanning...
I2C device found at address 0x0B!
done
c0b                     select device 0x0b
OK
w223e                   send bytes 0x22 0x3e
Status: 3 NACK data
x10,3f                  send byte 0x2f and wait for reply up to 0x10 bytes
Status: 0 OK                                                                    
<
58 0F 3F 3F 3F 3F 3F 3F
3F 3F 3F 3F 3F 3F 3F 3F

a                       get selected device
aFE
c0B                     select device 0x0b
c
w223E                   send bytes 0x22 3e
w3F                     send byte 0x3f and wait for reply
i5B0F3F3F3F3F3F3F....

Модуль ui2c є мінімальною функціональною заміною модулю smbus2 і повторює його інтерфейс, що спрощує адаптауію існуючих модулів. Також, для ідентифікації наявності UI2C адаптера існує метод probe_ui2c_device(dev_name, speed=115200)

ui2c.py

• class i2c_msg - keep prepared read/write requests and related data buffers
  • read(address, length)
  • write(address, buf)
• class UartI2C - handle I/O with I2C over UI2C
  • __init__(self, dev_name=None, speed=115200)
  • open(self, dev_name)
  • close(self)
  • i2c_rdwr(self, *i2c_msgs) - execute prepared requests inside single transaction
• method probe_ui2c_device(dev_name, speed=115200)
• property verbose - log level, 0-3
• property ui2c_logging - enable UI2C internal logging, must be adjusted before open()/__init__()

Python Example

    # replaced imports
    #import smbus2
    #from smbus2 import i2c_msg

    import ui2c
    from ui2c import i2c_msg

    # check UI2C presence
    if(not ui2c.probe_ui2c_device(dev_name, speed):
        raise IOError("UI2C not detected")

    # open port
    bus = ui2c.UartI2C(dev_name, speed)

    # prepare write packet with command
    part_write = i2c_msg.write(dev_addr, [cmd.value])
    
    # prepare reply request (read) packet
    part_read = i2c_msg.read(dev_addr, 2 + (1 if bus.pec else 0))

    # write command and wait for reply in single transaction
    bus.i2c_rdwr(part_write, part_read)
    received_data = bytes(part_read)

    print("Received data:", received_data)

Спочатку ви відкриваєте порт адаптера UART-to-I2C за допомогою ui2c.UartI2C(dev_name, speed), де dev_name це назва пристрою або ідентифікатор порту, а speed - швидкість передачі даних (бод).

Далі ви визначаєте адресу пристрою I2C (dev_addr) і команду, яку потрібно відправити (cmd).

Потім ви підготовляєте пакет для запису команди за допомогою i2c_msg.write(). Пакет запису містить адресу пристрою та байт команди.

Аналогічно, ви підготовляєте пакет для читання за допомогою i2c_msg.read(). Пакет читання вказує адресу пристрою та кількість байтів для читання.

Для виконання транзакції I2C ви викликаєте uart_i2c.i2c_rdwr(part_write, part_read), яке спочатку відправляє пакет запису, а потім виконує операцію читання. Отримані дані зберігаються в об'єкті part_read.

Нарешті, ви можете отримати отримані дані з part_read за допомогою bytes(part_read) і обробити або відобразити їх, як потрібно.

Будь ласка, замініть dev_name на фактичне ім'я пристрою або ідентифікатор порту вашого адаптера UART-to-I2C і адаптуйте змінні dev_addr та cmd відповідно до ваших конкретних вимог.

Зауважте, що цей приклад передбачає, що бібліотека ui2c встановлена локально і доступна.

C/C++ LIB

Структура i2c_msg

Представляє повідомлення I2C для операцій читання або запису.

struct i2c_msg {
    uint16_t addr;   /**< Адреса пристрою I2C. */
    uint16_t flags;  /**< Флаги I2C пакета. */
    uint16_t len;    /**< Довжина буфера даних. */
    uint8_t* buf;    /**< Вказівник на буфер даних. */
};

i2c_msg_read

Формує запит на зчитування даних з пристрою I2C у вказану структуру i2c_msg.

Повертає: 1, якщо операція успішна, 0 - у разі помилки.

void i2c_msg_read(struct i2c_msg* msg, int address, int length);

i2c_msg_write

Формує запит на запис даних до пристрою I2C за буфера структури i2c_msg.

Повертає: 1, якщо операція успішна, 0 - у разі помилки.

void i2c_msg_write(struct i2c_msg* msg, int address, char* data, int length);

i2c_msg_free

Звільняє ресурси, пов'язані зі структурою i2c_msg.

void i2c_msg_free(struct i2c_msg* msg);

ui2c_open

Відкриває пристрій адаптера UART-to-I2C для здійснення комунікації.

Параметри:

• dev_name - Назва пристрою (послідовного порту) для відкриття. Приклади: "COM1" (Windows), "/dev/ttyUSB0" (Linux).
• speed - Швидкість зв'язку UART, 115200 за замовчанням.

F_HANDLE ui2c_open(const char *dev_name, int speed);

ui2c_close

Закриває дескриптор послідовного порта.

void ui2c_close(F_HANDLE fd);

ui2c_probe

Перевіряє наявність адаптера UART-to-I2C на дескрипторі послідовного порта.

Параметри:

• fd - Дескриптор послідовного порту.

Повертає: 1, якщо адаптер UART-to-I2C присутній, 0 - в іншому випадку.

int ui2c_probe(F_HANDLE fd);

probe_ui2c_device

Перевіряє наявність адаптера UART-to-I2C за іменем послідовного порта.

Параметри:

• dev_name - Назва пристрою (послідовного порту) для перевірки. Приклади: "COM1" (Windows), "/dev/ttyUSB0" (Linux).
• speed - Швидкість зв'язку UART.

Повертає: 1, якщо пристрій UART-to-I2C присутній, 0 - в іншому випадку.

int probe_ui2c_device(const char *dev_name, int speed);

ui2c_enable_logging

Увімкнути режим журналювання на адаптері UART-to-I2C.

Параметри:

• fd - Дескриптор послідовного порту.
• uLevel - Рівень журналювання.

void ui2c_enable_logging(F_HANDLE fd, unsigned char uLevel);

ui2c_rdwr

Виконує операції читання та запису I2C пристрою через адаптер UART-to-I2C відповідно до вказаних структур i2c_msg не звільняючи шину I2C між операціями

Параметри:

• fd - Дескриптор послідовного порта.
• msgs - Масив структур i2c_msg, що описують операції читання та запису.
• num_msgs - Кількість структур i2c_msg в масиві.

Повертає: 0, якщо операція успішна, або код помилки.

• UI2C_2W_STATUS_OK 0x00 // OK
• UI2C_2W_ERR_TOO_LONG 0x01 // data too logs
• UI2C_2W_ERR_ADDR_NACK 0x02 // addr NACK
• UI2C_2W_ERR_DATA_NACK 0x03 // data NACK
• UI2C_2W_ERR_UNKNOWN 0x04 // general error
• UI2C_2W_ERR_TIMEOUT 0x05 // timeout

int ui2c_rdwr(F_HANDLE fd, struct i2c_msg **msgs, int num_msgs);

i2c_probe_dev

Перевіряє наявнысть на шині I2C пристрою з зазначеною адресою.

Повертає: 1, якщо операція успішна, 0 - у разі відсутності або помилки.

i2c_probe_dev(F_HANDLE fd, int dev_addr);

C Example

#include 
#include 
#include 



int main(int argc, char** argv) {
    // Define the i2c_msgs
    struct i2c_msg msg1, msg2;
    int addr = 0x0b; // default DJI battery address
    char data[] = { 0x3f };
    i2c_msg_write(&msg1, addr, data, 1); // request hardware ID  0x3f command
    i2c_msg_read(&msg2, addr, 2);        // read hardware ID, 2 bytes



    // Initialize the UartI2C
    int uart_i2c;
    if(argc<2) {
        printf("Serial port with UI2C adapter not specified\n");
        return -1;
    }
    printf("Try open %s\n", argv[1]);
    uart_i2c = ui2c_open(argv[1], 115200);
    if(uart_i2c <= 0)
        return -1;



    printf("Probe UI2C adapter...\n");
    if(!ui2c_probe(uart_i2c)) {
        printf("Probe UI2C failed\n");
        return -1;
    }



    printf("Probe device...\n");
    if(!i2c_probe_dev(uart_i2c, addr)) {
        printf("Probe I2C device @0x%x failed\n", addr);
        return -1;
    }



    // Perform the i2c_rdwr operation
    printf("Send/receive...\n");
    struct i2c_msg* msgs[2] = { &msg1, &msg2 };
    ui2c_rdwr(uart_i2c, &msgs[0], 2);



    // Print the received data
    printf("Received ID: %4.4x\n", *((uint16_t*)(msg2.buf)));



    // Cleanup
    i2c_msg_free(&msg1);
    i2c_msg_free(&msg2);
    ui2c_close(uart_i2c);



    return 0;
}

См. также

• FB:
• Wiki I2C
• cp2112
• Coptonix #020101 (Slave)
• FTDI232 MPSSE mode, LibMPSSE - I2C
• Wire I2C for Arduino

FB