mkrieger/busylight
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add capability to set LED color (#16)

Browse source
This commit is contained in:
iGoX 2024-12-27 18:24:20 +01:00
parent 70ba676151
commit 3b47df5146
12 changed files with 243 additions and 122 deletions
Download patch file Download diff file Expand all files Collapse all files

23
streamdeck-plugin/README.md
View file

@ -1,5 +1,28 @@
# Release notes # Release notes
## Version 0.2.0.0 (2024-12-28)
### Download
[org.igox.busylight.v0.2.0.0.streamDeckPlugin](download/org.igox.busylight.v0.2.0.0.streamDeckPlugin)
### Features
- Add the capability to set the color diplayed by BusyLigh LEDs.
### Fixes
- None.
### Bugs & known limitations
- None known at publication time.
### Screenshot
![v0.2.0.0 screenshot](img/v0.2.0.0.png)
## Version 0.1.0.0 (2024-12-28) ## Version 0.1.0.0 (2024-12-28)
### Download ### Download

BIN
streamdeck-plugin/busylight/org.igox.busylight.sdPlugin/imgs/actions/color/color.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
streamdeck-plugin/busylight/org.igox.busylight.sdPlugin/imgs/actions/color/color@2x.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 24 KiB

23
streamdeck-plugin/busylight/org.igox.busylight.sdPlugin/manifest.json
View file

@ -1,6 +1,6 @@
{ {
"Name": "iGoX BusyLight", "Name": "iGoX BusyLight",
"Version": "0.1.0.0", "Version": "0.2.0.0",
"Author": "iGoX", "Author": "iGoX",
"$schema": "https://schemas.elgato.com/streamdeck/plugins/manifest.json", "$schema": "https://schemas.elgato.com/streamdeck/plugins/manifest.json",
"Actions": [ "Actions": [
@ -51,8 +51,7 @@
"TitleAlignment": "bottom" "TitleAlignment": "bottom"
} }
] ]
} },
,
{ {
"Name": "Turn off the BusyLight", "Name": "Turn off the BusyLight",
"UUID": "org.igox.busylight.status.off", "UUID": "org.igox.busylight.status.off",
@ -73,7 +72,7 @@
"Name": "Set brightness", "Name": "Set brightness",
"UUID": "org.igox.busylight.brigthness.set", "UUID": "org.igox.busylight.brigthness.set",
"Icon": "imgs/actions/brightness/brightness", "Icon": "imgs/actions/brightness/brightness",
"Tooltip": "Set brightness", "Tooltip": "Set LED brightness",
"PropertyInspectorPath": "ui/brightness-config.html", "PropertyInspectorPath": "ui/brightness-config.html",
"Controllers": [ "Controllers": [
"Keypad" "Keypad"
@ -84,6 +83,22 @@
"TitleAlignment": "bottom" "TitleAlignment": "bottom"
} }
] ]
},
{
"Name": "Set color",
"UUID": "org.igox.busylight.color.set",
"Icon": "imgs/actions/color/color",
"Tooltip": "Set BusyLight displayed color",
"PropertyInspectorPath": "ui/color-config.html",
"Controllers": [
"Keypad"
],
"States": [
{
"Image": "imgs/actions/color/color",
"TitleAlignment": "bottom"
}
]
} }
], ],
"Category": "iGoX BusyLight", "Category": "iGoX BusyLight",

33
streamdeck-plugin/busylight/org.igox.busylight.sdPlugin/ui/color-config.html Normal file
View file

@ -0,0 +1,33 @@
<!DOCTYPE html>
<html>
<head lang="en">
<title>Configure your BusyLight</title>
<meta charset="utf-8" />
<script src="https://sdpi-components.dev/releases/v3/sdpi-components.js"></script>
<script>
function getGlobalSettings() {
const { streamDeckClient } = SDPIComponents;
const settings = streamDeckClient.getGlobalSettings();
return settings.url || 'http://busylight-esp32.local';
}
</script>
</head>
<body>
<!--
Learn more about property inspector components at https://sdpi-components.dev/docs/components
-->
<sdpi-item label="URL or IP">
<sdpi-textfield
setting="url"
placeholder="http://busylight-esp32.local"
global="true"
value="getGlobalSettings()">
</sdpi-textfield>
</sdpi-item>
<sdpi-item label="Color">
<sdpi-color
setting="color"></sdpi-color>
</sdpi-item>
</body>
</html>

