From 710b73747e43ead31e916fd94ee4ed7ad886bcc1 Mon Sep 17 00:00:00 2001 From: crispyberry Date: Sat, 14 Feb 2026 18:12:43 +0800 Subject: [PATCH] docs: JA docs --- .gitignore | 4 ++ README.md | 2 +- README_CN.md | 2 +- README_JA.md | 175 +++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 181 insertions(+), 2 deletions(-) create mode 100644 README_JA.md diff --git a/.gitignore b/.gitignore index 242b00b..e7816b8 100644 --- a/.gitignore +++ b/.gitignore @@ -38,6 +38,10 @@ main/mimi_secrets.h # Reference repos nanobot/ +# MCP / Memov +.mcp.json +.mem/ +.memignore # OS .DS_Store Thumbs.db diff --git a/README.md b/README.md index d2821cb..b266aef 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Discord](https://img.shields.io/badge/Discord-mimiclaw-5865F2?logo=discord&logoColor=white)](https://discord.gg/r8ZxSvB8Yr) [![X](https://img.shields.io/badge/X-@ssslvky-black?logo=x)](https://x.com/ssslvky) -**[English](README.md) | [中文](README_CN.md)** +**[English](README.md) | [中文](README_CN.md) | [日本語](README_JA.md)**

MimiClaw diff --git a/README_CN.md b/README_CN.md index 7a8c1d8..5b06cc3 100644 --- a/README_CN.md +++ b/README_CN.md @@ -5,7 +5,7 @@ [![Discord](https://img.shields.io/badge/Discord-mimiclaw-5865F2?logo=discord&logoColor=white)](https://discord.gg/r8ZxSvB8Yr) [![X](https://img.shields.io/badge/X-@ssslvky-black?logo=x)](https://x.com/ssslvky) -**[English](README.md) | [中文](README_CN.md)** +**[English](README.md) | [中文](README_CN.md) | [日本語](README_JA.md)**

MimiClaw diff --git a/README_JA.md b/README_JA.md new file mode 100644 index 0000000..cfc50e0 --- /dev/null +++ b/README_JA.md @@ -0,0 +1,175 @@ +# MimiClaw: $5チップで動くポケットAIアシスタント + +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) +[![DeepWiki](https://img.shields.io/badge/DeepWiki-mimiclaw-blue.svg)](https://deepwiki.com/memovai/mimiclaw) +[![Discord](https://img.shields.io/badge/Discord-mimiclaw-5865F2?logo=discord&logoColor=white)](https://discord.gg/r8ZxSvB8Yr) +[![X](https://img.shields.io/badge/X-@ssslvky-black?logo=x)](https://x.com/ssslvky) + +**[English](README.md) | [中文](README_CN.md) | [日本語](README_JA.md)** + +

+ MimiClaw +

+ +**$5チップ上の世界初のAIアシスタント（OpenClaw）。Linuxなし、Node.jsなし、純粋なCのみ。** + +MimiClawは小さなESP32-S3ボードをパーソナルAIアシスタントに変えます。USB電源に接続し、WiFiにつなげて、Telegramから話しかけるだけ — どんなタスクも処理し、ローカルメモリで時間とともに成長します — すべて親指サイズのチップ上で。 + +## MimiClawの特徴 + +- **超小型** — Linux不要、Node.js不要、無駄なし — 純粋なCのみ +- **便利** — Telegramでメッセージを送るだけ、あとはお任せ +- **忠実** — メモリから学習し、再起動しても忘れない +- **省エネ** — USB給電、0.5W、24時間365日稼働 +- **お手頃** — ESP32-S3ボード1枚、$5、それだけ + +## 仕組み + +![](assets/mimiclaw.png) + +Telegramでメッセージを送ると、ESP32-S3がWiFi経由で受信し、エージェントループに送ります — Claudeが思考し、ツールを呼び出し、メモリを読み取り — 返答を送り返します。すべてが$5のチップ上で動作し、データはすべてローカルのFlashに保存されます。 + +## クイックスタート + +### 必要なもの + +- **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)から取得 + +### インストール + +```bash +# まずESP-IDF v5.5+をインストールしてください: +# https://docs.espressif.com/projects/esp-idf/en/v5.5.2/esp32s3/get-started/ + +git clone https://github.com/memovai/mimiclaw.git +cd mimiclaw + +idf.py set-target esp32s3 +``` + +### 設定 + +MimiClawは**2層設定**を採用しています：`mimi_secrets.h`でビルド時のデフォルト値を設定し、シリアルCLIで実行時にオーバーライドできます。CLI設定値はNVS Flashに保存され、ビルド時の値より優先されます。 + +```bash +cp main/mimi_secrets.h.example main/mimi_secrets.h +``` + +`main/mimi_secrets.h`を編集： + +```c +#define MIMI_SECRET_WIFI_SSID "WiFi名" +#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_SEARCH_KEY "" // 任意：Brave Search APIキー +#define MIMI_SECRET_PROXY_HOST "" // 任意：例 "10.0.0.1" +#define MIMI_SECRET_PROXY_PORT "" // 任意：例 "7897" +``` + +ビルドとフラッシュ： + +```bash +# フルビルド（mimi_secrets.h変更後はfullclean必須） +idf.py fullclean && idf.py build + +# シリアルポートを確認 +ls /dev/cu.usb* # macOS +ls /dev/ttyACM* # Linux + +# フラッシュとモニター（PORTをあなたのポートに置き換え） +# USBアダプタ：おそらく /dev/cu.usbmodem11401（macOS）または /dev/ttyACM0（Linux） +idf.py -p PORT flash monitor +``` + +> **重要：正しいUSBポートに接続してください！** ほとんどのESP32-S3ボードには2つのUSB-Cポートがあります。**USB**（ネイティブUSB Serial/JTAG）と書かれたポートを使用してください。**COM**（外部UARTブリッジ）と書かれたポートは使わないでください。間違ったポートに接続するとフラッシュ/モニターが失敗します。 +> +>
+> 参考画像を表示 +> +> USBポートに接続、COMポートではありません +> +>
+ +### CLIコマンド + +シリアル接続で設定やデバッグができます。**設定コマンド**により再コンパイル不要で設定変更可能 — USBケーブルを挿すだけ。 + +**実行時設定**（NVSに保存、ビルド時のデフォルト値をオーバーライド）： + +``` +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_proxy 127.0.0.1 7897 # HTTPプロキシを設定 +mimi> clear_proxy # プロキシを削除 +mimi> set_search_key BSA... # Brave Search APIキーを設定 +mimi> config_show # 全設定を表示（マスク付き） +mimi> config_reset # NVSをクリア、ビルド時デフォルトに戻す +``` + +**デバッグ・メンテナンス：** + +``` +mimi> wifi_status # 接続されていますか？ +mimi> memory_read # ボットが何を覚えているか確認 +mimi> memory_write "内容" # MEMORY.mdに書き込み +mimi> heap_info # 空きRAMはどれくらい？ +mimi> session_list # 全チャットセッションを一覧 +mimi> session_clear 12345 # 会話を削除 +mimi> restart # 再起動 +``` + +## メモリ + +MimiClawはすべてのデータをプレーンテキストファイルとして保存します。直接読み取り・編集可能です： + +| ファイル | 説明 | +|----------|------| +| `SOUL.md` | ボットの性格 — 編集して振る舞いを変更 | +| `USER.md` | あなたの情報 — 名前、好み、言語 | +| `MEMORY.md` | 長期記憶 — ボットが常に覚えておくべきこと | +| `2026-02-05.md` | 日次メモ — 今日あったこと | +| `tg_12345.jsonl` | チャット履歴 — ボットとの会話 | + +## ツール + +MimiClawはAnthropicのtool useプロトコルを使用 — Claudeは会話中にツールを呼び出し、タスクが完了するまでループします（ReActパターン）。 + +| ツール | 説明 | +|--------|------| +| `web_search` | Brave Search APIでウェブ検索、最新情報を取得 | +| `get_current_time` | HTTP経由で現在の日時を取得し、システムクロックを設定 | + +ウェブ検索を有効にするには、`mimi_secrets.h`で[Brave Search APIキー](https://brave.com/search/api/)（`MIMI_SECRET_SEARCH_KEY`）を設定してください。 + +## その他の機能 + +- **WebSocketゲートウェイ** — ポート18789、LAN内から任意のWebSocketクライアントで接続 +- **OTAアップデート** — WiFi経由でファームウェア更新、USB不要 +- **デュアルコア** — ネットワークI/OとAI処理が別々のCPUコアで動作 +- **HTTPプロキシ** — CONNECTトンネル対応、制限付きネットワークに対応 +- **ツール呼び出し** — ReActエージェントループ、Anthropic tool useプロトコル + +## 開発者向け + +技術的な詳細は`docs/`フォルダにあります： + +- **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** — システム設計、モジュール構成、タスクレイアウト、メモリバジェット、プロトコル、Flashパーティション +- **[docs/TODO.md](docs/TODO.md)** — 機能ギャップとロードマップ + +## ライセンス + +MIT + +## 謝辞 + +[OpenClaw](https://github.com/openclaw/openclaw)と[Nanobot](https://github.com/HKUDS/nanobot)にインスパイアされました。MimiClawはコアAIエージェントアーキテクチャを組み込みハードウェア向けに再実装しました — Linuxなし、サーバーなし、$5のチップだけ。 + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=memovai/mimiclaw&type=Date)](https://star-history.com/#memovai/mimiclaw&Date)