mecha10-core 0.6.2

Mecha10 core runtime and foundational types
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
//! Example usage of Dependency Ordering for Node Startup/Shutdown
//!
//! This example demonstrates how to use the dependency resolution system to
//! ensure nodes start and stop in the correct order based on their dependencies.

use mecha10::prelude::*;
use std::collections::HashSet;

/// Example 1: Simple dependency chain
pub fn simple_chain_example() -> Result<()> {
    info!("Example 1: Simple dependency chain");

    let graph = create_graph(&[
        ("camera", vec![]),
        ("vision", vec!["camera"]),
        ("planner", vec!["vision"]),
        ("controller", vec!["planner"]),
    ])?;

    // Startup order
    let startup = graph.topological_sort()?;
    info!("Startup order: {:?}", startup);
    // Output: ["camera", "vision", "planner", "controller"]

    // Shutdown order (reverse)
    let shutdown = graph.reverse_topological_sort()?;
    info!("Shutdown order: {:?}", shutdown);
    // Output: ["controller", "planner", "vision", "camera"]

    Ok(())
}

/// Example 2: Parallel dependencies
pub fn parallel_dependencies_example() -> Result<()> {
    info!("Example 2: Parallel dependencies");

    let graph = create_graph(&[
        ("camera", vec![]),
        ("lidar", vec![]),
        ("imu", vec![]),
        ("sensor_fusion", vec!["camera", "lidar", "imu"]),
        ("localization", vec!["sensor_fusion"]),
    ])?;

    // Get startup plan with parallelization
    let plan = graph.startup_plan()?;

    info!("Startup plan with {} levels", plan.level_count());
    for (i, level) in plan.levels.iter().enumerate() {
        info!(
            "  Level {}: {:?} ({} nodes can start in parallel)",
            i,
            level,
            level.len()
        );
    }

    // Level 0: camera, lidar, imu (parallel)
    // Level 1: sensor_fusion (waits for all sensors)
    // Level 2: localization (waits for fusion)

    info!("Maximum parallelism: {} nodes", plan.max_parallelism());

    Ok(())
}

/// Example 3: Complex robot system
pub fn complex_system_example() -> Result<()> {
    info!("Example 3: Complex robot system");

    let graph = create_graph(&[
        // Hardware drivers (no dependencies)
        ("camera_driver", vec![]),
        ("lidar_driver", vec![]),
        ("imu_driver", vec![]),
        ("motor_driver", vec![]),
        // Sensor processing (depends on drivers)
        ("image_processor", vec!["camera_driver"]),
        ("point_cloud_processor", vec!["lidar_driver"]),
        ("odometry", vec!["imu_driver", "motor_driver"]),
        // Perception (depends on processed data)
        ("object_detector", vec!["image_processor"]),
        ("lane_detector", vec!["image_processor"]),
        ("obstacle_detector", vec!["point_cloud_processor"]),
        // High-level planning (depends on perception)
        ("localization", vec!["odometry", "point_cloud_processor"]),
        ("path_planner", vec!["localization", "obstacle_detector"]),
        ("behavior_planner", vec!["object_detector", "lane_detector"]),
        // Control (depends on planning)
        ("motion_controller", vec!["path_planner", "behavior_planner"]),
    ])?;

    let plan = graph.startup_plan()?;

    info!("\nComplex system startup plan:");
    info!("Total nodes: {}", plan.node_count());
    info!("Total levels: {}", plan.level_count());
    info!("Max parallelism: {}\n", plan.max_parallelism());

    for (i, level) in plan.levels.iter().enumerate() {
        info!("Level {}: {} nodes", i, level.len());
        info!("  {:?}", level);
    }

    // Shutdown plan (reversed)
    let shutdown = graph.shutdown_plan()?;
    info!("\nShutdown plan (first 2 levels):");
    for (i, level) in shutdown.levels.iter().take(2).enumerate() {
        info!("Level {}: {:?}", i, level);
    }

    Ok(())
}

/// Example 4: Detecting circular dependencies
pub fn circular_dependency_example() -> Result<()> {
    info!("Example 4: Detecting circular dependencies");

    let result = create_graph(&[
        ("node_a", vec!["node_b"]),
        ("node_b", vec!["node_c"]),
        ("node_c", vec!["node_a"]), // ❌ Creates cycle!
    ]);

    match result {
        Ok(_) => warn!("Unexpectedly passed validation"),
        Err(e) => {
            info!("✓ Correctly detected circular dependency:");
            info!("  {}", e);
        }
    }

    Ok(())
}

