@24i/bigscreen-sdk 1.0.40-alpha.2687 → 1.0.40

package/packages/driver-browser/src/getOsName.ts

@@ -1,30 +1,30 @@
-function getNavigatorPlatform() {
-    return navigator.platform || '';
-}
-
-function getNavigatorUserAgent() {
-    return navigator.userAgent || '';
-}
-
-/**
- * Gets an operating system running on, based on browser data.
- * @returns an operating system running on
- */
-export function getOsName() {
-    const platform = getNavigatorPlatform();
-    const userAgent = getNavigatorUserAgent();
-
-    let os = '';
-    if (platform.match(/iPad|iPhone|iPod/)) {
-        os = 'iOS';
-    } else if (userAgent.match(/Android/)) {
-        os = 'Android';
-    } else if (platform.match(/Mac/)) {
-        os = 'Mac';
-    } else if (platform.match(/Win/)) {
-        os = 'Windows';
-    } else if (platform.match(/Linux/)) {
-        os = 'Linux';
-    }
-    return os;
-}
+function getNavigatorPlatform() {
+    return navigator.platform || '';
+}
+
+function getNavigatorUserAgent() {
+    return navigator.userAgent || '';
+}
+
+/**
+ * Gets an operating system running on, based on browser data.
+ * @returns an operating system running on
+ */
+export function getOsName() {
+    const platform = getNavigatorPlatform();
+    const userAgent = getNavigatorUserAgent();
+
+    let os = '';
+    if (platform.match(/iPad|iPhone|iPod/)) {
+        os = 'iOS';
+    } else if (userAgent.match(/Android/)) {
+        os = 'Android';
+    } else if (platform.match(/Mac/)) {
+        os = 'Mac';
+    } else if (platform.match(/Win/)) {
+        os = 'Windows';
+    } else if (platform.match(/Linux/)) {
+        os = 'Linux';
+    }
+    return os;
+}

package/packages/driver-browser/src/index.ts

@@ -1 +1 @@
-export { DeviceBrowser } from './DeviceBrowser';
+export { DeviceBrowser } from './DeviceBrowser';

package/packages/driver-browser/src/keymap.ts

@@ -1,22 +1,22 @@
-import { generateKeyCodeKeyMap, overrideValues } from '@24i/bigscreen-sdk/driver-base/keymap';
-
-export const getKeyMap = () => {
-    overrideValues({
-        RED: { code: 'KeyR', keyCode: 82 },
-        GREEN: { code: 'KeyG', keyCode: 71 },
-        YELLOW: { code: 'KeyY', keyCode: 89 },
-        BLUE: { code: 'KeyB', keyCode: 66 },
-        VOL_UP: { code: 'KeyU', keyCode: 85 },
-        VOL_DOWN: { code: 'KeyJ', keyCode: 74 },
-        MUTE: { code: 'KeyM', keyCode: 77 },
-        PLAY: { code: 'KeyO', keyCode: 79 },
-        PAUSE: { code: 'KeyP', keyCode: 80 },
-        PLAYPAUSE: { code: 'Space', keyCode: 32 },
-        FF: { code: 'Period', keyCode: 190 },
-        REW: { code: 'Comma', keyCode: 188 },
-        STOP: { code: 'Escape', keyCode: 27 },
-        SUBTITLES: { code: 'KeyS', keyCode: 83 },
-        REC: { code: 'KeyI', keyCode: 73 },
-    });
-    return generateKeyCodeKeyMap();
-};
+import { generateKeyCodeKeyMap, overrideValues } from '@24i/bigscreen-sdk/driver-base/keymap';
+
+export const getKeyMap = () => {
+    overrideValues({
+        RED: { code: 'KeyR', keyCode: 82 },
+        GREEN: { code: 'KeyG', keyCode: 71 },
+        YELLOW: { code: 'KeyY', keyCode: 89 },
+        BLUE: { code: 'KeyB', keyCode: 66 },
+        VOL_UP: { code: 'KeyU', keyCode: 85 },
+        VOL_DOWN: { code: 'KeyJ', keyCode: 74 },
+        MUTE: { code: 'KeyM', keyCode: 77 },
+        PLAY: { code: 'KeyO', keyCode: 79 },
+        PAUSE: { code: 'KeyP', keyCode: 80 },
+        PLAYPAUSE: { code: 'Space', keyCode: 32 },
+        FF: { code: 'Period', keyCode: 190 },
+        REW: { code: 'Comma', keyCode: 188 },
+        STOP: { code: 'Escape', keyCode: 27 },
+        SUBTITLES: { code: 'KeyS', keyCode: 83 },
+        REC: { code: 'KeyI', keyCode: 73 },
+    });
+    return generateKeyCodeKeyMap();
+};

