Merge pull request #8 from PepperDash/feature/add-interface-hooks

Feature/add interface hooks

Author: ndorin

src/components/RoomConfigurationDisplay.tsx

@@ -1,12 +1,13 @@
 import {
-  useGetAllDeviceStateFromRoomConfiguration
+  useGetAllDeviceStateFromRoomConfiguration, useINumeric
 } from "src/lib/shared";
 import { useRoomConfiguration } from "src/lib/store/rooms/roomsSelectors";
 import { useRoomKey } from "src/lib/store/runtimeConfig/runtimeSelectors";
 
 const RoomConfigurationDisplay = () => {
   const roomKey = useRoomKey();
   const config = useRoomConfiguration(roomKey);
+  const numericKey = useINumeric(roomKey);
 
   useGetAllDeviceStateFromRoomConfiguration({ config });
 
@@ -19,6 +20,7 @@ const RoomConfigurationDisplay = () => {
       <div className="w-100 h-100 d-flex flex-column text-center overflow-auto">
         Room Config for {roomKey}:
         <pre className="text-wrap overflow-auto">{configData}</pre>
+        <button {...numericKey.digit0}>0</button>
       </div>
     </>
   );

src/lib/shared/Buttons/IconButton/IconButton.tsx

@@ -56,10 +56,10 @@ export const IconButton = ({
         onPointerLeave?.(e);
       }}
     >
-      <MultiIcon
+      {MultiIcon && <MultiIcon
         className={`${iconClassName || classes.iconsm}`}
         {...{ active: showActive, disabled }}
-      />
+      />}
       <div className={otherContentClassName}>{otherContent}</div>
     </button>
   );

src/lib/shared/Buttons/NamedIconButton/NamedIconButton.tsx

