senza-sdk 4.4.2 → 4.4.4-86e7d7a.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "senza-sdk",
-    "version": "4.4.2",
+    "version": "4.4.4-86e7d7a.0",
     "main": "./src/api.js",
     "description": "API for Senza application",
     "license": "MIT",

package/src/implementation/deviceManager.js

@@ -1,16 +1,16 @@
 import { DeviceManager as DeviceManagerInterface } from "../interface/deviceManager";
-import { getFCID, sdkLogger, getRestResponse } from "./utils";
+import { getFCID, sdkLogger, getRestResponse, clearTimer, SenzaError } from "./utils";
 import { sessionInfo } from "./SessionInfo";
-import {EventListenersManager} from "./eventListenersManager";
-import {bus, Events} from "./eventBus";
-import {lifecycle} from "./lifecycle";
+import { EventListenersManager } from "./eventListenersManager";
+import { bus, Events } from "./eventBus";
+import { lifecycle } from "./lifecycle";
 
 let wifi_ap_data;
 let wifi_status;
 let wifi_status_last_update = 0;
 
 const WIFI_STATUS_CACHE_SECONDS = 5;
-const FACTORY_RESET_TIMEOUT_SECONDS = 5;
+const API_CONFIRMATION_TIMEOUT_MS = 5000;
 
 async function getWifiApData() {
     // Wi-Fi access point data is static, so it needs to be retrieved only once
@@ -80,6 +80,33 @@ class DeviceManager extends DeviceManagerInterface {
         }
     }
 
+    /**
+     * Translate the HdmiStatus information to a single HdmiStatus for the application
+     * 1) cecStatus is a configuration setting from the client. If false, we always return UNKNOWN to the application
+     * 2) If cecStatus is true, we check the hdmiStatus. If not "connected", the HDMI status is definitely INACTIVE.
+     * 3) If hdmiStatus is "connected" and cecStatus is true, we rely on the cecActiveSourceStatus to determine the HdmiStatus
+     * @private
+     */
+    _translateHdmiStatus(hdmiStatusStr) {
+        const hdmiStatusObj = JSON.parse(hdmiStatusStr ?? "{}"); // Object containing the 3 statuses
+        let hdmiStatus = this.HdmiStatus.UNKNOWN;
+        if (hdmiStatusObj?.cecStatus) {
+            if (hdmiStatusObj.hdmiStatus !== "connected") {
+                hdmiStatus = this.HdmiStatus.INACTIVE;
+            } else {
+                const cecActive = this._cecActiveSourceStatusMap[hdmiStatusObj.cecActiveSourceStatus];
+                hdmiStatus = cecActive ?? this.HdmiStatus.UNKNOWN;
+                if (!cecActive) {
+                    sdkLogger.warn(`Unknown CEC active source status: ${hdmiStatusObj.cecActiveSourceStatus}`);
+                }
+            }
+        } else {
+            sdkLogger.warn("cec is disabled or no hdmiStatus");
+        }
+        sdkLogger.log("HDMI status is:", hdmiStatus);
+        return hdmiStatus;
+    }
+
     /**
      * @private Add event listeners for system events
      */
