Getting yellow error icon majority of the time I run shortcuts from Stream Deck

[mattahorton]

Hey there,

When this works it works great, but 9/10 times, I have to

1. open up the stream deck app
2. click on the shortcut I want to run
3. let it load my shortcuts

and then it works.

Obviously, this is not ideal or much of a shortcut 😅

Is there something I'm doing? Or is this a bug?

[joshpuetz]

+1 this is happening to me as well, but only the first time I want to run each shortcut after restarting my computer

[SENTINELITE]

Hey, @mattahorton & @joshpuetz!

Looking to debug & patch this one up over the weekend, if you're able to help me find the issue...

I've had a few reports of the plugin having trouble after waking up from a sleep. After "selecting" the shortcut via the SD interface, what you're experiencing, can you confirm it's after waking up from a nap? I'm sadly not able to reproduce this sketchy bug on my end.

Also, have either of you moved the key in the Stream Deck software? Cop/Pasted it? Switched profiles, restored from a backup, or went from one model (Mini, Mobile, XL, Mk ll, Footpedal, etc) to another?

@mattahorton This is definitely a bug. Thanks for bringing this to my attention & sorry for the trouble in the meantime!

@joshpuetz, because you seem to have a surefire way to "trigger" this breakdown, can you give the computer a restart & immediately follow these instructions, to log the error, & press the key, to get the ⚠️ sign on the SD key? You may need to set the SD software to not be a login-option, temporarily.

Some useful info that could help: CPU/Ram/GPU/SSD/macOS Version.

[mattahorton]

It definitely happens to me after wake from sleep. I rarely reboot. Basically when XCode forces me to.

I have not moved a key, switched profiles, restored from a backup, or changed models. Got my OG Stream Deck here. The only thing I have done is moved it from my PC to my Mac several months ago.

Also hey @joshpuetz 😅. Fancy meeting you here.

[mattahorton]

Oh also here's the machine specs (1TB storage btw):

[mattahorton]

Triple post, I'm sorry. I just verified that it works fresh after reboot.

[SENTINELITE]

Glad it's working now, @mattahorton! If you have more trouble, feel free to let me know. I'll be leaving this issue open meanwhile.

If this crops up again, can you do me a favor & copy the file keys.json listed below & reboot? I feel like the file's getting "corrupted", or I may be overwriting it somehow...

~/Library/Application Support/com.elgato.StreamDeck/Plugins/com.sentinelite.streamdeckshortcuts.sdPlugin/keys.json

I did seem to run into this on my end, but it's super rare, as such it'll be a fun one to hunt down! 😅

[mattahorton]

Absolutely. I am sure it will crop up again. Didn't this morning!

[joshpuetz]

Ok, here's the specs of the machine I'm on:

I have a Stream Deck mini, and it's my first time using it. I haven't backed up or restored a profile: this is my first install!

Here's the log output right after reboot from a shortcut button that isn't triggering (it shows the 'yellow error' icon):

default	09:09:39.544576-0500	StreamDeck-Shortcuts	DEBUG: keyDown() was pressed down!
default	09:09:39.544831-0500	StreamDeck-Shortcuts	DEBUG: keyDown() finshed being running!
default	09:09:39.544940-0500	StreamDeck-Shortcuts	⚙️ Trying to run shortcut named 'Sleep Mac'...
default	09:09:39.545042-0500	StreamDeck-Shortcuts	trying with event: keyDown, data: 372 bytes
default	09:09:39.632631-0500	StreamDeck-Shortcuts	trying with event: keyUp, data: 370 bytes

Interestingly when this happens, I checked ~/Library/Application Support/com.elgato.StreamDeck/Plugins/com.sentinelite.streamdeckshortcuts.sdPlugin/keys.json and it had a week old date stamp and didn't have my latest shortcuts in it:

{
  "F16A8CEE471B4DFAB98FB44B7ABBA862" : "Set Evening",
  "DE449A2489674E8D8A5B3AC151DF87A9" : "Start Focus",
  "E37EB81A9F8749D4E5C144225EBE9521" : "Set Evening",
  "4FADBCF3F79618122773C57CBB57CE7B" : "Pause Focus"
}

After loading up the StreamDeck configuratator and letting the shortcut list load on for the button in question, my keys.json file was updated and the shortcut works:

{
  "608332E96B7B994FA5AD314002A825AB" : "Set Bedroom 70",
  "E37EB81A9F8749D4E5C144225EBE9521" : "Set Evening",
  "DE449A2489674E8D8A5B3AC151DF87A9" : "Start Focus",
  "4FADBCF3F79618122773C57CBB57CE7B" : "Pause Focus",
  "F16A8CEE471B4DFAB98FB44B7ABBA862" : "Set Evening",
  "0DD1AED5EA91674BEDDB1D45AF904642" : "Sleep Mac"
}

Interestingly this DID NOT happen this morning when I rebooted, so it's frustratingly intermittent 🤔

[mattahorton]

Came back to my mac this morning after having the flu for about 4 days. It happened again, and then I got the Kilo One error and all of my stream deck routines have been erased. They're just empty buttons with names that do nothing.

[takashiyoshida]

I have the same "yellow error" icon shows up quite often, especially after rebooting my MacBook Pro. Upon checking the keys.json file, the file was empty until:

1. I opened Stream Deck application
2. Go to the relevant profile and click on the affected key

After step 2, the keys.json became populated (though only for the key I clicked on). I need to repeat step 2 as many times as I have shortcut keys.

[SENTINELITE]

Hey, @takashiyoshida!

Thanks for providing the feedback! I'll try to get another look into this.

It's super sporadic. In my workflow, I restart my computer daily, & I rarely get this to crop up.

You did mention going to the relevant "profile", can you go ahead & put some Shortcut Keys on your primary profile &/or change your default profile to the one with Shortcut Keys, & see how that behaves after a reboot?

I wonder if that's where the issue is coming from.

Regardless, I appreciate the input & will dedicate some time for this!

[takashiyoshida]

I'll give it a try after work. I admit that rebooting does not necessarily trigger this issue. In some cases, the content of keys.json persists even after rebooting so it's not as easy to reproduce.

[ishemes]

Thank you for this plugin! Unfortunately I also kept getting this error. In the end I decided to right click the shortcut in the shortcuts.app. Then choose 'Add to Dock'. This creates an application in the /Users//Applications/ folder. I then choose the Launch action from Streamdeck to launch this application. And it will launch the shortcut for me. I have been using the shortcuts daily like this for more than a week without any problems.

I'm a software developer, so if you need somebody to help you debug this, please let me know. Otherwise, you might want to change the plugin so it will create these apps for the end user and launch it from there. Good luck! And thanks again for your work!

[SENTINELITE]

No idea how I missed your comment, @ishemes. I apologize for the delay!

On a high level, the keys are saved to a JSON file, then read & compared at runtime. For some reason some of the keys are getting overwritten/disappearing...

I didn't dig into this, but now that I think about it, I believe when the key appears, it may be overwriting it's "old" key/value pair, which could be rendered as blank...

Anyway's this is a known issue. I'm not exactly sure what the cause is. I get it sporadically, too.

I think it's best to drop the external JSON file in a future update (V2.0?), as I don't think we need it.

If you want to dig around & see if you can figure it out, I'm all ears! 😊