¶ EXT-StreamDeck
This plugin allows to control your mirror with stream Deck by elgato©
¶ Testing Video
This is a demo in video (sorry for quality)
¶ Installation
To install this plugin, try this command:
cd ~/MagicMirror/modules/
git clone https://github.com/bugsounet/EXT-StreamDeck
cd EXT-StreamDeck
npm install
¶ Prepare using StreamDeck
Some linux rules are needed.
Let's set it !
cd ~/MagicMirror/modules/EXT-StreamDeck
npm run setup
And reboot your pi
¶ Configuration sample
{
module: 'EXT-StreamDeck',
config: {
debug: false,
device: null,
Brightness: 100,
EcoBrightness: 10,
EcoTime: 10000,
keyFinder: false,
keys: [
{
key: 0,
logo: "tv-on",
notification: "EXT_SCREEN-WAKEUP",
payload: null,
command: null,
sound: "opening"
},
{
key: 1,
logo: "spotify",
notification: "EXT_SPOTIFY-PLAY",
payload: null,
command: null,
sound: "opening"
},
{
key: 2,
logo: "volume-up",
notification: "EXT_VOLUME-SPEAKER_UP",
payload: null,
command: null,
sound: "up"
},
{
key: 3,
logo: "tv-off",
notification: "EXT_SCREEN-END",
payload: null,
command: null,
sound: "closing"
},
{
key: 4,
logo: "stop",
notification: "EXT_STOP",
payload: null,
command: null,
sound: "closing"
},
{
key: 5,
logo: "volume-down",
notification: "EXT_VOLUME-SPEAKER_DOWN",
payload: null,
command: null,
sound: "down"
}
]
}
},
¶ Detailed Configuration
Option Description Type Default debug Enable or not the Debug mode Boolean false device Path of the StreamDeck to use. null = the default String or null null Brightness Set the brightness of the streamDeck Number 100 EcoBrightness Set standby brightness Number 10 EcoTime Delay before standby (in ms) Number 10000 keyFinder Display keycode with MMM-GoogleAssistant Alert when a key is pressed Boolean false keys Define your keys rules (see bellow) Array
device: Generaly
nullvalue will use the first streamDeck found
If not works, you can discover the list of the streamDeck in backlog by activatedebugmode
[STREAMDECK] Found model: mini Path: /dev/hidraw0 serialNumber: BL36H1A06XXX
Just report the path. in this case:/dev/hidraw0
¶ keys
keys is an array of params for control your mirror
this array need keyCode, notification, payload, command and sound parameter
Option Description Type key Key number. You can catch it with keyFinder activated Number logo Set the logo to display (only in png) String notification Notification to send String payload Payload associated to notification (optional) String command Shell command to execute (optional) String sound Name of the sound when executed (mp3 only) String
key: Can be discover when you activate keyFinder
Just press a key and MMM-GoogleAssistant Alert will say the associated keyCode
Naturally, report it in this field
logo: logo name located in
resourcesdirectory (without extension)
Notes:
If you want more logo, just see in theicons-Sampledirectory !
Just past the new logo in the resources directory and use it!
notification: Generaly each module/plugins have some incoming notification for a fonction.
Just past the notification name
payload: If needed you can add a payload to the notification
command: You want to execute an shell command (with python, bash, sh,...)
Your file must be inscriptsdirectory
Sample: if you want to executetest.sh
command line is:
command: "sh test.sh",
sound: If you want to play a sound, just see in the
resourcesdirectory
all sound must be in.mp3
just past the name without extension
Note: you can add your own mp3 too!
¶ Update
cd ~/MagicMirror/modules/EXT-StreamDeck
npm run update