hippox-drivers 0.3.5

🦛All indivisible atomic driver units in Hippox.
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

//! Bluetooth LE advertise start skill - start BLE advertising
//!
//! This driver provides functionality to start BLE advertising, making
//! the device discoverable to BLE scanners.
use crate::DriverCallback;
use crate::DriverContext;
use crate::{
    DriverCategory, DriverError, DriverResult,
    types::{Driver, DriverParameter},
};
use serde_json::{Value, json};
use std::collections::HashMap;
use std::process::Command;
use tracing::{debug, info, warn};
/// Driver for starting BLE advertising
///
/// This driver starts BLE advertising to broadcast the device's presence
/// to BLE scanners, useful for IoT and sensor applications.
#[derive(Debug)]
pub struct BluetoothLeAdvertiseStartDriver;
#[async_trait::async_trait]
impl Driver for BluetoothLeAdvertiseStartDriver {
    /// Returns the unique name of this driver
    fn name(&self) -> &str {
        "bluetooth_le_advertise_start"
    }
    /// Returns a brief description of the driver's functionality
    fn description(&self) -> &str {
        "Start BLE advertising to make the device discoverable to BLE scanners"
    }
    /// Returns detailed usage guidance for LLMs
    fn usage_hint(&self) -> &str {
        "Use this skill to broadcast your device's presence to BLE devices. Useful for IoT and sensor applications."
    }
    /// Returns the parameter definitions for this driver
    fn parameters(&self) -> Vec<DriverParameter> {
        return vec![
            DriverParameter {
                name: "service_uuid".to_string(),
                param_type: "string".to_string(),
                description: "UUID of the service to advertise (optional)".to_string(),
                required: false,
                default: None,
                example: Some(Value::String("0000180f-0000-1000-8000-00805f9b34fb".to_string())),
                enum_values: None,
            },
            DriverParameter {
                name: "manufacturer_data".to_string(),
                param_type: "string".to_string(),
                description: "Manufacturer specific data (hex format)".to_string(),
                required: false,
                default: None,
                example: Some(Value::String("0x01020304".to_string())),
                enum_values: None,
            },
        ];
    }
    /// Returns an example call for this driver
    fn example_call(&self) -> DriverResult<Value> {
        return Ok(json!({
            "action": "bluetooth_le_advertise_start",
            "parameters": {
                "service_uuid": "0000180f-0000-1000-8000-00805f9b34fb"
            }
        }));
    }
    /// Returns an example output from this driver
    fn example_output(&self) -> String {
        "BLE advertising started".to_string()
    }
    /// Returns the category of this driver
    fn category(&self) -> DriverCategory {
        DriverCategory::Bluetooth
    }
    /// Executes the driver with the given parameters
    async fn execute(
        &self,
        parameters: &HashMap<String, Value>,
        callback: Option<&dyn DriverCallback>,
        context: Option<&DriverContext>,
    ) -> DriverResult<String> {
        debug!("Executing bluetooth_le_advertise_start driver");
        let service_uuid = parameters.get("service_uuid").and_then(|v| v.as_str());
        debug!("Starting BLE advertising, service_uuid: {:?}", service_uuid);
        #[cfg(target_os = "linux")]
        {
            debug!("Executing bluetoothctl advertise on");
            let output = crate::common::hidden_cmd("bluetoothctl")
                .args(["advertise", "on"])
                .output()
                .map_err(|e| DriverError::execution(format!("Failed to execute bluetoothctl: {}", e)))?;
            if !output.status.success() {
                let stderr = String::from_utf8_lossy(&output.stderr);
                warn!("bluetoothctl advertise on failed: {}", stderr);
                return Err(DriverError::execution(format!("Failed to start advertising: {}", stderr)));
            }
            if let Some(uuid) = service_uuid {
                debug!("Setting advertise service: {}", uuid);
                let _ = crate::common::hidden_cmd("bluetoothctl").args(["advertise", "service", uuid]).output().ok();
            }
        }
        info!("BLE advertising started");
        return Ok("BLE advertising started".to_string());
    }
}