描述

描述

OSCUP是一種開源 UART 協(xié)議，專為與 ESP32 ARM 處理器配合使用而設(shè)計(jì)。詳細(xì)記錄的代碼有助于弄清楚如何在 UART 端口上實(shí)現(xiàn)自定義協(xié)議。使用此協(xié)議，您可以傳輸和接收由固定前導(dǎo)碼跟蹤的數(shù)據(jù)。它為每個(gè)發(fā)送的數(shù)據(jù)包實(shí)現(xiàn) ACK 和 NACK，以管理錯(cuò)誤或丟失的數(shù)據(jù)包。

怎么運(yùn)行的

它依賴于 Espressiff 提供的原始庫，例如 /device/uart.h 用于連接低級(jí)硬件和功能。該協(xié)議提供兩個(gè)功能write，read用于發(fā)送和接收數(shù)據(jù)。當(dāng)您創(chuàng)建一個(gè)新的 Oscup 對(duì)象時(shí)，您需要向它傳遞一個(gè) ID，該 ID 用于跟蹤發(fā)送數(shù)據(jù)包的設(shè)備。可選地，Oscup 對(duì)象可以被實(shí)例化，指定 UART 端口和相關(guān)的 UART TX 引腳和 UART RX 引腳。默認(rèn)情況下，通信發(fā)生在 UART 0，或者更確切地說是 USB 端口。

事實(shí)上，可以使用 OSCUP 進(jìn)行計(jì)算機(jī)和 ESP32 之間或兩個(gè) ESP32 之間的通信。

命令

每次協(xié)議在 UART 上寫入數(shù)據(jù)時(shí)，它都會(huì)在數(shù)據(jù)包中插入一條命令。該命令是強(qiáng)制性的，否則您可能會(huì)問自己為什么要使用協(xié)議（只需使用 arduino Serial）。顯然，在接收方，您必須區(qū)分接收到的命令。有可用的 4 個(gè)主要命令：

• SHARE：此命令表示發(fā)送方只想與接收方共享此數(shù)據(jù)（出于次要原因）。如果您只想在其他設(shè)備上打印數(shù)據(jù)，則可以使用它。
• CONFIRM：此命令表示將發(fā)送的數(shù)據(jù)是操作的結(jié)果（例如，我們按下設(shè)備 1 上的按鈕，我們將數(shù)據(jù)發(fā)送到設(shè)備 2，我們希望設(shè)備 2 不僅打印此數(shù)據(jù)，而且存儲(chǔ)它們).
• ACK: 用于告訴發(fā)送方，接收方已經(jīng)收到數(shù)據(jù)包
• NACK: 用于告訴發(fā)送方，接收方還沒有收到數(shù)據(jù)包；發(fā)件人將嘗試再次發(fā)送 顯然，您可以配置您喜歡執(zhí)行每個(gè)命令的操作。我們建議不要使用 ACK 和 NACK，至于其他兩個(gè)，前面的指示只是我們?yōu)槭褂眠@兩個(gè)命令定義的指南。另外，你可以在arduino上配置新命令（command = uint8_t），直接在write函數(shù)中發(fā)送

公共職能

• begin: 初始化 UART 參數(shù)并將其轉(zhuǎn)發(fā)給控制硬件。必須在 void setup() 中調(diào)用它。它以波特率作為唯一的輸入?yún)?shù)，它將決定通信波特率。
• write：寫函數(shù)接受一個(gè)命令“用戶定義”，有效負(fù)載的長(zhǎng)度和有效負(fù)載，其長(zhǎng)度固定為 40 字節(jié)。此函數(shù)將此數(shù)據(jù)寫入 UART 并返回錯(cuò)誤代碼。
• read：它讀取傳入的數(shù)據(jù)并將它們插入 packet_t 結(jié)構(gòu)中，該結(jié)構(gòu)在 .h 文件中定義。如果一切正常，它返回讀取緩沖區(qū)的長(zhǎng)度，否則返回負(fù)錯(cuò)誤。
• get_timer: 返回定時(shí)器的計(jì)數(shù)器
• get_APB_clk: 返回 APB 的頻率。通常 APB 用于設(shè)置嵌入式處理器上的外設(shè)頻率。

貢獻(xiàn)

我們是 Daniel 和 Riccardo，都是大學(xué)的 AI 學(xué)生。我們開發(fā)了這個(gè)協(xié)議來從 ESP32 獲取數(shù)據(jù)來做 AI 的事情（在我們的 Git Repo 上查看 FiremanSam）。

?

?