/// Example 5: Checking if nodes can start/stop
pub fn can_start_stop_example() -> Result<()> {
    info!("Example 5: Checking if nodes can start/stop");

    let graph = create_graph(&[
        ("camera", vec![]),
        ("vision", vec!["camera"]),
        ("planner", vec!["vision"]),
    ])?;

    let mut running = HashSet::new();

    // Check which nodes can start
    info!("\nInitial state (nothing running):");
    info!("  camera can start: {}", graph.can_start("camera", &running));
    info!("  vision can start: {}", graph.can_start("vision", &running));
    info!("  planner can start: {}", graph.can_start("planner", &running));

    // Start camera
    running.insert("camera".to_string());
    info!("\nAfter starting camera:");
    info!("  vision can start: {}", graph.can_start("vision", &running));
    info!("  planner can start: {}", graph.can_start("planner", &running));

    // Start vision
    running.insert("vision".to_string());
    info!("\nAfter starting vision:");
    info!("  planner can start: {}", graph.can_start("planner", &running));

    // Start planner
    running.insert("planner".to_string());

    // Check which nodes can stop
    info!("\nAll nodes running - checking stop order:");
    info!("  camera can stop: {}", graph.can_stop("camera", &running));
    info!("  vision can stop: {}", graph.can_stop("vision", &running));
    info!("  planner can stop: {}", graph.can_stop("planner", &running));

    // Stop planner
    running.remove("planner");
    info!("\nAfter stopping planner:");
    info!("  vision can stop: {}", graph.can_stop("vision", &running));
    info!("  camera can stop: {}", graph.can_stop("camera", &running));

    Ok(())
}

/// Example 6: Getting all dependencies and dependents
pub fn transitive_dependencies_example() -> Result<()> {
    info!("Example 6: Transitive dependencies");

    let graph = create_graph(&[
        ("a", vec![]),
        ("b", vec!["a"]),
        ("c", vec!["b"]),
        ("d", vec!["c"]),
        ("e", vec!["c"]),
    ])?;

    // Get all dependencies of 'd' (transitive closure)
    let deps = graph.get_all_dependencies("d");
    info!("\nAll dependencies of 'd': {:?}", deps);
    // Output: ["c", "b", "a"]

    // Get all dependents of 'a' (transitive closure)
    let dependents = graph.get_all_dependents("a");
    info!("All dependents of 'a': {:?}", dependents);
    // Output: ["b", "c", "d", "e"]

    // Get direct dependencies only
    let direct_deps = graph.get_direct_dependencies("d");
    info!("\nDirect dependencies of 'd': {:?}", direct_deps);
    // Output: ["c"]

    // Get direct dependents only
    let direct_dependents = graph.get_direct_dependents("a");
    info!("Direct dependents of 'a': {:?}", direct_dependents);
    // Output: ["b"]

    Ok(())
}

/// Example 7: From NodeConfig objects
pub fn from_node_configs_example() -> Result<()> {
    info!("Example 7: Building graph from NodeConfig");

    use std::collections::HashMap;

    let configs = vec![
        NodeConfig {
            id: "camera".to_string(),
            name: Some("RGB Camera".to_string()),
            executable: "./camera".to_string(),
            args: vec![],
            env: HashMap::new(),
            mode: NodeMode::Local,
            auto_restart: true,
            health_check_interval_s: 5,
            publishes: vec!["/sensor/camera/rgb".to_string()],
            subscribes: vec![],
            depends_on: vec![],
        },
        NodeConfig {
            id: "vision".to_string(),
            name: Some("Vision Processing".to_string()),
            executable: "./vision".to_string(),
            args: vec![],
            env: HashMap::new(),
            mode: NodeMode::Remote,
            auto_restart: true,
            health_check_interval_s: 5,
            publishes: vec!["/perception/detections".to_string()],
            subscribes: vec!["/sensor/camera/rgb".to_string()],
            depends_on: vec!["camera".to_string()],
        },
        NodeConfig {
            id: "planner".to_string(),
            name: Some("Path Planning".to_string()),
            executable: "./planner".to_string(),
            args: vec![],
            env: HashMap::new(),
            mode: NodeMode::Remote,
            auto_restart: true,
            health_check_interval_s: 5,
            publishes: vec!["/planning/path".to_string()],
            subscribes: vec!["/perception/detections".to_string()],
            depends_on: vec!["vision".to_string()],
        },
    ];

    let graph = DependencyGraph::from_configs(&configs)?;

    info!("\nBuilt graph from {} NodeConfig objects", configs.len());

    let startup = graph.topological_sort()?;
    info!("Startup order: {:?}", startup);

    let plan = graph.startup_plan()?;
    info!("\nStartup plan:");
    for (i, level) in plan.levels.iter().enumerate() {
        info!("  Level {}: {:?}", i, level);
    }

    Ok(())
}

