zeroclawlabs 0.6.9

Zero overhead. Zero compromise. 100% Rust. The fastest, smallest AI assistant.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
//! Aardvark hardware tools — I2C, SPI, and GPIO operations via the Total Phase
//! Aardvark USB adapter.
//!
//! All tools follow the same pattern as the built-in GPIO tools:
//! 1. Accept an optional `device` alias parameter.
//! 2. Resolve the Aardvark device from the [`DeviceRegistry`].
//! 3. Build a [`ZcCommand`] and send it through the registered transport.
//! 4. Return a [`ToolResult`] with human-readable output.
//!
//! These tools are only registered when at least one Aardvark adapter is
//! detected at startup (see [`DeviceRegistry::has_aardvark`]).

use super::device::DeviceRegistry;
use super::protocol::ZcCommand;
use crate::tools::traits::{Tool, ToolResult};
use async_trait::async_trait;
use serde_json::json;
use std::sync::Arc;
use tokio::sync::RwLock;

// ── Factory ───────────────────────────────────────────────────────────────────

/// Build the five Aardvark hardware tools.
///
/// Called from [`ToolRegistry::load`] when an Aardvark adapter is present.
pub fn aardvark_tools(devices: Arc<RwLock<DeviceRegistry>>) -> Vec<Box<dyn Tool>> {
    vec![
        Box::new(I2cScanTool::new(devices.clone())),
        Box::new(I2cReadTool::new(devices.clone())),
        Box::new(I2cWriteTool::new(devices.clone())),
        Box::new(SpiTransferTool::new(devices.clone())),
        Box::new(GpioAardvarkTool::new(devices.clone())),
    ]
}

// ── Helpers ───────────────────────────────────────────────────────────────────

/// Resolve the Aardvark device from args and return an owned `DeviceContext`.
///
/// Thin wrapper so individual tool `execute` methods don't duplicate the logic.
async fn resolve(
    registry: &Arc<RwLock<DeviceRegistry>>,
    args: &serde_json::Value,
) -> Result<(String, super::device::DeviceContext), ToolResult> {
    let reg = registry.read().await;
    reg.resolve_aardvark_device(args).map_err(|msg| ToolResult {
        success: false,
        output: String::new(),
        error: Some(msg),
    })
}

// ── I2cScanTool ───────────────────────────────────────────────────────────────

/// Tool: scan the I2C bus for responding device addresses.
pub struct I2cScanTool {
    registry: Arc<RwLock<DeviceRegistry>>,
}

impl I2cScanTool {
    pub fn new(registry: Arc<RwLock<DeviceRegistry>>) -> Self {
        Self { registry }
    }
}

#[async_trait]
impl Tool for I2cScanTool {
    fn name(&self) -> &str {
        "i2c_scan"
    }

    fn description(&self) -> &str {
        "Scan the I2C bus via the Aardvark USB adapter and return all responding \
         device addresses in hex (e.g. [0x48, 0x68])"
    }

    fn parameters_schema(&self) -> serde_json::Value {
        json!({
            "type": "object",
            "properties": {
                "device": {
                    "type": "string",
                    "description": "Aardvark device alias (e.g. aardvark0). Omit to auto-select."
                }
            },
            "required": []
        })
    }

    async fn execute(&self, args: serde_json::Value) -> anyhow::Result<ToolResult> {
        let (_alias, ctx) = match resolve(&self.registry, &args).await {
            Ok(v) => v,
            Err(result) => return Ok(result),
        };

        let cmd = ZcCommand::simple("i2c_scan");
        match ctx.transport.send(&cmd).await {
            Ok(resp) if resp.ok => {
                let devices = resp
                    .data
                    .get("devices")
                    .and_then(|v| v.as_array())
                    .cloned()
                    .unwrap_or_default();
                let output = if devices.is_empty() {
                    "I2C scan complete — no devices found on the bus.".to_string()
                } else {
                    let addrs: Vec<&str> = devices.iter().filter_map(|v| v.as_str()).collect();
                    format!(
                        "I2C scan found {} device(s): {}",
                        addrs.len(),
                        addrs.join(", ")
                    )
                };
                Ok(ToolResult {
                    success: true,
                    output,
                    error: None,
                })
            }
            Ok(resp) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(
                    resp.error
                        .unwrap_or_else(|| "i2c_scan: device returned ok:false".to_string()),
                ),
            }),
            Err(e) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(format!("transport error: {e}")),
            }),
        }
    }
}

