openaction 2.7.0

A crate for creating plugins for the OpenAction API
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

use super::{OutboundEventManager, PayloadEvent};

use crate::OpenActionResult as Result;

use serde::Serialize;

#[derive(Clone, Serialize)]
pub struct DeviceInfo {
	pub id: String,
	pub name: String,
	pub rows: u8,
	pub columns: u8,
	pub encoders: u8,
	pub r#type: u8,
}

#[derive(Serialize)]
pub struct PressPayload {
	pub device: String,
	pub position: u8,
}

#[derive(Serialize)]
pub struct TicksPayload {
	pub device: String,
	pub position: u8,
	pub ticks: i16,
}

#[derive(Serialize)]
pub struct TouchscreenPressPayload {
	pub device: String,
	pub position: u8,
	pub x: u16,
	pub y: u16,
	pub hold: bool,
}

impl OutboundEventManager {
	pub async fn register_device(
		&mut self,
		id: String,
		name: String,
		rows: u8,
		columns: u8,
		encoders: u8,
		r#type: u8,
	) -> Result<()> {
		self.send_event(PayloadEvent {
			event: "registerDevice",
			payload: DeviceInfo {
				id,
				name,
				rows,
				columns,
				encoders,
				r#type,
			},
		})
		.await
	}

	pub async fn deregister_device(&mut self, id: String) -> Result<()> {
		self.send_event(PayloadEvent {
			event: "deregisterDevice",
			payload: id,
		})
		.await
	}

	pub async fn rerender_images(&mut self, id: String) -> Result<()> {
		self.send_event(PayloadEvent {
			event: "rerenderImages",
			payload: id,
		})
		.await
	}

	pub async fn key_down(&mut self, device: String, position: u8) -> Result<()> {
		self.send_event(PayloadEvent {
			event: "keyDown",
			payload: PressPayload { device, position },
		})
		.await
	}

	pub async fn key_up(&mut self, device: String, position: u8) -> Result<()> {
		self.send_event(PayloadEvent {
			event: "keyUp",
			payload: PressPayload { device, position },
		})
		.await
	}

	pub async fn encoder_change(&mut self, device: String, position: u8, ticks: i16) -> Result<()> {
		self.send_event(PayloadEvent {
			event: "encoderChange",
			payload: TicksPayload {
				device,
				position,
				ticks,
			},
		})
		.await
	}

	pub async fn encoder_down(&mut self, device: String, position: u8) -> Result<()> {
		self.send_event(PayloadEvent {
			event: "encoderDown",
			payload: PressPayload { device, position },
		})
		.await
	}

	pub async fn encoder_up(&mut self, device: String, position: u8) -> Result<()> {
		self.send_event(PayloadEvent {
			event: "encoderUp",
			payload: PressPayload { device, position },
		})
		.await
	}

	pub async fn touchscreen_press(&mut self, device: String, position: u8, x: u16, y: u16, hold: bool) -> Result<()> {
		self.send_event(PayloadEvent {
			event: "touchscreenPress",
			payload: TouchscreenPressPayload {
				device,
				position,
				x,
				y,
				hold,
			},
		})
		.await
	}
}