From a7ba2e21511fd1b00c7cd54dbd4710087716f6c6 Mon Sep 17 00:00:00 2001 From: crispyberry Date: Sat, 14 Feb 2026 18:38:56 +0800 Subject: [PATCH] docs: update READMEs to document OpenAI provider support Co-Authored-By: Claude Opus 4.6 --- README.md | 15 +++++++++------ README_CN.md | 15 +++++++++------ README_JA.md | 15 +++++++++------ 3 files changed, 27 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index b266aef..61d7533 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ MimiClaw turns a tiny ESP32-S3 board into a personal AI assistant. Plug it into ![](assets/mimiclaw.png) -You send a message on Telegram. The ESP32-S3 picks it up over WiFi, feeds it into an agent loop — Claude thinks, calls tools, reads memory — and sends the reply back. Everything runs on a single $5 chip with all your data stored locally on flash. +You send a message on Telegram. The ESP32-S3 picks it up over WiFi, feeds it into an agent loop — the LLM thinks, calls tools, reads memory — and sends the reply back. Supports both **Anthropic (Claude)** and **OpenAI (GPT)** as providers, switchable at runtime. Everything runs on a single $5 chip with all your data stored locally on flash. ## Quick Start @@ -36,7 +36,7 @@ You send a message on Telegram. The ESP32-S3 picks it up over WiFi, feeds it int - An **ESP32-S3 dev board** with 16 MB flash and 8 MB PSRAM (e.g. Xiaozhi AI board, ~$10) - A **USB Type-C cable** - A **Telegram bot token** — talk to [@BotFather](https://t.me/BotFather) on Telegram to create one -- An **Anthropic API key** — from [console.anthropic.com](https://console.anthropic.com) +- An **Anthropic API key** — from [console.anthropic.com](https://console.anthropic.com), or an **OpenAI API key** — from [platform.openai.com](https://platform.openai.com) ### Install @@ -65,6 +65,7 @@ Edit `main/mimi_secrets.h`: #define MIMI_SECRET_WIFI_PASS "YourWiFiPassword" #define MIMI_SECRET_TG_TOKEN "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" #define MIMI_SECRET_API_KEY "sk-ant-api03-xxxxx" +#define MIMI_SECRET_MODEL_PROVIDER "anthropic" // "anthropic" or "openai" #define MIMI_SECRET_SEARCH_KEY "" // optional: Brave Search API key #define MIMI_SECRET_PROXY_HOST "" // optional: e.g. "10.0.0.1" #define MIMI_SECRET_PROXY_PORT "" // optional: e.g. "7897" @@ -103,8 +104,9 @@ Connect via serial to configure or debug. **Config commands** let you change set ``` mimi> wifi_set MySSID MyPassword # change WiFi network mimi> set_tg_token 123456:ABC... # change Telegram bot token -mimi> set_api_key sk-ant-api03-... # change Anthropic API key -mimi> set_model claude-sonnet-4-5 # change LLM model +mimi> set_api_key sk-ant-api03-... # change API key (Anthropic or OpenAI) +mimi> set_model_provider openai # switch provider (anthropic|openai) +mimi> set_model gpt-4o # change LLM model mimi> set_proxy 127.0.0.1 7897 # set HTTP proxy mimi> clear_proxy # remove proxy mimi> set_search_key BSA... # set Brave Search API key @@ -138,7 +140,7 @@ MimiClaw stores everything as plain text files you can read and edit: ## Tools -MimiClaw uses Anthropic's tool use protocol — Claude can call tools during a conversation and loop until the task is done (ReAct pattern). +MimiClaw supports tool calling for both Anthropic and OpenAI — the LLM can call tools during a conversation and loop until the task is done (ReAct pattern). | Tool | Description | |------|-------------| @@ -153,7 +155,8 @@ To enable web search, set a [Brave Search API key](https://brave.com/search/api/ - **OTA updates** — flash new firmware over WiFi, no USB needed - **Dual-core** — network I/O and AI processing run on separate CPU cores - **HTTP proxy** — CONNECT tunnel support for restricted networks -- **Tool use** — ReAct agent loop with Anthropic tool use protocol +- **Multi-provider** — supports both Anthropic (Claude) and OpenAI (GPT), switchable at runtime +- **Tool use** — ReAct agent loop with tool calling for both providers ## For Developers diff --git a/README_CN.md b/README_CN.md index 5b06cc3..398166a 100644 --- a/README_CN.md +++ b/README_CN.md @@ -27,7 +27,7 @@ MimiClaw 把一块小小的 ESP32-S3 开发板变成你的私人 AI 助理。插 ![](assets/mimiclaw.png) -你在 Telegram 发一条消息，ESP32-S3 通过 WiFi 收到后送进 Agent 循环 — Claude 思考、调用工具、读取记忆 — 再把回复发回来。一切都跑在一颗 $5 的芯片上，所有数据存在本地 Flash。 +你在 Telegram 发一条消息，ESP32-S3 通过 WiFi 收到后送进 Agent 循环 — LLM 思考、调用工具、读取记忆 — 再把回复发回来。同时支持 **Anthropic (Claude)** 和 **OpenAI (GPT)** 两种提供商，运行时可切换。一切都跑在一颗 $5 的芯片上，所有数据存在本地 Flash。 ## 快速开始 @@ -36,7 +36,7 @@ MimiClaw 把一块小小的 ESP32-S3 开发板变成你的私人 AI 助理。插 - 一块 **ESP32-S3 开发板**，16MB Flash + 8MB PSRAM（如小智 AI 开发板，~¥30） - 一根 **USB Type-C 数据线** - 一个 **Telegram Bot Token** — 在 Telegram 找 [@BotFather](https://t.me/BotFather) 创建 -- 一个 **Anthropic API Key** — 从 [console.anthropic.com](https://console.anthropic.com) 获取 +- 一个 **Anthropic API Key** — 从 [console.anthropic.com](https://console.anthropic.com) 获取，或一个 **OpenAI API Key** — 从 [platform.openai.com](https://platform.openai.com) 获取 ### 安装 @@ -65,6 +65,7 @@ cp main/mimi_secrets.h.example main/mimi_secrets.h #define MIMI_SECRET_WIFI_PASS "你的WiFi密码" #define MIMI_SECRET_TG_TOKEN "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" #define MIMI_SECRET_API_KEY "sk-ant-api03-xxxxx" +#define MIMI_SECRET_MODEL_PROVIDER "anthropic" // "anthropic" 或 "openai" #define MIMI_SECRET_SEARCH_KEY "" // 可选：Brave Search API key #define MIMI_SECRET_PROXY_HOST "10.0.0.1" // 可选：代理地址 #define MIMI_SECRET_PROXY_PORT "7897" // 可选：代理端口 @@ -118,8 +119,9 @@ mimi> clear_proxy # 清除代理 ``` mimi> wifi_set MySSID MyPassword # 换 WiFi mimi> set_tg_token 123456:ABC... # 换 Telegram Bot Token -mimi> set_api_key sk-ant-api03-... # 换 Anthropic API Key -mimi> set_model claude-sonnet-4-5-20250929 # 换模型 +mimi> set_api_key sk-ant-api03-... # 换 API Key（Anthropic 或 OpenAI） +mimi> set_model_provider openai # 切换提供商（anthropic|openai） +mimi> set_model gpt-4o # 换模型 mimi> set_proxy 192.168.1.83 7897 # 设置代理 mimi> clear_proxy # 清除代理 mimi> set_search_key BSA... # 设置 Brave Search API Key @@ -153,7 +155,7 @@ MimiClaw 把所有数据存为纯文本文件，可以直接读取和编辑： ## 工具 -MimiClaw 使用 Anthropic 的 tool use 协议 — Claude 在对话中可以调用工具，循环执行直到任务完成（ReAct 模式）。 +MimiClaw 同时支持 Anthropic 和 OpenAI 的工具调用 — LLM 在对话中可以调用工具，循环执行直到任务完成（ReAct 模式）。 | 工具 | 说明 | |------|------| @@ -168,7 +170,8 @@ MimiClaw 使用 Anthropic 的 tool use 协议 — Claude 在对话中可以调 - **OTA 更新** — WiFi 远程刷固件，无需 USB - **双核** — 网络 I/O 和 AI 处理分别跑在不同 CPU 核心 - **HTTP 代理** — CONNECT 隧道，适配受限网络 -- **工具调用** — ReAct Agent 循环，Anthropic tool use 协议 +- **多提供商** — 同时支持 Anthropic (Claude) 和 OpenAI (GPT)，运行时可切换 +- **工具调用** — ReAct Agent 循环，两种提供商均支持工具调用 ## 开发者 diff --git a/README_JA.md b/README_JA.md index cfc50e0..11d09fb 100644 --- a/README_JA.md +++ b/README_JA.md @@ -27,7 +27,7 @@ MimiClawは小さなESP32-S3ボードをパーソナルAIアシスタントに ![](assets/mimiclaw.png) -Telegramでメッセージを送ると、ESP32-S3がWiFi経由で受信し、エージェントループに送ります — Claudeが思考し、ツールを呼び出し、メモリを読み取り — 返答を送り返します。すべてが$5のチップ上で動作し、データはすべてローカルのFlashに保存されます。 +Telegramでメッセージを送ると、ESP32-S3がWiFi経由で受信し、エージェントループに送ります — LLMが思考し、ツールを呼び出し、メモリを読み取り — 返答を送り返します。**Anthropic (Claude)** と **OpenAI (GPT)** の両方をサポートし、実行時に切り替え可能です。すべてが$5のチップ上で動作し、データはすべてローカルのFlashに保存されます。 ## クイックスタート @@ -36,7 +36,7 @@ Telegramでメッセージを送ると、ESP32-S3がWiFi経由で受信し、エ - **ESP32-S3開発ボード**（16MB Flash + 8MB PSRAM搭載、例：小智AIボード、約$10） - **USB Type-Cケーブル** - **Telegram Botトークン** — Telegramで[@BotFather](https://t.me/BotFather)に話しかけて作成 -- **Anthropic APIキー** — [console.anthropic.com](https://console.anthropic.com)から取得 +- **Anthropic APIキー** — [console.anthropic.com](https://console.anthropic.com)から取得、または **OpenAI APIキー** — [platform.openai.com](https://platform.openai.com)から取得 ### インストール @@ -65,6 +65,7 @@ cp main/mimi_secrets.h.example main/mimi_secrets.h #define MIMI_SECRET_WIFI_PASS "WiFiパスワード" #define MIMI_SECRET_TG_TOKEN "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11" #define MIMI_SECRET_API_KEY "sk-ant-api03-xxxxx" +#define MIMI_SECRET_MODEL_PROVIDER "anthropic" // "anthropic" または "openai" #define MIMI_SECRET_SEARCH_KEY "" // 任意：Brave Search APIキー #define MIMI_SECRET_PROXY_HOST "" // 任意：例 "10.0.0.1" #define MIMI_SECRET_PROXY_PORT "" // 任意：例 "7897" @@ -103,8 +104,9 @@ idf.py -p PORT flash monitor ``` mimi> wifi_set MySSID MyPassword # WiFiネットワークを変更 mimi> set_tg_token 123456:ABC... # Telegram Botトークンを変更 -mimi> set_api_key sk-ant-api03-... # Anthropic APIキーを変更 -mimi> set_model claude-sonnet-4-5 # LLMモデルを変更 +mimi> set_api_key sk-ant-api03-... # APIキーを変更（AnthropicまたはOpenAI） +mimi> set_model_provider openai # プロバイダーを切替（anthropic|openai） +mimi> set_model gpt-4o # LLMモデルを変更 mimi> set_proxy 127.0.0.1 7897 # HTTPプロキシを設定 mimi> clear_proxy # プロキシを削除 mimi> set_search_key BSA... # Brave Search APIキーを設定 @@ -138,7 +140,7 @@ MimiClawはすべてのデータをプレーンテキストファイルとして ## ツール -MimiClawはAnthropicのtool useプロトコルを使用 — Claudeは会話中にツールを呼び出し、タスクが完了するまでループします（ReActパターン）。 +MimiClawはAnthropicとOpenAI両方のツール呼び出しをサポート — LLMは会話中にツールを呼び出し、タスクが完了するまでループします（ReActパターン）。 | ツール | 説明 | |--------|------| @@ -153,7 +155,8 @@ MimiClawはAnthropicのtool useプロトコルを使用 — Claudeは会話中 - **OTAアップデート** — WiFi経由でファームウェア更新、USB不要 - **デュアルコア** — ネットワークI/OとAI処理が別々のCPUコアで動作 - **HTTPプロキシ** — CONNECTトンネル対応、制限付きネットワークに対応 -- **ツール呼び出し** — ReActエージェントループ、Anthropic tool useプロトコル +- **マルチプロバイダー** — Anthropic (Claude) と OpenAI (GPT) の両方をサポート、実行時に切り替え可能 +- **ツール呼び出し** — ReActエージェントループ、両プロバイダーでツール呼び出し対応 ## 開発者向け