// ── I2cReadTool ───────────────────────────────────────────────────────────────

/// Tool: read bytes from an I2C device register.
pub struct I2cReadTool {
    registry: Arc<RwLock<DeviceRegistry>>,
}

impl I2cReadTool {
    pub fn new(registry: Arc<RwLock<DeviceRegistry>>) -> Self {
        Self { registry }
    }
}

#[async_trait]
impl Tool for I2cReadTool {
    fn name(&self) -> &str {
        "i2c_read"
    }

    fn description(&self) -> &str {
        "Read bytes from an I2C device via the Aardvark USB adapter. \
         Provide the I2C address and optionally a register to read from."
    }

    fn parameters_schema(&self) -> serde_json::Value {
        json!({
            "type": "object",
            "properties": {
                "device": {
                    "type": "string",
                    "description": "Aardvark device alias (e.g. aardvark0). Omit to auto-select."
                },
                "addr": {
                    "type": "integer",
                    "description": "I2C device address (e.g. 72 for 0x48)"
                },
                "register": {
                    "type": "integer",
                    "description": "Register address to read from (optional)"
                },
                "len": {
                    "type": "integer",
                    "description": "Number of bytes to read",
                    "default": 1
                }
            },
            "required": ["addr"]
        })
    }

    async fn execute(&self, args: serde_json::Value) -> anyhow::Result<ToolResult> {
        let addr = match args.get("addr").and_then(|v| v.as_u64()) {
            Some(a) => a,
            None => {
                return Ok(ToolResult {
                    success: false,
                    output: String::new(),
                    error: Some("missing required parameter: addr".to_string()),
                });
            }
        };
        let len = args.get("len").and_then(|v| v.as_u64()).unwrap_or(1);

        let (_alias, ctx) = match resolve(&self.registry, &args).await {
            Ok(v) => v,
            Err(result) => return Ok(result),
        };

        let mut params = json!({ "addr": addr, "len": len });
        if let Some(reg) = args.get("register").and_then(|v| v.as_u64()) {
            params["register"] = json!(reg);
        }
        let cmd = ZcCommand::new("i2c_read", params);

        match ctx.transport.send(&cmd).await {
            Ok(resp) if resp.ok => {
                let hex = resp
                    .data
                    .get("hex")
                    .and_then(|v| v.as_array())
                    .map(|a| {
                        a.iter()
                            .filter_map(|v| v.as_str())
                            .collect::<Vec<_>>()
                            .join(", ")
                    })
                    .unwrap_or_else(|| "?".to_string());
                Ok(ToolResult {
                    success: true,
                    output: format!("I2C read from addr {addr:#04x}: [{hex}]"),
                    error: None,
                })
            }
            Ok(resp) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(
                    resp.error
                        .unwrap_or_else(|| "i2c_read: device returned ok:false".to_string()),
                ),
            }),
            Err(e) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(format!("transport error: {e}")),
            }),
        }
    }
}

// ── I2cWriteTool ──────────────────────────────────────────────────────────────

/// Tool: write bytes to an I2C device.
pub struct I2cWriteTool {
    registry: Arc<RwLock<DeviceRegistry>>,
}

impl I2cWriteTool {
    pub fn new(registry: Arc<RwLock<DeviceRegistry>>) -> Self {
        Self { registry }
    }
}

#[async_trait]
impl Tool for I2cWriteTool {
    fn name(&self) -> &str {
        "i2c_write"
    }

    fn description(&self) -> &str {
        "Write bytes to an I2C device via the Aardvark USB adapter"
    }

