Two important libraries are used: pyXPUDPServer (leleopard) and Python Stream Deck (abcminiuser) In order to make it working you have to install these libraries.
The script reads a config.json file and the images from a specified folder, I'll make it easy to understand with an example:
We want to put the "Master Caution" button to the second button/first raw of the Stream Deck, so firstly we have to create two images for it, one for the "ON" state and the other for the "OFF" state.
| 1.mc.on.png | 1.mc.off.png |
 |  |
The file name is important and contains three dot separated informations:
| 1.mc.on.png | |||
| 1 | mc | on | png |
| The position of the button, It's zero based, so the first one in the first raw is the number 0, the last one in the third row is the number 14 | This is a name reference to the button, will be written in the config.json | On/Off for the two states | Image extension, could be png or jpeg |
So what if we want to put the "Master Caution" in the last button of our Stream Deck, we have to change the name files to "14.mc.on.png" and "14.mc.off.png", I think it's pretty easy, isn't it?
OK after we created the images we have to put them in a defined folder created on the same level of the script. In this case a folder named "737800". After that we have to make some change to the config.json.
{
"MAIN": {
"XPLANE_IP": "127.0.0.1",
"XPLANE_PORT": 49000,
"SERVER_IP": "127.0.0.1",
"SERVER_PORT": 49008,
"SELECTED_AIRCRAFT": "B738"
},
"B738": {
"imgfolder": "737800/",
"drefcmds": [
{
"dataref": "laminar/B738/annunciator/master_caution_light",
"command": "laminar/B738/push_button/master_caution1",
"imgrefn": "mc"
}
]
}
}
It's kind of self-explanatory but we can say something about it as well, the first part "MAIN" is needed to the script to work correctly, since we work through the UDP, you can use this script also on another pc put in the same network, in that case you have to change the XPLANE_IP and SERVER_IP accordly, if you're planning to use it on the same pc you do not need to change anything till "SELECTED_AIRCRAFT", which is the reference to the settings for the aircraft written below, in this case "B738".
The aicraft settings need:
- "imgfolder" path, the folder which contains our ON/OFF "Master Caution" images.
- "dataref" string, the X-PLane aircraft dataref related to the status we want report to the button, in this case is reported the one of the ZIBO 737 "Master Caution"
- "command" string, the X-PLane aircraft command related to the function we want assign to the button, in this case is reported the one of the ZIBO 737 "Master Caution"
- "imgrefn" name, in this case "mc", the same one used in the ON/OFF images for "Master Caution"
After set that, all we have to do is running the script (Please note that you have to close the Elegato Stream Deck software before)
That's all!
The uploaded script in the repository has all functions displayed in the first image and works for the ZIBO737 aicraft. In order to make it working with another aicraft you have to change all datarefs and commands reported in the config.json. It's something in alpha stage and I have to say that this script is provided "AS IS", without warranty of any kind.
I've tested it on Windows 10 64 bit, I really do not know If could work on other os. Feel free to try it out.
I had a lot of fun on making this, really, hope you'll enjoy it! Happy Flying!
--It's the first time I use Python and GitHub so please understand me for any kind of errors I've made!--