Add support for updated response to CURRENT_APP command for HDMI inputs

Author: WesSouza

CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- Added `getCurrentAppDetails` with additional information returned for HDMI
+  inputs.
+
+### Fixed
+
+- Updated `getCurrentApp` to work for HDMI inputs on newer webOS versions that
+  return additional information.
+
 ## 4.3.0 - 2024-09-20
 
 ## 4.2.0 - 2024-01-03

packages/lgtv-ip-control/README.md

@@ -124,6 +124,17 @@ responding.
 const currentApp = await lgtv.getCurrentApp();
 ```
 
+### `.getCurrentAppDetails(): Promise<AppDetails | null>`
+
+Gets the current app details as an object. Might include the current app, HDCP
+status, HDCP version, etc. Please note that `signal` seems to always be `true`,
+even if no device is connected. Might return `null` if the TV is powered off but
+still responding.
+
+```js
+const currentAppDetails = await lgtv.getCurrentAppDetails();
+```
+
 ### `.getCurrentVolume(): Promise<number>`
 
 Gets the current volume as an integer from `0` to `100`.

packages/lgtv-ip-control/src/classes/LGTV.ts

@@ -10,6 +10,7 @@ import {
   PowerStates,
   ScreenMuteModes,
 } from '../constants/TV.js';
+import { AppDetails } from '../types.js';
 import { LGEncoder, LGEncryption } from './LGEncryption.js';
 import { TimeoutError, TinySocket } from './TinySocket.js';
 
@@ -58,15 +59,31 @@ export class LGTV {
   }
 
   async getCurrentApp(): Promise<Apps | string | null> {
+    const appDetails = await this.getCurrentAppDetails();
+    return appDetails?.app ?? null;
+  }
+
+  async getCurrentAppDetails(): Promise<AppDetails | null> {
     const response = await this.sendCommand('CURRENT_APP');
     if (response === '') {
       return null;
     }
-    const match = response.match(/^APP:([\w.]+)$/);
-    if (!match) {
+
+    const pairs: Record<string, string> = {};
+    for (const match of response.matchAll(/([\w\s]+):(\S+)/g)) {
+      pairs[match[1].trim()] = match[2];
+    }
+    if (!pairs['APP']) {
       throw new ResponseParseError(`failed to parse response: ${response}`);
     }
-    return match[1];
+
+    return {
+      app: pairs['APP'],
+      hotPlug: pairs['Hot plug'],
+      signal: pairs['Signal'] ? pairs['Signal'] === 'Yes' : undefined,
+      hdcpVersion: pairs['HDCP'],
+      hdcpStatus: pairs['HDCP Status'],
+    };
   }
 
   async getCurrentVolume(): Promise<number> {

packages/lgtv-ip-control/src/types.ts

@@ -0,0 +1,9 @@
+import { Apps } from './constants/TV.js';
+
+export type AppDetails = {
+  app: Apps | string | undefined;
+  hdcpStatus: string | undefined;
+  hdcpVersion: string | undefined;
+  hotPlug: string | undefined;
+  signal: boolean | undefined;
+};

packages/lgtv-ip-control/test/LGTV.test.ts

@@ -128,6 +128,16 @@ describe.each([
       { response: 'APP:youtube.leanback.v4', expected: Apps.youtube },
       { response: 'APP:com.hbo.hbomax', expected: Apps.hbomax },
       { response: 'APP:netflix', expected: Apps.netflix },
+      {
+        response:
+          'APP:com.webos.app.hdmi1 Hot plug:Connected Signal:Yes HDCP:1.4 HDCP Status:None',
+        expected: 'com.webos.app.hdmi1',
+      },
+      {
+        response:
+          'APP:com.webos.app.hdmi4 Hot plug:Connected Signal:Yes HDCP:2.2 HDCP Status:Authenticated',
+        expected: 'com.webos.app.hdmi4',
+      },
       { response: 'APP:unsupported', expected: 'unsupported' },
     ])('gets current app: $response', async ({ response, expected }) => {
       const mocking = mockResponse('CURRENT_APP', response);
@@ -137,6 +147,51 @@ describe.each([
       await expect(actual).resolves.toBe(expected);
     });
 
+    it.each([
+      { response: '', expected: null },
+      {
+        response:
+          'APP:com.webos.app.hdmi1 Hot plug:Connected Signal:Yes HDCP:1.4 HDCP Status:None',
+        expected: {
+          app: 'com.webos.app.hdmi1',
+          hotPlug: 'Connected',
+          signal: true,
+          hdcpVersion: '1.4',
+          hdcpStatus: 'None',
+        },
+      },
+      {
+        response:
+          'APP:com.webos.app.hdmi4 Hot plug:Connected Signal:Yes HDCP:2.2 HDCP Status:Authenticated',
+        expected: {
+          app: 'com.webos.app.hdmi4',
+          hotPlug: 'Connected',
+          signal: true,
+          hdcpVersion: '2.2',
+          hdcpStatus: 'Authenticated',
+        },
+      },
+      {
+        response: 'APP:unsupported',
+        expected: {
+          app: 'unsupported',
+          hotPlug: undefined,
+          signal: undefined,
+          hdcpVersion: undefined,
+          hdcpStatus: undefined,
+        },
+      },
+    ])(
+      'gets current app details: $response',
+      async ({ response, expected }) => {
+        const mocking = mockResponse('CURRENT_APP', response);
+        await testTV.connect();
+        const actual = testTV.getCurrentAppDetails();
+        await expect(mocking).resolves.not.toThrow();
+        await expect(actual).resolves.toEqual(expected);
+      },
+    );
+
     it.each([
       { response: 'VOL:0', expected: 0 },
       { response: 'VOL:43', expected: 43 },