Decode dial up and down events

emorydunn · Dec 14, 2023 · adda2fe · adda2fe
1 parent defc065
commit adda2fe
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 2 deletions.
diff --git a/Sources/StreamDeck/Events/Events.swift b/Sources/StreamDeck/Events/Events.swift
@@ -59,6 +59,8 @@ extension ReceivableEvent {
 		case keyUp
 		case dialRotate
 		case dialPress
+		case dialDown
+		case dialUp
 		case touchTap
 		case willAppear
 		case willDisappear

diff --git a/Sources/StreamDeck/StreamDeck Plugin/Action/Action+Support.swift b/Sources/StreamDeck/StreamDeck Plugin/Action/Action+Support.swift
@@ -123,7 +123,8 @@ extension Action {
 		dialRotate(device: action.device, payload: action.payload)
 	}
 
-	/// Decode and deliver a dial rotation event.
+	@available(*, deprecated, message: "Please note, from Stream Deck 6.5 onwards, dialPress will not be emitted by the API. Plugins should use dialDown and dialUp to receive events relating to dial presses.")
+	/// Decode and deliver a dial press event.
 	/// - Parameters:
 	///   - data: Event data
 	///   - decoder: The decoder to use
@@ -132,7 +133,27 @@ extension Action {
 
 		dialPress(device: action.device, payload: action.payload)
 	}
-
+
+	/// Decode and deliver a dial down event.
+	/// - Parameters:
+	///   - data: Event data
+	///   - decoder: The decoder to use
+	func decodeDialDown(_ data: Data, using decoder: JSONDecoder) throws {
+		let action = try decoder.decode(ActionEvent<EncoderPressEvent<Settings>>.self, from: data)
+
+		dialDown(device: action.device, payload: action.payload)
+	}
+
+	/// Decode and deliver a dial up event.
+	/// - Parameters:
+	///   - data: Event data
+	///   - decoder: The decoder to use
+	func decodeDialUp(_ data: Data, using decoder: JSONDecoder) throws {
+		let action = try decoder.decode(ActionEvent<EncoderPressEvent<Settings>>.self, from: data)
+
+		dialUp(device: action.device, payload: action.payload)
+	}
+
 	/// Decode and deliver a dial rotation event.
 	/// - Parameters:
 	///   - data: Event data

diff --git a/Sources/StreamDeck/StreamDeck Plugin/StreamDeckPlugin.swift b/Sources/StreamDeck/StreamDeck Plugin/StreamDeckPlugin.swift
@@ -364,6 +364,16 @@ public final class StreamDeckPlugin {
 
 			try self[context]?.decodeDialPress(data, using: decoder)
 
+		case .dialDown:
+			log.info("Forwarding \(event) to \(context ?? "no context")")
+
+			try self[context]?.decodeDialDown(data, using: decoder)
+
+		case .dialUp:
+			log.info("Forwarding \(event) to \(context ?? "no context")")
+
+			try self[context]?.decodeDialUp(data, using: decoder)
+
 		case .touchTap:
 			log.info("Forwarding \(event) to \(context ?? "no context")")