mecha10-templates 0.6.2

Mecha10 project templates — code generation, init, and template services
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

//! Driver code generation templates

use crate::utils::to_pascal_case;

/// Render a driver source file for one of the standard driver kinds.
///
/// All driver templates (sensor, actuator, controller) share the same
/// `Config` struct + driver struct + `impl Driver` scaffolding and differ
/// only in the config fields, the log label used in init/shutdown, the
/// init/update/shutdown TODO bodies, and any extra inherent methods (e.g.
/// the actuator's `set_command`). This helper factors that shape out so
/// each `*_driver` function only supplies the varying pieces.
#[allow(clippy::too_many_arguments)]
fn driver_template(
    name: &str,
    title: &str,
    config_fields: &str,
    extra_methods: &str,
    log_label: &str,
    init_todo: &str,
    update_todo: &str,
    shutdown_todo: &str,
) -> String {
    let pascal = to_pascal_case(name);
    format!(
        r#"//! {name} - {title}
//!
//! Auto-generated driver template.

use anyhow::Result;
use mecha10_core::Driver;
use serde::{{Deserialize, Serialize}};
use tracing::info;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct {pascal}Config {{
{config_fields}
}}

pub struct {pascal} {{
    config: {pascal}Config,
}}

impl {pascal} {{
    pub fn new(config: {pascal}Config) -> Self {{
        Self {{ config }}
    }}
{extra_methods}}}

#[async_trait::async_trait]
impl Driver for {pascal} {{
    async fn initialize(&mut self) -> Result<()> {{
        info!("Initializing {name} {log_label}");
        {init_todo}
        Ok(())
    }}

    async fn update(&mut self) -> Result<()> {{
        {update_todo}
        Ok(())
    }}

    async fn shutdown(&mut self) -> Result<()> {{
        info!("Shutting down {name} {log_label}");
        {shutdown_todo}Ok(())
    }}
}}
"#,
    )
}

/// Generate sensor driver template
pub fn sensor_driver(name: &str) -> String {
    driver_template(
        name,
        "Sensor Driver",
        "    pub update_rate_hz: f64,",
        "",
        "driver",
        "// TODO: Initialize hardware/sensor",
        "// TODO: Read sensor data\n        // TODO: Publish to message bus",
        "",
    )
}

/// Generate actuator driver template
pub fn actuator_driver(name: &str) -> String {
    driver_template(
        name,
        "Actuator Driver",
        "    pub max_speed: f64,\n    pub acceleration: f64,",
        "\n    pub async fn set_command(&mut self, command: f64) -> Result<()> {\n        // TODO: Send command to actuator\n        Ok(())\n    }\n",
        "driver",
        "// TODO: Initialize actuator",
        "// TODO: Process actuator commands from message bus",
        "// TODO: Stop actuator safely\n        ",
    )
}

/// Generate controller driver template
pub fn controller_driver(name: &str) -> String {
    driver_template(
        name,
        "Controller Driver",
        "    pub control_rate_hz: f64,",
        "",
        "controller",
        "// TODO: Initialize controller",
        "// TODO: Run control loop",
        "",
    )
}