@phystack/hub-device 4.4.44 → 4.4.46

package/src/types/twin.types.ts

@@ -6,7 +6,7 @@ export enum TwinTypeEnum {
   Edge = 'Edge',
   Cloud = 'Cloud',
   Web = 'Web',
-  Peripheral = 'Peripheral'
+  Peripheral = 'Peripheral',
 }
 
 export enum TwinStatusEnum {
@@ -329,6 +329,48 @@ export interface System {
   virtual: boolean;
 }
 
+export enum AvailabilityStatus {
+  Available = 'Available',
+  Unavailable = 'Unavailable',
+  Unknown = 'Unknown',
+}
+
+export interface AudioPort {
+  name: string; // Port identifier (e.g., "analog-output-headphones")
+  description: string; // Human-readable description (e.g., "Headphones")
+  type?: string; // Port type (e.g., "Headphones", "HDMI", "Line")
+  priority?: number; // Port priority
+  availabilityStatus?: AvailabilityStatus; // Port availability status
+}
+
+export interface AudioDevice {
+  identifier: string;
+  displayName?: string; // Optional - info is consolidated in label field
+  volume?: number; // Volume level (0-100%)
+  muted?: boolean; // Mute status
+  availablePorts?: AudioPort[]; // Available ports for this device
+  label?: string; // Human-readable label with device info (e.g., "Headphones (Default, Available)", "HDMI Display (Available)")
+}
+
+export interface AudioDevices {
+  outputs: AudioDevice[];
+  inputs: AudioDevice[];
+}
+
+export interface AudioOutputControl {
+  identifier?: string; // The sink identifier from pactl (e.g., "alsa_output.pci-0000_00_1b.0.stereo-fallback").
+  volume?: number; // Volume level (0-100%)
+  muted?: boolean; // Mute status
+  activePort?: string; // Port to activate (e.g., "analog-output-headphones", "hdmi-output-0")
+}
+
+export interface AudioInputControl {
+  identifier?: string; // The source identifier from pactl (e.g., "alsa_input.pci-0000_00_1b.0.stereo-fallback").
+  volume?: number; // Volume level (0-100%)
+  muted?: boolean; // Mute status
+  activePort?: string; // Port to activate (e.g., "analog-input-microphone", "hdmi-input-0")
+}
+
 export interface DeviceTwinReportedProperties {
   ip: DeviceIp[];
   os: {
@@ -361,6 +403,7 @@ export interface DeviceTwinReportedProperties {
   users: any[]; // todo: update
   system: System;
   jobs: Job[];
+  audioDevices?: AudioDevices;
 }
 
 export interface EdgeTwinReportedProperties {
@@ -476,6 +519,8 @@ export interface DeviceTwinDesiredProperties {
   externalId?: string;
   accessKey: string;
   jobs?: Job[];
+  audioOutputControl?: AudioOutputControl;
+  audioInputControl?: AudioInputControl;
 }
 
 export interface DeviceTwinDesiredPropertiesResponse {
@@ -487,6 +532,8 @@ export interface DeviceTwinDesiredPropertiesResponse {
   accessKey: string;
   jobs: Job[];
   timezone?: string;
+  audioOutputControl?: AudioOutputControl;
+  audioInputControl?: AudioInputControl;
 }
 
 interface ScreenTwinDocument extends TwinDocumentBase {
@@ -530,11 +577,11 @@ interface DeviceTwinDocument extends TwinDocumentBase {
 }
 
 export type TwinDocument =
-| ScreenTwinDocument
-| EdgeTwinDocument
-| CloudTwinDocument
-| WebTwinDocument
-| DeviceTwinDocument;
+  | ScreenTwinDocument
+  | EdgeTwinDocument
+  | CloudTwinDocument
+  | WebTwinDocument
+  | DeviceTwinDocument;
 
 interface TwinResponseBase {
   id: string;
@@ -600,19 +647,19 @@ export interface PeripheralTwinResponse extends TwinResponseBase {
 }
 
 export type TwinResponse =
-| DeviceTwinResponse
-| ScreenTwinResponse
-| EdgeTwinResponse
-| CloudTwinResponse
-| WebTwinResponse
-| PeripheralTwinResponse;
+  | DeviceTwinResponse
+  | ScreenTwinResponse
+  | EdgeTwinResponse
+  | CloudTwinResponse
+  | WebTwinResponse
+  | PeripheralTwinResponse;
 
 export type TwinDesiredPropertiesResponse =
-| DeviceTwinDesiredPropertiesResponse
-| ScreenTwinDesiredPropertiesResponse
-| EdgeTwinDesiredPropertiesResponse
-| CloudTwinDesiredPropertiesResponse
-| WebTwinDesiredPropertiesResponse;
+  | DeviceTwinDesiredPropertiesResponse
+  | ScreenTwinDesiredPropertiesResponse
+  | EdgeTwinDesiredPropertiesResponse
+  | CloudTwinDesiredPropertiesResponse
+  | WebTwinDesiredPropertiesResponse;
 
 interface TwinCreateDocumentBase {
   deviceId: string;
@@ -645,9 +692,9 @@ export interface EdgeTwinCreateDocument extends TwinCreateDocumentBase {
 }
 
 export type TwinCreateDocument =
-| DeviceTwinCreateDocument
-| ScreenTwinCreateDocument
-| EdgeTwinCreateDocument;
+  | DeviceTwinCreateDocument
+  | ScreenTwinCreateDocument
+  | EdgeTwinCreateDocument;
 
 export interface TwinsGroupedByDeviceId {
   _id: string;
@@ -660,9 +707,9 @@ export interface TwinsGroupedByDeviceIdResponse {
 }
 
 export type InstanceTwinReportedProperties =
-| EdgeTwinReportedProperties
-| DeviceTwinReportedProperties
-| ScreenTwinReportedProperties;
+  | EdgeTwinReportedProperties
+  | DeviceTwinReportedProperties
+  | ScreenTwinReportedProperties;
 
 export interface DeviceTwinUpdatePayload {
   spaceId?: string;
@@ -676,6 +723,8 @@ export interface DeviceTwinDesiredPropertiesUpdatePayload {
   spaceId?: string;
   env?: string;
   displayName?: string;
+  audioOutputControl?: AudioOutputControl;
+  audioInputControl?: AudioInputControl;
 }
 
 export interface ScreenTwinDesiredPropertiesUpdatePayload {
@@ -698,8 +747,8 @@ export interface DeviceTwinUpdateDocument {
 }
 
 export type InstanceTwinDesiredProperties =
-| ScreenTwinDesiredPropertiesUpdatePayload
-| DeviceTwinDesiredPropertiesUpdatePayload;
+  | ScreenTwinDesiredPropertiesUpdatePayload
+  | DeviceTwinDesiredPropertiesUpdatePayload;
 
 export interface InstanceTwinUpdateDocument {
   status?: TwinStatusEnum;
@@ -712,7 +761,6 @@ export interface InstanceTwinUpdateDocument {
 
 export type TwinUpdateDocument = DeviceTwinUpdateDocument | InstanceTwinUpdateDocument;
 
-
 export interface DeviceIp {
   interface: string;
   ipv4: string;