package/packages/driver-browser/src/patchSuitestKeys.ts

@@ -1,27 +1,27 @@
-import { KeyMap } from '@24i/bigscreen-sdk/driver-base';
-
-/**
- * Patch for Suitest browser
- * It emits keyboard event with zero in keyCode for some buttons.
- * SRC: https://suite.st/docs/faq/tv-specific-keys-in-browser/
- */
-export function patchSuitestKeys() {
-    Object.defineProperty(KeyboardEvent.prototype, 'keyCode', {
-        get() {
-            switch (this.key) {
-                case '\u01CD': return KeyMap.BACK.keyCode;
-                case '\u0193': return KeyMap.RED.keyCode;
-                case '\u0194': return KeyMap.GREEN.keyCode;
-                case '\u0195': return KeyMap.YELLOW.keyCode;
-                case '\u0196': return KeyMap.BLUE.keyCode;
-                case '\u019F': return KeyMap.PLAY.keyCode;
-                case '\u019B': return KeyMap.PAUSE.keyCode;
-                case '\u019D': return KeyMap.STOP.keyCode;
-                case '\u019C': return KeyMap.REW.keyCode;
-                case '\u01A1': return KeyMap.FF.keyCode;
-                // Other keys like UP/DOWN/LEFT/RIGHT and ENTER keep the same values.
-                default: return this.which;
-            }
-        },
-    });
-}
+import { KeyMap } from '@24i/bigscreen-sdk/driver-base';
+
+/**
+ * Patch for Suitest browser
+ * It emits keyboard event with zero in keyCode for some buttons.
+ * SRC: https://suite.st/docs/faq/tv-specific-keys-in-browser/
+ */
+export function patchSuitestKeys() {
+    Object.defineProperty(KeyboardEvent.prototype, 'keyCode', {
+        get() {
+            switch (this.key) {
+                case '\u01CD': return KeyMap.BACK.keyCode;
+                case '\u0193': return KeyMap.RED.keyCode;
+                case '\u0194': return KeyMap.GREEN.keyCode;
+                case '\u0195': return KeyMap.YELLOW.keyCode;
+                case '\u0196': return KeyMap.BLUE.keyCode;
+                case '\u019F': return KeyMap.PLAY.keyCode;
+                case '\u019B': return KeyMap.PAUSE.keyCode;
+                case '\u019D': return KeyMap.STOP.keyCode;
+                case '\u019C': return KeyMap.REW.keyCode;
+                case '\u01A1': return KeyMap.FF.keyCode;
+                // Other keys like UP/DOWN/LEFT/RIGHT and ENTER keep the same values.
+                default: return this.which;
+            }
+        },
+    });
+}

package/packages/driver-entone/README.md

@@ -1,9 +1,9 @@
----
-id: README
-title: Driver Entone
-hide_title: true
-sidebar_label: Driver Entone
----
-
-# Driver Entone
-The Entone driver for Amino Kamai and Amulet set-top boxes running on Entone middleware.
+---
+id: README
+title: Driver Entone
+hide_title: true
+sidebar_label: Driver Entone
+---
+
+# Driver Entone
+The Entone driver for Amino Kamai and Amulet set-top boxes running on Entone middleware.

package/packages/driver-entone/src/DeviceEntone.ts