/// Example 8: Warehouse robot with complex dependencies
pub fn warehouse_robot_example() -> Result<()> {
    info!("Example 8: Warehouse robot system");

    let graph = create_graph(&[
        // Hardware layer
        ("sick_lidar", vec![]),
        ("realsense_camera", vec![]),
        ("imu_sensor", vec![]),
        ("odrive_motors", vec![]),
        ("gripper_controller", vec![]),
        // Processing layer
        ("lidar_processor", vec!["sick_lidar"]),
        ("rgb_processor", vec!["realsense_camera"]),
        ("depth_processor", vec!["realsense_camera"]),
        ("imu_filter", vec!["imu_sensor"]),
        ("wheel_odometry", vec!["odrive_motors", "imu_sensor"]),
        // Perception layer
        ("slam", vec!["lidar_processor", "wheel_odometry"]),
        ("object_detection", vec!["rgb_processor"]),
        ("shelf_detection", vec!["depth_processor"]),
        // Planning layer
        ("global_planner", vec!["slam"]),
        ("local_planner", vec!["global_planner", "object_detection"]),
        ("grasp_planner", vec!["shelf_detection", "object_detection"]),
        // Control layer
        ("navigation_controller", vec!["local_planner"]),
        ("manipulation_controller", vec!["grasp_planner", "gripper_controller"]),
        // Coordination
        (
            "task_coordinator",
            vec!["navigation_controller", "manipulation_controller"],
        ),
    ])?;

    let plan = graph.startup_plan()?;

    info!("\nWarehouse robot startup plan:");
    info!("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━");
    info!("Total nodes: {}", plan.node_count());
    info!("Total levels: {}", plan.level_count());
    info!("Max parallelism: {} nodes", plan.max_parallelism());
    info!("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n");

    for (i, level) in plan.levels.iter().enumerate() {
        let layer_name = match i {
            0 => "Hardware",
            1 => "Processing",
            2 => "Perception",
            3 => "Planning",
            4 => "Control",
            5 => "Coordination",
            _ => "Advanced",
        };

        info!("Level {} - {} Layer ({} nodes):", i, layer_name, level.len());
        for node in level {
            info!("  • {}", node);
        }
        info!("");
    }

    Ok(())
}

fn main() -> Result<()> {
    // Initialize logging
    tracing_subscriber::fmt().with_max_level(tracing::Level::INFO).init();

    println!("Dependency Ordering Usage Examples");
    println!("===================================\n");
    println!("Dependency ordering ensures nodes start and stop in the correct order.");
    println!("Dependencies must start before dependents, and stop after them.\n");

    // Run examples
    simple_chain_example()?;
    println!();

    parallel_dependencies_example()?;
    println!();

    complex_system_example()?;
    println!();

    circular_dependency_example()?;
    println!();

    can_start_stop_example()?;
    println!();

    transitive_dependencies_example()?;
    println!();

    from_node_configs_example()?;
    println!();

    warehouse_robot_example()?;
    println!();

    println!("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━");
    println!("All examples completed!");
    println!("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n");

    println!("Usage in your code:");
    println!("  use mecha10::prelude::*;");
    println!();
    println!("  // Build graph from configs");
    println!("  let graph = DependencyGraph::from_configs(&node_configs)?;");
    println!();
    println!("  // Get startup order");
    println!("  let plan = graph.startup_plan()?;");
    println!("  for level in &plan.levels {{");
    println!("      // Start nodes in this level (can be parallel)");
    println!("      for node_id in level {{");
    println!("          runtime.start_node(node_id).await?;");
    println!("      }}");
    println!("  }}");
    println!();
    println!("  // Get shutdown order");
    println!("  let shutdown = graph.shutdown_plan()?;");
    println!("  for level in &shutdown.levels {{");
    println!("      // Stop nodes in this level");
    println!("  }}");

    Ok(())
}