Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sherlouk/codedeck
WIP: A Swift library for interfacing with the Elgato Stream Deck
https://github.com/sherlouk/codedeck
api deck elgato elgato-stream-deck hid interface stream streamdeck swift swift-library usb usb-hid
Last synced: 7 days ago
JSON representation
WIP: A Swift library for interfacing with the Elgato Stream Deck
- Host: GitHub
- URL: https://github.com/sherlouk/codedeck
- Owner: Sherlouk
- License: mit
- Created: 2018-11-26T18:16:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-04T22:45:33.000Z (11 months ago)
- Last Synced: 2024-10-30T17:24:47.851Z (17 days ago)
- Topics: api, deck, elgato, elgato-stream-deck, hid, interface, stream, streamdeck, swift, swift-library, usb, usb-hid
- Language: Swift
- Size: 257 KB
- Stars: 13
- Watchers: 1
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Codedeck [](https://coveralls.io/github/Sherlouk/Codedeck?branch=master)
A Swift library for interfacing with an Elgato StreamDeck.
## Features
- Multiplatform Support (_See below_)
- Hotswapping and Multiple Connected Devices Support
- Set Device Brightness
- Fill Key with Solid RGB Colors
- More Soon!
#### Multiplatform Support
Swift is compatible with most modern systems and this project makes an effort to
keep dependencies light and not coupled to things like Cocoa/UIKit etc.
There are some extensions which, if Cocoa is available, adds extra functionality
but this does not limit what you're able to do rather just makes things simpler!
## Usage
#### Creating a `StreamDeck`
A `StreamDeck` currently requires a `HIDDevice` to be created. This is a thin
wrapper around the `IOHIDDevice` available in Apple's IOKit.
This library provides a device monitoring solution which informs of you when
certain devices are connected/disconnected from the system. This allows you to
hotswap StreamDeck devices as well as connect to multiple at once!
```swift
// 1. Create a device monitor and store a reference to it in your application
var monitor: HIDDeviceMonitor = {
return HIDDeviceMonitor(streamDeckProducts: [ .streamDeck ])
}()
// 2. Create a delegate class within your application
extension SomeClass: HIDDeviceMonitorDelegate {
func HIDDeviceAdded(device: HIDDevice) {
// ...
}
func HIDDeviceRemoved(device: HIDDevice) {
// ...
}
func HIDDeviceError(error: Error) {
// ...
}
}
// 3. Start monitoring for existing and new devices
monitor.startMonitoring(delegate: ...)
// 4. When you have access to a "HIDDevice" initialize a "StreamDeck" with it
let streamDeck = try StreamDeck(device: HIDDevice)
```
## Credit
Credit to [Arti3DPlayer/USBDeviceSwift](https://github.com/Arti3DPlayer/USBDeviceSwift)
for the foundations of the HID detection which I expanded upon
Credit to [Lange/node-elgato-stream-deck](https://github.com/Lange/node-elgato-stream-deck)
for their work and making the necessary payloads available