autodeck 0.4.0

Elgato StreamDeck based Automation Software
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


# An example automata that always succeeds
[[automata]]
state = "stopped"

[automata.states.stopped]
on_press = { func = "./scripts/success.sh", on_success = "running", on_error = "error" }
display = { mode = "Image", file = "../streamdeck/icons/windows.png", invert = true }

[automata.states.running]
on_press = { on_success = "stopped" }
display = { mode = "Image", file = "../streamdeck/icons/windows.png", invert = false }

[automata.states.error]
on_press = { on_success = "stopped" }
display = { mode = "Image", file = "../streamdeck/icons/windows.png", invert = false, background = { r = 255, g = 0, b = 0} }


# An example automata that always fails
[[automata]]
state = "stopped"

[automata.states.stopped]
on_press = { func = "./scripts/failure.sh", on_success = "running", on_error = "error" }
display = { mode = "Colour", r = 0, g = 0, b = 255 }

[automata.states.running]
on_press = { on_success = "stopped" }
display = { mode = "Colour", r = 0, g = 255, b = 0 }

[automata.states.error]
on_press = { on_success = "stopped" }
display = { mode = "Colour", r = 255, g = 0, b = 0 }

# An example automata that sometimes does either
[[automata]]
state = "stopped"

[automata.states.stopped]
on_press = { func = "./scripts/sometimes.sh", on_success = "running", on_error = "error" }
display = { mode = "Colour", r = 0, g = 0, b = 255 }

[automata.states.running]
on_press = { on_success = "stopped" }
display = { mode = "Colour", r = 0, g = 255, b = 0 }

[automata.states.error]
on_press = { on_success = "stopped" }
display = { mode = "Colour", r = 255, g = 0, b = 0 }

# An example automata that launches into a state at startup
[[automata]]
state = "init"
on_init = { func = "./scripts/sometimes.sh", on_success = "okay", on_error = "error" }

[automata.states.init]
display = { mode = "Colour", r = 0, g = 0, b = 0 }

[automata.states.okay]
display = { mode = "Colour", r = 0, g = 255, b = 0 }

[automata.states.error]
display = { mode = "Colour", r = 255, g = 0, b = 0 }


# An example automata that updates it's state at runtime
[[automata]]
state = "init"
on_init = { func = "./scripts/sometimes.sh", on_success = "okay", on_error = "error" }

[automata.states.init]
display = { mode = "Colour", r = 0, g = 0, b = 0 }

[automata.states.okay]
on_poll = { func = "./scripts/sometimes.sh", on_success = "okay", on_error = "error" }
display = { mode = "Colour", r = 0, g = 255, b = 0 }

[automata.states.error]
on_poll = { func = "./scripts/sometimes.sh", on_success = "okay", on_error = "error" }
display = { mode = "Colour", r = 255, g = 0, b = 0 }


# An example automata that parses state from stdout using filters
[[automata]]
state = "one"

[automata.states.one]
on_press = { func = "./scripts/sometimes-stdout.sh", success_filter = "ok", on_success = "one", on_failure = "two" }
display = { mode = "Colour", r = 0, g = 255, b = 0 }

[automata.states.two]
on_press = { func = "./scripts/sometimes-stdout.sh", failure_filter = "error", on_success = "one", on_failure = "two" }
display = { mode = "Colour", r = 255, g = 0, b = 0 }