merge: sync upstream/main into feat/multi-agent-routing
Update registerSharedTools to use new WebSearchToolOptions API and add hardware tools (I2C, SPI) from upstream. Accept upstream's new web tools config test.
This commit is contained in:
commit
7a7969ad7d
36 changed files with 2765 additions and 169 deletions
|
|
@ -9,6 +9,8 @@
|
||||||
# ── Chat Channel ──────────────────────────
|
# ── Chat Channel ──────────────────────────
|
||||||
# TELEGRAM_BOT_TOKEN=123456:ABC...
|
# TELEGRAM_BOT_TOKEN=123456:ABC...
|
||||||
# DISCORD_BOT_TOKEN=xxx
|
# DISCORD_BOT_TOKEN=xxx
|
||||||
|
# LINE_CHANNEL_SECRET=xxx
|
||||||
|
# LINE_CHANNEL_ACCESS_TOKEN=xxx
|
||||||
|
|
||||||
# ── Web Search (optional) ────────────────
|
# ── Web Search (optional) ────────────────
|
||||||
# BRAVE_SEARCH_API_KEY=BSA...
|
# BRAVE_SEARCH_API_KEY=BSA...
|
||||||
|
|
|
||||||
5
.github/workflows/build.yml
vendored
5
.github/workflows/build.yml
vendored
|
|
@ -16,5 +16,10 @@ jobs:
|
||||||
with:
|
with:
|
||||||
go-version-file: go.mod
|
go-version-file: go.mod
|
||||||
|
|
||||||
|
- name: fmt
|
||||||
|
run: |
|
||||||
|
make fmt
|
||||||
|
git diff --exit-code || (echo "::error::Code is not formatted. Run 'make fmt' and commit the changes." && exit 1)
|
||||||
|
|
||||||
- name: Build
|
- name: Build
|
||||||
run: make build-all
|
run: make build-all
|
||||||
|
|
|
||||||
55
README.ja.md
55
README.ja.md
|
|
@ -223,7 +223,7 @@ picoclaw agent -m "What is 2+2?"
|
||||||
|
|
||||||
## 💬 チャットアプリ
|
## 💬 チャットアプリ
|
||||||
|
|
||||||
Telegram、Discord、QQ、DingTalk で PicoClaw と会話できます
|
Telegram、Discord、QQ、DingTalk、LINE で PicoClaw と会話できます
|
||||||
|
|
||||||
| チャネル | セットアップ |
|
| チャネル | セットアップ |
|
||||||
|---------|------------|
|
|---------|------------|
|
||||||
|
|
@ -231,6 +231,7 @@ Telegram、Discord、QQ、DingTalk で PicoClaw と会話できます
|
||||||
| **Discord** | 簡単(Bot トークン + Intents) |
|
| **Discord** | 簡単(Bot トークン + Intents) |
|
||||||
| **QQ** | 簡単(AppID + AppSecret) |
|
| **QQ** | 簡単(AppID + AppSecret) |
|
||||||
| **DingTalk** | 普通(アプリ認証情報) |
|
| **DingTalk** | 普通(アプリ認証情報) |
|
||||||
|
| **LINE** | 普通(認証情報 + Webhook URL) |
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><b>Telegram</b>(推奨)</summary>
|
<summary><b>Telegram</b>(推奨)</summary>
|
||||||
|
|
@ -314,7 +315,7 @@ picoclaw gateway
|
||||||
|
|
||||||
**1. Bot を作成**
|
**1. Bot を作成**
|
||||||
|
|
||||||
- [QQ オープンプラットフォーム](https://connect.qq.com/) にアクセス
|
- [QQ オープンプラットフォーム](https://q.qq.com/#) にアクセス
|
||||||
- アプリケーションを作成 → **AppID** と **AppSecret** を取得
|
- アプリケーションを作成 → **AppID** と **AppSecret** を取得
|
||||||
|
|
||||||
**2. 設定**
|
**2. 設定**
|
||||||
|
|
@ -376,6 +377,56 @@ picoclaw gateway
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary><b>LINE</b></summary>
|
||||||
|
|
||||||
|
**1. LINE 公式アカウントを作成**
|
||||||
|
|
||||||
|
- [LINE Developers Console](https://developers.line.biz/) にアクセス
|
||||||
|
- プロバイダーを作成 → Messaging API チャネルを作成
|
||||||
|
- **チャネルシークレット** と **チャネルアクセストークン** をコピー
|
||||||
|
|
||||||
|
**2. 設定**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"channels": {
|
||||||
|
"line": {
|
||||||
|
"enabled": true,
|
||||||
|
"channel_secret": "YOUR_CHANNEL_SECRET",
|
||||||
|
"channel_access_token": "YOUR_CHANNEL_ACCESS_TOKEN",
|
||||||
|
"webhook_host": "0.0.0.0",
|
||||||
|
"webhook_port": 18791,
|
||||||
|
"webhook_path": "/webhook/line",
|
||||||
|
"allow_from": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**3. Webhook URL を設定**
|
||||||
|
|
||||||
|
LINE の Webhook には HTTPS が必要です。リバースプロキシまたはトンネルを使用してください:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# ngrok の例
|
||||||
|
ngrok http 18791
|
||||||
|
```
|
||||||
|
|
||||||
|
LINE Developers Console で Webhook URL を `https://あなたのドメイン/webhook/line` に設定し、**Webhook の利用** を有効にしてください。
|
||||||
|
|
||||||
|
**4. 起動**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
picoclaw gateway
|
||||||
|
```
|
||||||
|
|
||||||
|
> グループチャットでは @メンション時のみ応答します。返信は元メッセージを引用する形式です。
|
||||||
|
|
||||||
|
> **Docker Compose**: `picoclaw-gateway` サービスに `ports: ["18791:18791"]` を追加して Webhook ポートを公開してください。
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## ⚙️ 設定
|
## ⚙️ 設定
|
||||||
|
|
||||||
設定ファイル: `~/.picoclaw/config.json`
|
設定ファイル: `~/.picoclaw/config.json`
|
||||||
|
|
|
||||||
103
README.md
103
README.md
|
|
@ -69,7 +69,7 @@
|
||||||
🤖 **AI-Bootstrapped**: Autonomous Go-native implementation — 95% Agent-generated core with human-in-the-loop refinement.
|
🤖 **AI-Bootstrapped**: Autonomous Go-native implementation — 95% Agent-generated core with human-in-the-loop refinement.
|
||||||
|
|
||||||
| | OpenClaw | NanoBot | **PicoClaw** |
|
| | OpenClaw | NanoBot | **PicoClaw** |
|
||||||
| --- | --- | --- |--- |
|
| ----------------------------- | ------------- | ------------------------ | ----------------------------------------- |
|
||||||
| **Language** | TypeScript | Python | **Go** |
|
| **Language** | TypeScript | Python | **Go** |
|
||||||
| **RAM** | >1GB | >100MB | **< 10MB** |
|
| **RAM** | >1GB | >100MB | **< 10MB** |
|
||||||
| **Startup**</br>(0.8GHz core) | >500s | >30s | **<1s** |
|
| **Startup**</br>(0.8GHz core) | >500s | >30s | **<1s** |
|
||||||
|
|
@ -180,7 +180,7 @@ docker compose --profile gateway up -d
|
||||||
> [!TIP]
|
> [!TIP]
|
||||||
> Set your API key in `~/.picoclaw/config.json`.
|
> Set your API key in `~/.picoclaw/config.json`.
|
||||||
> Get API keys: [OpenRouter](https://openrouter.ai/keys) (LLM) · [Zhipu](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys) (LLM)
|
> Get API keys: [OpenRouter](https://openrouter.ai/keys) (LLM) · [Zhipu](https://open.bigmodel.cn/usercenter/proj-mgmt/apikeys) (LLM)
|
||||||
> Web search is **optional** - get free [Brave Search API](https://brave.com/search/api) (2000 free queries/month)
|
> Web search is **optional** - get free [Brave Search API](https://brave.com/search/api) (2000 free queries/month) or use built-in auto fallback.
|
||||||
|
|
||||||
**1. Initialize**
|
**1. Initialize**
|
||||||
|
|
||||||
|
|
@ -209,9 +209,14 @@ picoclaw onboard
|
||||||
},
|
},
|
||||||
"tools": {
|
"tools": {
|
||||||
"web": {
|
"web": {
|
||||||
"search": {
|
"brave": {
|
||||||
|
"enabled": false,
|
||||||
"api_key": "YOUR_BRAVE_API_KEY",
|
"api_key": "YOUR_BRAVE_API_KEY",
|
||||||
"max_results": 5
|
"max_results": 5
|
||||||
|
},
|
||||||
|
"duckduckgo": {
|
||||||
|
"enabled": true,
|
||||||
|
"max_results": 5
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -237,14 +242,15 @@ That's it! You have a working AI assistant in 2 minutes.
|
||||||
|
|
||||||
## 💬 Chat Apps
|
## 💬 Chat Apps
|
||||||
|
|
||||||
Talk to your picoclaw through Telegram, Discord, or DingTalk
|
Talk to your picoclaw through Telegram, Discord, DingTalk, or LINE
|
||||||
|
|
||||||
| Channel | Setup |
|
| Channel | Setup |
|
||||||
|---------|-------|
|
| ------------ | ---------------------------------- |
|
||||||
| **Telegram** | Easy (just a token) |
|
| **Telegram** | Easy (just a token) |
|
||||||
| **Discord** | Easy (bot token + intents) |
|
| **Discord** | Easy (bot token + intents) |
|
||||||
| **QQ** | Easy (AppID + AppSecret) |
|
| **QQ** | Easy (AppID + AppSecret) |
|
||||||
| **DingTalk** | Medium (app credentials) |
|
| **DingTalk** | Medium (app credentials) |
|
||||||
|
| **LINE** | Medium (credentials + webhook URL) |
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><b>Telegram</b> (Recommended)</summary>
|
<summary><b>Telegram</b> (Recommended)</summary>
|
||||||
|
|
@ -332,7 +338,7 @@ picoclaw gateway
|
||||||
|
|
||||||
**1. Create a bot**
|
**1. Create a bot**
|
||||||
|
|
||||||
- Go to [QQ Open Platform](https://connect.qq.com/)
|
- Go to [QQ Open Platform](https://q.qq.com/#)
|
||||||
- Create an application → Get **AppID** and **AppSecret**
|
- Create an application → Get **AppID** and **AppSecret**
|
||||||
|
|
||||||
**2. Configure**
|
**2. Configure**
|
||||||
|
|
@ -394,14 +400,62 @@ picoclaw gateway
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary><b>LINE</b></summary>
|
||||||
|
|
||||||
|
**1. Create a LINE Official Account**
|
||||||
|
|
||||||
|
- Go to [LINE Developers Console](https://developers.line.biz/)
|
||||||
|
- Create a provider → Create a Messaging API channel
|
||||||
|
- Copy **Channel Secret** and **Channel Access Token**
|
||||||
|
|
||||||
|
**2. Configure**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"channels": {
|
||||||
|
"line": {
|
||||||
|
"enabled": true,
|
||||||
|
"channel_secret": "YOUR_CHANNEL_SECRET",
|
||||||
|
"channel_access_token": "YOUR_CHANNEL_ACCESS_TOKEN",
|
||||||
|
"webhook_host": "0.0.0.0",
|
||||||
|
"webhook_port": 18791,
|
||||||
|
"webhook_path": "/webhook/line",
|
||||||
|
"allow_from": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**3. Set up Webhook URL**
|
||||||
|
|
||||||
|
LINE requires HTTPS for webhooks. Use a reverse proxy or tunnel:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Example with ngrok
|
||||||
|
ngrok http 18791
|
||||||
|
```
|
||||||
|
|
||||||
|
Then set the Webhook URL in LINE Developers Console to `https://your-domain/webhook/line` and enable **Use webhook**.
|
||||||
|
|
||||||
|
**4. Run**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
picoclaw gateway
|
||||||
|
```
|
||||||
|
|
||||||
|
> In group chats, the bot responds only when @mentioned. Replies quote the original message.
|
||||||
|
|
||||||
|
> **Docker Compose**: Add `ports: ["18791:18791"]` to the `picoclaw-gateway` service to expose the webhook port.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## <img src="assets/clawdchat-icon.png" width="24" height="24" alt="ClawdChat"> Join the Agent Social Network
|
## <img src="assets/clawdchat-icon.png" width="24" height="24" alt="ClawdChat"> Join the Agent Social Network
|
||||||
|
|
||||||
Connect Picoclaw to the Agent Social Network simply by sending a single message via the CLI or any integrated Chat App.
|
Connect Picoclaw to the Agent Social Network simply by sending a single message via the CLI or any integrated Chat App.
|
||||||
|
|
||||||
**Read `https://clawdchat.ai/skill.md` and follow the instructions to join [ClawdChat.ai](https://clawdchat.ai)**
|
**Read `https://clawdchat.ai/skill.md` and follow the instructions to join [ClawdChat.ai](https://clawdchat.ai)**
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## ⚙️ Configuration
|
## ⚙️ Configuration
|
||||||
|
|
||||||
Config file: `~/.picoclaw/config.json`
|
Config file: `~/.picoclaw/config.json`
|
||||||
|
|
@ -599,7 +653,7 @@ The subagent has access to tools (message, web_search, etc.) and can communicate
|
||||||
> Groq provides free voice transcription via Whisper. If configured, Telegram voice messages will be automatically transcribed.
|
> Groq provides free voice transcription via Whisper. If configured, Telegram voice messages will be automatically transcribed.
|
||||||
|
|
||||||
| Provider | Purpose | Get API Key |
|
| Provider | Purpose | Get API Key |
|
||||||
|----------|---------|-------------|
|
| -------------------------- | --------------------------------------- | ------------------------------------------------------ |
|
||||||
| `gemini` | LLM (Gemini direct) | [aistudio.google.com](https://aistudio.google.com) |
|
| `gemini` | LLM (Gemini direct) | [aistudio.google.com](https://aistudio.google.com) |
|
||||||
| `zhipu` | LLM (Zhipu direct) | [bigmodel.cn](bigmodel.cn) |
|
| `zhipu` | LLM (Zhipu direct) | [bigmodel.cn](bigmodel.cn) |
|
||||||
| `openrouter(To be tested)` | LLM (recommended, access to all models) | [openrouter.ai](https://openrouter.ai) |
|
| `openrouter(To be tested)` | LLM (recommended, access to all models) | [openrouter.ai](https://openrouter.ai) |
|
||||||
|
|
@ -632,8 +686,8 @@ The subagent has access to tools (message, web_search, etc.) and can communicate
|
||||||
"zhipu": {
|
"zhipu": {
|
||||||
"api_key": "Your API Key",
|
"api_key": "Your API Key",
|
||||||
"api_base": "https://open.bigmodel.cn/api/paas/v4"
|
"api_base": "https://open.bigmodel.cn/api/paas/v4"
|
||||||
},
|
}
|
||||||
},
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -694,8 +748,14 @@ picoclaw agent -m "Hello"
|
||||||
},
|
},
|
||||||
"tools": {
|
"tools": {
|
||||||
"web": {
|
"web": {
|
||||||
"search": {
|
"brave": {
|
||||||
"api_key": "BSA..."
|
"enabled": false,
|
||||||
|
"api_key": "BSA...",
|
||||||
|
"max_results": 5
|
||||||
|
},
|
||||||
|
"duckduckgo": {
|
||||||
|
"enabled": true,
|
||||||
|
"max_results": 5
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
@ -711,7 +771,7 @@ picoclaw agent -m "Hello"
|
||||||
## CLI Reference
|
## CLI Reference
|
||||||
|
|
||||||
| Command | Description |
|
| Command | Description |
|
||||||
|---------|-------------|
|
| ------------------------- | ----------------------------- |
|
||||||
| `picoclaw onboard` | Initialize config & workspace |
|
| `picoclaw onboard` | Initialize config & workspace |
|
||||||
| `picoclaw agent -m "..."` | Chat with the agent |
|
| `picoclaw agent -m "..."` | Chat with the agent |
|
||||||
| `picoclaw agent` | Interactive chat mode |
|
| `picoclaw agent` | Interactive chat mode |
|
||||||
|
|
@ -752,16 +812,23 @@ This is normal if you haven't configured a search API key yet. PicoClaw will pro
|
||||||
|
|
||||||
To enable web search:
|
To enable web search:
|
||||||
|
|
||||||
1. Get a free API key at [https://brave.com/search/api](https://brave.com/search/api) (2000 free queries/month)
|
1. **Option 1 (Recommended)**: Get a free API key at [https://brave.com/search/api](https://brave.com/search/api) (2000 free queries/month) for the best results.
|
||||||
2. Add to `~/.picoclaw/config.json`:
|
2. **Option 2 (No Credit Card)**: If you don't have a key, we automatically fall back to **DuckDuckGo** (no key required).
|
||||||
|
|
||||||
|
Add the key to `~/.picoclaw/config.json` if using Brave:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"tools": {
|
"tools": {
|
||||||
"web": {
|
"web": {
|
||||||
"search": {
|
"brave": {
|
||||||
|
"enabled": false,
|
||||||
"api_key": "YOUR_BRAVE_API_KEY",
|
"api_key": "YOUR_BRAVE_API_KEY",
|
||||||
"max_results": 5
|
"max_results": 5
|
||||||
|
},
|
||||||
|
"duckduckgo": {
|
||||||
|
"enabled": true,
|
||||||
|
"max_results": 5
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -781,7 +848,7 @@ This happens when another instance of the bot is running. Make sure only one `pi
|
||||||
## 📝 API Key Comparison
|
## 📝 API Key Comparison
|
||||||
|
|
||||||
| Service | Free Tier | Use Case |
|
| Service | Free Tier | Use Case |
|
||||||
|---------|-----------|-----------|
|
| ---------------- | ------------------- | ------------------------------------- |
|
||||||
| **OpenRouter** | 200K tokens/month | Multiple models (Claude, GPT-4, etc.) |
|
| **OpenRouter** | 200K tokens/month | Multiple models (Claude, GPT-4, etc.) |
|
||||||
| **Zhipu** | 200K tokens/month | Best for Chinese users |
|
| **Zhipu** | 200K tokens/month | Best for Chinese users |
|
||||||
| **Brave Search** | 2000 queries/month | Web search functionality |
|
| **Brave Search** | 2000 queries/month | Web search functionality |
|
||||||
|
|
|
||||||
|
|
@ -342,7 +342,7 @@ picoclaw gateway
|
||||||
|
|
||||||
**1. 创建机器人**
|
**1. 创建机器人**
|
||||||
|
|
||||||
* 前往 [QQ 开放平台](https://connect.qq.com/)
|
* 前往 [QQ 开放平台](https://q.qq.com/#)
|
||||||
* 创建应用 → 获取 **AppID** 和 **AppSecret**
|
* 创建应用 → 获取 **AppID** 和 **AppSecret**
|
||||||
|
|
||||||
**2. 配置**
|
**2. 配置**
|
||||||
|
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 143 KiB After Width: | Height: | Size: 145 KiB |
|
|
@ -25,11 +25,13 @@ import (
|
||||||
"github.com/sipeed/picoclaw/pkg/channels"
|
"github.com/sipeed/picoclaw/pkg/channels"
|
||||||
"github.com/sipeed/picoclaw/pkg/config"
|
"github.com/sipeed/picoclaw/pkg/config"
|
||||||
"github.com/sipeed/picoclaw/pkg/cron"
|
"github.com/sipeed/picoclaw/pkg/cron"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/devices"
|
||||||
"github.com/sipeed/picoclaw/pkg/heartbeat"
|
"github.com/sipeed/picoclaw/pkg/heartbeat"
|
||||||
"github.com/sipeed/picoclaw/pkg/logger"
|
"github.com/sipeed/picoclaw/pkg/logger"
|
||||||
"github.com/sipeed/picoclaw/pkg/migrate"
|
"github.com/sipeed/picoclaw/pkg/migrate"
|
||||||
"github.com/sipeed/picoclaw/pkg/providers"
|
"github.com/sipeed/picoclaw/pkg/providers"
|
||||||
"github.com/sipeed/picoclaw/pkg/skills"
|
"github.com/sipeed/picoclaw/pkg/skills"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/state"
|
||||||
"github.com/sipeed/picoclaw/pkg/tools"
|
"github.com/sipeed/picoclaw/pkg/tools"
|
||||||
"github.com/sipeed/picoclaw/pkg/voice"
|
"github.com/sipeed/picoclaw/pkg/voice"
|
||||||
)
|
)
|
||||||
|
|
@ -751,6 +753,18 @@ func gatewayCmd() {
|
||||||
}
|
}
|
||||||
fmt.Println("✓ Heartbeat service started")
|
fmt.Println("✓ Heartbeat service started")
|
||||||
|
|
||||||
|
stateManager := state.NewManager(cfg.WorkspacePath())
|
||||||
|
deviceService := devices.NewService(devices.Config{
|
||||||
|
Enabled: cfg.Devices.Enabled,
|
||||||
|
MonitorUSB: cfg.Devices.MonitorUSB,
|
||||||
|
}, stateManager)
|
||||||
|
deviceService.SetBus(msgBus)
|
||||||
|
if err := deviceService.Start(ctx); err != nil {
|
||||||
|
fmt.Printf("Error starting device service: %v\n", err)
|
||||||
|
} else if cfg.Devices.Enabled {
|
||||||
|
fmt.Println("✓ Device event service started")
|
||||||
|
}
|
||||||
|
|
||||||
if err := channelManager.StartAll(ctx); err != nil {
|
if err := channelManager.StartAll(ctx); err != nil {
|
||||||
fmt.Printf("Error starting channels: %v\n", err)
|
fmt.Printf("Error starting channels: %v\n", err)
|
||||||
}
|
}
|
||||||
|
|
@ -763,6 +777,7 @@ func gatewayCmd() {
|
||||||
|
|
||||||
fmt.Println("\nShutting down...")
|
fmt.Println("\nShutting down...")
|
||||||
cancel()
|
cancel()
|
||||||
|
deviceService.Stop()
|
||||||
heartbeatService.Stop()
|
heartbeatService.Stop()
|
||||||
cronService.Stop()
|
cronService.Stop()
|
||||||
agentLoop.Stop()
|
agentLoop.Stop()
|
||||||
|
|
|
||||||
|
|
@ -51,6 +51,15 @@
|
||||||
"bot_token": "xoxb-YOUR-BOT-TOKEN",
|
"bot_token": "xoxb-YOUR-BOT-TOKEN",
|
||||||
"app_token": "xapp-YOUR-APP-TOKEN",
|
"app_token": "xapp-YOUR-APP-TOKEN",
|
||||||
"allow_from": []
|
"allow_from": []
|
||||||
|
},
|
||||||
|
"line": {
|
||||||
|
"enabled": false,
|
||||||
|
"channel_secret": "YOUR_LINE_CHANNEL_SECRET",
|
||||||
|
"channel_access_token": "YOUR_LINE_CHANNEL_ACCESS_TOKEN",
|
||||||
|
"webhook_host": "0.0.0.0",
|
||||||
|
"webhook_port": 18791,
|
||||||
|
"webhook_path": "/webhook/line",
|
||||||
|
"allow_from": []
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"providers": {
|
"providers": {
|
||||||
|
|
@ -104,6 +113,10 @@
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"interval": 30
|
"interval": 30
|
||||||
},
|
},
|
||||||
|
"devices": {
|
||||||
|
"enabled": false,
|
||||||
|
"monitor_usb": true
|
||||||
|
},
|
||||||
"gateway": {
|
"gateway": {
|
||||||
"host": "0.0.0.0",
|
"host": "0.0.0.0",
|
||||||
"port": 18790
|
"port": 18790
|
||||||
|
|
|
||||||
|
|
@ -77,8 +77,6 @@ func NewAgentLoop(cfg *config.Config, msgBus *bus.MessageBus, provider providers
|
||||||
|
|
||||||
// registerSharedTools registers tools that are shared across all agents (web, message, spawn).
|
// registerSharedTools registers tools that are shared across all agents (web, message, spawn).
|
||||||
func registerSharedTools(cfg *config.Config, msgBus *bus.MessageBus, registry *AgentRegistry, provider providers.LLMProvider) {
|
func registerSharedTools(cfg *config.Config, msgBus *bus.MessageBus, registry *AgentRegistry, provider providers.LLMProvider) {
|
||||||
braveAPIKey := cfg.Tools.Web.Search.APIKey
|
|
||||||
|
|
||||||
for _, agentID := range registry.ListAgentIDs() {
|
for _, agentID := range registry.ListAgentIDs() {
|
||||||
agent, ok := registry.GetAgent(agentID)
|
agent, ok := registry.GetAgent(agentID)
|
||||||
if !ok {
|
if !ok {
|
||||||
|
|
@ -86,9 +84,21 @@ func registerSharedTools(cfg *config.Config, msgBus *bus.MessageBus, registry *A
|
||||||
}
|
}
|
||||||
|
|
||||||
// Web tools
|
// Web tools
|
||||||
agent.Tools.Register(tools.NewWebSearchTool(braveAPIKey, cfg.Tools.Web.Search.MaxResults))
|
if searchTool := tools.NewWebSearchTool(tools.WebSearchToolOptions{
|
||||||
|
BraveAPIKey: cfg.Tools.Web.Brave.APIKey,
|
||||||
|
BraveMaxResults: cfg.Tools.Web.Brave.MaxResults,
|
||||||
|
BraveEnabled: cfg.Tools.Web.Brave.Enabled,
|
||||||
|
DuckDuckGoMaxResults: cfg.Tools.Web.DuckDuckGo.MaxResults,
|
||||||
|
DuckDuckGoEnabled: cfg.Tools.Web.DuckDuckGo.Enabled,
|
||||||
|
}); searchTool != nil {
|
||||||
|
agent.Tools.Register(searchTool)
|
||||||
|
}
|
||||||
agent.Tools.Register(tools.NewWebFetchTool(50000))
|
agent.Tools.Register(tools.NewWebFetchTool(50000))
|
||||||
|
|
||||||
|
// Hardware tools (I2C, SPI) - Linux only, returns error on other platforms
|
||||||
|
agent.Tools.Register(tools.NewI2CTool())
|
||||||
|
agent.Tools.Register(tools.NewSPITool())
|
||||||
|
|
||||||
// Message tool
|
// Message tool
|
||||||
messageTool := tools.NewMessageTool()
|
messageTool := tools.NewMessageTool()
|
||||||
messageTool.SetSendCallback(func(channel, chatID, content string) error {
|
messageTool.SetSendCallback(func(channel, chatID, content string) error {
|
||||||
|
|
|
||||||
|
|
@ -58,7 +58,22 @@ func (c *BaseChannel) IsAllowed(senderID string) bool {
|
||||||
for _, allowed := range c.allowList {
|
for _, allowed := range c.allowList {
|
||||||
// Strip leading "@" from allowed value for username matching
|
// Strip leading "@" from allowed value for username matching
|
||||||
trimmed := strings.TrimPrefix(allowed, "@")
|
trimmed := strings.TrimPrefix(allowed, "@")
|
||||||
if senderID == allowed || idPart == allowed || senderID == trimmed || idPart == trimmed || (userPart != "" && (userPart == allowed || userPart == trimmed)) {
|
allowedID := trimmed
|
||||||
|
allowedUser := ""
|
||||||
|
if idx := strings.Index(trimmed, "|"); idx > 0 {
|
||||||
|
allowedID = trimmed[:idx]
|
||||||
|
allowedUser = trimmed[idx+1:]
|
||||||
|
}
|
||||||
|
|
||||||
|
// Support either side using "id|username" compound form.
|
||||||
|
// This keeps backward compatibility with legacy Telegram allowlist entries.
|
||||||
|
if senderID == allowed ||
|
||||||
|
idPart == allowed ||
|
||||||
|
senderID == trimmed ||
|
||||||
|
idPart == trimmed ||
|
||||||
|
idPart == allowedID ||
|
||||||
|
(allowedUser != "" && senderID == allowedUser) ||
|
||||||
|
(userPart != "" && (userPart == allowed || userPart == trimmed || userPart == allowedUser)) {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
52
pkg/channels/base_test.go
Normal file
52
pkg/channels/base_test.go
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
package channels
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
func TestBaseChannelIsAllowed(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
allowList []string
|
||||||
|
senderID string
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "empty allowlist allows all",
|
||||||
|
allowList: nil,
|
||||||
|
senderID: "anyone",
|
||||||
|
want: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "compound sender matches numeric allowlist",
|
||||||
|
allowList: []string{"123456"},
|
||||||
|
senderID: "123456|alice",
|
||||||
|
want: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "compound sender matches username allowlist",
|
||||||
|
allowList: []string{"@alice"},
|
||||||
|
senderID: "123456|alice",
|
||||||
|
want: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "numeric sender matches legacy compound allowlist",
|
||||||
|
allowList: []string{"123456|alice"},
|
||||||
|
senderID: "123456",
|
||||||
|
want: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "non matching sender is denied",
|
||||||
|
allowList: []string{"123456"},
|
||||||
|
senderID: "654321|bob",
|
||||||
|
want: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
ch := NewBaseChannel("test", nil, nil, tt.allowList)
|
||||||
|
if got := ch.IsAllowed(tt.senderID); got != tt.want {
|
||||||
|
t.Fatalf("IsAllowed(%q) = %v, want %v", tt.senderID, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
36
pkg/channels/feishu_32.go
Normal file
36
pkg/channels/feishu_32.go
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
//go:build !amd64 && !arm64 && !riscv64 && !mips64 && !ppc64
|
||||||
|
|
||||||
|
package channels
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
|
||||||
|
"github.com/sipeed/picoclaw/pkg/bus"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// FeishuChannel is a stub implementation for 32-bit architectures
|
||||||
|
type FeishuChannel struct {
|
||||||
|
*BaseChannel
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewFeishuChannel returns an error on 32-bit architectures where the Feishu SDK is not supported
|
||||||
|
func NewFeishuChannel(cfg config.FeishuConfig, bus *bus.MessageBus) (*FeishuChannel, error) {
|
||||||
|
return nil, errors.New("feishu channel is not supported on 32-bit architectures (armv7l, 386, etc.). Please use a 64-bit system or disable feishu in your config")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start is a stub method to satisfy the Channel interface
|
||||||
|
func (c *FeishuChannel) Start(ctx context.Context) error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stop is a stub method to satisfy the Channel interface
|
||||||
|
func (c *FeishuChannel) Stop(ctx context.Context) error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Send is a stub method to satisfy the Channel interface
|
||||||
|
func (c *FeishuChannel) Send(ctx context.Context, msg bus.OutboundMessage) error {
|
||||||
|
return errors.New("feishu channel is not supported on 32-bit architectures")
|
||||||
|
}
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
|
//go:build amd64 || arm64 || riscv64 || mips64 || ppc64
|
||||||
|
|
||||||
package channels
|
package channels
|
||||||
|
|
||||||
import (
|
import (
|
||||||
598
pkg/channels/line.go
Normal file
598
pkg/channels/line.go
Normal file
|
|
@ -0,0 +1,598 @@
|
||||||
|
package channels
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"crypto/hmac"
|
||||||
|
"crypto/sha256"
|
||||||
|
"encoding/base64"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/sipeed/picoclaw/pkg/bus"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/config"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/logger"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/utils"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
lineAPIBase = "https://api.line.me/v2/bot"
|
||||||
|
lineDataAPIBase = "https://api-data.line.me/v2/bot"
|
||||||
|
lineReplyEndpoint = lineAPIBase + "/message/reply"
|
||||||
|
linePushEndpoint = lineAPIBase + "/message/push"
|
||||||
|
lineContentEndpoint = lineDataAPIBase + "/message/%s/content"
|
||||||
|
lineBotInfoEndpoint = lineAPIBase + "/info"
|
||||||
|
lineLoadingEndpoint = lineAPIBase + "/chat/loading/start"
|
||||||
|
lineReplyTokenMaxAge = 25 * time.Second
|
||||||
|
)
|
||||||
|
|
||||||
|
type replyTokenEntry struct {
|
||||||
|
token string
|
||||||
|
timestamp time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// LINEChannel implements the Channel interface for LINE Official Account
|
||||||
|
// using the LINE Messaging API with HTTP webhook for receiving messages
|
||||||
|
// and REST API for sending messages.
|
||||||
|
type LINEChannel struct {
|
||||||
|
*BaseChannel
|
||||||
|
config config.LINEConfig
|
||||||
|
httpServer *http.Server
|
||||||
|
botUserID string // Bot's user ID
|
||||||
|
botBasicID string // Bot's basic ID (e.g. @216ru...)
|
||||||
|
botDisplayName string // Bot's display name for text-based mention detection
|
||||||
|
replyTokens sync.Map // chatID -> replyTokenEntry
|
||||||
|
quoteTokens sync.Map // chatID -> quoteToken (string)
|
||||||
|
ctx context.Context
|
||||||
|
cancel context.CancelFunc
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewLINEChannel creates a new LINE channel instance.
|
||||||
|
func NewLINEChannel(cfg config.LINEConfig, messageBus *bus.MessageBus) (*LINEChannel, error) {
|
||||||
|
if cfg.ChannelSecret == "" || cfg.ChannelAccessToken == "" {
|
||||||
|
return nil, fmt.Errorf("line channel_secret and channel_access_token are required")
|
||||||
|
}
|
||||||
|
|
||||||
|
base := NewBaseChannel("line", cfg, messageBus, cfg.AllowFrom)
|
||||||
|
|
||||||
|
return &LINEChannel{
|
||||||
|
BaseChannel: base,
|
||||||
|
config: cfg,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start launches the HTTP webhook server.
|
||||||
|
func (c *LINEChannel) Start(ctx context.Context) error {
|
||||||
|
logger.InfoC("line", "Starting LINE channel (Webhook Mode)")
|
||||||
|
|
||||||
|
c.ctx, c.cancel = context.WithCancel(ctx)
|
||||||
|
|
||||||
|
// Fetch bot profile to get bot's userId for mention detection
|
||||||
|
if err := c.fetchBotInfo(); err != nil {
|
||||||
|
logger.WarnCF("line", "Failed to fetch bot info (mention detection disabled)", map[string]interface{}{
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
logger.InfoCF("line", "Bot info fetched", map[string]interface{}{
|
||||||
|
"bot_user_id": c.botUserID,
|
||||||
|
"basic_id": c.botBasicID,
|
||||||
|
"display_name": c.botDisplayName,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
path := c.config.WebhookPath
|
||||||
|
if path == "" {
|
||||||
|
path = "/webhook/line"
|
||||||
|
}
|
||||||
|
mux.HandleFunc(path, c.webhookHandler)
|
||||||
|
|
||||||
|
addr := fmt.Sprintf("%s:%d", c.config.WebhookHost, c.config.WebhookPort)
|
||||||
|
c.httpServer = &http.Server{
|
||||||
|
Addr: addr,
|
||||||
|
Handler: mux,
|
||||||
|
}
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
logger.InfoCF("line", "LINE webhook server listening", map[string]interface{}{
|
||||||
|
"addr": addr,
|
||||||
|
"path": path,
|
||||||
|
})
|
||||||
|
if err := c.httpServer.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
||||||
|
logger.ErrorCF("line", "Webhook server error", map[string]interface{}{
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
c.setRunning(true)
|
||||||
|
logger.InfoC("line", "LINE channel started (Webhook Mode)")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// fetchBotInfo retrieves the bot's userId, basicId, and displayName from the LINE API.
|
||||||
|
func (c *LINEChannel) fetchBotInfo() error {
|
||||||
|
req, err := http.NewRequest(http.MethodGet, lineBotInfoEndpoint, nil)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
req.Header.Set("Authorization", "Bearer "+c.config.ChannelAccessToken)
|
||||||
|
|
||||||
|
client := &http.Client{Timeout: 10 * time.Second}
|
||||||
|
resp, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
return fmt.Errorf("bot info API returned status %d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
var info struct {
|
||||||
|
UserID string `json:"userId"`
|
||||||
|
BasicID string `json:"basicId"`
|
||||||
|
DisplayName string `json:"displayName"`
|
||||||
|
}
|
||||||
|
if err := json.NewDecoder(resp.Body).Decode(&info); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
c.botUserID = info.UserID
|
||||||
|
c.botBasicID = info.BasicID
|
||||||
|
c.botDisplayName = info.DisplayName
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stop gracefully shuts down the HTTP server.
|
||||||
|
func (c *LINEChannel) Stop(ctx context.Context) error {
|
||||||
|
logger.InfoC("line", "Stopping LINE channel")
|
||||||
|
|
||||||
|
if c.cancel != nil {
|
||||||
|
c.cancel()
|
||||||
|
}
|
||||||
|
|
||||||
|
if c.httpServer != nil {
|
||||||
|
shutdownCtx, cancel := context.WithTimeout(ctx, 5*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
if err := c.httpServer.Shutdown(shutdownCtx); err != nil {
|
||||||
|
logger.ErrorCF("line", "Webhook server shutdown error", map[string]interface{}{
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
c.setRunning(false)
|
||||||
|
logger.InfoC("line", "LINE channel stopped")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// webhookHandler handles incoming LINE webhook requests.
|
||||||
|
func (c *LINEChannel) webhookHandler(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method != http.MethodPost {
|
||||||
|
http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
body, err := io.ReadAll(r.Body)
|
||||||
|
if err != nil {
|
||||||
|
logger.ErrorCF("line", "Failed to read request body", map[string]interface{}{
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
http.Error(w, "Bad request", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
signature := r.Header.Get("X-Line-Signature")
|
||||||
|
if !c.verifySignature(body, signature) {
|
||||||
|
logger.WarnC("line", "Invalid webhook signature")
|
||||||
|
http.Error(w, "Forbidden", http.StatusForbidden)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
var payload struct {
|
||||||
|
Events []lineEvent `json:"events"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal(body, &payload); err != nil {
|
||||||
|
logger.ErrorCF("line", "Failed to parse webhook payload", map[string]interface{}{
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
http.Error(w, "Bad request", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return 200 immediately, process events asynchronously
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
|
||||||
|
for _, event := range payload.Events {
|
||||||
|
go c.processEvent(event)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// verifySignature validates the X-Line-Signature using HMAC-SHA256.
|
||||||
|
func (c *LINEChannel) verifySignature(body []byte, signature string) bool {
|
||||||
|
if signature == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
mac := hmac.New(sha256.New, []byte(c.config.ChannelSecret))
|
||||||
|
mac.Write(body)
|
||||||
|
expected := base64.StdEncoding.EncodeToString(mac.Sum(nil))
|
||||||
|
|
||||||
|
return hmac.Equal([]byte(expected), []byte(signature))
|
||||||
|
}
|
||||||
|
|
||||||
|
// LINE webhook event types
|
||||||
|
type lineEvent struct {
|
||||||
|
Type string `json:"type"`
|
||||||
|
ReplyToken string `json:"replyToken"`
|
||||||
|
Source lineSource `json:"source"`
|
||||||
|
Message json.RawMessage `json:"message"`
|
||||||
|
Timestamp int64 `json:"timestamp"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type lineSource struct {
|
||||||
|
Type string `json:"type"` // "user", "group", "room"
|
||||||
|
UserID string `json:"userId"`
|
||||||
|
GroupID string `json:"groupId"`
|
||||||
|
RoomID string `json:"roomId"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type lineMessage struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Type string `json:"type"` // "text", "image", "video", "audio", "file", "sticker"
|
||||||
|
Text string `json:"text"`
|
||||||
|
QuoteToken string `json:"quoteToken"`
|
||||||
|
Mention *struct {
|
||||||
|
Mentionees []lineMentionee `json:"mentionees"`
|
||||||
|
} `json:"mention"`
|
||||||
|
ContentProvider struct {
|
||||||
|
Type string `json:"type"`
|
||||||
|
} `json:"contentProvider"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type lineMentionee struct {
|
||||||
|
Index int `json:"index"`
|
||||||
|
Length int `json:"length"`
|
||||||
|
Type string `json:"type"` // "user", "all"
|
||||||
|
UserID string `json:"userId"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *LINEChannel) processEvent(event lineEvent) {
|
||||||
|
if event.Type != "message" {
|
||||||
|
logger.DebugCF("line", "Ignoring non-message event", map[string]interface{}{
|
||||||
|
"type": event.Type,
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
senderID := event.Source.UserID
|
||||||
|
chatID := c.resolveChatID(event.Source)
|
||||||
|
isGroup := event.Source.Type == "group" || event.Source.Type == "room"
|
||||||
|
|
||||||
|
var msg lineMessage
|
||||||
|
if err := json.Unmarshal(event.Message, &msg); err != nil {
|
||||||
|
logger.ErrorCF("line", "Failed to parse message", map[string]interface{}{
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// In group chats, only respond when the bot is mentioned
|
||||||
|
if isGroup && !c.isBotMentioned(msg) {
|
||||||
|
logger.DebugCF("line", "Ignoring group message without mention", map[string]interface{}{
|
||||||
|
"chat_id": chatID,
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store reply token for later use
|
||||||
|
if event.ReplyToken != "" {
|
||||||
|
c.replyTokens.Store(chatID, replyTokenEntry{
|
||||||
|
token: event.ReplyToken,
|
||||||
|
timestamp: time.Now(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Store quote token for quoting the original message in reply
|
||||||
|
if msg.QuoteToken != "" {
|
||||||
|
c.quoteTokens.Store(chatID, msg.QuoteToken)
|
||||||
|
}
|
||||||
|
|
||||||
|
var content string
|
||||||
|
var mediaPaths []string
|
||||||
|
localFiles := []string{}
|
||||||
|
|
||||||
|
defer func() {
|
||||||
|
for _, file := range localFiles {
|
||||||
|
if err := os.Remove(file); err != nil {
|
||||||
|
logger.DebugCF("line", "Failed to cleanup temp file", map[string]interface{}{
|
||||||
|
"file": file,
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
switch msg.Type {
|
||||||
|
case "text":
|
||||||
|
content = msg.Text
|
||||||
|
// Strip bot mention from text in group chats
|
||||||
|
if isGroup {
|
||||||
|
content = c.stripBotMention(content, msg)
|
||||||
|
}
|
||||||
|
case "image":
|
||||||
|
localPath := c.downloadContent(msg.ID, "image.jpg")
|
||||||
|
if localPath != "" {
|
||||||
|
localFiles = append(localFiles, localPath)
|
||||||
|
mediaPaths = append(mediaPaths, localPath)
|
||||||
|
content = "[image]"
|
||||||
|
}
|
||||||
|
case "audio":
|
||||||
|
localPath := c.downloadContent(msg.ID, "audio.m4a")
|
||||||
|
if localPath != "" {
|
||||||
|
localFiles = append(localFiles, localPath)
|
||||||
|
mediaPaths = append(mediaPaths, localPath)
|
||||||
|
content = "[audio]"
|
||||||
|
}
|
||||||
|
case "video":
|
||||||
|
localPath := c.downloadContent(msg.ID, "video.mp4")
|
||||||
|
if localPath != "" {
|
||||||
|
localFiles = append(localFiles, localPath)
|
||||||
|
mediaPaths = append(mediaPaths, localPath)
|
||||||
|
content = "[video]"
|
||||||
|
}
|
||||||
|
case "file":
|
||||||
|
content = "[file]"
|
||||||
|
case "sticker":
|
||||||
|
content = "[sticker]"
|
||||||
|
default:
|
||||||
|
content = fmt.Sprintf("[%s]", msg.Type)
|
||||||
|
}
|
||||||
|
|
||||||
|
if strings.TrimSpace(content) == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
metadata := map[string]string{
|
||||||
|
"platform": "line",
|
||||||
|
"source_type": event.Source.Type,
|
||||||
|
"message_id": msg.ID,
|
||||||
|
}
|
||||||
|
|
||||||
|
logger.DebugCF("line", "Received message", map[string]interface{}{
|
||||||
|
"sender_id": senderID,
|
||||||
|
"chat_id": chatID,
|
||||||
|
"message_type": msg.Type,
|
||||||
|
"is_group": isGroup,
|
||||||
|
"preview": utils.Truncate(content, 50),
|
||||||
|
})
|
||||||
|
|
||||||
|
// Show typing/loading indicator (requires user ID, not group ID)
|
||||||
|
c.sendLoading(senderID)
|
||||||
|
|
||||||
|
c.HandleMessage(senderID, chatID, content, mediaPaths, metadata)
|
||||||
|
}
|
||||||
|
|
||||||
|
// isBotMentioned checks if the bot is mentioned in the message.
|
||||||
|
// It first checks the mention metadata (userId match), then falls back
|
||||||
|
// to text-based detection using the bot's display name, since LINE may
|
||||||
|
// not include userId in mentionees for Official Accounts.
|
||||||
|
func (c *LINEChannel) isBotMentioned(msg lineMessage) bool {
|
||||||
|
// Check mention metadata
|
||||||
|
if msg.Mention != nil {
|
||||||
|
for _, m := range msg.Mention.Mentionees {
|
||||||
|
if m.Type == "all" {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if c.botUserID != "" && m.UserID == c.botUserID {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Mention metadata exists with mentionees but bot not matched by userId.
|
||||||
|
// The bot IS likely mentioned (LINE includes mention struct when bot is @-ed),
|
||||||
|
// so check if any mentionee overlaps with bot display name in text.
|
||||||
|
if c.botDisplayName != "" {
|
||||||
|
for _, m := range msg.Mention.Mentionees {
|
||||||
|
if m.Index >= 0 && m.Length > 0 {
|
||||||
|
runes := []rune(msg.Text)
|
||||||
|
end := m.Index + m.Length
|
||||||
|
if end <= len(runes) {
|
||||||
|
mentionText := string(runes[m.Index:end])
|
||||||
|
if strings.Contains(mentionText, c.botDisplayName) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback: text-based detection with display name
|
||||||
|
if c.botDisplayName != "" && strings.Contains(msg.Text, "@"+c.botDisplayName) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// stripBotMention removes the @BotName mention text from the message.
|
||||||
|
func (c *LINEChannel) stripBotMention(text string, msg lineMessage) string {
|
||||||
|
stripped := false
|
||||||
|
|
||||||
|
// Try to strip using mention metadata indices
|
||||||
|
if msg.Mention != nil {
|
||||||
|
runes := []rune(text)
|
||||||
|
for i := len(msg.Mention.Mentionees) - 1; i >= 0; i-- {
|
||||||
|
m := msg.Mention.Mentionees[i]
|
||||||
|
// Strip if userId matches OR if the mention text contains the bot display name
|
||||||
|
shouldStrip := false
|
||||||
|
if c.botUserID != "" && m.UserID == c.botUserID {
|
||||||
|
shouldStrip = true
|
||||||
|
} else if c.botDisplayName != "" && m.Index >= 0 && m.Length > 0 {
|
||||||
|
end := m.Index + m.Length
|
||||||
|
if end <= len(runes) {
|
||||||
|
mentionText := string(runes[m.Index:end])
|
||||||
|
if strings.Contains(mentionText, c.botDisplayName) {
|
||||||
|
shouldStrip = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if shouldStrip {
|
||||||
|
start := m.Index
|
||||||
|
end := m.Index + m.Length
|
||||||
|
if start >= 0 && end <= len(runes) {
|
||||||
|
runes = append(runes[:start], runes[end:]...)
|
||||||
|
stripped = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if stripped {
|
||||||
|
return strings.TrimSpace(string(runes))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fallback: strip @DisplayName from text
|
||||||
|
if c.botDisplayName != "" {
|
||||||
|
text = strings.ReplaceAll(text, "@"+c.botDisplayName, "")
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.TrimSpace(text)
|
||||||
|
}
|
||||||
|
|
||||||
|
// resolveChatID determines the chat ID from the event source.
|
||||||
|
// For group/room messages, use the group/room ID; for 1:1, use the user ID.
|
||||||
|
func (c *LINEChannel) resolveChatID(source lineSource) string {
|
||||||
|
switch source.Type {
|
||||||
|
case "group":
|
||||||
|
return source.GroupID
|
||||||
|
case "room":
|
||||||
|
return source.RoomID
|
||||||
|
default:
|
||||||
|
return source.UserID
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Send sends a message to LINE. It first tries the Reply API (free)
|
||||||
|
// using a cached reply token, then falls back to the Push API.
|
||||||
|
func (c *LINEChannel) Send(ctx context.Context, msg bus.OutboundMessage) error {
|
||||||
|
if !c.IsRunning() {
|
||||||
|
return fmt.Errorf("line channel not running")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load and consume quote token for this chat
|
||||||
|
var quoteToken string
|
||||||
|
if qt, ok := c.quoteTokens.LoadAndDelete(msg.ChatID); ok {
|
||||||
|
quoteToken = qt.(string)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try reply token first (free, valid for ~25 seconds)
|
||||||
|
if entry, ok := c.replyTokens.LoadAndDelete(msg.ChatID); ok {
|
||||||
|
tokenEntry := entry.(replyTokenEntry)
|
||||||
|
if time.Since(tokenEntry.timestamp) < lineReplyTokenMaxAge {
|
||||||
|
if err := c.sendReply(ctx, tokenEntry.token, msg.Content, quoteToken); err == nil {
|
||||||
|
logger.DebugCF("line", "Message sent via Reply API", map[string]interface{}{
|
||||||
|
"chat_id": msg.ChatID,
|
||||||
|
"quoted": quoteToken != "",
|
||||||
|
})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
logger.DebugC("line", "Reply API failed, falling back to Push API")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fall back to Push API
|
||||||
|
return c.sendPush(ctx, msg.ChatID, msg.Content, quoteToken)
|
||||||
|
}
|
||||||
|
|
||||||
|
// buildTextMessage creates a text message object, optionally with quoteToken.
|
||||||
|
func buildTextMessage(content, quoteToken string) map[string]string {
|
||||||
|
msg := map[string]string{
|
||||||
|
"type": "text",
|
||||||
|
"text": content,
|
||||||
|
}
|
||||||
|
if quoteToken != "" {
|
||||||
|
msg["quoteToken"] = quoteToken
|
||||||
|
}
|
||||||
|
return msg
|
||||||
|
}
|
||||||
|
|
||||||
|
// sendReply sends a message using the LINE Reply API.
|
||||||
|
func (c *LINEChannel) sendReply(ctx context.Context, replyToken, content, quoteToken string) error {
|
||||||
|
payload := map[string]interface{}{
|
||||||
|
"replyToken": replyToken,
|
||||||
|
"messages": []map[string]string{buildTextMessage(content, quoteToken)},
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.callAPI(ctx, lineReplyEndpoint, payload)
|
||||||
|
}
|
||||||
|
|
||||||
|
// sendPush sends a message using the LINE Push API.
|
||||||
|
func (c *LINEChannel) sendPush(ctx context.Context, to, content, quoteToken string) error {
|
||||||
|
payload := map[string]interface{}{
|
||||||
|
"to": to,
|
||||||
|
"messages": []map[string]string{buildTextMessage(content, quoteToken)},
|
||||||
|
}
|
||||||
|
|
||||||
|
return c.callAPI(ctx, linePushEndpoint, payload)
|
||||||
|
}
|
||||||
|
|
||||||
|
// sendLoading sends a loading animation indicator to the chat.
|
||||||
|
func (c *LINEChannel) sendLoading(chatID string) {
|
||||||
|
payload := map[string]interface{}{
|
||||||
|
"chatId": chatID,
|
||||||
|
"loadingSeconds": 60,
|
||||||
|
}
|
||||||
|
if err := c.callAPI(c.ctx, lineLoadingEndpoint, payload); err != nil {
|
||||||
|
logger.DebugCF("line", "Failed to send loading indicator", map[string]interface{}{
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// callAPI makes an authenticated POST request to the LINE API.
|
||||||
|
func (c *LINEChannel) callAPI(ctx context.Context, endpoint string, payload interface{}) error {
|
||||||
|
body, err := json.Marshal(payload)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to marshal payload: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, bytes.NewReader(body))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to create request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
req.Header.Set("Authorization", "Bearer "+c.config.ChannelAccessToken)
|
||||||
|
|
||||||
|
client := &http.Client{Timeout: 30 * time.Second}
|
||||||
|
resp, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("API request failed: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
respBody, _ := io.ReadAll(resp.Body)
|
||||||
|
return fmt.Errorf("LINE API error (status %d): %s", resp.StatusCode, string(respBody))
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// downloadContent downloads media content from the LINE API.
|
||||||
|
func (c *LINEChannel) downloadContent(messageID, filename string) string {
|
||||||
|
url := fmt.Sprintf(lineContentEndpoint, messageID)
|
||||||
|
return utils.DownloadFile(url, filename, utils.DownloadOptions{
|
||||||
|
LoggerPrefix: "line",
|
||||||
|
ExtraHeaders: map[string]string{
|
||||||
|
"Authorization": "Bearer " + c.config.ChannelAccessToken,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
@ -150,6 +150,19 @@ func (m *Manager) initChannels() error {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if m.config.Channels.LINE.Enabled && m.config.Channels.LINE.ChannelAccessToken != "" {
|
||||||
|
logger.DebugC("channels", "Attempting to initialize LINE channel")
|
||||||
|
line, err := NewLINEChannel(m.config.Channels.LINE, m.bus)
|
||||||
|
if err != nil {
|
||||||
|
logger.ErrorCF("channels", "Failed to initialize LINE channel", map[string]interface{}{
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
m.channels["line"] = line
|
||||||
|
logger.InfoC("channels", "LINE channel enabled successfully")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
logger.InfoCF("channels", "Channel initialization completed", map[string]interface{}{
|
logger.InfoCF("channels", "Channel initialization completed", map[string]interface{}{
|
||||||
"enabled_channels": len(m.channels),
|
"enabled_channels": len(m.channels),
|
||||||
})
|
})
|
||||||
|
|
|
||||||
|
|
@ -177,15 +177,17 @@ func (c *TelegramChannel) handleMessage(ctx context.Context, update telego.Updat
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
senderID := fmt.Sprintf("%d", user.ID)
|
userID := fmt.Sprintf("%d", user.ID)
|
||||||
|
senderID := userID
|
||||||
if user.Username != "" {
|
if user.Username != "" {
|
||||||
senderID = fmt.Sprintf("%d|%s", user.ID, user.Username)
|
senderID = fmt.Sprintf("%s|%s", userID, user.Username)
|
||||||
}
|
}
|
||||||
|
|
||||||
// 检查白名单,避免为被拒绝的用户下载附件
|
// 检查白名单,避免为被拒绝的用户下载附件
|
||||||
if !c.IsAllowed(senderID) {
|
if !c.IsAllowed(userID) && !c.IsAllowed(senderID) {
|
||||||
logger.DebugCF("telegram", "Message rejected by allowlist", map[string]interface{}{
|
logger.DebugCF("telegram", "Message rejected by allowlist", map[string]interface{}{
|
||||||
"user_id": senderID,
|
"user_id": userID,
|
||||||
|
"username": user.Username,
|
||||||
})
|
})
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
@ -368,7 +370,7 @@ func (c *TelegramChannel) handleMessage(ctx context.Context, update telego.Updat
|
||||||
"peer_id": peerID,
|
"peer_id": peerID,
|
||||||
}
|
}
|
||||||
|
|
||||||
c.HandleMessage(fmt.Sprintf("%d", user.ID), fmt.Sprintf("%d", chatID), content, mediaPaths, metadata)
|
c.HandleMessage(senderID, fmt.Sprintf("%d", chatID), content, mediaPaths, metadata)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *TelegramChannel) downloadPhoto(ctx context.Context, fileID string) string {
|
func (c *TelegramChannel) downloadPhoto(ctx context.Context, fileID string) string {
|
||||||
|
|
|
||||||
|
|
@ -52,6 +52,7 @@ type Config struct {
|
||||||
Gateway GatewayConfig `json:"gateway"`
|
Gateway GatewayConfig `json:"gateway"`
|
||||||
Tools ToolsConfig `json:"tools"`
|
Tools ToolsConfig `json:"tools"`
|
||||||
Heartbeat HeartbeatConfig `json:"heartbeat"`
|
Heartbeat HeartbeatConfig `json:"heartbeat"`
|
||||||
|
Devices DevicesConfig `json:"devices"`
|
||||||
mu sync.RWMutex
|
mu sync.RWMutex
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -159,6 +160,7 @@ type ChannelsConfig struct {
|
||||||
QQ QQConfig `json:"qq"`
|
QQ QQConfig `json:"qq"`
|
||||||
DingTalk DingTalkConfig `json:"dingtalk"`
|
DingTalk DingTalkConfig `json:"dingtalk"`
|
||||||
Slack SlackConfig `json:"slack"`
|
Slack SlackConfig `json:"slack"`
|
||||||
|
LINE LINEConfig `json:"line"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type WhatsAppConfig struct {
|
type WhatsAppConfig struct {
|
||||||
|
|
@ -217,11 +219,26 @@ type SlackConfig struct {
|
||||||
AllowFrom []string `json:"allow_from" env:"PICOCLAW_CHANNELS_SLACK_ALLOW_FROM"`
|
AllowFrom []string `json:"allow_from" env:"PICOCLAW_CHANNELS_SLACK_ALLOW_FROM"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type LINEConfig struct {
|
||||||
|
Enabled bool `json:"enabled" env:"PICOCLAW_CHANNELS_LINE_ENABLED"`
|
||||||
|
ChannelSecret string `json:"channel_secret" env:"PICOCLAW_CHANNELS_LINE_CHANNEL_SECRET"`
|
||||||
|
ChannelAccessToken string `json:"channel_access_token" env:"PICOCLAW_CHANNELS_LINE_CHANNEL_ACCESS_TOKEN"`
|
||||||
|
WebhookHost string `json:"webhook_host" env:"PICOCLAW_CHANNELS_LINE_WEBHOOK_HOST"`
|
||||||
|
WebhookPort int `json:"webhook_port" env:"PICOCLAW_CHANNELS_LINE_WEBHOOK_PORT"`
|
||||||
|
WebhookPath string `json:"webhook_path" env:"PICOCLAW_CHANNELS_LINE_WEBHOOK_PATH"`
|
||||||
|
AllowFrom FlexibleStringSlice `json:"allow_from" env:"PICOCLAW_CHANNELS_LINE_ALLOW_FROM"`
|
||||||
|
}
|
||||||
|
|
||||||
type HeartbeatConfig struct {
|
type HeartbeatConfig struct {
|
||||||
Enabled bool `json:"enabled" env:"PICOCLAW_HEARTBEAT_ENABLED"`
|
Enabled bool `json:"enabled" env:"PICOCLAW_HEARTBEAT_ENABLED"`
|
||||||
Interval int `json:"interval" env:"PICOCLAW_HEARTBEAT_INTERVAL"` // minutes, min 5
|
Interval int `json:"interval" env:"PICOCLAW_HEARTBEAT_INTERVAL"` // minutes, min 5
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type DevicesConfig struct {
|
||||||
|
Enabled bool `json:"enabled" env:"PICOCLAW_DEVICES_ENABLED"`
|
||||||
|
MonitorUSB bool `json:"monitor_usb" env:"PICOCLAW_DEVICES_MONITOR_USB"`
|
||||||
|
}
|
||||||
|
|
||||||
type ProvidersConfig struct {
|
type ProvidersConfig struct {
|
||||||
Anthropic ProviderConfig `json:"anthropic"`
|
Anthropic ProviderConfig `json:"anthropic"`
|
||||||
OpenAI ProviderConfig `json:"openai"`
|
OpenAI ProviderConfig `json:"openai"`
|
||||||
|
|
@ -233,6 +250,7 @@ type ProvidersConfig struct {
|
||||||
Nvidia ProviderConfig `json:"nvidia"`
|
Nvidia ProviderConfig `json:"nvidia"`
|
||||||
Moonshot ProviderConfig `json:"moonshot"`
|
Moonshot ProviderConfig `json:"moonshot"`
|
||||||
ShengSuanYun ProviderConfig `json:"shengsuanyun"`
|
ShengSuanYun ProviderConfig `json:"shengsuanyun"`
|
||||||
|
DeepSeek ProviderConfig `json:"deepseek"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type ProviderConfig struct {
|
type ProviderConfig struct {
|
||||||
|
|
@ -247,13 +265,20 @@ type GatewayConfig struct {
|
||||||
Port int `json:"port" env:"PICOCLAW_GATEWAY_PORT"`
|
Port int `json:"port" env:"PICOCLAW_GATEWAY_PORT"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type WebSearchConfig struct {
|
type BraveConfig struct {
|
||||||
APIKey string `json:"api_key" env:"PICOCLAW_TOOLS_WEB_SEARCH_API_KEY"`
|
Enabled bool `json:"enabled" env:"PICOCLAW_TOOLS_WEB_BRAVE_ENABLED"`
|
||||||
MaxResults int `json:"max_results" env:"PICOCLAW_TOOLS_WEB_SEARCH_MAX_RESULTS"`
|
APIKey string `json:"api_key" env:"PICOCLAW_TOOLS_WEB_BRAVE_API_KEY"`
|
||||||
|
MaxResults int `json:"max_results" env:"PICOCLAW_TOOLS_WEB_BRAVE_MAX_RESULTS"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type DuckDuckGoConfig struct {
|
||||||
|
Enabled bool `json:"enabled" env:"PICOCLAW_TOOLS_WEB_DUCKDUCKGO_ENABLED"`
|
||||||
|
MaxResults int `json:"max_results" env:"PICOCLAW_TOOLS_WEB_DUCKDUCKGO_MAX_RESULTS"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type WebToolsConfig struct {
|
type WebToolsConfig struct {
|
||||||
Search WebSearchConfig `json:"search"`
|
Brave BraveConfig `json:"brave"`
|
||||||
|
DuckDuckGo DuckDuckGoConfig `json:"duckduckgo"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type ToolsConfig struct {
|
type ToolsConfig struct {
|
||||||
|
|
@ -321,6 +346,15 @@ func DefaultConfig() *Config {
|
||||||
AppToken: "",
|
AppToken: "",
|
||||||
AllowFrom: []string{},
|
AllowFrom: []string{},
|
||||||
},
|
},
|
||||||
|
LINE: LINEConfig{
|
||||||
|
Enabled: false,
|
||||||
|
ChannelSecret: "",
|
||||||
|
ChannelAccessToken: "",
|
||||||
|
WebhookHost: "0.0.0.0",
|
||||||
|
WebhookPort: 18791,
|
||||||
|
WebhookPath: "/webhook/line",
|
||||||
|
AllowFrom: FlexibleStringSlice{},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
Providers: ProvidersConfig{
|
Providers: ProvidersConfig{
|
||||||
Anthropic: ProviderConfig{},
|
Anthropic: ProviderConfig{},
|
||||||
|
|
@ -340,16 +374,25 @@ func DefaultConfig() *Config {
|
||||||
},
|
},
|
||||||
Tools: ToolsConfig{
|
Tools: ToolsConfig{
|
||||||
Web: WebToolsConfig{
|
Web: WebToolsConfig{
|
||||||
Search: WebSearchConfig{
|
Brave: BraveConfig{
|
||||||
|
Enabled: false,
|
||||||
APIKey: "",
|
APIKey: "",
|
||||||
MaxResults: 5,
|
MaxResults: 5,
|
||||||
},
|
},
|
||||||
|
DuckDuckGo: DuckDuckGoConfig{
|
||||||
|
Enabled: true,
|
||||||
|
MaxResults: 5,
|
||||||
|
},
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
Heartbeat: HeartbeatConfig{
|
Heartbeat: HeartbeatConfig{
|
||||||
Enabled: true,
|
Enabled: true,
|
||||||
Interval: 30, // default 30 minutes
|
Interval: 30, // default 30 minutes
|
||||||
},
|
},
|
||||||
|
Devices: DevicesConfig{
|
||||||
|
Enabled: false,
|
||||||
|
MonitorUSB: true,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -281,6 +281,22 @@ func TestDefaultConfig_Channels(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestDefaultConfig_WebTools verifies web tools config
|
||||||
|
func TestDefaultConfig_WebTools(t *testing.T) {
|
||||||
|
cfg := DefaultConfig()
|
||||||
|
|
||||||
|
// Verify web tools defaults
|
||||||
|
if cfg.Tools.Web.Brave.MaxResults != 5 {
|
||||||
|
t.Error("Expected Brave MaxResults 5, got ", cfg.Tools.Web.Brave.MaxResults)
|
||||||
|
}
|
||||||
|
if cfg.Tools.Web.Brave.APIKey != "" {
|
||||||
|
t.Error("Brave API key should be empty by default")
|
||||||
|
}
|
||||||
|
if cfg.Tools.Web.DuckDuckGo.MaxResults != 5 {
|
||||||
|
t.Error("Expected DuckDuckGo MaxResults 5, got ", cfg.Tools.Web.DuckDuckGo.MaxResults)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// TestConfig_Complete verifies all config fields are set
|
// TestConfig_Complete verifies all config fields are set
|
||||||
func TestConfig_Complete(t *testing.T) {
|
func TestConfig_Complete(t *testing.T) {
|
||||||
cfg := DefaultConfig()
|
cfg := DefaultConfig()
|
||||||
|
|
|
||||||
57
pkg/devices/events/events.go
Normal file
57
pkg/devices/events/events.go
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
package events
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
type EventSource interface {
|
||||||
|
Kind() Kind
|
||||||
|
Start(ctx context.Context) (<-chan *DeviceEvent, error)
|
||||||
|
Stop() error
|
||||||
|
}
|
||||||
|
|
||||||
|
type Action string
|
||||||
|
|
||||||
|
const (
|
||||||
|
ActionAdd Action = "add"
|
||||||
|
ActionRemove Action = "remove"
|
||||||
|
ActionChange Action = "change"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Kind string
|
||||||
|
|
||||||
|
const (
|
||||||
|
KindUSB Kind = "usb"
|
||||||
|
KindBluetooth Kind = "bluetooth"
|
||||||
|
KindPCI Kind = "pci"
|
||||||
|
KindGeneric Kind = "generic"
|
||||||
|
)
|
||||||
|
|
||||||
|
type DeviceEvent struct {
|
||||||
|
Action Action
|
||||||
|
Kind Kind
|
||||||
|
DeviceID string // e.g. "1-2" for USB bus 1 dev 2
|
||||||
|
Vendor string // Vendor name or ID
|
||||||
|
Product string // Product name or ID
|
||||||
|
Serial string // Serial number if available
|
||||||
|
Capabilities string // Human-readable capability description
|
||||||
|
Raw map[string]string // Raw properties for extensibility
|
||||||
|
}
|
||||||
|
|
||||||
|
func (e *DeviceEvent) FormatMessage() string {
|
||||||
|
actionEmoji := "🔌"
|
||||||
|
actionText := "Connected"
|
||||||
|
if e.Action == ActionRemove {
|
||||||
|
actionEmoji = "🔌"
|
||||||
|
actionText = "Disconnected"
|
||||||
|
}
|
||||||
|
|
||||||
|
msg := actionEmoji + " Device " + actionText + "\n\n"
|
||||||
|
msg += "Type: " + string(e.Kind) + "\n"
|
||||||
|
msg += "Device: " + e.Vendor + " " + e.Product + "\n"
|
||||||
|
if e.Capabilities != "" {
|
||||||
|
msg += "Capabilities: " + e.Capabilities + "\n"
|
||||||
|
}
|
||||||
|
if e.Serial != "" {
|
||||||
|
msg += "Serial: " + e.Serial + "\n"
|
||||||
|
}
|
||||||
|
return msg
|
||||||
|
}
|
||||||
152
pkg/devices/service.go
Normal file
152
pkg/devices/service.go
Normal file
|
|
@ -0,0 +1,152 @@
|
||||||
|
package devices
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
|
||||||
|
"github.com/sipeed/picoclaw/pkg/bus"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/constants"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/devices/events"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/devices/sources"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/logger"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/state"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Service struct {
|
||||||
|
bus *bus.MessageBus
|
||||||
|
state *state.Manager
|
||||||
|
sources []events.EventSource
|
||||||
|
enabled bool
|
||||||
|
ctx context.Context
|
||||||
|
cancel context.CancelFunc
|
||||||
|
mu sync.RWMutex
|
||||||
|
}
|
||||||
|
|
||||||
|
type Config struct {
|
||||||
|
Enabled bool
|
||||||
|
MonitorUSB bool // When true, monitor USB hotplug (Linux only)
|
||||||
|
// Future: MonitorBluetooth, MonitorPCI, etc.
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewService(cfg Config, stateMgr *state.Manager) *Service {
|
||||||
|
s := &Service{
|
||||||
|
state: stateMgr,
|
||||||
|
enabled: cfg.Enabled,
|
||||||
|
sources: make([]EventSource, 0),
|
||||||
|
}
|
||||||
|
|
||||||
|
if cfg.Enabled && cfg.MonitorUSB {
|
||||||
|
s.sources = append(s.sources, sources.NewUSBMonitor())
|
||||||
|
}
|
||||||
|
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) SetBus(msgBus *bus.MessageBus) {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
s.bus = msgBus
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) Start(ctx context.Context) error {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
|
||||||
|
if !s.enabled || len(s.sources) == 0 {
|
||||||
|
logger.InfoC("devices", "Device event service disabled or no sources")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
s.ctx, s.cancel = context.WithCancel(ctx)
|
||||||
|
|
||||||
|
for _, src := range s.sources {
|
||||||
|
eventCh, err := src.Start(s.ctx)
|
||||||
|
if err != nil {
|
||||||
|
logger.ErrorCF("devices", "Failed to start source", map[string]interface{}{
|
||||||
|
"kind": src.Kind(),
|
||||||
|
"error": err.Error(),
|
||||||
|
})
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
go s.handleEvents(src.Kind(), eventCh)
|
||||||
|
logger.InfoCF("devices", "Device source started", map[string]interface{}{
|
||||||
|
"kind": src.Kind(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
logger.InfoC("devices", "Device event service started")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) Stop() {
|
||||||
|
s.mu.Lock()
|
||||||
|
defer s.mu.Unlock()
|
||||||
|
|
||||||
|
if s.cancel != nil {
|
||||||
|
s.cancel()
|
||||||
|
s.cancel = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, src := range s.sources {
|
||||||
|
src.Stop()
|
||||||
|
}
|
||||||
|
|
||||||
|
logger.InfoC("devices", "Device event service stopped")
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) handleEvents(kind events.Kind, eventCh <-chan *events.DeviceEvent) {
|
||||||
|
for ev := range eventCh {
|
||||||
|
if ev == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
s.sendNotification(ev)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) sendNotification(ev *events.DeviceEvent) {
|
||||||
|
s.mu.RLock()
|
||||||
|
msgBus := s.bus
|
||||||
|
s.mu.RUnlock()
|
||||||
|
|
||||||
|
if msgBus == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
lastChannel := s.state.GetLastChannel()
|
||||||
|
if lastChannel == "" {
|
||||||
|
logger.DebugCF("devices", "No last channel, skipping notification", map[string]interface{}{
|
||||||
|
"event": ev.FormatMessage(),
|
||||||
|
})
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
platform, userID := parseLastChannel(lastChannel)
|
||||||
|
if platform == "" || userID == "" || constants.IsInternalChannel(platform) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
msg := ev.FormatMessage()
|
||||||
|
msgBus.PublishOutbound(bus.OutboundMessage{
|
||||||
|
Channel: platform,
|
||||||
|
ChatID: userID,
|
||||||
|
Content: msg,
|
||||||
|
})
|
||||||
|
|
||||||
|
logger.InfoCF("devices", "Device notification sent", map[string]interface{}{
|
||||||
|
"kind": ev.Kind,
|
||||||
|
"action": ev.Action,
|
||||||
|
"to": platform,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseLastChannel(lastChannel string) (platform, userID string) {
|
||||||
|
if lastChannel == "" {
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
parts := strings.SplitN(lastChannel, ":", 2)
|
||||||
|
if len(parts) != 2 || parts[0] == "" || parts[1] == "" {
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
return parts[0], parts[1]
|
||||||
|
}
|
||||||
5
pkg/devices/source.go
Normal file
5
pkg/devices/source.go
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
package devices
|
||||||
|
|
||||||
|
import "github.com/sipeed/picoclaw/pkg/devices/events"
|
||||||
|
|
||||||
|
type EventSource = events.EventSource
|
||||||
198
pkg/devices/sources/usb_linux.go
Normal file
198
pkg/devices/sources/usb_linux.go
Normal file
|
|
@ -0,0 +1,198 @@
|
||||||
|
//go:build linux
|
||||||
|
|
||||||
|
package sources
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os/exec"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
|
||||||
|
"github.com/sipeed/picoclaw/pkg/devices/events"
|
||||||
|
"github.com/sipeed/picoclaw/pkg/logger"
|
||||||
|
)
|
||||||
|
|
||||||
|
var usbClassToCapability = map[string]string{
|
||||||
|
"00": "Interface Definition (by interface)",
|
||||||
|
"01": "Audio",
|
||||||
|
"02": "CDC Communication (Network Card/Modem)",
|
||||||
|
"03": "HID (Keyboard/Mouse/Gamepad)",
|
||||||
|
"05": "Physical Interface",
|
||||||
|
"06": "Image (Scanner/Camera)",
|
||||||
|
"07": "Printer",
|
||||||
|
"08": "Mass Storage (USB Flash Drive/Hard Disk)",
|
||||||
|
"09": "USB Hub",
|
||||||
|
"0a": "CDC Data",
|
||||||
|
"0b": "Smart Card",
|
||||||
|
"0e": "Video (Camera)",
|
||||||
|
"dc": "Diagnostic Device",
|
||||||
|
"e0": "Wireless Controller (Bluetooth)",
|
||||||
|
"ef": "Miscellaneous",
|
||||||
|
"fe": "Application Specific",
|
||||||
|
"ff": "Vendor Specific",
|
||||||
|
}
|
||||||
|
|
||||||
|
type USBMonitor struct {
|
||||||
|
cmd *exec.Cmd
|
||||||
|
cancel context.CancelFunc
|
||||||
|
mu sync.Mutex
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewUSBMonitor() *USBMonitor {
|
||||||
|
return &USBMonitor{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *USBMonitor) Kind() events.Kind {
|
||||||
|
return events.KindUSB
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *USBMonitor) Start(ctx context.Context) (<-chan *events.DeviceEvent, error) {
|
||||||
|
m.mu.Lock()
|
||||||
|
defer m.mu.Unlock()
|
||||||
|
|
||||||
|
// udevadm monitor outputs: UDEV/KERNEL [timestamp] action devpath (subsystem)
|
||||||
|
// Followed by KEY=value lines, empty line separates events
|
||||||
|
// Use -s/--subsystem-match (eudev) or --udev-subsystem-match (systemd udev)
|
||||||
|
cmd := exec.CommandContext(ctx, "udevadm", "monitor", "--property", "--subsystem-match=usb")
|
||||||
|
stdout, err := cmd.StdoutPipe()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("udevadm stdout pipe: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := cmd.Start(); err != nil {
|
||||||
|
return nil, fmt.Errorf("udevadm start: %w (is udevadm installed?)", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
m.cmd = cmd
|
||||||
|
eventCh := make(chan *events.DeviceEvent, 16)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer close(eventCh)
|
||||||
|
scanner := bufio.NewScanner(stdout)
|
||||||
|
var props map[string]string
|
||||||
|
var action string
|
||||||
|
isUdev := false // Only UDEV events have complete info (ID_VENDOR, ID_MODEL); KERNEL events come first with less info
|
||||||
|
|
||||||
|
for scanner.Scan() {
|
||||||
|
line := scanner.Text()
|
||||||
|
if line == "" {
|
||||||
|
// End of event block - only process UDEV events (skip KERNEL to avoid duplicate/incomplete notifications)
|
||||||
|
if isUdev && props != nil && (action == "add" || action == "remove") {
|
||||||
|
if ev := parseUSBEvent(action, props); ev != nil {
|
||||||
|
select {
|
||||||
|
case eventCh <- ev:
|
||||||
|
case <-ctx.Done():
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
props = nil
|
||||||
|
action = ""
|
||||||
|
isUdev = false
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
idx := strings.Index(line, "=")
|
||||||
|
// First line of block: "UDEV [ts] action devpath" or "KERNEL[ts] action devpath" - no KEY=value
|
||||||
|
if idx <= 0 {
|
||||||
|
isUdev = strings.HasPrefix(strings.TrimSpace(line), "UDEV")
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parse KEY=value
|
||||||
|
key := line[:idx]
|
||||||
|
val := line[idx+1:]
|
||||||
|
if props == nil {
|
||||||
|
props = make(map[string]string)
|
||||||
|
}
|
||||||
|
props[key] = val
|
||||||
|
|
||||||
|
if key == "ACTION" {
|
||||||
|
action = val
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := scanner.Err(); err != nil {
|
||||||
|
logger.ErrorCF("devices", "udevadm scan error", map[string]interface{}{"error": err.Error()})
|
||||||
|
}
|
||||||
|
cmd.Wait()
|
||||||
|
}()
|
||||||
|
|
||||||
|
return eventCh, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *USBMonitor) Stop() error {
|
||||||
|
m.mu.Lock()
|
||||||
|
defer m.mu.Unlock()
|
||||||
|
if m.cmd != nil && m.cmd.Process != nil {
|
||||||
|
m.cmd.Process.Kill()
|
||||||
|
m.cmd = nil
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseUSBEvent(action string, props map[string]string) *events.DeviceEvent {
|
||||||
|
// Only care about add/remove for physical devices (not interfaces)
|
||||||
|
subsystem := props["SUBSYSTEM"]
|
||||||
|
if subsystem != "usb" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// Skip interface events - we want device-level only to avoid duplicates
|
||||||
|
devType := props["DEVTYPE"]
|
||||||
|
if devType == "usb_interface" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// Prefer usb_device, but accept if DEVTYPE not set (varies by udev version)
|
||||||
|
if devType != "" && devType != "usb_device" {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
ev := &events.DeviceEvent{
|
||||||
|
Raw: props,
|
||||||
|
}
|
||||||
|
switch action {
|
||||||
|
case "add":
|
||||||
|
ev.Action = events.ActionAdd
|
||||||
|
case "remove":
|
||||||
|
ev.Action = events.ActionRemove
|
||||||
|
default:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
ev.Kind = events.KindUSB
|
||||||
|
|
||||||
|
ev.Vendor = props["ID_VENDOR"]
|
||||||
|
if ev.Vendor == "" {
|
||||||
|
ev.Vendor = props["ID_VENDOR_ID"]
|
||||||
|
}
|
||||||
|
if ev.Vendor == "" {
|
||||||
|
ev.Vendor = "Unknown Vendor"
|
||||||
|
}
|
||||||
|
|
||||||
|
ev.Product = props["ID_MODEL"]
|
||||||
|
if ev.Product == "" {
|
||||||
|
ev.Product = props["ID_MODEL_ID"]
|
||||||
|
}
|
||||||
|
if ev.Product == "" {
|
||||||
|
ev.Product = "Unknown Device"
|
||||||
|
}
|
||||||
|
|
||||||
|
ev.Serial = props["ID_SERIAL_SHORT"]
|
||||||
|
ev.DeviceID = props["DEVPATH"]
|
||||||
|
if bus := props["BUSNUM"]; bus != "" {
|
||||||
|
if dev := props["DEVNUM"]; dev != "" {
|
||||||
|
ev.DeviceID = bus + ":" + dev
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Map USB class to capability
|
||||||
|
if class := props["ID_USB_CLASS"]; class != "" {
|
||||||
|
ev.Capabilities = usbClassToCapability[strings.ToLower(class)]
|
||||||
|
}
|
||||||
|
if ev.Capabilities == "" {
|
||||||
|
ev.Capabilities = "USB Device"
|
||||||
|
}
|
||||||
|
|
||||||
|
return ev
|
||||||
|
}
|
||||||
29
pkg/devices/sources/usb_stub.go
Normal file
29
pkg/devices/sources/usb_stub.go
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
//go:build !linux
|
||||||
|
|
||||||
|
package sources
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
|
||||||
|
"github.com/sipeed/picoclaw/pkg/devices/events"
|
||||||
|
)
|
||||||
|
|
||||||
|
type USBMonitor struct{}
|
||||||
|
|
||||||
|
func NewUSBMonitor() *USBMonitor {
|
||||||
|
return &USBMonitor{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *USBMonitor) Kind() events.Kind {
|
||||||
|
return events.KindUSB
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *USBMonitor) Start(ctx context.Context) (<-chan *events.DeviceEvent, error) {
|
||||||
|
ch := make(chan *events.DeviceEvent)
|
||||||
|
close(ch) // Immediately close, no events
|
||||||
|
return ch, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *USBMonitor) Stop() error {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
@ -212,12 +212,17 @@ func ConvertConfig(data map[string]interface{}) (*config.Config, []string, error
|
||||||
|
|
||||||
if tools, ok := getMap(data, "tools"); ok {
|
if tools, ok := getMap(data, "tools"); ok {
|
||||||
if web, ok := getMap(tools, "web"); ok {
|
if web, ok := getMap(tools, "web"); ok {
|
||||||
|
// Migrate old "search" config to "brave" if api_key is present
|
||||||
if search, ok := getMap(web, "search"); ok {
|
if search, ok := getMap(web, "search"); ok {
|
||||||
if v, ok := getString(search, "api_key"); ok {
|
if v, ok := getString(search, "api_key"); ok {
|
||||||
cfg.Tools.Web.Search.APIKey = v
|
cfg.Tools.Web.Brave.APIKey = v
|
||||||
|
if v != "" {
|
||||||
|
cfg.Tools.Web.Brave.Enabled = true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if v, ok := getFloat(search, "max_results"); ok {
|
if v, ok := getFloat(search, "max_results"); ok {
|
||||||
cfg.Tools.Web.Search.MaxResults = int(v)
|
cfg.Tools.Web.Brave.MaxResults = int(v)
|
||||||
|
cfg.Tools.Web.DuckDuckGo.MaxResults = int(v)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -271,8 +276,8 @@ func MergeConfig(existing, incoming *config.Config) *config.Config {
|
||||||
existing.Channels.MaixCam = incoming.Channels.MaixCam
|
existing.Channels.MaixCam = incoming.Channels.MaixCam
|
||||||
}
|
}
|
||||||
|
|
||||||
if existing.Tools.Web.Search.APIKey == "" {
|
if existing.Tools.Web.Brave.APIKey == "" {
|
||||||
existing.Tools.Web.Search = incoming.Tools.Web.Search
|
existing.Tools.Web.Brave = incoming.Tools.Web.Brave
|
||||||
}
|
}
|
||||||
|
|
||||||
return existing
|
return existing
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,7 @@ func NewHTTPProvider(apiKey, apiBase, proxy string) *HTTPProvider {
|
||||||
|
|
||||||
return &HTTPProvider{
|
return &HTTPProvider{
|
||||||
apiKey: apiKey,
|
apiKey: apiKey,
|
||||||
apiBase: apiBase,
|
apiBase: strings.TrimRight(apiBase, "/"),
|
||||||
httpClient: client,
|
httpClient: client,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -116,7 +116,7 @@ func (p *HTTPProvider) Chat(ctx context.Context, messages []Message, tools []Too
|
||||||
}
|
}
|
||||||
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
if resp.StatusCode != http.StatusOK {
|
||||||
return nil, fmt.Errorf("API error: %s", string(body))
|
return nil, fmt.Errorf("API request failed:\n Status: %d\n Body: %s", resp.StatusCode, string(body))
|
||||||
}
|
}
|
||||||
|
|
||||||
return p.parseResponse(body)
|
return p.parseResponse(body)
|
||||||
|
|
@ -303,6 +303,17 @@ func CreateProvider(cfg *config.Config) (LLMProvider, error) {
|
||||||
workspace = "."
|
workspace = "."
|
||||||
}
|
}
|
||||||
return NewClaudeCliProvider(workspace), nil
|
return NewClaudeCliProvider(workspace), nil
|
||||||
|
case "deepseek":
|
||||||
|
if cfg.Providers.DeepSeek.APIKey != "" {
|
||||||
|
apiKey = cfg.Providers.DeepSeek.APIKey
|
||||||
|
apiBase = cfg.Providers.DeepSeek.APIBase
|
||||||
|
if apiBase == "" {
|
||||||
|
apiBase = "https://api.deepseek.com/v1"
|
||||||
|
}
|
||||||
|
if model != "deepseek-chat" && model != "deepseek-reasoner" {
|
||||||
|
model = "deepseek-chat"
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
147
pkg/tools/i2c.go
Normal file
147
pkg/tools/i2c.go
Normal file
|
|
@ -0,0 +1,147 @@
|
||||||
|
package tools
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"runtime"
|
||||||
|
)
|
||||||
|
|
||||||
|
// I2CTool provides I2C bus interaction for reading sensors and controlling peripherals.
|
||||||
|
type I2CTool struct{}
|
||||||
|
|
||||||
|
func NewI2CTool() *I2CTool {
|
||||||
|
return &I2CTool{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *I2CTool) Name() string {
|
||||||
|
return "i2c"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *I2CTool) Description() string {
|
||||||
|
return "Interact with I2C bus devices for reading sensors and controlling peripherals. Actions: detect (list buses), scan (find devices on a bus), read (read bytes from device), write (send bytes to device). Linux only."
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *I2CTool) Parameters() map[string]interface{} {
|
||||||
|
return map[string]interface{}{
|
||||||
|
"type": "object",
|
||||||
|
"properties": map[string]interface{}{
|
||||||
|
"action": map[string]interface{}{
|
||||||
|
"type": "string",
|
||||||
|
"enum": []string{"detect", "scan", "read", "write"},
|
||||||
|
"description": "Action to perform: detect (list available I2C buses), scan (find devices on a bus), read (read bytes from a device), write (send bytes to a device)",
|
||||||
|
},
|
||||||
|
"bus": map[string]interface{}{
|
||||||
|
"type": "string",
|
||||||
|
"description": "I2C bus number (e.g. \"1\" for /dev/i2c-1). Required for scan/read/write.",
|
||||||
|
},
|
||||||
|
"address": map[string]interface{}{
|
||||||
|
"type": "integer",
|
||||||
|
"description": "7-bit I2C device address (0x03-0x77). Required for read/write.",
|
||||||
|
},
|
||||||
|
"register": map[string]interface{}{
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Register address to read from or write to. If set, sends register byte before read/write.",
|
||||||
|
},
|
||||||
|
"data": map[string]interface{}{
|
||||||
|
"type": "array",
|
||||||
|
"items": map[string]interface{}{"type": "integer"},
|
||||||
|
"description": "Bytes to write (0-255 each). Required for write action.",
|
||||||
|
},
|
||||||
|
"length": map[string]interface{}{
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Number of bytes to read (1-256). Default: 1. Used with read action.",
|
||||||
|
},
|
||||||
|
"confirm": map[string]interface{}{
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Must be true for write operations. Safety guard to prevent accidental writes.",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"required": []string{"action"},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *I2CTool) Execute(ctx context.Context, args map[string]interface{}) *ToolResult {
|
||||||
|
if runtime.GOOS != "linux" {
|
||||||
|
return ErrorResult("I2C is only supported on Linux. This tool requires /dev/i2c-* device files.")
|
||||||
|
}
|
||||||
|
|
||||||
|
action, ok := args["action"].(string)
|
||||||
|
if !ok {
|
||||||
|
return ErrorResult("action is required")
|
||||||
|
}
|
||||||
|
|
||||||
|
switch action {
|
||||||
|
case "detect":
|
||||||
|
return t.detect()
|
||||||
|
case "scan":
|
||||||
|
return t.scan(args)
|
||||||
|
case "read":
|
||||||
|
return t.readDevice(args)
|
||||||
|
case "write":
|
||||||
|
return t.writeDevice(args)
|
||||||
|
default:
|
||||||
|
return ErrorResult(fmt.Sprintf("unknown action: %s (valid: detect, scan, read, write)", action))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// detect lists available I2C buses by globbing /dev/i2c-*
|
||||||
|
func (t *I2CTool) detect() *ToolResult {
|
||||||
|
matches, err := filepath.Glob("/dev/i2c-*")
|
||||||
|
if err != nil {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to scan for I2C buses: %v", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(matches) == 0 {
|
||||||
|
return SilentResult("No I2C buses found. You may need to:\n1. Load the i2c-dev module: modprobe i2c-dev\n2. Check that I2C is enabled in device tree\n3. Configure pinmux for your board (see hardware skill)")
|
||||||
|
}
|
||||||
|
|
||||||
|
type busInfo struct {
|
||||||
|
Path string `json:"path"`
|
||||||
|
Bus string `json:"bus"`
|
||||||
|
}
|
||||||
|
|
||||||
|
buses := make([]busInfo, 0, len(matches))
|
||||||
|
re := regexp.MustCompile(`/dev/i2c-(\d+)`)
|
||||||
|
for _, m := range matches {
|
||||||
|
if sub := re.FindStringSubmatch(m); sub != nil {
|
||||||
|
buses = append(buses, busInfo{Path: m, Bus: sub[1]})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
result, _ := json.MarshalIndent(buses, "", " ")
|
||||||
|
return SilentResult(fmt.Sprintf("Found %d I2C bus(es):\n%s", len(buses), string(result)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// isValidBusID checks that a bus identifier is a simple number (prevents path injection)
|
||||||
|
func isValidBusID(id string) bool {
|
||||||
|
matched, _ := regexp.MatchString(`^\d+$`, id)
|
||||||
|
return matched
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseI2CAddress extracts and validates an I2C address from args
|
||||||
|
func parseI2CAddress(args map[string]interface{}) (int, *ToolResult) {
|
||||||
|
addrFloat, ok := args["address"].(float64)
|
||||||
|
if !ok {
|
||||||
|
return 0, ErrorResult("address is required (e.g. 0x38 for AHT20)")
|
||||||
|
}
|
||||||
|
addr := int(addrFloat)
|
||||||
|
if addr < 0x03 || addr > 0x77 {
|
||||||
|
return 0, ErrorResult("address must be in valid 7-bit range (0x03-0x77)")
|
||||||
|
}
|
||||||
|
return addr, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseI2CBus extracts and validates an I2C bus from args
|
||||||
|
func parseI2CBus(args map[string]interface{}) (string, *ToolResult) {
|
||||||
|
bus, ok := args["bus"].(string)
|
||||||
|
if !ok || bus == "" {
|
||||||
|
return "", ErrorResult("bus is required (e.g. \"1\" for /dev/i2c-1)")
|
||||||
|
}
|
||||||
|
if !isValidBusID(bus) {
|
||||||
|
return "", ErrorResult("invalid bus identifier: must be a number (e.g. \"1\")")
|
||||||
|
}
|
||||||
|
return bus, nil
|
||||||
|
}
|
||||||
282
pkg/tools/i2c_linux.go
Normal file
282
pkg/tools/i2c_linux.go
Normal file
|
|
@ -0,0 +1,282 @@
|
||||||
|
package tools
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"syscall"
|
||||||
|
"unsafe"
|
||||||
|
)
|
||||||
|
|
||||||
|
// I2C ioctl constants from Linux kernel headers (<linux/i2c-dev.h>, <linux/i2c.h>)
|
||||||
|
const (
|
||||||
|
i2cSlave = 0x0703 // Set slave address (fails if in use by driver)
|
||||||
|
i2cFuncs = 0x0705 // Query adapter functionality bitmask
|
||||||
|
i2cSmbus = 0x0720 // Perform SMBus transaction
|
||||||
|
|
||||||
|
// I2C_FUNC capability bits
|
||||||
|
i2cFuncSmbusQuick = 0x00010000
|
||||||
|
i2cFuncSmbusReadByte = 0x00020000
|
||||||
|
|
||||||
|
// SMBus transaction types
|
||||||
|
i2cSmbusRead = 0
|
||||||
|
i2cSmbusWrite = 1
|
||||||
|
|
||||||
|
// SMBus protocol sizes
|
||||||
|
i2cSmbusQuick = 0
|
||||||
|
i2cSmbusByte = 1
|
||||||
|
)
|
||||||
|
|
||||||
|
// i2cSmbusData matches the kernel union i2c_smbus_data (34 bytes max).
|
||||||
|
// For quick and byte transactions only the first byte is used (if at all).
|
||||||
|
type i2cSmbusData [34]byte
|
||||||
|
|
||||||
|
// i2cSmbusArgs matches the kernel struct i2c_smbus_ioctl_data.
|
||||||
|
type i2cSmbusArgs struct {
|
||||||
|
readWrite uint8
|
||||||
|
command uint8
|
||||||
|
size uint32
|
||||||
|
data *i2cSmbusData
|
||||||
|
}
|
||||||
|
|
||||||
|
// smbusProbe performs a single SMBus probe at the given address.
|
||||||
|
// Uses SMBus Quick Write (safest) or falls back to SMBus Read Byte for
|
||||||
|
// EEPROM address ranges where quick write can corrupt AT24RF08 chips.
|
||||||
|
// This matches i2cdetect's MODE_AUTO behavior.
|
||||||
|
func smbusProbe(fd int, addr int, hasQuick bool) bool {
|
||||||
|
// EEPROM ranges: use read byte (quick write can corrupt AT24RF08)
|
||||||
|
useReadByte := (addr >= 0x30 && addr <= 0x37) || (addr >= 0x50 && addr <= 0x5F)
|
||||||
|
|
||||||
|
if !useReadByte && hasQuick {
|
||||||
|
// SMBus Quick Write: [START] [ADDR|W] [ACK/NACK] [STOP]
|
||||||
|
// Safest probe — no data transferred
|
||||||
|
args := i2cSmbusArgs{
|
||||||
|
readWrite: i2cSmbusWrite,
|
||||||
|
command: 0,
|
||||||
|
size: i2cSmbusQuick,
|
||||||
|
data: nil,
|
||||||
|
}
|
||||||
|
_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), i2cSmbus, uintptr(unsafe.Pointer(&args)))
|
||||||
|
return errno == 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// SMBus Read Byte: [START] [ADDR|R] [ACK/NACK] [DATA] [STOP]
|
||||||
|
var data i2cSmbusData
|
||||||
|
args := i2cSmbusArgs{
|
||||||
|
readWrite: i2cSmbusRead,
|
||||||
|
command: 0,
|
||||||
|
size: i2cSmbusByte,
|
||||||
|
data: &data,
|
||||||
|
}
|
||||||
|
_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), i2cSmbus, uintptr(unsafe.Pointer(&args)))
|
||||||
|
return errno == 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// scan probes valid 7-bit addresses on a bus for connected devices.
|
||||||
|
// Uses the same hybrid probe strategy as i2cdetect's MODE_AUTO:
|
||||||
|
// SMBus Quick Write for most addresses, SMBus Read Byte for EEPROM ranges.
|
||||||
|
func (t *I2CTool) scan(args map[string]interface{}) *ToolResult {
|
||||||
|
bus, errResult := parseI2CBus(args)
|
||||||
|
if errResult != nil {
|
||||||
|
return errResult
|
||||||
|
}
|
||||||
|
|
||||||
|
devPath := fmt.Sprintf("/dev/i2c-%s", bus)
|
||||||
|
fd, err := syscall.Open(devPath, syscall.O_RDWR, 0)
|
||||||
|
if err != nil {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to open %s: %v (check permissions and i2c-dev module)", devPath, err))
|
||||||
|
}
|
||||||
|
defer syscall.Close(fd)
|
||||||
|
|
||||||
|
// Query adapter capabilities to determine available probe methods.
|
||||||
|
// I2C_FUNCS writes an unsigned long, which is word-sized on Linux.
|
||||||
|
var funcs uintptr
|
||||||
|
_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), i2cFuncs, uintptr(unsafe.Pointer(&funcs)))
|
||||||
|
if errno != 0 {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to query I2C adapter capabilities on %s: %v", devPath, errno))
|
||||||
|
}
|
||||||
|
|
||||||
|
hasQuick := funcs&i2cFuncSmbusQuick != 0
|
||||||
|
hasReadByte := funcs&i2cFuncSmbusReadByte != 0
|
||||||
|
|
||||||
|
if !hasQuick && !hasReadByte {
|
||||||
|
return ErrorResult(fmt.Sprintf("I2C adapter %s supports neither SMBus Quick nor Read Byte — cannot probe safely", devPath))
|
||||||
|
}
|
||||||
|
|
||||||
|
type deviceEntry struct {
|
||||||
|
Address string `json:"address"`
|
||||||
|
Status string `json:"status,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var found []deviceEntry
|
||||||
|
// Scan 0x08-0x77, skipping I2C reserved addresses 0x00-0x07
|
||||||
|
for addr := 0x08; addr <= 0x77; addr++ {
|
||||||
|
// Set slave address — EBUSY means a kernel driver owns this address
|
||||||
|
_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), i2cSlave, uintptr(addr))
|
||||||
|
if errno != 0 {
|
||||||
|
if errno == syscall.EBUSY {
|
||||||
|
found = append(found, deviceEntry{
|
||||||
|
Address: fmt.Sprintf("0x%02x", addr),
|
||||||
|
Status: "busy (in use by kernel driver)",
|
||||||
|
})
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if smbusProbe(fd, addr, hasQuick) {
|
||||||
|
found = append(found, deviceEntry{
|
||||||
|
Address: fmt.Sprintf("0x%02x", addr),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(found) == 0 {
|
||||||
|
return SilentResult(fmt.Sprintf("No devices found on %s. Check wiring and pull-up resistors.", devPath))
|
||||||
|
}
|
||||||
|
|
||||||
|
result, _ := json.MarshalIndent(map[string]interface{}{
|
||||||
|
"bus": devPath,
|
||||||
|
"devices": found,
|
||||||
|
"count": len(found),
|
||||||
|
}, "", " ")
|
||||||
|
return SilentResult(fmt.Sprintf("Scan of %s:\n%s", devPath, string(result)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// readDevice reads bytes from an I2C device, optionally at a specific register
|
||||||
|
func (t *I2CTool) readDevice(args map[string]interface{}) *ToolResult {
|
||||||
|
bus, errResult := parseI2CBus(args)
|
||||||
|
if errResult != nil {
|
||||||
|
return errResult
|
||||||
|
}
|
||||||
|
|
||||||
|
addr, errResult := parseI2CAddress(args)
|
||||||
|
if errResult != nil {
|
||||||
|
return errResult
|
||||||
|
}
|
||||||
|
|
||||||
|
length := 1
|
||||||
|
if l, ok := args["length"].(float64); ok {
|
||||||
|
length = int(l)
|
||||||
|
}
|
||||||
|
if length < 1 || length > 256 {
|
||||||
|
return ErrorResult("length must be between 1 and 256")
|
||||||
|
}
|
||||||
|
|
||||||
|
devPath := fmt.Sprintf("/dev/i2c-%s", bus)
|
||||||
|
fd, err := syscall.Open(devPath, syscall.O_RDWR, 0)
|
||||||
|
if err != nil {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to open %s: %v", devPath, err))
|
||||||
|
}
|
||||||
|
defer syscall.Close(fd)
|
||||||
|
|
||||||
|
// Set slave address
|
||||||
|
_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), i2cSlave, uintptr(addr))
|
||||||
|
if errno != 0 {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to set I2C address 0x%02x: %v", addr, errno))
|
||||||
|
}
|
||||||
|
|
||||||
|
// If register is specified, write it first
|
||||||
|
if regFloat, ok := args["register"].(float64); ok {
|
||||||
|
reg := int(regFloat)
|
||||||
|
if reg < 0 || reg > 255 {
|
||||||
|
return ErrorResult("register must be between 0x00 and 0xFF")
|
||||||
|
}
|
||||||
|
_, err := syscall.Write(fd, []byte{byte(reg)})
|
||||||
|
if err != nil {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to write register 0x%02x: %v", reg, err))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read data
|
||||||
|
buf := make([]byte, length)
|
||||||
|
n, err := syscall.Read(fd, buf)
|
||||||
|
if err != nil {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to read from device 0x%02x: %v", addr, err))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Format as hex bytes
|
||||||
|
hexBytes := make([]string, n)
|
||||||
|
intBytes := make([]int, n)
|
||||||
|
for i := 0; i < n; i++ {
|
||||||
|
hexBytes[i] = fmt.Sprintf("0x%02x", buf[i])
|
||||||
|
intBytes[i] = int(buf[i])
|
||||||
|
}
|
||||||
|
|
||||||
|
result, _ := json.MarshalIndent(map[string]interface{}{
|
||||||
|
"bus": devPath,
|
||||||
|
"address": fmt.Sprintf("0x%02x", addr),
|
||||||
|
"bytes": intBytes,
|
||||||
|
"hex": hexBytes,
|
||||||
|
"length": n,
|
||||||
|
}, "", " ")
|
||||||
|
return SilentResult(string(result))
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeDevice writes bytes to an I2C device, optionally at a specific register
|
||||||
|
func (t *I2CTool) writeDevice(args map[string]interface{}) *ToolResult {
|
||||||
|
confirm, _ := args["confirm"].(bool)
|
||||||
|
if !confirm {
|
||||||
|
return ErrorResult("write operations require confirm: true. Please confirm with the user before writing to I2C devices, as incorrect writes can misconfigure hardware.")
|
||||||
|
}
|
||||||
|
|
||||||
|
bus, errResult := parseI2CBus(args)
|
||||||
|
if errResult != nil {
|
||||||
|
return errResult
|
||||||
|
}
|
||||||
|
|
||||||
|
addr, errResult := parseI2CAddress(args)
|
||||||
|
if errResult != nil {
|
||||||
|
return errResult
|
||||||
|
}
|
||||||
|
|
||||||
|
dataRaw, ok := args["data"].([]interface{})
|
||||||
|
if !ok || len(dataRaw) == 0 {
|
||||||
|
return ErrorResult("data is required for write (array of byte values 0-255)")
|
||||||
|
}
|
||||||
|
if len(dataRaw) > 256 {
|
||||||
|
return ErrorResult("data too long: maximum 256 bytes per I2C transaction")
|
||||||
|
}
|
||||||
|
|
||||||
|
data := make([]byte, 0, len(dataRaw)+1)
|
||||||
|
|
||||||
|
// If register is specified, prepend it to the data
|
||||||
|
if regFloat, ok := args["register"].(float64); ok {
|
||||||
|
reg := int(regFloat)
|
||||||
|
if reg < 0 || reg > 255 {
|
||||||
|
return ErrorResult("register must be between 0x00 and 0xFF")
|
||||||
|
}
|
||||||
|
data = append(data, byte(reg))
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, v := range dataRaw {
|
||||||
|
f, ok := v.(float64)
|
||||||
|
if !ok {
|
||||||
|
return ErrorResult(fmt.Sprintf("data[%d] is not a valid byte value", i))
|
||||||
|
}
|
||||||
|
b := int(f)
|
||||||
|
if b < 0 || b > 255 {
|
||||||
|
return ErrorResult(fmt.Sprintf("data[%d] = %d is out of byte range (0-255)", i, b))
|
||||||
|
}
|
||||||
|
data = append(data, byte(b))
|
||||||
|
}
|
||||||
|
|
||||||
|
devPath := fmt.Sprintf("/dev/i2c-%s", bus)
|
||||||
|
fd, err := syscall.Open(devPath, syscall.O_RDWR, 0)
|
||||||
|
if err != nil {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to open %s: %v", devPath, err))
|
||||||
|
}
|
||||||
|
defer syscall.Close(fd)
|
||||||
|
|
||||||
|
// Set slave address
|
||||||
|
_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), i2cSlave, uintptr(addr))
|
||||||
|
if errno != 0 {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to set I2C address 0x%02x: %v", addr, errno))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write data
|
||||||
|
n, err := syscall.Write(fd, data)
|
||||||
|
if err != nil {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to write to device 0x%02x: %v", addr, err))
|
||||||
|
}
|
||||||
|
|
||||||
|
return SilentResult(fmt.Sprintf("Wrote %d byte(s) to device 0x%02x on %s", n, addr, devPath))
|
||||||
|
}
|
||||||
18
pkg/tools/i2c_other.go
Normal file
18
pkg/tools/i2c_other.go
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
//go:build !linux
|
||||||
|
|
||||||
|
package tools
|
||||||
|
|
||||||
|
// scan is a stub for non-Linux platforms.
|
||||||
|
func (t *I2CTool) scan(args map[string]interface{}) *ToolResult {
|
||||||
|
return ErrorResult("I2C is only supported on Linux")
|
||||||
|
}
|
||||||
|
|
||||||
|
// readDevice is a stub for non-Linux platforms.
|
||||||
|
func (t *I2CTool) readDevice(args map[string]interface{}) *ToolResult {
|
||||||
|
return ErrorResult("I2C is only supported on Linux")
|
||||||
|
}
|
||||||
|
|
||||||
|
// writeDevice is a stub for non-Linux platforms.
|
||||||
|
func (t *I2CTool) writeDevice(args map[string]interface{}) *ToolResult {
|
||||||
|
return ErrorResult("I2C is only supported on Linux")
|
||||||
|
}
|
||||||
156
pkg/tools/spi.go
Normal file
156
pkg/tools/spi.go
Normal file
|
|
@ -0,0 +1,156 @@
|
||||||
|
package tools
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"path/filepath"
|
||||||
|
"regexp"
|
||||||
|
"runtime"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SPITool provides SPI bus interaction for high-speed peripheral communication.
|
||||||
|
type SPITool struct{}
|
||||||
|
|
||||||
|
func NewSPITool() *SPITool {
|
||||||
|
return &SPITool{}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *SPITool) Name() string {
|
||||||
|
return "spi"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *SPITool) Description() string {
|
||||||
|
return "Interact with SPI bus devices for high-speed peripheral communication. Actions: list (find SPI devices), transfer (full-duplex send/receive), read (receive bytes). Linux only."
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *SPITool) Parameters() map[string]interface{} {
|
||||||
|
return map[string]interface{}{
|
||||||
|
"type": "object",
|
||||||
|
"properties": map[string]interface{}{
|
||||||
|
"action": map[string]interface{}{
|
||||||
|
"type": "string",
|
||||||
|
"enum": []string{"list", "transfer", "read"},
|
||||||
|
"description": "Action to perform: list (find available SPI devices), transfer (full-duplex send/receive), read (receive bytes by sending zeros)",
|
||||||
|
},
|
||||||
|
"device": map[string]interface{}{
|
||||||
|
"type": "string",
|
||||||
|
"description": "SPI device identifier (e.g. \"2.0\" for /dev/spidev2.0). Required for transfer/read.",
|
||||||
|
},
|
||||||
|
"speed": map[string]interface{}{
|
||||||
|
"type": "integer",
|
||||||
|
"description": "SPI clock speed in Hz. Default: 1000000 (1 MHz).",
|
||||||
|
},
|
||||||
|
"mode": map[string]interface{}{
|
||||||
|
"type": "integer",
|
||||||
|
"description": "SPI mode (0-3). Default: 0. Mode sets CPOL and CPHA: 0=0,0 1=0,1 2=1,0 3=1,1.",
|
||||||
|
},
|
||||||
|
"bits": map[string]interface{}{
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Bits per word. Default: 8.",
|
||||||
|
},
|
||||||
|
"data": map[string]interface{}{
|
||||||
|
"type": "array",
|
||||||
|
"items": map[string]interface{}{"type": "integer"},
|
||||||
|
"description": "Bytes to send (0-255 each). Required for transfer action.",
|
||||||
|
},
|
||||||
|
"length": map[string]interface{}{
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Number of bytes to read (1-4096). Required for read action.",
|
||||||
|
},
|
||||||
|
"confirm": map[string]interface{}{
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Must be true for transfer operations. Safety guard to prevent accidental writes.",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"required": []string{"action"},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *SPITool) Execute(ctx context.Context, args map[string]interface{}) *ToolResult {
|
||||||
|
if runtime.GOOS != "linux" {
|
||||||
|
return ErrorResult("SPI is only supported on Linux. This tool requires /dev/spidev* device files.")
|
||||||
|
}
|
||||||
|
|
||||||
|
action, ok := args["action"].(string)
|
||||||
|
if !ok {
|
||||||
|
return ErrorResult("action is required")
|
||||||
|
}
|
||||||
|
|
||||||
|
switch action {
|
||||||
|
case "list":
|
||||||
|
return t.list()
|
||||||
|
case "transfer":
|
||||||
|
return t.transfer(args)
|
||||||
|
case "read":
|
||||||
|
return t.readDevice(args)
|
||||||
|
default:
|
||||||
|
return ErrorResult(fmt.Sprintf("unknown action: %s (valid: list, transfer, read)", action))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// list finds available SPI devices by globbing /dev/spidev*
|
||||||
|
func (t *SPITool) list() *ToolResult {
|
||||||
|
matches, err := filepath.Glob("/dev/spidev*")
|
||||||
|
if err != nil {
|
||||||
|
return ErrorResult(fmt.Sprintf("failed to scan for SPI devices: %v", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(matches) == 0 {
|
||||||
|
return SilentResult("No SPI devices found. You may need to:\n1. Enable SPI in device tree\n2. Configure pinmux for your board (see hardware skill)\n3. Check that spidev module is loaded")
|
||||||
|
}
|
||||||
|
|
||||||
|
type devInfo struct {
|
||||||
|
Path string `json:"path"`
|
||||||
|
Device string `json:"device"`
|
||||||
|
}
|
||||||
|
|
||||||
|
devices := make([]devInfo, 0, len(matches))
|
||||||
|
re := regexp.MustCompile(`/dev/spidev(\d+\.\d+)`)
|
||||||
|
for _, m := range matches {
|
||||||
|
if sub := re.FindStringSubmatch(m); sub != nil {
|
||||||
|
devices = append(devices, devInfo{Path: m, Device: sub[1]})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
result, _ := json.MarshalIndent(devices, "", " ")
|
||||||
|
return SilentResult(fmt.Sprintf("Found %d SPI device(s):\n%s", len(devices), string(result)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseSPIArgs extracts and validates common SPI parameters
|
||||||
|
func parseSPIArgs(args map[string]interface{}) (device string, speed uint32, mode uint8, bits uint8, errMsg string) {
|
||||||
|
dev, ok := args["device"].(string)
|
||||||
|
if !ok || dev == "" {
|
||||||
|
return "", 0, 0, 0, "device is required (e.g. \"2.0\" for /dev/spidev2.0)"
|
||||||
|
}
|
||||||
|
matched, _ := regexp.MatchString(`^\d+\.\d+$`, dev)
|
||||||
|
if !matched {
|
||||||
|
return "", 0, 0, 0, "invalid device identifier: must be in format \"X.Y\" (e.g. \"2.0\")"
|
||||||
|
}
|
||||||
|
|
||||||
|
speed = 1000000 // default 1 MHz
|
||||||
|
if s, ok := args["speed"].(float64); ok {
|
||||||
|
if s < 1 || s > 125000000 {
|
||||||
|
return "", 0, 0, 0, "speed must be between 1 Hz and 125 MHz"
|
||||||
|
}
|
||||||
|
speed = uint32(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
mode = 0
|
||||||
|
if m, ok := args["mode"].(float64); ok {
|
||||||
|
if int(m) < 0 || int(m) > 3 {
|
||||||
|
return "", 0, 0, 0, "mode must be 0-3"
|
||||||
|
}
|
||||||
|
mode = uint8(m)
|
||||||
|
}
|
||||||
|
|
||||||
|
bits = 8
|
||||||
|
if b, ok := args["bits"].(float64); ok {
|
||||||
|
if int(b) < 1 || int(b) > 32 {
|
||||||
|
return "", 0, 0, 0, "bits must be between 1 and 32"
|
||||||
|
}
|
||||||
|
bits = uint8(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
return dev, speed, mode, bits, ""
|
||||||
|
}
|
||||||
196
pkg/tools/spi_linux.go
Normal file
196
pkg/tools/spi_linux.go
Normal file
|
|
@ -0,0 +1,196 @@
|
||||||
|
package tools
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"runtime"
|
||||||
|
"syscall"
|
||||||
|
"unsafe"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SPI ioctl constants from Linux kernel headers.
|
||||||
|
// Calculated from _IOW('k', nr, size) macro:
|
||||||
|
//
|
||||||
|
// direction(1)<<30 | size<<16 | type(0x6B)<<8 | nr
|
||||||
|
const (
|
||||||
|
spiIocWrMode = 0x40016B01 // _IOW('k', 1, __u8)
|
||||||
|
spiIocWrBitsPerWord = 0x40016B03 // _IOW('k', 3, __u8)
|
||||||
|
spiIocWrMaxSpeedHz = 0x40046B04 // _IOW('k', 4, __u32)
|
||||||
|
spiIocMessage1 = 0x40206B00 // _IOW('k', 0, struct spi_ioc_transfer) — 32 bytes
|
||||||
|
)
|
||||||
|
|
||||||
|
// spiTransfer matches Linux kernel struct spi_ioc_transfer (32 bytes on all architectures).
|
||||||
|
type spiTransfer struct {
|
||||||
|
txBuf uint64
|
||||||
|
rxBuf uint64
|
||||||
|
length uint32
|
||||||
|
speedHz uint32
|
||||||
|
delayUsecs uint16
|
||||||
|
bitsPerWord uint8
|
||||||
|
csChange uint8
|
||||||
|
txNbits uint8
|
||||||
|
rxNbits uint8
|
||||||
|
wordDelay uint8
|
||||||
|
pad uint8
|
||||||
|
}
|
||||||
|
|
||||||
|
// configureSPI opens an SPI device and sets mode, bits per word, and speed
|
||||||
|
func configureSPI(devPath string, mode uint8, bits uint8, speed uint32) (int, *ToolResult) {
|
||||||
|
fd, err := syscall.Open(devPath, syscall.O_RDWR, 0)
|
||||||
|
if err != nil {
|
||||||
|
return -1, ErrorResult(fmt.Sprintf("failed to open %s: %v (check permissions and spidev module)", devPath, err))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set SPI mode
|
||||||
|
_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), spiIocWrMode, uintptr(unsafe.Pointer(&mode)))
|
||||||
|
if errno != 0 {
|
||||||
|
syscall.Close(fd)
|
||||||
|
return -1, ErrorResult(fmt.Sprintf("failed to set SPI mode %d: %v", mode, errno))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set bits per word
|
||||||
|
_, _, errno = syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), spiIocWrBitsPerWord, uintptr(unsafe.Pointer(&bits)))
|
||||||
|
if errno != 0 {
|
||||||
|
syscall.Close(fd)
|
||||||
|
return -1, ErrorResult(fmt.Sprintf("failed to set bits per word %d: %v", bits, errno))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set max speed
|
||||||
|
_, _, errno = syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), spiIocWrMaxSpeedHz, uintptr(unsafe.Pointer(&speed)))
|
||||||
|
if errno != 0 {
|
||||||
|
syscall.Close(fd)
|
||||||
|
return -1, ErrorResult(fmt.Sprintf("failed to set SPI speed %d Hz: %v", speed, errno))
|
||||||
|
}
|
||||||
|
|
||||||
|
return fd, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// transfer performs a full-duplex SPI transfer
|
||||||
|
func (t *SPITool) transfer(args map[string]interface{}) *ToolResult {
|
||||||
|
confirm, _ := args["confirm"].(bool)
|
||||||
|
if !confirm {
|
||||||
|
return ErrorResult("transfer operations require confirm: true. Please confirm with the user before sending data to SPI devices.")
|
||||||
|
}
|
||||||
|
|
||||||
|
dev, speed, mode, bits, errMsg := parseSPIArgs(args)
|
||||||
|
if errMsg != "" {
|
||||||
|
return ErrorResult(errMsg)
|
||||||
|
}
|
||||||
|
|
||||||
|
dataRaw, ok := args["data"].([]interface{})
|
||||||
|
if !ok || len(dataRaw) == 0 {
|
||||||
|
return ErrorResult("data is required for transfer (array of byte values 0-255)")
|
||||||
|
}
|
||||||
|
if len(dataRaw) > 4096 {
|
||||||
|
return ErrorResult("data too long: maximum 4096 bytes per SPI transfer")
|
||||||
|
}
|
||||||
|
|
||||||
|
txBuf := make([]byte, len(dataRaw))
|
||||||
|
for i, v := range dataRaw {
|
||||||
|
f, ok := v.(float64)
|
||||||
|
if !ok {
|
||||||
|
return ErrorResult(fmt.Sprintf("data[%d] is not a valid byte value", i))
|
||||||
|
}
|
||||||
|
b := int(f)
|
||||||
|
if b < 0 || b > 255 {
|
||||||
|
return ErrorResult(fmt.Sprintf("data[%d] = %d is out of byte range (0-255)", i, b))
|
||||||
|
}
|
||||||
|
txBuf[i] = byte(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
devPath := fmt.Sprintf("/dev/spidev%s", dev)
|
||||||
|
fd, errResult := configureSPI(devPath, mode, bits, speed)
|
||||||
|
if errResult != nil {
|
||||||
|
return errResult
|
||||||
|
}
|
||||||
|
defer syscall.Close(fd)
|
||||||
|
|
||||||
|
rxBuf := make([]byte, len(txBuf))
|
||||||
|
|
||||||
|
xfer := spiTransfer{
|
||||||
|
txBuf: uint64(uintptr(unsafe.Pointer(&txBuf[0]))),
|
||||||
|
rxBuf: uint64(uintptr(unsafe.Pointer(&rxBuf[0]))),
|
||||||
|
length: uint32(len(txBuf)),
|
||||||
|
speedHz: speed,
|
||||||
|
bitsPerWord: bits,
|
||||||
|
}
|
||||||
|
|
||||||
|
_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), spiIocMessage1, uintptr(unsafe.Pointer(&xfer)))
|
||||||
|
runtime.KeepAlive(txBuf)
|
||||||
|
runtime.KeepAlive(rxBuf)
|
||||||
|
if errno != 0 {
|
||||||
|
return ErrorResult(fmt.Sprintf("SPI transfer failed: %v", errno))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Format received bytes
|
||||||
|
hexBytes := make([]string, len(rxBuf))
|
||||||
|
intBytes := make([]int, len(rxBuf))
|
||||||
|
for i, b := range rxBuf {
|
||||||
|
hexBytes[i] = fmt.Sprintf("0x%02x", b)
|
||||||
|
intBytes[i] = int(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
result, _ := json.MarshalIndent(map[string]interface{}{
|
||||||
|
"device": devPath,
|
||||||
|
"sent": len(txBuf),
|
||||||
|
"received": intBytes,
|
||||||
|
"hex": hexBytes,
|
||||||
|
}, "", " ")
|
||||||
|
return SilentResult(string(result))
|
||||||
|
}
|
||||||
|
|
||||||
|
// readDevice reads bytes from SPI by sending zeros (read-only, no confirm needed)
|
||||||
|
func (t *SPITool) readDevice(args map[string]interface{}) *ToolResult {
|
||||||
|
dev, speed, mode, bits, errMsg := parseSPIArgs(args)
|
||||||
|
if errMsg != "" {
|
||||||
|
return ErrorResult(errMsg)
|
||||||
|
}
|
||||||
|
|
||||||
|
length := 0
|
||||||
|
if l, ok := args["length"].(float64); ok {
|
||||||
|
length = int(l)
|
||||||
|
}
|
||||||
|
if length < 1 || length > 4096 {
|
||||||
|
return ErrorResult("length is required for read (1-4096)")
|
||||||
|
}
|
||||||
|
|
||||||
|
devPath := fmt.Sprintf("/dev/spidev%s", dev)
|
||||||
|
fd, errResult := configureSPI(devPath, mode, bits, speed)
|
||||||
|
if errResult != nil {
|
||||||
|
return errResult
|
||||||
|
}
|
||||||
|
defer syscall.Close(fd)
|
||||||
|
|
||||||
|
txBuf := make([]byte, length) // zeros
|
||||||
|
rxBuf := make([]byte, length)
|
||||||
|
|
||||||
|
xfer := spiTransfer{
|
||||||
|
txBuf: uint64(uintptr(unsafe.Pointer(&txBuf[0]))),
|
||||||
|
rxBuf: uint64(uintptr(unsafe.Pointer(&rxBuf[0]))),
|
||||||
|
length: uint32(length),
|
||||||
|
speedHz: speed,
|
||||||
|
bitsPerWord: bits,
|
||||||
|
}
|
||||||
|
|
||||||
|
_, _, errno := syscall.Syscall(syscall.SYS_IOCTL, uintptr(fd), spiIocMessage1, uintptr(unsafe.Pointer(&xfer)))
|
||||||
|
runtime.KeepAlive(txBuf)
|
||||||
|
runtime.KeepAlive(rxBuf)
|
||||||
|
if errno != 0 {
|
||||||
|
return ErrorResult(fmt.Sprintf("SPI read failed: %v", errno))
|
||||||
|
}
|
||||||
|
|
||||||
|
hexBytes := make([]string, len(rxBuf))
|
||||||
|
intBytes := make([]int, len(rxBuf))
|
||||||
|
for i, b := range rxBuf {
|
||||||
|
hexBytes[i] = fmt.Sprintf("0x%02x", b)
|
||||||
|
intBytes[i] = int(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
result, _ := json.MarshalIndent(map[string]interface{}{
|
||||||
|
"device": devPath,
|
||||||
|
"bytes": intBytes,
|
||||||
|
"hex": hexBytes,
|
||||||
|
"length": len(rxBuf),
|
||||||
|
}, "", " ")
|
||||||
|
return SilentResult(string(result))
|
||||||
|
}
|
||||||
13
pkg/tools/spi_other.go
Normal file
13
pkg/tools/spi_other.go
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
//go:build !linux
|
||||||
|
|
||||||
|
package tools
|
||||||
|
|
||||||
|
// transfer is a stub for non-Linux platforms.
|
||||||
|
func (t *SPITool) transfer(args map[string]interface{}) *ToolResult {
|
||||||
|
return ErrorResult("SPI is only supported on Linux")
|
||||||
|
}
|
||||||
|
|
||||||
|
// readDevice is a stub for non-Linux platforms.
|
||||||
|
func (t *SPITool) readDevice(args map[string]interface{}) *ToolResult {
|
||||||
|
return ErrorResult("SPI is only supported on Linux")
|
||||||
|
}
|
||||||
261
pkg/tools/web.go
261
pkg/tools/web.go
|
|
@ -13,20 +13,203 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
userAgent = "Mozilla/5.0 (compatible; picoclaw/1.0)"
|
userAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"
|
||||||
)
|
)
|
||||||
|
|
||||||
type WebSearchTool struct {
|
type SearchProvider interface {
|
||||||
|
Search(ctx context.Context, query string, count int) (string, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
type BraveSearchProvider struct {
|
||||||
apiKey string
|
apiKey string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *BraveSearchProvider) Search(ctx context.Context, query string, count int) (string, error) {
|
||||||
|
searchURL := fmt.Sprintf("https://api.search.brave.com/res/v1/web/search?q=%s&count=%d",
|
||||||
|
url.QueryEscape(query), count)
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "GET", searchURL, nil)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("failed to create request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Set("Accept", "application/json")
|
||||||
|
req.Header.Set("X-Subscription-Token", p.apiKey)
|
||||||
|
|
||||||
|
client := &http.Client{Timeout: 10 * time.Second}
|
||||||
|
resp, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("request failed: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("failed to read response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var searchResp struct {
|
||||||
|
Web struct {
|
||||||
|
Results []struct {
|
||||||
|
Title string `json:"title"`
|
||||||
|
URL string `json:"url"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
} `json:"results"`
|
||||||
|
} `json:"web"`
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := json.Unmarshal(body, &searchResp); err != nil {
|
||||||
|
// Log error body for debugging
|
||||||
|
fmt.Printf("Brave API Error Body: %s\n", string(body))
|
||||||
|
return "", fmt.Errorf("failed to parse response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
results := searchResp.Web.Results
|
||||||
|
if len(results) == 0 {
|
||||||
|
return fmt.Sprintf("No results for: %s", query), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var lines []string
|
||||||
|
lines = append(lines, fmt.Sprintf("Results for: %s", query))
|
||||||
|
for i, item := range results {
|
||||||
|
if i >= count {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
lines = append(lines, fmt.Sprintf("%d. %s\n %s", i+1, item.Title, item.URL))
|
||||||
|
if item.Description != "" {
|
||||||
|
lines = append(lines, fmt.Sprintf(" %s", item.Description))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.Join(lines, "\n"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type DuckDuckGoSearchProvider struct{}
|
||||||
|
|
||||||
|
func (p *DuckDuckGoSearchProvider) Search(ctx context.Context, query string, count int) (string, error) {
|
||||||
|
searchURL := fmt.Sprintf("https://html.duckduckgo.com/html/?q=%s", url.QueryEscape(query))
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(ctx, "GET", searchURL, nil)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("failed to create request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Set("User-Agent", userAgent)
|
||||||
|
|
||||||
|
client := &http.Client{Timeout: 10 * time.Second}
|
||||||
|
resp, err := client.Do(req)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("request failed: %w", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("failed to read response: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return p.extractResults(string(body), count, query)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *DuckDuckGoSearchProvider) extractResults(html string, count int, query string) (string, error) {
|
||||||
|
// Simple regex based extraction for DDG HTML
|
||||||
|
// Strategy: Find all result containers or key anchors directly
|
||||||
|
|
||||||
|
// Try finding the result links directly first, as they are the most critical
|
||||||
|
// Pattern: <a class="result__a" href="...">Title</a>
|
||||||
|
// The previous regex was a bit strict. Let's make it more flexible for attributes order/content
|
||||||
|
reLink := regexp.MustCompile(`<a[^>]*class="[^"]*result__a[^"]*"[^>]*href="([^"]+)"[^>]*>([\s\S]*?)</a>`)
|
||||||
|
matches := reLink.FindAllStringSubmatch(html, count+5)
|
||||||
|
|
||||||
|
if len(matches) == 0 {
|
||||||
|
return fmt.Sprintf("No results found or extraction failed. Query: %s", query), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var lines []string
|
||||||
|
lines = append(lines, fmt.Sprintf("Results for: %s (via DuckDuckGo)", query))
|
||||||
|
|
||||||
|
// Pre-compile snippet regex to run inside the loop
|
||||||
|
// We'll search for snippets relative to the link position or just globally if needed
|
||||||
|
// But simple global search for snippets might mismatch order.
|
||||||
|
// Since we only have the raw HTML string, let's just extract snippets globally and assume order matches (risky but simple for regex)
|
||||||
|
// Or better: Let's assume the snippet follows the link in the HTML
|
||||||
|
|
||||||
|
// A better regex approach: iterate through text and find matches in order
|
||||||
|
// But for now, let's grab all snippets too
|
||||||
|
reSnippet := regexp.MustCompile(`<a class="result__snippet[^"]*".*?>([\s\S]*?)</a>`)
|
||||||
|
snippetMatches := reSnippet.FindAllStringSubmatch(html, count+5)
|
||||||
|
|
||||||
|
maxItems := min(len(matches), count)
|
||||||
|
|
||||||
|
for i := 0; i < maxItems; i++ {
|
||||||
|
urlStr := matches[i][1]
|
||||||
|
title := stripTags(matches[i][2])
|
||||||
|
title = strings.TrimSpace(title)
|
||||||
|
|
||||||
|
// URL decoding if needed
|
||||||
|
if strings.Contains(urlStr, "uddg=") {
|
||||||
|
if u, err := url.QueryUnescape(urlStr); err == nil {
|
||||||
|
idx := strings.Index(u, "uddg=")
|
||||||
|
if idx != -1 {
|
||||||
|
urlStr = u[idx+5:]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
lines = append(lines, fmt.Sprintf("%d. %s\n %s", i+1, title, urlStr))
|
||||||
|
|
||||||
|
// Attempt to attach snippet if available and index aligns
|
||||||
|
if i < len(snippetMatches) {
|
||||||
|
snippet := stripTags(snippetMatches[i][1])
|
||||||
|
snippet = strings.TrimSpace(snippet)
|
||||||
|
if snippet != "" {
|
||||||
|
lines = append(lines, fmt.Sprintf(" %s", snippet))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.Join(lines, "\n"), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func stripTags(content string) string {
|
||||||
|
re := regexp.MustCompile(`<[^>]+>`)
|
||||||
|
return re.ReplaceAllString(content, "")
|
||||||
|
}
|
||||||
|
|
||||||
|
type WebSearchTool struct {
|
||||||
|
provider SearchProvider
|
||||||
maxResults int
|
maxResults int
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewWebSearchTool(apiKey string, maxResults int) *WebSearchTool {
|
type WebSearchToolOptions struct {
|
||||||
if maxResults <= 0 || maxResults > 10 {
|
BraveAPIKey string
|
||||||
maxResults = 5
|
BraveMaxResults int
|
||||||
|
BraveEnabled bool
|
||||||
|
DuckDuckGoMaxResults int
|
||||||
|
DuckDuckGoEnabled bool
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func NewWebSearchTool(opts WebSearchToolOptions) *WebSearchTool {
|
||||||
|
var provider SearchProvider
|
||||||
|
maxResults := 5
|
||||||
|
|
||||||
|
// Priority: Brave > DuckDuckGo
|
||||||
|
if opts.BraveEnabled && opts.BraveAPIKey != "" {
|
||||||
|
provider = &BraveSearchProvider{apiKey: opts.BraveAPIKey}
|
||||||
|
if opts.BraveMaxResults > 0 {
|
||||||
|
maxResults = opts.BraveMaxResults
|
||||||
|
}
|
||||||
|
} else if opts.DuckDuckGoEnabled {
|
||||||
|
provider = &DuckDuckGoSearchProvider{}
|
||||||
|
if opts.DuckDuckGoMaxResults > 0 {
|
||||||
|
maxResults = opts.DuckDuckGoMaxResults
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
return &WebSearchTool{
|
return &WebSearchTool{
|
||||||
apiKey: apiKey,
|
provider: provider,
|
||||||
maxResults: maxResults,
|
maxResults: maxResults,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -59,10 +242,6 @@ func (t *WebSearchTool) Parameters() map[string]interface{} {
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *WebSearchTool) Execute(ctx context.Context, args map[string]interface{}) *ToolResult {
|
func (t *WebSearchTool) Execute(ctx context.Context, args map[string]interface{}) *ToolResult {
|
||||||
if t.apiKey == "" {
|
|
||||||
return ErrorResult("BRAVE_API_KEY not configured")
|
|
||||||
}
|
|
||||||
|
|
||||||
query, ok := args["query"].(string)
|
query, ok := args["query"].(string)
|
||||||
if !ok {
|
if !ok {
|
||||||
return ErrorResult("query is required")
|
return ErrorResult("query is required")
|
||||||
|
|
@ -75,68 +254,14 @@ func (t *WebSearchTool) Execute(ctx context.Context, args map[string]interface{}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
searchURL := fmt.Sprintf("https://api.search.brave.com/res/v1/web/search?q=%s&count=%d",
|
result, err := t.provider.Search(ctx, query, count)
|
||||||
url.QueryEscape(query), count)
|
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, "GET", searchURL, nil)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return ErrorResult(fmt.Sprintf("failed to create request: %v", err))
|
return ErrorResult(fmt.Sprintf("search failed: %v", err))
|
||||||
}
|
}
|
||||||
|
|
||||||
req.Header.Set("Accept", "application/json")
|
|
||||||
req.Header.Set("X-Subscription-Token", t.apiKey)
|
|
||||||
|
|
||||||
client := &http.Client{Timeout: 10 * time.Second}
|
|
||||||
resp, err := client.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return ErrorResult(fmt.Sprintf("request failed: %v", err))
|
|
||||||
}
|
|
||||||
defer resp.Body.Close()
|
|
||||||
|
|
||||||
body, err := io.ReadAll(resp.Body)
|
|
||||||
if err != nil {
|
|
||||||
return ErrorResult(fmt.Sprintf("failed to read response: %v", err))
|
|
||||||
}
|
|
||||||
|
|
||||||
var searchResp struct {
|
|
||||||
Web struct {
|
|
||||||
Results []struct {
|
|
||||||
Title string `json:"title"`
|
|
||||||
URL string `json:"url"`
|
|
||||||
Description string `json:"description"`
|
|
||||||
} `json:"results"`
|
|
||||||
} `json:"web"`
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := json.Unmarshal(body, &searchResp); err != nil {
|
|
||||||
return ErrorResult(fmt.Sprintf("failed to parse response: %v", err))
|
|
||||||
}
|
|
||||||
|
|
||||||
results := searchResp.Web.Results
|
|
||||||
if len(results) == 0 {
|
|
||||||
msg := fmt.Sprintf("No results for: %s", query)
|
|
||||||
return &ToolResult{
|
return &ToolResult{
|
||||||
ForLLM: msg,
|
ForLLM: result,
|
||||||
ForUser: msg,
|
ForUser: result,
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var lines []string
|
|
||||||
lines = append(lines, fmt.Sprintf("Results for: %s", query))
|
|
||||||
for i, item := range results {
|
|
||||||
if i >= count {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
lines = append(lines, fmt.Sprintf("%d. %s\n %s", i+1, item.Title, item.URL))
|
|
||||||
if item.Description != "" {
|
|
||||||
lines = append(lines, fmt.Sprintf(" %s", item.Description))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
output := strings.Join(lines, "\n")
|
|
||||||
return &ToolResult{
|
|
||||||
ForLLM: fmt.Sprintf("Found %d results for: %s", len(results), query),
|
|
||||||
ForUser: output,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -173,30 +173,19 @@ func TestWebTool_WebFetch_Truncation(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestWebTool_WebSearch_NoApiKey verifies error handling when API key is missing
|
// TestWebTool_WebSearch_NoApiKey verifies that nil is returned when no provider is configured
|
||||||
func TestWebTool_WebSearch_NoApiKey(t *testing.T) {
|
func TestWebTool_WebSearch_NoApiKey(t *testing.T) {
|
||||||
tool := NewWebSearchTool("", 5)
|
tool := NewWebSearchTool(WebSearchToolOptions{BraveAPIKey: "", BraveMaxResults: 5})
|
||||||
ctx := context.Background()
|
|
||||||
args := map[string]interface{}{
|
|
||||||
"query": "test",
|
|
||||||
}
|
|
||||||
|
|
||||||
result := tool.Execute(ctx, args)
|
// Should return nil when no provider is enabled
|
||||||
|
if tool != nil {
|
||||||
// Should return error result
|
t.Errorf("Expected nil when no search provider is configured")
|
||||||
if !result.IsError {
|
|
||||||
t.Errorf("Expected error when API key is missing")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Should mention missing API key
|
|
||||||
if !strings.Contains(result.ForLLM, "BRAVE_API_KEY") && !strings.Contains(result.ForUser, "BRAVE_API_KEY") {
|
|
||||||
t.Errorf("Expected API key error message, got ForLLM: %s", result.ForLLM)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestWebTool_WebSearch_MissingQuery verifies error handling for missing query
|
// TestWebTool_WebSearch_MissingQuery verifies error handling for missing query
|
||||||
func TestWebTool_WebSearch_MissingQuery(t *testing.T) {
|
func TestWebTool_WebSearch_MissingQuery(t *testing.T) {
|
||||||
tool := NewWebSearchTool("test-key", 5)
|
tool := NewWebSearchTool(WebSearchToolOptions{BraveAPIKey: "test-key", BraveMaxResults: 5, BraveEnabled: true})
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
args := map[string]interface{}{}
|
args := map[string]interface{}{}
|
||||||
|
|
||||||
|
|
|
||||||
64
skills/hardware/SKILL.md
Normal file
64
skills/hardware/SKILL.md
Normal file
|
|
@ -0,0 +1,64 @@
|
||||||
|
---
|
||||||
|
name: hardware
|
||||||
|
description: Read and control I2C and SPI peripherals on Sipeed boards (LicheeRV Nano, MaixCAM, NanoKVM).
|
||||||
|
homepage: https://wiki.sipeed.com/hardware/en/lichee/RV_Nano/1_intro.html
|
||||||
|
metadata: {"nanobot":{"emoji":"🔧","requires":{"tools":["i2c","spi"]}}}
|
||||||
|
---
|
||||||
|
|
||||||
|
# Hardware (I2C / SPI)
|
||||||
|
|
||||||
|
Use the `i2c` and `spi` tools to interact with sensors, displays, and other peripherals connected to the board.
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
```
|
||||||
|
# 1. Find available buses
|
||||||
|
i2c detect
|
||||||
|
|
||||||
|
# 2. Scan for connected devices
|
||||||
|
i2c scan (bus: "1")
|
||||||
|
|
||||||
|
# 3. Read from a sensor (e.g. AHT20 temperature/humidity)
|
||||||
|
i2c read (bus: "1", address: 0x38, register: 0xAC, length: 6)
|
||||||
|
|
||||||
|
# 4. SPI devices
|
||||||
|
spi list
|
||||||
|
spi read (device: "2.0", length: 4)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Before You Start — Pinmux Setup
|
||||||
|
|
||||||
|
Most I2C/SPI pins are shared with WiFi on Sipeed boards. You must configure pinmux before use.
|
||||||
|
|
||||||
|
See `references/board-pinout.md` for board-specific commands.
|
||||||
|
|
||||||
|
**Common steps:**
|
||||||
|
1. Stop WiFi if using shared pins: `/etc/init.d/S30wifi stop`
|
||||||
|
2. Load i2c-dev module: `modprobe i2c-dev`
|
||||||
|
3. Configure pinmux with `devmem` (board-specific)
|
||||||
|
4. Verify with `i2c detect` and `i2c scan`
|
||||||
|
|
||||||
|
## Safety
|
||||||
|
|
||||||
|
- **Write operations** require `confirm: true` — always confirm with the user first
|
||||||
|
- I2C addresses are validated to 7-bit range (0x03-0x77)
|
||||||
|
- SPI modes are validated (0-3 only)
|
||||||
|
- Maximum per-transaction: 256 bytes (I2C), 4096 bytes (SPI)
|
||||||
|
|
||||||
|
## Common Devices
|
||||||
|
|
||||||
|
See `references/common-devices.md` for register maps and usage of popular sensors:
|
||||||
|
AHT20, BME280, SSD1306 OLED, MPU6050 IMU, DS3231 RTC, INA219 power monitor, PCA9685 PWM, and more.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
| Problem | Solution |
|
||||||
|
|---------|----------|
|
||||||
|
| No I2C buses found | `modprobe i2c-dev` and check device tree |
|
||||||
|
| Permission denied | Run as root or add user to `i2c` group |
|
||||||
|
| No devices on scan | Check wiring, pull-up resistors (4.7k typical), and pinmux |
|
||||||
|
| Bus number changed | I2C adapter numbers can shift between boots; use `i2c detect` to find current assignment |
|
||||||
|
| WiFi stopped working | I2C-1/SPI-2 share pins with WiFi SDIO; can't use both simultaneously |
|
||||||
|
| `devmem` not found | Download separately or use `busybox devmem` |
|
||||||
|
| SPI transfer returns all zeros | Check MISO wiring and device power |
|
||||||
|
| SPI transfer returns all 0xFF | Device not responding; check CS pin and clock polarity (mode) |
|
||||||
131
skills/hardware/references/board-pinout.md
Normal file
131
skills/hardware/references/board-pinout.md
Normal file
|
|
@ -0,0 +1,131 @@
|
||||||
|
# Board Pinout & Pinmux Reference
|
||||||
|
|
||||||
|
## LicheeRV Nano (SG2002)
|
||||||
|
|
||||||
|
### I2C Buses
|
||||||
|
|
||||||
|
| Bus | Pins | Notes |
|
||||||
|
|-----|------|-------|
|
||||||
|
| I2C-1 | P18 (SCL), P21 (SDA) | **Shared with WiFi SDIO** — must stop WiFi first |
|
||||||
|
| I2C-3 | Available on header | Check device tree for pin assignment |
|
||||||
|
| I2C-5 | Software (BitBang) | Slower but no pin conflicts |
|
||||||
|
|
||||||
|
### SPI Buses
|
||||||
|
|
||||||
|
| Bus | Pins | Notes |
|
||||||
|
|-----|------|-------|
|
||||||
|
| SPI-2 | P18 (CS), P21 (MISO), P22 (MOSI), P23 (SCK) | **Shared with WiFi** — must stop WiFi first |
|
||||||
|
| SPI-4 | Software (BitBang) | Slower but no pin conflicts |
|
||||||
|
|
||||||
|
### Setup Steps for I2C-1
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. Stop WiFi (shares pins with I2C-1)
|
||||||
|
/etc/init.d/S30wifi stop
|
||||||
|
|
||||||
|
# 2. Configure pinmux for I2C-1
|
||||||
|
devmem 0x030010D0 b 0x2 # P18 → I2C1_SCL
|
||||||
|
devmem 0x030010DC b 0x2 # P21 → I2C1_SDA
|
||||||
|
|
||||||
|
# 3. Load i2c-dev module
|
||||||
|
modprobe i2c-dev
|
||||||
|
|
||||||
|
# 4. Verify
|
||||||
|
ls /dev/i2c-*
|
||||||
|
```
|
||||||
|
|
||||||
|
### Setup Steps for SPI-2
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. Stop WiFi (shares pins with SPI-2)
|
||||||
|
/etc/init.d/S30wifi stop
|
||||||
|
|
||||||
|
# 2. Configure pinmux for SPI-2
|
||||||
|
devmem 0x030010D0 b 0x1 # P18 → SPI2_CS
|
||||||
|
devmem 0x030010DC b 0x1 # P21 → SPI2_MISO
|
||||||
|
devmem 0x030010E0 b 0x1 # P22 → SPI2_MOSI
|
||||||
|
devmem 0x030010E4 b 0x1 # P23 → SPI2_SCK
|
||||||
|
|
||||||
|
# 3. Verify
|
||||||
|
ls /dev/spidev*
|
||||||
|
```
|
||||||
|
|
||||||
|
### Max Tested SPI Speed
|
||||||
|
- SPI-2 hardware: tested up to **93 MHz**
|
||||||
|
- `spidev_test` is pre-installed on the official image for loopback testing
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## MaixCAM
|
||||||
|
|
||||||
|
### I2C Buses
|
||||||
|
|
||||||
|
| Bus | Pins | Notes |
|
||||||
|
|-----|------|-------|
|
||||||
|
| I2C-1 | Overlaps with WiFi | Not recommended |
|
||||||
|
| I2C-3 | Overlaps with WiFi | Not recommended |
|
||||||
|
| I2C-5 | A15 (SCL), A27 (SDA) | **Recommended** — software I2C, no conflicts |
|
||||||
|
|
||||||
|
### Setup Steps for I2C-5
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Configure pins using pinmap utility
|
||||||
|
# (MaixCAM uses a pinmap tool instead of devmem)
|
||||||
|
# Refer to: https://wiki.sipeed.com/hardware/en/maixcam/gpio.html
|
||||||
|
|
||||||
|
# Load i2c-dev
|
||||||
|
modprobe i2c-dev
|
||||||
|
|
||||||
|
# Verify
|
||||||
|
ls /dev/i2c-*
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## MaixCAM2
|
||||||
|
|
||||||
|
### I2C Buses
|
||||||
|
|
||||||
|
| Bus | Pins | Notes |
|
||||||
|
|-----|------|-------|
|
||||||
|
| I2C-6 | A1 (SCL), A0 (SDA) | Available on header |
|
||||||
|
| I2C-7 | Available | Check device tree |
|
||||||
|
|
||||||
|
### Setup Steps
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Configure pinmap for I2C-6
|
||||||
|
# A1 → I2C6_SCL, A0 → I2C6_SDA
|
||||||
|
# Refer to MaixCAM2 documentation for pinmap commands
|
||||||
|
|
||||||
|
modprobe i2c-dev
|
||||||
|
ls /dev/i2c-*
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## NanoKVM
|
||||||
|
|
||||||
|
Uses the same SG2002 SoC as LicheeRV Nano. GPIO and I2C access follows the same pinmux procedure. Refer to the LicheeRV Nano section above.
|
||||||
|
|
||||||
|
Check NanoKVM-specific pin headers for available I2C/SPI lines:
|
||||||
|
- https://wiki.sipeed.com/hardware/en/kvm/NanoKVM/introduction.html
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Issues
|
||||||
|
|
||||||
|
### devmem not found
|
||||||
|
The `devmem` utility may not be in the default image. Options:
|
||||||
|
- Use `busybox devmem` if busybox is installed
|
||||||
|
- Download devmem from the Sipeed package repository
|
||||||
|
- Cross-compile from source (single C file)
|
||||||
|
|
||||||
|
### Dynamic bus numbering
|
||||||
|
I2C adapter numbers can change between boots depending on driver load order. Always use `i2c detect` to find current bus assignments rather than hardcoding bus numbers.
|
||||||
|
|
||||||
|
### Permissions
|
||||||
|
`/dev/i2c-*` and `/dev/spidev*` typically require root access. Options:
|
||||||
|
- Run picoclaw as root
|
||||||
|
- Add user to `i2c` and `spi` groups
|
||||||
|
- Create udev rules: `SUBSYSTEM=="i2c-dev", MODE="0666"`
|
||||||
78
skills/hardware/references/common-devices.md
Normal file
78
skills/hardware/references/common-devices.md
Normal file
|
|
@ -0,0 +1,78 @@
|
||||||
|
# Common I2C/SPI Device Reference
|
||||||
|
|
||||||
|
## I2C Devices
|
||||||
|
|
||||||
|
### AHT20 — Temperature & Humidity
|
||||||
|
- **Address:** 0x38
|
||||||
|
- **Init:** Write `[0xBE, 0x08, 0x00]` then wait 10ms
|
||||||
|
- **Measure:** Write `[0xAC, 0x33, 0x00]`, wait 80ms, read 6 bytes
|
||||||
|
- **Parse:** Status=byte[0], Humidity=(byte[1]<<12|byte[2]<<4|byte[3]>>4)/2^20*100, Temp=(byte[3]&0x0F<<16|byte[4]<<8|byte[5])/2^20*200-50
|
||||||
|
- **Notes:** No register addressing — write command bytes directly (omit `register` param)
|
||||||
|
|
||||||
|
### BME280 / BMP280 — Temperature, Humidity, Pressure
|
||||||
|
- **Address:** 0x76 or 0x77 (SDO pin selects)
|
||||||
|
- **Chip ID register:** 0xD0 → BMP280=0x58, BME280=0x60
|
||||||
|
- **Data registers:** 0xF7-0xFE (pressure, temperature, humidity)
|
||||||
|
- **Config:** Write 0xF2 (humidity oversampling), 0xF4 (temp/press oversampling + mode), 0xF5 (standby, filter)
|
||||||
|
- **Forced measurement:** Write `[0x25]` to register 0xF4, wait 40ms, read 8 bytes from 0xF7
|
||||||
|
- **Calibration:** Read 26 bytes from 0x88 and 7 bytes from 0xE1 for compensation formulas
|
||||||
|
- **Also available via SPI** (mode 0 or 3)
|
||||||
|
|
||||||
|
### SSD1306 — 128x64 OLED Display
|
||||||
|
- **Address:** 0x3C (or 0x3D if SA0 high)
|
||||||
|
- **Command prefix:** 0x00 (write to register 0x00)
|
||||||
|
- **Data prefix:** 0x40 (write to register 0x40)
|
||||||
|
- **Init sequence:** `[0xAE, 0xD5, 0x80, 0xA8, 0x3F, 0xD3, 0x00, 0x40, 0x8D, 0x14, 0x20, 0x00, 0xA1, 0xC8, 0xDA, 0x12, 0x81, 0xCF, 0xD9, 0xF1, 0xDB, 0x40, 0xA4, 0xA6, 0xAF]`
|
||||||
|
- **Display on:** 0xAF, **Display off:** 0xAE
|
||||||
|
- **Also available via SPI** (faster, recommended for animations)
|
||||||
|
|
||||||
|
### MPU6050 — 6-axis Accelerometer + Gyroscope
|
||||||
|
- **Address:** 0x68 (or 0x69 if AD0 high)
|
||||||
|
- **WHO_AM_I:** Register 0x75 → should return 0x68
|
||||||
|
- **Wake up:** Write `[0x00]` to register 0x6B (clear sleep bit)
|
||||||
|
- **Read accel:** 6 bytes from register 0x3B (XH,XL,YH,YL,ZH,ZL) — signed 16-bit, default ±2g
|
||||||
|
- **Read gyro:** 6 bytes from register 0x43 — signed 16-bit, default ±250°/s
|
||||||
|
- **Read temp:** 2 bytes from register 0x41 — Temp°C = value/340 + 36.53
|
||||||
|
|
||||||
|
### DS3231 — Real-Time Clock
|
||||||
|
- **Address:** 0x68
|
||||||
|
- **Read time:** 7 bytes from register 0x00 (seconds, minutes, hours, day, date, month, year) — BCD encoded
|
||||||
|
- **Set time:** Write 7 BCD bytes to register 0x00
|
||||||
|
- **Temperature:** 2 bytes from register 0x11 (signed, 0.25°C resolution)
|
||||||
|
- **Status:** Register 0x0F — bit 2 = busy, bit 0 = alarm 1 flag
|
||||||
|
|
||||||
|
### INA219 — Current & Power Monitor
|
||||||
|
- **Address:** 0x40-0x4F (A0,A1 pin selectable)
|
||||||
|
- **Config:** Register 0x00 — set voltage range, gain, ADC resolution
|
||||||
|
- **Shunt voltage:** Register 0x01 (signed 16-bit, LSB=10µV)
|
||||||
|
- **Bus voltage:** Register 0x02 (bits 15:3, LSB=4mV)
|
||||||
|
- **Power:** Register 0x03 (after calibration)
|
||||||
|
- **Current:** Register 0x04 (after calibration)
|
||||||
|
- **Calibration:** Register 0x05 — set based on shunt resistor value
|
||||||
|
|
||||||
|
### PCA9685 — 16-Channel PWM / Servo Controller
|
||||||
|
- **Address:** 0x40-0x7F (A0-A5 selectable, default 0x40)
|
||||||
|
- **Mode 1:** Register 0x00 — bit 4=sleep, bit 5=auto-increment
|
||||||
|
- **Set PWM freq:** Sleep → write prescale to 0xFE → wake. Prescale = round(25MHz / (4096 × freq)) - 1
|
||||||
|
- **Channel N on/off:** Registers 0x06+4*N to 0x09+4*N (ON_L, ON_H, OFF_L, OFF_H)
|
||||||
|
- **Servo 0°-180°:** ON=0, OFF=150-600 (at 50Hz). Typical: 0°=150, 90°=375, 180°=600
|
||||||
|
|
||||||
|
### AT24C256 — 256Kbit EEPROM
|
||||||
|
- **Address:** 0x50-0x57 (A0-A2 selectable)
|
||||||
|
- **Read:** Write 2-byte address (high, low), then read N bytes
|
||||||
|
- **Write:** Write 2-byte address + up to 64 bytes (page write), wait 5ms for write cycle
|
||||||
|
- **Page size:** 64 bytes. Writes that cross page boundary wrap around.
|
||||||
|
|
||||||
|
## SPI Devices
|
||||||
|
|
||||||
|
### MCP3008 — 8-Channel 10-bit ADC
|
||||||
|
- **Interface:** SPI mode 0, max 3.6 MHz @ 5V
|
||||||
|
- **Read channel N:** Send `[0x01, (0x80 | N<<4), 0x00]`, result in last 10 bits of bytes 1-2
|
||||||
|
- **Formula:** value = ((byte[1] & 0x03) << 8) | byte[2]
|
||||||
|
- **Voltage:** value × Vref / 1024
|
||||||
|
|
||||||
|
### W25Q128 — 128Mbit SPI Flash
|
||||||
|
- **Interface:** SPI mode 0 or 3, up to 104 MHz
|
||||||
|
- **Read ID:** Send `[0x9F, 0, 0, 0]` → manufacturer + device ID
|
||||||
|
- **Read data:** Send `[0x03, addr_high, addr_mid, addr_low]` + N zero bytes
|
||||||
|
- **Status:** Send `[0x05, 0]` → bit 0 = BUSY
|
||||||
Loading…
Add table
Reference in a new issue