    fn parameters_schema(&self) -> serde_json::Value {
        json!({
            "type": "object",
            "properties": {
                "device": {
                    "type": "string",
                    "description": "Aardvark device alias (e.g. aardvark0). Omit to auto-select."
                },
                "addr": {
                    "type": "integer",
                    "description": "I2C device address (e.g. 72 for 0x48)"
                },
                "bytes": {
                    "type": "array",
                    "items": { "type": "integer" },
                    "description": "Bytes to write (e.g. [1, 96] for register 0x01 config 0x60)"
                }
            },
            "required": ["addr", "bytes"]
        })
    }

    async fn execute(&self, args: serde_json::Value) -> anyhow::Result<ToolResult> {
        let addr = match args.get("addr").and_then(|v| v.as_u64()) {
            Some(a) => a,
            None => {
                return Ok(ToolResult {
                    success: false,
                    output: String::new(),
                    error: Some("missing required parameter: addr".to_string()),
                });
            }
        };
        let bytes = match args.get("bytes").and_then(|v| v.as_array()) {
            Some(b) => b.clone(),
            None => {
                return Ok(ToolResult {
                    success: false,
                    output: String::new(),
                    error: Some("missing required parameter: bytes".to_string()),
                });
            }
        };

        let (_alias, ctx) = match resolve(&self.registry, &args).await {
            Ok(v) => v,
            Err(result) => return Ok(result),
        };

        let cmd = ZcCommand::new("i2c_write", json!({ "addr": addr, "bytes": bytes }));

        match ctx.transport.send(&cmd).await {
            Ok(resp) if resp.ok => {
                let n = resp
                    .data
                    .get("bytes_written")
                    .and_then(|v| v.as_u64())
                    .unwrap_or(bytes.len() as u64);
                Ok(ToolResult {
                    success: true,
                    output: format!("I2C write to addr {addr:#04x}: {n} byte(s) written"),
                    error: None,
                })
            }
            Ok(resp) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(
                    resp.error
                        .unwrap_or_else(|| "i2c_write: device returned ok:false".to_string()),
                ),
            }),
            Err(e) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(format!("transport error: {e}")),
            }),
        }
    }
}

// ── SpiTransferTool ───────────────────────────────────────────────────────────

/// Tool: full-duplex SPI transfer.
pub struct SpiTransferTool {
    registry: Arc<RwLock<DeviceRegistry>>,
}

impl SpiTransferTool {
    pub fn new(registry: Arc<RwLock<DeviceRegistry>>) -> Self {
        Self { registry }
    }
}

#[async_trait]
impl Tool for SpiTransferTool {
    fn name(&self) -> &str {
        "spi_transfer"
    }

    fn description(&self) -> &str {
        "Perform a full-duplex SPI transfer via the Aardvark USB adapter. \
         Sends the given bytes and returns the received bytes (same length)."
    }

    fn parameters_schema(&self) -> serde_json::Value {
        json!({
            "type": "object",
            "properties": {
                "device": {
                    "type": "string",
                    "description": "Aardvark device alias (e.g. aardvark0). Omit to auto-select."
                },
                "bytes": {
                    "type": "array",
                    "items": { "type": "integer" },
                    "description": "Bytes to send (received bytes have the same length)"
                }
            },
            "required": ["bytes"]
        })
    }

    async fn execute(&self, args: serde_json::Value) -> anyhow::Result<ToolResult> {
        let bytes = match args.get("bytes").and_then(|v| v.as_array()) {
            Some(b) => b.clone(),
            None => {
                return Ok(ToolResult {
                    success: false,
                    output: String::new(),
                    error: Some("missing required parameter: bytes".to_string()),
                });
            }
        };

        let (_alias, ctx) = match resolve(&self.registry, &args).await {
            Ok(v) => v,
            Err(result) => return Ok(result),
        };

        let cmd = ZcCommand::new("spi_transfer", json!({ "bytes": bytes }));

        match ctx.transport.send(&cmd).await {
            Ok(resp) if resp.ok => {
                let hex = resp
                    .data
                    .get("hex")
                    .and_then(|v| v.as_array())
                    .map(|a| {
                        a.iter()
                            .filter_map(|v| v.as_str())
                            .collect::<Vec<_>>()
                            .join(", ")
                    })
                    .unwrap_or_else(|| "?".to_string());
                Ok(ToolResult {
                    success: true,
                    output: format!("SPI transfer complete. Received: [{hex}]"),
                    error: None,
                })
            }
            Ok(resp) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(
                    resp.error
                        .unwrap_or_else(|| "spi_transfer: device returned ok:false".to_string()),
                ),
            }),
            Err(e) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(format!("transport error: {e}")),
            }),
        }
    }
}

