smlang 0.8.0

A no-std state machine language DSL
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

//! Pattern Matching State Machine
//!
//! This demonstrates the use of input state pattern matching so that states that share a common
//! transition to the same output state can be described more succinctly
#![deny(missing_docs)]

use smlang::statemachine;

// statemachine! {
//     transitions: {
//         *Idle + Charge = Charging,
//         Idle + Discharge = Discharging,
//         Charging + ChargeComplete = Charged,
//         Discharging + DischargeComplete = Discharged,
//         Charged + Discharge = Discharging,
//         Dischaged + Charge = Charging,
//         Charging + Discharge = Discharging,
//         Discharging + Charge = Charging,
//         Idle + FaultDetected = Fault,
//         Charging + FaultDetected = Fault,
//         Discharging + FaultDetected = Fault,
//         Charged + FaultDetected = Fault,
//         Discharged + FaultDetected = Fault,
//         Fault + FaultCleard = Idle,
//     },
// }

// A simple charge/discharge state machine that has a dedicated "Fault" state
statemachine! {
    name: Battery,
    transitions: {
        *Idle | Discharging | Discharged + Charge = Charging,
        Idle | Charging | Charged + Discharge = Discharging,
        Charging + ChargeComplete = Charged,
        Discharging + DischargeComplete = Discharged,
        _ + FaultDetected = Fault,
        Fault + FaultCleard = Idle,
    },
}

/// Context
pub struct Context;

impl BatteryStateMachineContext for Context {}

fn main() {
    let mut sm = BatteryStateMachine::new(Context);

    assert!(matches!(sm.state(), &BatteryStates::Idle));

    let r = sm.process_event(BatteryEvents::Charge);
    assert!(matches!(r, Ok(&BatteryStates::Charging)));

    let r = sm.process_event(BatteryEvents::Discharge);
    assert!(matches!(r, Ok(&BatteryStates::Discharging)));

    let r = sm.process_event(BatteryEvents::Charge);
    assert!(matches!(r, Ok(&BatteryStates::Charging)));

    let r = sm.process_event(BatteryEvents::ChargeComplete);
    assert!(matches!(r, Ok(&BatteryStates::Charged)));

    let r = sm.process_event(BatteryEvents::Charge);
    assert!(matches!(r, Err(BatteryError::InvalidEvent)));
    assert!(matches!(sm.state(), &BatteryStates::Charged));

    let r = sm.process_event(BatteryEvents::Discharge);
    assert!(matches!(r, Ok(&BatteryStates::Discharging)));

    let r = sm.process_event(BatteryEvents::DischargeComplete);
    assert!(matches!(r, Ok(&BatteryStates::Discharged)));

    let r = sm.process_event(BatteryEvents::Discharge);
    assert!(matches!(r, Err(BatteryError::InvalidEvent)));
    assert!(matches!(sm.state(), &BatteryStates::Discharged));

    sm = BatteryStateMachine::new_with_state(Context, BatteryStates::Idle);
    let r = sm.process_event(BatteryEvents::FaultDetected);
    assert!(matches!(r, Ok(&BatteryStates::Fault)));

    sm = BatteryStateMachine::new_with_state(Context, BatteryStates::Charging);
    let r = sm.process_event(BatteryEvents::FaultDetected);
    assert!(matches!(r, Ok(&BatteryStates::Fault)));

    sm = BatteryStateMachine::new_with_state(Context, BatteryStates::Charged);
    let r = sm.process_event(BatteryEvents::FaultDetected);
    assert!(matches!(r, Ok(&BatteryStates::Fault)));

    sm = BatteryStateMachine::new_with_state(Context, BatteryStates::Discharging);
    let r = sm.process_event(BatteryEvents::FaultDetected);
    assert!(matches!(r, Ok(&BatteryStates::Fault)));

    sm = BatteryStateMachine::new_with_state(Context, BatteryStates::Discharged);
    let r = sm.process_event(BatteryEvents::FaultDetected);
    assert!(matches!(r, Ok(&BatteryStates::Fault)));

    let r = sm.process_event(BatteryEvents::Charge);
    assert!(matches!(r, Err(BatteryError::InvalidEvent)));
    assert!(matches!(sm.state(), &BatteryStates::Fault));

    let r = sm.process_event(BatteryEvents::Discharge);
    assert!(matches!(r, Err(BatteryError::InvalidEvent)));
    assert!(matches!(sm.state(), &BatteryStates::Fault));

    let r = sm.process_event(BatteryEvents::ChargeComplete);
    assert!(matches!(r, Err(BatteryError::InvalidEvent)));
    assert!(matches!(sm.state(), &BatteryStates::Fault));

    let r = sm.process_event(BatteryEvents::DischargeComplete);
    assert!(matches!(r, Err(BatteryError::InvalidEvent)));
    assert!(matches!(sm.state(), &BatteryStates::Fault));
}