@@ -1,232 +1,232 @@
-import { DeviceBase, ScreenSaverStatus, VolumeRange } from '@24i/bigscreen-sdk/driver-base';
-import { getKeyMap } from './keymap';
-import { EntoneDeviceModelName } from './constants';
-import { IEntone, NetworkEvent } from './IEntone';
-
-// To use console error to log run-time errors occurred on Entone API.
-/* eslint-disable no-console */
-
-declare const ENTONE: IEntone;
-const emptyFunction = () => {};
-
-/**
- * Entone device class.
- */
-export class DeviceEntone extends DeviceBase {
-    /** Network status. The true for connected, false for disconnected */
-    private isNetworkStatusUp = true;
-
-    async initDevice() {
-        this.keyMap = getKeyMap();
-        this.initNetworkChangeListener();
-    }
-
-    initNetworkChangeListener() {
-        try {
-            ENTONE.network.setNetworkEvtCallback(this.onNetworkEvent);
-        } catch (e) {
-            console.error('[DeviceEntone] Failed to set network event callback', e);
-        }
-    }
-
-    onNetworkEvent = (event: NetworkEvent) => {
-        const {
-            NETWORK_LINK_STATUS_UP, NETWORK_LINK_STATUS_DOWN,
-        } = ENTONE.network;
-        switch (event.status) {
-            case NETWORK_LINK_STATUS_UP:
-                this.onNetworkStatusChange(true);
-                break;
-            case NETWORK_LINK_STATUS_DOWN:
-                this.onNetworkStatusChange(false);
-                break;
-            default: // do nothing
-        }
-    };
-
-    onNetworkStatusChange(isConnected: boolean) {
-        this.isNetworkStatusUp = isConnected;
-        this.triggerEvent('networkchange', { isConnected });
-    }
-
-    exit() {
-        // not supported on Entone STB platform
-    }
-
-    reboot() {
-        try {
-            const result = ENTONE.stb.reboot();
-            if (result === -1) throw new Error('Entone reboot returns -1');
-        } catch (e) {
-            console.error('[DeviceEntone] Failed reboot', e);
-        }
-    }
-
-    async getManufacturerName() {
-        return 'Amino';
-    }
-
-    async getPlatformName() {
-        return 'Entone';
-    }
-
-    async getPlatformVersion() {
-        return '';
-    }
-
-    async getDeviceName() {
-        const modelName = await this.getModelName();
-        const firmware = await this.getFirmware();
-        return `Amino ${modelName}, ${firmware}`;
-    }
-
-    async getModelName() {
-        try {
-            const hardwareModel = ENTONE.stb.getHardwareModel();
-            return EntoneDeviceModelName[hardwareModel] || '';
-        } catch (e) {
-            console.error('[DeviceEntone] Failed getModelName', e);
-        }
-        return '';
-    }
-
-    async getFirmware() {
-        try {
-            return ENTONE.stb.getSoftwareVersion() || '';
-        } catch (e) {
-            console.error('[DeviceEntone] Failed getFirmware', e);
-        }
-        return '';
-    }
-
-    async is4KSupported() {
-        return false;
-    }
-
-    async is8KSupported() {
-        return false;
-    }
-
-    async getUuid() {
-        try {
-            const hardwareModel = ENTONE.stb.getHardwareModel() || '';
-            const serialNumber = ENTONE.stb.getSerialNumber() || '';
-            if (hardwareModel || serialNumber) {
-                return `${hardwareModel}-${serialNumber}`;
-            }
-        } catch (e) {
-            console.error('[DeviceEntone] Failed getUuid', e);
-        }
-        return '';
-    }
-
-    async getVolume() {
-        try {
-            const { leftVolPercentage, rightVolPercentage } = ENTONE.stb.getAudioVolume();
-            const volume = Math.max(leftVolPercentage, rightVolPercentage);
-            return volume ?? VolumeRange.UNSUPPORTED;
-        } catch (e) {
-            console.error('[DeviceEntone] Failed getVolume', e);
-        }
-        return VolumeRange.UNSUPPORTED;
-    }
-
-    async setVolume(volumePercentage: number) {
-        const errorMsg = this.validateVolumeValue(volumePercentage);
-        if (errorMsg) {
-            throw new Error(errorMsg);
-        }
-        ENTONE.stb.setAudioVolume(volumePercentage, volumePercentage, emptyFunction);
-    }
-
-    async mute(mute: boolean) {
-        ENTONE.stb.mute(mute);
-    }
-
-    async isMute() {
-        try {
-            const isMuted = ENTONE.stb.getMute();
-            return !!isMuted;
-        } catch (e) {
-            console.error('[DeviceEntone] Failed isMute', e);
-        }
-        return false;
-    }
-
-    async getScreenSaver() {
-        // not supported on Entone STB platform
-        return { enabled: false };
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    async setScreenSaver(status: ScreenSaverStatus) {
-        // not supported on Entone STB platform
-    }
-
-    async setUserAgent(userAgent: string) {
-        try {
-            const status = ENTONE.browser.configUserAgent({
-                id: 0,
-                user_agent_mode: 'set',
-                user_agent: userAgent,
-            });
-            if (status !== ENTONE.status.SUCCESS) {
-                throw new Error(`Error status: ${status}`);
-            }
-            return true;
-        } catch (e) {
-            console.error('[DeviceEntone] Failed setUserAgent', e);
-        }
-        return false;
-    }
-
-    async getConnectionType() {
-        try {
-            const { CAT5, WIFI } = ENTONE.network.nic_type;
-            const config = ENTONE.network.getConfig();
-            const nicType = config.result.network[0].nic_type;
-            // NOTE: not fully verified because our STB was configured for Ethernet only
-            switch (nicType) {
-                case CAT5:
-                    return 'cable';
-                case WIFI:
-                    return 'wifi';
-                default:
-                    return 'unknown';
-            }
-        } catch (e) {
-            console.error('[DeviceEntone] Failed getConnectionType', e);
-        }
-        return 'unknown';
-    }
-
-    async isNetworkConnected() {
-        /**
-         * NOTE: used variable control instead of ENTONE.network.getLinkStatus()
-         * which is undefined. Tested on 2.9.32_build10-etv-vmx--as3
-         */
-        return this.isNetworkStatusUp;
-    }
-
-    async getLocalIP() {
-        let ipAddress;
-        try {
-            const config = ENTONE.network.getConfig();
-            ipAddress = config.result.network[0].ip_address;
-        } catch (e) {
-            console.error('[DeviceEntone] Failed getLocalIP', e);
-        }
-        return ipAddress || '';
-    }
-
-    async getMacAddress() {
-        let macAddress;
-        try {
-            const config = ENTONE.network.getConfig();
-            macAddress = config.result.network[0].mac_address;
-        } catch (e) {
-            console.error('[DeviceEntone] Failed getMacAddress', e);
-        }
-        return macAddress || '';
-    }
-}
+import { DeviceBase, ScreenSaverStatus, VolumeRange } from '@24i/bigscreen-sdk/driver-base';
+import { getKeyMap } from './keymap';
+import { EntoneDeviceModelName } from './constants';
+import { IEntone, NetworkEvent } from './IEntone';
+
+// To use console error to log run-time errors occurred on Entone API.
+/* eslint-disable no-console */
+
+declare const ENTONE: IEntone;
+const emptyFunction = () => {};
+
+/**
+ * Entone device class.
+ */
+export class DeviceEntone extends DeviceBase {
+    /** Network status. The true for connected, false for disconnected */
+    private isNetworkStatusUp = true;
+
+    async initDevice() {
+        this.keyMap = getKeyMap();
+        this.initNetworkChangeListener();
+    }
+
+    initNetworkChangeListener() {
+        try {
+            ENTONE.network.setNetworkEvtCallback(this.onNetworkEvent);
+        } catch (e) {
+            console.error('[DeviceEntone] Failed to set network event callback', e);
+        }
+    }
+
+    onNetworkEvent = (event: NetworkEvent) => {
+        const {
+            NETWORK_LINK_STATUS_UP, NETWORK_LINK_STATUS_DOWN,
+        } = ENTONE.network;
+        switch (event.status) {
+            case NETWORK_LINK_STATUS_UP:
+                this.onNetworkStatusChange(true);
+                break;
+            case NETWORK_LINK_STATUS_DOWN:
+                this.onNetworkStatusChange(false);
+                break;
+            default: // do nothing
+        }
+    };
+
+    onNetworkStatusChange(isConnected: boolean) {
+        this.isNetworkStatusUp = isConnected;
+        this.triggerEvent('networkchange', { isConnected });
+    }
+
+    exit() {
+        // not supported on Entone STB platform
+    }
+
+    reboot() {
+        try {
+            const result = ENTONE.stb.reboot();
+            if (result === -1) throw new Error('Entone reboot returns -1');
+        } catch (e) {
+            console.error('[DeviceEntone] Failed reboot', e);
+        }
+    }
+
+    async getManufacturerName() {
+        return 'Amino';
+    }
+
+    async getPlatformName() {
+        return 'Entone';
+    }
+
+    async getPlatformVersion() {
+        return '';
+    }
+
+    async getDeviceName() {
+        const modelName = await this.getModelName();
+        const firmware = await this.getFirmware();
+        return `Amino ${modelName}, ${firmware}`;
+    }
+
+    async getModelName() {
+        try {
+            const hardwareModel = ENTONE.stb.getHardwareModel();
+            return EntoneDeviceModelName[hardwareModel] || '';
+        } catch (e) {
+            console.error('[DeviceEntone] Failed getModelName', e);
+        }
+        return '';
+    }
+
+    async getFirmware() {
+        try {
+            return ENTONE.stb.getSoftwareVersion() || '';
+        } catch (e) {
+            console.error('[DeviceEntone] Failed getFirmware', e);
+        }
+        return '';
+    }
+
+    async is4KSupported() {
+        return false;
+    }
+
+    async is8KSupported() {
+        return false;
+    }
+
+    async getUuid() {
+        try {
+            const hardwareModel = ENTONE.stb.getHardwareModel() || '';
+            const serialNumber = ENTONE.stb.getSerialNumber() || '';
+            if (hardwareModel || serialNumber) {
+                return `${hardwareModel}-${serialNumber}`;
+            }
+        } catch (e) {
+            console.error('[DeviceEntone] Failed getUuid', e);
+        }
+        return '';
+    }
+
+    async getVolume() {
+        try {
+            const { leftVolPercentage, rightVolPercentage } = ENTONE.stb.getAudioVolume();
+            const volume = Math.max(leftVolPercentage, rightVolPercentage);
+            return volume ?? VolumeRange.UNSUPPORTED;
+        } catch (e) {
+            console.error('[DeviceEntone] Failed getVolume', e);
+        }
+        return VolumeRange.UNSUPPORTED;
+    }
+
+    async setVolume(volumePercentage: number) {
+        const errorMsg = this.validateVolumeValue(volumePercentage);
+        if (errorMsg) {
+            throw new Error(errorMsg);
+        }
+        ENTONE.stb.setAudioVolume(volumePercentage, volumePercentage, emptyFunction);
+    }
+
+    async mute(mute: boolean) {
+        ENTONE.stb.mute(mute);
+    }
+
+    async isMute() {
+        try {
+            const isMuted = ENTONE.stb.getMute();
+            return !!isMuted;
+        } catch (e) {
+            console.error('[DeviceEntone] Failed isMute', e);
+        }
+        return false;
+    }
+
+    async getScreenSaver() {
+        // not supported on Entone STB platform
+        return { enabled: false };
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async setScreenSaver(status: ScreenSaverStatus) {
+        // not supported on Entone STB platform
+    }
+
+    async setUserAgent(userAgent: string) {
+        try {
+            const status = ENTONE.browser.configUserAgent({
+                id: 0,
+                user_agent_mode: 'set',
+                user_agent: userAgent,
+            });
+            if (status !== ENTONE.status.SUCCESS) {
+                throw new Error(`Error status: ${status}`);
+            }
+            return true;
+        } catch (e) {
+            console.error('[DeviceEntone] Failed setUserAgent', e);
+        }
+        return false;
+    }
+
+    async getConnectionType() {
+        try {
+            const { CAT5, WIFI } = ENTONE.network.nic_type;
+            const config = ENTONE.network.getConfig();
+            const nicType = config.result.network[0].nic_type;
+            // NOTE: not fully verified because our STB was configured for Ethernet only
+            switch (nicType) {
+                case CAT5:
+                    return 'cable';
+                case WIFI:
+                    return 'wifi';
+                default:
+                    return 'unknown';
+            }
+        } catch (e) {
+            console.error('[DeviceEntone] Failed getConnectionType', e);
+        }
+        return 'unknown';
+    }
+
+    async isNetworkConnected() {
+        /**
+         * NOTE: used variable control instead of ENTONE.network.getLinkStatus()
+         * which is undefined. Tested on 2.9.32_build10-etv-vmx--as3
+         */
+        return this.isNetworkStatusUp;
+    }
+
+    async getLocalIP() {
+        let ipAddress;
+        try {
+            const config = ENTONE.network.getConfig();
+            ipAddress = config.result.network[0].ip_address;
+        } catch (e) {
+            console.error('[DeviceEntone] Failed getLocalIP', e);
+        }
+        return ipAddress || '';
+    }
+
+    async getMacAddress() {
+        let macAddress;
+        try {
+            const config = ENTONE.network.getConfig();
+            macAddress = config.result.network[0].mac_address;
+        } catch (e) {
+            console.error('[DeviceEntone] Failed getMacAddress', e);
+        }
+        return macAddress || '';
+    }
+}