3
streamdeck-plugin/busylight/org.igox.busylight.sdPlugin/ui/status-config.html
View file

@ -14,9 +14,6 @@
</head> </head>
<body> <body>
<script>
</script>
<!-- <!--
Learn more about property inspector components at https://sdpi-components.dev/docs/components Learn more about property inspector components at https://sdpi-components.dev/docs/components
--> -->

10
streamdeck-plugin/busylight/src/actions/set-brightness.ts
View file

@ -5,7 +5,7 @@ export class SetBrightness extends SingletonAction<BrightnessSettings> {
override async onKeyDown(ev: KeyDownEvent<BrightnessSettings>): Promise<void> { override async onKeyDown(ev: KeyDownEvent<BrightnessSettings>): Promise<void> {
streamDeck.logger.trace(`>>> Received KeyDownEvent. Settings: ${JSON.stringify(ev.payload.settings)} <<<`); streamDeck.logger.debug(`>>> Received KeyDownEvent. Settings: ${JSON.stringify(ev.payload.settings)} <<<`);
const { settings } = ev.payload; const { settings } = ev.payload;
settings.brightness ??= 40; settings.brightness ??= 40;
@ -14,14 +14,14 @@ export class SetBrightness extends SingletonAction<BrightnessSettings> {
override onWillAppear(ev: WillAppearEvent<BrightnessSettings>): void | Promise<void> { override onWillAppear(ev: WillAppearEvent<BrightnessSettings>): void | Promise<void> {
streamDeck.logger.trace(`>>> Received WillAppearEvent. Settings: ${JSON.stringify(ev.payload.settings)} <<<`); streamDeck.logger.debug(`>>> Received WillAppearEvent. Settings: ${JSON.stringify(ev.payload.settings)} <<<`);
return ev.action.setTitle(`${ev.payload.settings.brightness ?? 40}%`); return ev.action.setTitle(`${ev.payload.settings.brightness ?? 40}%`);
} }
override async onDidReceiveSettings(ev: DidReceiveSettingsEvent<BrightnessSettings>): Promise<void> { override async onDidReceiveSettings(ev: DidReceiveSettingsEvent<BrightnessSettings>): Promise<void> {
streamDeck.logger.trace(`>>> Received onDidReceiveSettings. Settings: ${JSON.stringify(ev.payload.settings)} <<<`); streamDeck.logger.debug(`>>> Received onDidReceiveSettings. Settings: ${JSON.stringify(ev.payload.settings)} <<<`);
const { settings } = ev.payload; const { settings } = ev.payload;
await ev.action.setSettings(settings); await ev.action.setSettings(settings);
@ -33,7 +33,7 @@ async function setBrightness(brightness: number) {
const settings = await streamDeck.settings.getGlobalSettings(); const settings = await streamDeck.settings.getGlobalSettings();
const url = settings.url; const url = settings.url;
streamDeck.logger.trace(`>>> Sending brightness: ${brightness} to ${url} <<<`); streamDeck.logger.debug(`>>> Sending brightness: ${brightness} to ${url} <<<`);
fetch(`${url}/api/brightness`, fetch(`${url}/api/brightness`,
{ {
@ -44,7 +44,7 @@ async function setBrightness(brightness: number) {
body: JSON.stringify({"brightness": brightness/100}) body: JSON.stringify({"brightness": brightness/100})
}) })
.then(response => response.json()) .then(response => response.json())
.then(data => streamDeck.logger.trace(data)); .then(data => streamDeck.logger.debug(data));
} }
type BrightnessSettings = { type BrightnessSettings = {

51
streamdeck-plugin/busylight/src/actions/set-color.ts Normal file
View file

@ -0,0 +1,51 @@
import streamDeck, { action, JsonObject, KeyDownEvent, DidReceiveSettingsEvent, SingletonAction } from "@elgato/streamdeck";
@action({ UUID: "org.igox.busylight.color.set" })
export class SetColor extends SingletonAction {
override async onKeyDown(ev: KeyDownEvent<ColorSettings>): Promise<void> {
streamDeck.logger.debug(`>>> Received KeyDownEvent. Settings: ${JSON.stringify(ev.payload.settings)} <<<`);
const { settings } = ev.payload;
settings.color ??= '#FFFFFF';
setColor(hexToRgb(settings.color));
}
override async onDidReceiveSettings(ev: DidReceiveSettingsEvent<ColorSettings>): Promise<void> {
streamDeck.logger.debug(`>>> Received onDidReceiveSettings. Settings: ${JSON.stringify(ev.payload.settings)} <<<`);
const { settings } = ev.payload;
await ev.action.setSettings(settings);
}
}
function hexToRgb(hex: string): { r: number, g: number, b: number } {
const hexNumber = parseInt(hex.replace('#', ''), 16);
const r = (hexNumber >> 16) & 255;
const g = (hexNumber >> 8) & 255;
const b = hexNumber & 255;
return { r, g, b };
}
async function setColor(color: JsonObject) {
const settings = await streamDeck.settings.getGlobalSettings();
const url = settings.url;
streamDeck.logger.debug(`>>> Sending color: ${JSON.stringify({"r": color.r, "g": color.g, "b": color.b})} to ${url} <<<`);
fetch(`${url}/api/color`,
{
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({"r": color.r, "g": color.g, "b": color.b})
})
.then(response => response.json())
.then(data => streamDeck.logger.debug(data));
}
type ColorSettings = {
color?: string;
};

4
streamdeck-plugin/busylight/src/actions/set-status.ts
View file

@ -32,7 +32,7 @@ async function setStatus(status: string) {
const settings = await streamDeck.settings.getGlobalSettings(); const settings = await streamDeck.settings.getGlobalSettings();
const url = settings.url; const url = settings.url;
streamDeck.logger.trace(`>>> Sending status: ${status} to ${url} <<<`); streamDeck.logger.debug(`>>> Sending status: ${status} to ${url} <<<`);
fetch(`${url}/api/status/${status}`, fetch(`${url}/api/status/${status}`,
{ {
@ -42,5 +42,5 @@ async function setStatus(status: string) {
} }
}) })
.then(response => response.json()) .then(response => response.json())
.then(data => streamDeck.logger.trace(data)); .then(data => streamDeck.logger.debug(data));
} }

2
streamdeck-plugin/busylight/src/plugin.ts
View file

@ -3,6 +3,7 @@ import streamDeck, { LogLevel, SingletonAction, action, type DidReceiveSettingsE
//import { IncrementCounter } from "./actions/increment-counter"; //import { IncrementCounter } from "./actions/increment-counter";
import { SetStatusAvailable, SetStatusBusy, SetStatusAway, SetStatusOff } from "./actions/set-status"; import { SetStatusAvailable, SetStatusBusy, SetStatusAway, SetStatusOff } from "./actions/set-status";
import { SetBrightness } from "./actions/set-brightness"; import { SetBrightness } from "./actions/set-brightness";
import { SetColor } from "./actions/set-color";
// We can enable "trace" logging so that all messages between the Stream Deck, and the plugin are recorded. When storing sensitive information // We can enable "trace" logging so that all messages between the Stream Deck, and the plugin are recorded. When storing sensitive information
streamDeck.logger.setLevel(LogLevel.INFO); streamDeck.logger.setLevel(LogLevel.INFO);
@ -13,6 +14,7 @@ streamDeck.actions.registerAction(new SetStatusBusy());
streamDeck.actions.registerAction(new SetStatusAway()); streamDeck.actions.registerAction(new SetStatusAway());
streamDeck.actions.registerAction(new SetStatusOff()); streamDeck.actions.registerAction(new SetStatusOff());
streamDeck.actions.registerAction(new SetBrightness()); streamDeck.actions.registerAction(new SetBrightness());
streamDeck.actions.registerAction(new SetColor());
// Finally, connect to the Stream Deck. // Finally, connect to the Stream Deck.
streamDeck.connect(); streamDeck.connect();

BIN
streamdeck-plugin/download/org.igox.busylight.v0.2.0.0.streamDeckPlugin Normal file
View file

Binary file not shown.

BIN
streamdeck-plugin/img/v0.2.0.0.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 125 KiB