// ── GpioAardvarkTool ──────────────────────────────────────────────────────────

/// Tool: set or read the Aardvark adapter's GPIO pins.
///
/// The Aardvark has 8 GPIO pins accessible via the 10-pin expansion header.
/// Each pin can be configured as input or output via bitmasks.
pub struct GpioAardvarkTool {
    registry: Arc<RwLock<DeviceRegistry>>,
}

impl GpioAardvarkTool {
    pub fn new(registry: Arc<RwLock<DeviceRegistry>>) -> Self {
        Self { registry }
    }
}

#[async_trait]
impl Tool for GpioAardvarkTool {
    fn name(&self) -> &str {
        "gpio_aardvark"
    }

    fn description(&self) -> &str {
        "Set or read the Aardvark USB adapter GPIO pins via bitmasks. \
         Use action='set' with direction and value bitmasks to drive output pins, \
         or action='get' to read current pin states."
    }

    fn parameters_schema(&self) -> serde_json::Value {
        json!({
            "type": "object",
            "properties": {
                "device": {
                    "type": "string",
                    "description": "Aardvark device alias (e.g. aardvark0). Omit to auto-select."
                },
                "action": {
                    "type": "string",
                    "enum": ["set", "get"],
                    "description": "'set' to write GPIO pins, 'get' to read pin states"
                },
                "direction": {
                    "type": "integer",
                    "description": "For action='set': bitmask of output pins (1=output, 0=input)"
                },
                "value": {
                    "type": "integer",
                    "description": "For action='set': bitmask of output pin levels (1=high, 0=low)"
                }
            },
            "required": ["action"]
        })
    }

    async fn execute(&self, args: serde_json::Value) -> anyhow::Result<ToolResult> {
        let action = match args.get("action").and_then(|v| v.as_str()) {
            Some(a) => a.to_string(),
            None => {
                return Ok(ToolResult {
                    success: false,
                    output: String::new(),
                    error: Some("missing required parameter: action".to_string()),
                });
            }
        };

        let (_alias, ctx) = match resolve(&self.registry, &args).await {
            Ok(v) => v,
            Err(result) => return Ok(result),
        };

        let cmd = match action.as_str() {
            "set" => {
                let direction = args.get("direction").and_then(|v| v.as_u64()).unwrap_or(0);
                let value = args.get("value").and_then(|v| v.as_u64()).unwrap_or(0);
                ZcCommand::new(
                    "gpio_set",
                    json!({ "direction": direction, "value": value }),
                )
            }
            "get" => ZcCommand::simple("gpio_get"),
            other => {
                return Ok(ToolResult {
                    success: false,
                    output: String::new(),
                    error: Some(format!("unknown action '{other}'; use 'set' or 'get'")),
                });
            }
        };

        match ctx.transport.send(&cmd).await {
            Ok(resp) if resp.ok => {
                let output = if action == "get" {
                    let val = resp.data.get("value").and_then(|v| v.as_u64()).unwrap_or(0);
                    format!("Aardvark GPIO pins: {val:#010b} (0x{val:02x})")
                } else {
                    let dir = resp
                        .data
                        .get("direction")
                        .and_then(|v| v.as_u64())
                        .unwrap_or(0);
                    let val = resp.data.get("value").and_then(|v| v.as_u64()).unwrap_or(0);
                    format!("Aardvark GPIO set — direction: {dir:#010b}, value: {val:#010b}")
                };
                Ok(ToolResult {
                    success: true,
                    output,
                    error: None,
                })
            }
            Ok(resp) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(
                    resp.error
                        .unwrap_or_else(|| "gpio_aardvark: device returned ok:false".to_string()),
                ),
            }),
            Err(e) => Ok(ToolResult {
                success: false,
                output: String::new(),
                error: Some(format!("transport error: {e}")),
            }),
        }
    }
}