@@ -91,25 +118,7 @@ class DeviceManager extends DeviceManagerInterface {
         typeof document !== "undefined" && document.addEventListener("hs/hdmiStatusChanged", async (event) => {
             sdkLogger.info("Got hs/hdmiStatusChanged event with detail", JSON.stringify(event?.detail));
 
-            // Translate the HdmiStatus information to a single HdmiStatus for the application
-            // 1) cecStatus is a configuration setting from the client. If false, we always return UNKNOWN to the application
-            // 2) If cecStatus is true, we check the hdmiStatus. If not "connected", the HDMI status is definitely INACTIVE.
-            // 3) If hdmiStatus is "connected" and cecStatus is true, we rely on the cecActiveSourceStatus to determine the HdmiStatus
-            let hdmiStatus = this.HdmiStatus.UNKNOWN;
-            const status = JSON.parse(event?.detail?.hdmiStatus ?? "{}"); // Object containing the 3 statuses
-            if (status?.cecStatus) {
-                if (status.hdmiStatus !== "connected") {
-                    hdmiStatus = this.HdmiStatus.INACTIVE;
-                } else {
-                    const cecActive = this._cecActiveSourceStatusMap[status.cecActiveSourceStatus];
-                    hdmiStatus = cecActive ?? this.HdmiStatus.UNKNOWN;
-                    if (!cecActive) {
-                        sdkLogger.warn(`Unknown CEC active source status: ${status.cecActiveSourceStatus}`);
-                    }
-                }
-            } else {
-                sdkLogger.warn("cec is disabled or no hdmiStatus");
-            }
+            const hdmiStatus = this._translateHdmiStatus(event?.detail?.hdmiStatus);
 
             const timeBeforeCallbacks = Date.now();
 
@@ -179,6 +188,46 @@ class DeviceManager extends DeviceManagerInterface {
         return super.deviceInfo;
     }
 
+    getHdmiStatus() {
+        if (window.cefQuery) {
+            const FCID = getFCID();
+            const message = {
+                type: "getHdmiStatus",
+                fcid: FCID
+            };
+            const request = { target: "TC", waitForResponse: true, message: JSON.stringify(message) };
+            sdkLogger.log("Sending getHdmiStatus request");
+            return new Promise((resolve, reject) => {
+                let timerId = 0;
+                const timeBeforeSendingRequest = Date.now();
+                const queryId = window.cefQuery({
+                    request: JSON.stringify(request),
+                    persistent: false,
+                    onSuccess: (data) => {
+                        timerId = clearTimer(timerId);
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        sdkLogger.withFields({ duration }).log(`getHdmiStatus completed successfully after ${duration} ms with data: ${data}`);
+                        const hdmiStatus = this._translateHdmiStatus(data ? data : "{}");
+                        resolve(hdmiStatus);
+                    },
+                    onFailure: (code, msg) => {
+                        const duration = Date.now() - timeBeforeSendingRequest;
+                        sdkLogger.withFields({ duration }).log(`getHdmiStatus failed after ${duration} ms. Error code: ${code}, error message: ${msg}`);
+                        timerId = clearTimer(timerId);
+                        reject(new SenzaError(code, msg));
+                    }
+                });
+                sdkLogger.log(`window.cefQuery for getHdmiStatus returned query id ${queryId}`);
+                const timeout = API_CONFIRMATION_TIMEOUT_MS + 1000;
+                timerId = setTimeout(() => {
+                    sdkLogger.log(`getHdmiStatus reached timeout of ${timeout} ms, canceling query id ${queryId}`);
+                    window.cefQueryCancel(queryId);
+                    reject(new SenzaError(6000, `getHdmiStatus reached timeout of ${timeout} ms`));
+                }, timeout, queryId);
+            });
+        }
+    }
+
     reboot() {
         return new Promise((resolve, reject) => {
             if (window.cefQuery) {
@@ -295,12 +344,12 @@ class DeviceManager extends DeviceManagerInterface {
                     reject(`factoryReset failed: ${code} ${msg}`);
                 }
             });
-
+            const timeout = API_CONFIRMATION_TIMEOUT_MS + 1000;
             timeoutHandler = setTimeout(() => {
-                logger.error(`factoryReset failed: reached timeout of ${FACTORY_RESET_TIMEOUT_SECONDS * 1000} ms`);
+                logger.error(`factoryReset failed: reached timeout of ${timeout} ms`);
                 window.cefQueryCancel(queryId);
-                reject(`factoryReset failed: reached timeout of ${FACTORY_RESET_TIMEOUT_SECONDS * 1000} ms`);
-            }, FACTORY_RESET_TIMEOUT_SECONDS * 1000);
+                reject(`factoryReset failed: reached timeout of ${timeout} ms`);
+            }, timeout);
         });
     }
 

package/src/interface/deviceManager.js

@@ -54,6 +54,16 @@ export class DeviceManager extends EventTarget {
 
     }
 
+    /**
+     * Get the current HDMI status from the connector
+     * @return {Promise<HdmiStatus>} Promise which is resolved when getHdmiStatus has been successfully performed
+     * Failure to getHdmiStatus for any reason, results in the promise being rejected.
+     * @private
+     */
+    getHdmiStatus() {
+        return noop("DeviceManager.getHdmiStatus");
+    }
+
     /**
      * Reboot the device
      * @return {Promise} Promise which is resolved when the reboot command has been successfully processed.

package/src/interface/version.js

@@ -1 +1 @@
-export const version = "4.4.2";
+export const version = "4.4.4-86e7d7a.0";