@@ -5,7 +5,11 @@ export function NamedIconButton({
   name,
   ...otherProps
 }: NamedIconButtonProps) {
-  return <IconButton multiIcon={iconsDictionary[name]} {...otherProps} />;
+  const multiIcon = iconsDictionary[name] ?? null;
+
+  if(!multiIcon) console.error(`Icon ${name} not found in dictionary`);
+
+  return <IconButton multiIcon={multiIcon} {...otherProps} />;
 }
 
 type NamedIconButtonProps = Omit<IconButtonProps, 'multiIcon'> & {

src/lib/shared/helpers/volumeHelpers.ts

@@ -1,3 +1,6 @@
-export * from "./useGetDeviceStateFromRoomConfiguration";
-// export * from "./usePressHoldRelease"
 export * from "./interfaces";
+export * from "./useDeviceIBasicVolumeWithFeedback";
+export * from "./useGetDeviceStateFromRoomConfiguration";
+export * from "./usePressHoldRelease";
+export * from "./useRoomIBasicVolumeWithFeedback";
+

src/lib/shared/hooks/index.ts

@@ -1,6 +1,26 @@
-export * from './interfaceNames';
-export * from './useIHasPowerControl';
-export * from './useIRunDirectRouteAction';
-export * from './useMobileControlTouchpanelController';
-export * from './useTwoWayDisplayBase';
+export * from "./interfaceNames";
+export * from "./useAvrControl";
+export * from "./useEndpoint";
+export * from "./useIBasicVolumeWithFeedback";
+export * from "./useIChannelMessenger";
+export * from "./useIColor";
+export * from "./useICommunicationMonitor";
+export * from "./useIDPad";
+export * from "./useIDeviceInfoMessenger";
+export * from "./useIDvr";
+export * from "./useIHasPowerControl";
+export * from "./useIHasSelectableItems";
+export * from "./useILevelControls";
+export * from "./useILightingScenes";
+export * from "./useIMatrixRouting";
+export * from "./useINumeric";
+export * from "./useIRoomEventSchedule";
+export * from "./useIRunDirectRouteAction";
+export * from "./useIRunRouteAction";
+export * from "./useISetTopBoxcontrols";
+export * from "./useIShadesOpenCloseStop";
+export * from "./useISwitchedOutput";
+export * from "./useITransport";
+export * from "./useMobileControlTouchpanelController";
+export * from "./useTwoWayDisplayBase";
 

src/lib/shared/hooks/interfaces/index.ts

@@ -1 +1,23 @@
-export type InterfaceNames = "IHasPowerControl" | "IRoutingFeedback" | "IRunDirectRouteAction" | "IRunRouteAction" | "IRouting";
+export type InterfaceNames =
+| "IBasicVolumeWithFeedback"
+  | "ICommunicationMonitor"
+  | "IDeviceInfoProvider"
+  | "IHasCurrentSourceInfoChange"
+  | "IHasInputs"
+  | "IHasPowerControl"
+  | "IHasPowerControlWithFeedback"
+  | "IHasSurroundChannels"
+  | "ILevelControls"
+  | "IMatrixRouting"
+  | "IRouting"
+  | "IRouting"
+  | "IRoutingFeedback"
+  | "IRoutingInputs"
+  | "IRoutingOutputs"
+  | "IRoutingSink"
+  | "IRoutingSinkWithSwitching"
+  | "IRunDirectRouteAction"
+  | "IRunDirectRouteAction"
+  | "IRunRouteAction"
+  | "IRunRouteActoin"
+  | string;

src/lib/shared/hooks/interfaces/interfaceNames.ts

@@ -0,0 +1,39 @@
+import { useGetDevice } from 'src/lib/store';
+import { PowerState } from 'src/lib/types';
+import { IHasInputsState } from 'src/lib/types/state/state/IHasInputsState';
+import { IHasSurroundSoundModesState } from 'src/lib/types/state/state/IHasSurroundSoundModesState';
+import { useDeviceIBasicVolumeWithFeedback } from '../useDeviceIBasicVolumeWithFeedback';
+import { IBasicVolumeWithFeedbackReturn } from './useIBasicVolumeWithFeedback';
+import { IHasPowerWithFeedbackProps, useIHasPowerControl } from './useIHasPowerControl';
+import { IHasSelectableItemsReturn, useIHasSelectableItems } from './useIHasSelectableItems';
+import { IHasSurroundChannelsReturn, useIHasSurroundChannels } from './useIHasSurroundChannels';
+
+export function useAvrControl(key: string): AvrReturn | undefined {
+    const avrState = useGetDevice<PowerState>(key);
+    const powerControl = useIHasPowerControl(key);
+    const inputControl = useIHasSelectableItems<IHasInputsState>(key);
+    const surroundSoundModes = useIHasSelectableItems<IHasSurroundSoundModesState>(key);
+    const mainVolumeControl = useDeviceIBasicVolumeWithFeedback(key);
+    const surroundChannels = useIHasSurroundChannels(key);
+
+    if (!avrState) return undefined;
+
+    return {
+        avrState,
+        powerControl,
+        inputControl: inputControl!,
+        surroundSoundModes: surroundSoundModes!,
+        surroundChannels: surroundChannels!,
+        mainVolumeControl: mainVolumeControl!
+    };
+}
+
+interface AvrReturn {
+    avrState: PowerState;
+    powerControl: IHasPowerWithFeedbackProps;
+    inputControl: IHasSelectableItemsReturn<IHasInputsState>;
+    surroundSoundModes: IHasSelectableItemsReturn<IHasSurroundSoundModesState>;
+    surroundChannels: IHasSurroundChannelsReturn;
+    mainVolumeControl: IBasicVolumeWithFeedbackReturn;
+}
+

src/lib/shared/hooks/interfaces/useAvrControl.ts

@@ -0,0 +1,16 @@
+import { useGetDevice } from 'src/lib';
+import { EndpointState } from 'src/lib/types/state/state/endpointState/endpointState';
+
+
+export function useEndpoint(key: string): IEndpointReturn | undefined {
+
+    const endpointState = useGetDevice<EndpointState>(key);
+  
+    if (!endpointState) return undefined;
+
+    return { endpointState };
+}
+
+export interface IEndpointReturn {
+    endpointState: EndpointState;
+}

src/lib/shared/hooks/interfaces/useEndpoint.ts

@@ -0,0 +1,74 @@
+import { Volume } from "src/lib/types";
+import { useWebsocketContext } from "src/lib/utils/useWebsocketContext";
+import { useButtonHeldHeartbeat } from "../useHeldButtonAction";
+import { PressHoldReleaseReturn } from "../usePressHoldRelease";
+
+export function useIBasicVolumeWithFeedback(
+  path: string, volumeState: Volume | undefined
+): IBasicVolumeWithFeedbackReturn | undefined {
+  const { sendMessage, sendSimpleMessage } = useWebsocketContext();
+
+  const volumeUp = useButtonHeldHeartbeat(`${path}`, "volumeUp");
+  const volumeDown = useButtonHeldHeartbeat(`${path}`, "volumeDown");
+
+  if (!volumeState) return undefined;
+
+  const setLevel = (value: number) =>
+    sendSimpleMessage(`${path}/level`, value);
+
+  const muteToggle = () => sendMessage(`${path}/muteToggle`, null);
+
+  const muteOn = () => sendMessage(`${path}/muteOn`, null);
+
+  const muteOff = () => sendMessage(`${path}/muteOff`, null);
+
+  return {
+    volumeState,
+    volumeUp,
+    volumeDown,
+    setLevel,
+    muteToggle,
+    muteOn,
+    muteOff,
+  };
+}
+
+export interface IBasicVolumeWithFeedbackReturn {
+  volumeState: Volume;
+  volumeUp: PressHoldReleaseReturn;
+  volumeDown: PressHoldReleaseReturn;
+  setLevel: (level: number) => void;
+  muteToggle: () => void;
+  muteOn: () => void;
+  muteOff: () => void;
+}
+
+export function useGetIBasicVolumeWithFeedback(
+  path: string, volumeState: Volume | undefined
+): IBasicVolumeWithFeedbackReturn | undefined {
+  const { sendMessage, sendSimpleMessage } = useWebsocketContext();
+
+  const volumeUp = useButtonHeldHeartbeat(`${path}`, "volumeUp");
+  const volumeDown = useButtonHeldHeartbeat(`${path}`, "volumeDown");
+
+  if (!volumeState) return undefined;
+
+  const setLevel = (value: number) =>
+    sendSimpleMessage(`${path}/level`, value);
+
+  const muteToggle = () => sendMessage(`${path}/muteToggle`, null);
+
+  const muteOn = () => sendMessage(`${path}/muteOn`, null);
+
+  const muteOff = () => sendMessage(`${path}/muteOff`, null);
+
+  return {
+    volumeState,
+    volumeUp,
+    volumeDown,
+    setLevel,
+    muteToggle,
+    muteOn,
+    muteOff,
+  };
+}

src/lib/shared/hooks/interfaces/useIBasicVolumeWithFeedback.ts

@@ -0,0 +1,30 @@
+import { useButtonHeldHeartbeat } from '../useHeldButtonAction';
+import { PressHoldReleaseReturn } from '../usePressHoldRelease';
+
+export function useIChannelMessenger(key: string): IChannelMessengerProps | undefined {
+
+    const path = `/device/${key}`;
+
+    const channelUp = useButtonHeldHeartbeat(path, 'chanUp');
+
+    const channelDown = useButtonHeldHeartbeat(path, 'chanDown');
+
+    const lastChannel = useButtonHeldHeartbeat(path, 'lastChan');
+
+    const guide = useButtonHeldHeartbeat(path, 'guide');
+
+    const info = useButtonHeldHeartbeat(path, 'info');
+
+    const exit = useButtonHeldHeartbeat(path, 'exit');
+
+  return { channelUp, channelDown, lastChannel, guide, info, exit };
+}
+
+export interface IChannelMessengerProps {
+  channelUp: PressHoldReleaseReturn;
+  channelDown: PressHoldReleaseReturn;
+  lastChannel: PressHoldReleaseReturn;
+  guide: PressHoldReleaseReturn;
+  info: PressHoldReleaseReturn;
+  exit: PressHoldReleaseReturn;
+}

src/lib/shared/hooks/interfaces/useIChannelMessenger.ts

@@ -0,0 +1,27 @@
+import { useButtonHeldHeartbeat } from '../useHeldButtonAction';
+import { PressHoldReleaseReturn } from '../usePressHoldRelease';
+
+export function useIColor(key: string): IColorProps | undefined {
+  const path = `/device/${key}`;
+
+  const red = useButtonHeldHeartbeat(path, 'red');
+  
+  const green = useButtonHeldHeartbeat(path, 'green');
+
+  const yellow = useButtonHeldHeartbeat(path, 'yellow');
+
+  const blue = useButtonHeldHeartbeat(path, 'blue');
+
+  return { red, green, yellow, blue };
+}
+
+export interface IColorProps {
+  red: PressHoldReleaseReturn;
+  green: PressHoldReleaseReturn;
+  yellow: PressHoldReleaseReturn;
+  blue: PressHoldReleaseReturn;
+}
+
+
+
+

src/lib/shared/hooks/interfaces/useIColor.ts

@@ -0,0 +1,15 @@
+import { CommunicationMonitorState, useGetDevice } from 'src/lib';
+
+export function useICommunicationMonitor(key: string): ICommunicationMonitorReturn | undefined {
+  const device = useGetDevice<CommunicationMonitorState>(key);
+
+  if (!device) return undefined;
+
+  return {
+    communicationMonitorState: device,
+  };
+}
+
+export interface ICommunicationMonitorReturn {
+  communicationMonitorState: CommunicationMonitorState;
+}

src/lib/shared/hooks/interfaces/useICommunicationMonitor.ts

@@ -0,0 +1,26 @@
+import { useButtonHeldHeartbeat } from "../useHeldButtonAction";
+import { PressHoldReleaseReturn } from "../usePressHoldRelease";
+
+export function useIDPad(key: string): IDPadProps | undefined {
+  const path = `/device/${key}`;
+
+  const up = useButtonHeldHeartbeat(path, "up");
+  const down = useButtonHeldHeartbeat(path, "down");
+  const left = useButtonHeldHeartbeat(path, "left");
+  const right = useButtonHeldHeartbeat(path, "right");
+  const select = useButtonHeldHeartbeat(path, "select");
+  const menu = useButtonHeldHeartbeat(path, "menu");
+  const exit = useButtonHeldHeartbeat(path, "exit");
+
+  return { up, down, left, right, select, menu, exit };
+}
+
+export interface IDPadProps {
+  up: PressHoldReleaseReturn;
+  down: PressHoldReleaseReturn;
+  left: PressHoldReleaseReturn;
+  right: PressHoldReleaseReturn;
+  select: PressHoldReleaseReturn;
+  menu: PressHoldReleaseReturn;
+  exit: PressHoldReleaseReturn;
+}

src/lib/shared/hooks/interfaces/useIDPad.ts

@@ -0,0 +1,11 @@
+import { DeviceInfo, DeviceInfoState, useGetDevice } from 'src/lib';
+
+
+export function useIDeviceInfoMessenger(key: string): DeviceInfo | undefined {
+  const device = useGetDevice<DeviceInfoState>(key);
+
+  if (!device) return undefined;
+
+  return device.deviceInfo || undefined;
+  
+}

src/lib/shared/hooks/interfaces/useIDeviceInfoMessenger.ts

@@ -0,0 +1,21 @@
+import { useButtonHeldHeartbeat } from '../useHeldButtonAction';
+import { PressHoldReleaseReturn } from '../usePressHoldRelease';
+
+export function useIDvr(key: string): IDvrProps | undefined {
+  const path = `/device/${key}`;
+
+
+  const dvrList = useButtonHeldHeartbeat(path, 'dvrList');
+
+  const record = useButtonHeldHeartbeat(path, 'record');
+
+  return { dvrList, record };
+}
+
+interface IDvrProps {
+  dvrList: PressHoldReleaseReturn;
+  record: PressHoldReleaseReturn;
+}
+
+
+