feature(flash): Setting a specific brightness

admin/public/locales/en/translation.json

@@ -99,6 +99,9 @@
         "title": "Photobooth",
         "amt_manually_taken": "Amount of pictures manually taken",
         "amt_unattended": "Amount of pictures unattended",
+        "flash": "Flash",
+        "toggle_on": "Turn ON",
+        "toggle_off": "Turn OFF",
         "remote_take_picture": "Remote take picture",
         "success_notification": {
             "title": "Remote picture",

admin/public/locales/fr/translation.json

@@ -99,6 +99,9 @@
         "title": "Photomaton",
         "amt_manually_taken": "Photos prises manuellement",
         "amt_unattended": "Photos prises automatiquement",
+        "flash": "Flash",
+        "toggle_on": "Allumer",
+        "toggle_off": "Éteindre",
         "remote_take_picture": "Prendre une photo",
         "success_notification": {
             "title": "Prise de photo",

admin/src/hooks/auth.tsx

@@ -35,6 +35,11 @@ type AuthProps = {
     event: PhEvent | null;
     time: DateTime | null;
 
+    hardwareFlash: {
+        powered: boolean;
+        brightness: number;
+    };
+
     karaoke: PhKaraoke | null;
     karaokeQueue: PhSongSession[];
 
@@ -53,6 +58,7 @@ type AuthContextProps = AuthProps & {
 
     setMode: (mode: string) => void;
     setEvent: (evt: PhEvent) => void;
+    setHardwareFlash: (powered: boolean, brightness: number) => void;
     setKaraoke: (karaoke: PhKaraoke) => void;
     setTimecode: (timecode: number) => void;
     setKaraokeQueue: (queue: PhSongSession[]) => void;
@@ -70,6 +76,11 @@ const defaultProps: AuthProps = {
     event: null,
     time: null,
 
+    hardwareFlash: {
+        powered: false,
+        brightness: 100,
+    },
+
     karaoke: null,
     karaokeQueue: [],
 
@@ -81,25 +92,32 @@ const defaultProps: AuthProps = {
 
 const AuthContext = createContext<AuthContextProps>({
     ...defaultProps,
-    login: async () => {},
-    loginGuest: async () => {},
-    setToken: () => {},
+    login: async () => { },
+    loginGuest: async () => { },
+    setToken: () => { },
     isLoggedIn: () => false,
-    logout: () => {},
+    logout: () => { },
 
-    setMode: () => {},
-    setEvent: () => {},
-    setKaraoke: () => {},
-    setTimecode: () => {},
-    setKaraokeQueue: () => {},
-    setSyncInProgress: () => {},
+    setMode: () => { },
+    setEvent: () => { },
+    setHardwareFlash: () => { },
+    setKaraoke: () => { },
+    setTimecode: () => { },
+    setKaraokeQueue: () => { },
+    setSyncInProgress: () => { },
 
-    setDisplayName: () => {},
+    setDisplayName: () => { },
 });
 
 export default function AuthProvider({ children }: { children: ReactNode }) {
-    const [context, setContext] = useState<AuthProps>(defaultProps);
-    const { topics } = useSettings();
+    const { topics, hwflash_powered, modules_settings } = useSettings();
+    const [context, setContext] = useState<AuthProps>({
+        ...defaultProps,
+        hardwareFlash: {
+            powered: hwflash_powered,
+            brightness: modules_settings.photobooth.flash_brightness,
+        },
+    });
 
     const login = async (username: string, password: string) => {
         const data = await context.api.auth.login(username, password);
@@ -171,6 +189,11 @@ export default function AuthProvider({ children }: { children: ReactNode }) {
         setContext((oldCtx) => ({ ...oldCtx, displayName: displayName }));
     };
 
+    const setHardwareFlash = (powered: boolean, brightness: number) => setContext((oldCtx) => ({
+        ...oldCtx,
+        hardwareFlash: { powered, brightness },
+    }));
+
     useAsyncEffect(async () => {
         context.api.setOnExpired(() => setToken());
 
@@ -200,6 +223,7 @@ export default function AuthProvider({ children }: { children: ReactNode }) {
                 isLoggedIn,
                 logout,
                 setEvent,
+                setHardwareFlash,
                 setMode,
                 setKaraoke,
                 setTimecode,

admin/src/hooks/mercure.tsx

@@ -41,7 +41,7 @@ export default function MercureProvider({
     children: ReactNode;
 }) {
     const [ctx, setCtx] = useState<MercureProps>(defaultProps);
-    const { setEvent, setMode, isLoggedIn, setSyncInProgress } = useAuth();
+    const { setEvent, setMode, isLoggedIn, setSyncInProgress, setHardwareFlash } = useAuth();
     const [notif, ctxHolder] = notification.useNotification();
 
     const eventSource = useRef<EventSource>();
@@ -93,6 +93,11 @@ export default function MercureProvider({
             setEvent(event);
         });
 
+        es.addEventListener('/flash', (x) => {
+            const data = JSON.parse(x.data);
+            setHardwareFlash(data.powered, data.brightness);
+        });
+
         es.addEventListener('/mode', (x) => setMode(JSON.parse(x.data).mode));
 
         es.addEventListener('/sync-progress', (x) => setSyncInProgress(JSON.parse(x.data).syncInProgress));

admin/src/hooks/settings.tsx

@@ -2,16 +2,29 @@ import { ReactNode, createContext, useContext, useState } from 'react';
 import Loader from '../components/loader';
 import useAsyncEffect from 'use-async-effect';
 
-const DEFAULT_TOPICS = ['/time', '/mode', '/event', '/snackbar', '/karaoke', '/karaoke_queue', '/sync-progress'];
+const DEFAULT_TOPICS = [
+    '/time',
+    '/mode',
+    '/event',
+    '/snackbar',
+    '/karaoke',
+    '/karaoke_queue',
+    '/sync-progress',
+    '/flash',
+];
 
 /** @TODO: Implement APIs */
 type SettingsProps = {
     loaded: boolean;
     pageName: string;
 
+    modules_settings: Record<string, any>;
+
     guests_allowed: boolean;
     enabled_modules: string[];
 
+    hwflash_powered: boolean,
+
     version: string;
     commit: string;
     hwid: string | null;
@@ -29,8 +42,13 @@ const defaultProps: SettingsProps = {
     pageName: 'home',
     topics: DEFAULT_TOPICS,
 
+    modules_settings: {},
+
     guests_allowed: false,
     enabled_modules: [],
+
+    hwflash_powered: false,
+
     version: 'INDEV',
     commit: 'XXXXXX',
     hwid: null,

admin/src/pages/photobooth.tsx

@@ -1,8 +1,9 @@
-import { Button, Flex, Typography, notification } from 'antd';
+import { Button, Flex, Slider, Tooltip, Typography, notification } from 'antd';
+import { IconSun, IconSunOff } from '@tabler/icons-react';
+import { useEffect, useState } from 'react';
 import KeyVal from '../components/keyval';
 import Title from 'antd/es/typography/Title';
 import { useAuth } from '../hooks/auth';
-import { useEffect } from 'react';
 import { useSettings } from '../hooks/settings';
 import { useTranslation } from 'react-i18next';
 
@@ -11,10 +12,17 @@ export default function Photobooth() {
 
     const [notif, ctxHolder] = notification.useNotification();
     const { setPageName } = useSettings();
-    const { event, api } = useAuth();
+    const { event, api, hardwareFlash } = useAuth();
+
+    const [hwFlashBrightness, setHwFlashBrightness] = useState<number>(hardwareFlash.brightness);
 
     useEffect(() => setPageName('photobooth'), []);
 
+    const flashChange = async (powered: boolean, brightness: number) => {
+        setHwFlashBrightness(brightness);
+        await api.photobooth.setFlash(powered, brightness);
+    };
+
     return (
         <Flex vertical gap={2}>
             <Typography>
@@ -26,6 +34,27 @@ export default function Photobooth() {
                 <>
                     <KeyVal label={t('amt_manually_taken')}>{event.amtImagesHandtaken}</KeyVal>
                     <KeyVal label={t('amt_unattended')}>{event.amtImagesUnattended}</KeyVal>
+
+                    <span className="red">{t('flash')}: </span>
+                    <Flex gap={8} align='center'>
+                        <span>{hwFlashBrightness}%</span>
+
+                        <Slider
+                            style={{flex: 1}}
+                            min={0}
+                            max={100}
+                            value={hwFlashBrightness}
+                            onChange={x => flashChange(hardwareFlash.powered, x)}
+                        />
+
+                        <Tooltip title={t(hardwareFlash.powered ? 'toggle_off' : 'toggle_on')}>
+                            <Button
+                                icon={hardwareFlash.powered ? <IconSunOff /> : <IconSun />}
+                                onClick={() => flashChange(!hardwareFlash.powered, hwFlashBrightness)}
+                            />
+                        </Tooltip>
+                    </Flex>
+
                     <Flex style={{ marginTop: '2em' }} vertical>
                         <Button
                             onClick={async () => {

ansible/inventory.yaml.dist

@@ -9,6 +9,7 @@ all:
       partyhall_admin_password: 'admin_password'
       partyhall_admin_fullname: 'Administrator'
 
+      partyhall_photobooth_flash_brightness: 100 # Hardware flash brightness, in percentage
       partyhall_photobooth_webcam_width: 1280
       partyhall_photobooth_webcam_height: 720
 

ansible/templates/partyhall.yaml.j2

@@ -35,6 +35,7 @@ hardware_handler:
 settings:
     photobooth:
         countdown: 3 # Amount of seconds to countdown before taking a picture
+        flash_brightness: {{ partyhall_photobooth_flash_brightness }} # Hardware flash brightness, in percentage
         resolution: # The resolution of your webcam
             width: {{ partyhall_photobooth_webcam_width }}
             height: {{ partyhall_photobooth_webcam_height }}

backend/config/config.go

@@ -44,8 +44,9 @@ type HardwareHandler struct {
 
 type ModulesSettings struct {
 	Photobooth struct {
-		Countdown  int `yaml:"countdown" json:"countdown"`
-		Resolution struct {
+		Countdown       int `yaml:"countdown" json:"countdown"`
+		FlashBrightness int `yaml:"flash_brightness" json:"flash_brightness"`
+		Resolution      struct {
 			Width  int `yaml:"width" json:"width"`
 			Height int `yaml:"height" json:"height"`
 		} `yaml:"resolution" json:"resolution"`

backend/hwhandler/hwhandler.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"strconv"
 	"strings"
 	"time"
 
@@ -164,15 +165,14 @@ func (d *Device) OnFlash(c mqtt.Client, m mqtt.Message) {
 	data := strings.ToLower(string(m.Payload()))
 	fmt.Println("[MQTT] Flash " + data)
 
-	var err error = nil
-	if data == "on" {
-		err = d.WriteMessage("FLASH_ON")
-	} else if data == "off" {
-		err = d.WriteMessage("FLASH_OFF")
-	} else {
-		fmt.Println("\t=> Bad request")
+	val, err := strconv.Atoi(data)
+	if err != nil {
+		fmt.Println("Failed to send flash: bad payload => ", err)
+
+		return
 	}
 
+	err = d.WriteMessage(fmt.Sprintf("FLASH %v", val))
 	if err != nil {
 		fmt.Println("\t=> Failed to send message to device: " + err.Error())
 	}

backend/hwhandler/hwhandler.ino

@@ -46,10 +46,21 @@ void checkButton(int btn) {
 //#endregion
 
 void process_data(const char* data) {
-  if (strcmp(data, "FLASH_ON") == 0) {
-    digitalWrite(LEDS_RELAY_PIN, HIGH);
-  } else if (strcmp(data, "FLASH_OFF") == 0) {
-    digitalWrite(LEDS_RELAY_PIN, LOW);
+  char buffer[MAX_INPUT];
+  strncpy(buffer, data, sizeof(buffer) - 1);
+  buffer[sizeof(buffer) - 1] = '\0';
+
+  char* command = strtok(buffer, " ");
+  char* value_str = strtok(NULL, " ");
+
+  if (command && value_str) {
+    if (strcmp(command, "FLASH") == 0) {
+      int value = atoi(value_str);
+
+      if (value >= 0 && value <= 255) {
+        analogWrite(LEDS_RELAY_PIN, value);
+      }
+    }
   }
 }
 

backend/mqtt/hw_flash.go

@@ -0,0 +1,45 @@
+package mqtt
+
+import (
+	"fmt"
+
+	"github.com/partyhall/partyhall/api_errors"
+	"github.com/partyhall/partyhall/log"
+	"github.com/partyhall/partyhall/mercure_client"
+	"github.com/partyhall/partyhall/state"
+	"github.com/partyhall/partyhall/utils"
+)
+
+func SetFlash(powered bool, brightness int) {
+	brightness = utils.ClampInt(brightness, 0, 100)
+	if brightness == 0 {
+		powered = false
+	}
+
+	state.STATE.ModulesSettings.Photobooth.FlashBrightness = brightness
+
+	if !powered {
+		brightness = 0
+	}
+
+	state.STATE.HardwareFlashPowered = powered
+
+	mercure_client.CLIENT.PublishEvent(
+		"/flash",
+		map[string]any{
+			"powered":    powered,
+			"brightness": brightness,
+		},
+	)
+
+	err := EasyMqtt.Send("partyhall/flash", fmt.Sprintf("%v", brightness))
+	if err != nil {
+		api_errors.MQTT_PUBLISH_FAILURE.WithExtra(map[string]any{
+			"err": err,
+		})
+
+		log.Error("[MQTT] Faied to publish partyhall/flash", "err", err)
+
+		return
+	}
+}