@24i/bigscreen-sdk 0.9.9-alpha.2147

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

@@ -0,0 +1,460 @@
+/**
+ * Entone JavaScript API
+ *
+ * Entone JavaScript API type is not fully described here, there are picked
+ * only necessary parts for our usage.
+ *
+ * Type definition based on "EntoneJS_Doc_14.8.69.1_build4-etv" documentation.
+ */
+export interface IEntone {
+    /**
+     * Status constants. String values are in full name for compatibility.
+     */
+    status: Status,
+    /**
+     * Functions/Constants for Input Handling.
+     */
+    input: Input,
+    /**
+     * Functions for network configuration.
+     */
+    network: Network,
+    /**
+     * Functions for get/set general STB status.
+     */
+    stb: Stb,
+    /**
+     * Functions for browser control.
+     */
+    browser: Browser,
+}
+
+/**
+ * Status constants. String values are in full name for compatibility.
+ */
+interface Status {
+    /** General failure */
+    readonly ERROR: string,
+    /** Function returned successfully */
+    readonly SUCCESS: string,
+    /** Invalid Argument (EINVAL) */
+    readonly INVALID_ARGUMENT: string,
+}
+
+/**
+ * Functions/Constants for Input Handling.
+ */
+interface Input {
+    /** 0 button on both keyboard and remote control */
+    readonly KEY_0: number,
+    /** 1 button on both keyboard and remote control */
+    readonly KEY_1: number,
+    /** 2 button on both keyboard and remote control */
+    readonly KEY_2: number,
+    /** 3 button on both keyboard and remote control */
+    readonly KEY_3: number,
+    /** 4 button on both keyboard and remote control */
+    readonly KEY_4: number,
+    /** 5 button on both keyboard and remote control */
+    readonly KEY_5: number,
+    /** 6 button on both keyboard and remote control */
+    readonly KEY_6: number,
+    /** 7 button on both keyboard and remote control */
+    readonly KEY_7: number,
+    /** 8 button on both keyboard and remote control */
+    readonly KEY_8: number,
+    /** 9 button on both keyboard and remote control */
+    readonly KEY_9: number,
+    /** Backspace button on keyboard and Back button on remote control */
+    readonly KEY_BACK: number,
+    /** Blue button on remote control */
+    readonly KEY_BLUE: number,
+    /** Channel Down button on remote control */
+    readonly KEY_CHANNELDOWN: number,
+    /** Channel Up button on remote control */
+    readonly KEY_CHANNELUP: number,
+    /** CC (Closed Caption) button on remote control */
+    readonly KEY_CLOSED_CAPTION: number,
+    /** Down button on both keyboard and remote control */
+    readonly KEY_DOWN: number,
+    /** Enter button on keyboard and OK button on remote control */
+    readonly KEY_ENTER: number,
+    /** Esc button on keyboard and Exit button on remote control */
+    readonly KEY_EXIT: number,
+    /** Fast Forward button on remote control */
+    readonly KEY_FASTFORWARD: number,
+    /** Favorites button on remote control */
+    readonly KEY_FAVORITES: number,
+    /** Green button on remote control */
+    readonly KEY_GREEN: number,
+    /** Guide button on remote control */
+    readonly KEY_GUIDE: number,
+    /** Home button on remote control */
+    readonly KEY_HOME: number,
+    /** Info button on remote control */
+    readonly KEY_INFO: number,
+    /** Input button on remote control */
+    readonly KEY_INPUT: number,
+    /** Lang button on remote control */
+    readonly KEY_LANG: number,
+    /** Last button on remote control */
+    readonly KEY_LAST: number,
+    /** Left button on both keyboard and remote control */
+    readonly KEY_LEFT: number,
+    /** List button on remote control */
+    readonly KEY_LIST: number,
+    /** Menu button on remote control */
+    readonly KEY_MENU: number,
+    /** Music button on remote control */
+    readonly KEY_MUSIC: number,
+    /** Mute button on remote control */
+    readonly KEY_MUTE: number,
+    /** Next Chapter button on remote control */
+    readonly KEY_NEXTCHAPTER: number
+    /** Back button on remote control when running Open IPTV Forum (OIPF) window.
+     * Supported by Opera SDK4. */
+    readonly KEY_OIPF_BACK: number,
+    /** Options button on remote control */
+    readonly KEY_OPTIONS: number,
+    /** Page Down button on remote control */
+    readonly KEY_PAGE_DOWN: number,
+    /** Page Up button on remote control */
+    readonly KEY_PAGE_UP: number,
+    /** Pause button on remote control */
+    readonly KEY_PAUSE: number,
+    /** PIP ON OFF button on remote control */
+    readonly KEY_PIP_ON_OFF: number,
+    /** Play button on remote control */
+    readonly KEY_PLAY: number,
+    /** PlayPause button on remote control */
+    readonly KEY_PLAYPAUSE: number,
+    /** Power button on remote control */
+    readonly KEY_POWER: number,
+    /** Previous Chapter button on remote control */
+    readonly KEY_PREVIOUSCHAPTER: number,
+    /** PVR button on remote control */
+    readonly KEY_PVR: number,
+    /** Radio button on remote control */
+    readonly KEY_RADIO: number,
+    /** Record button on remote control */
+    readonly KEY_RECORD: number,
+    /** Red button on remote control */
+    readonly KEY_RED: number,
+    /** Rewind button on remote control */
+    readonly KEY_REWIND: number,
+    /** Right button on both keyboard and remote control */
+    readonly KEY_RIGHT: number,
+    /** Search button on remote control */
+    readonly KEY_SEARCH: number,
+    /** Stop button on remote control */
+    readonly KEY_STOP: number,
+    /** Subtitle button on remote control */
+    readonly KEY_SUBTITLE: number,
+    /** SUB/CC button on remote control */
+    readonly KEY_SUBTITLE_CC: number,
+    /** TT (Teletext) button on remote control */
+    readonly KEY_TELETEXT: number,
+    /** TV button on remote control */
+    readonly KEY_TV: number,
+    /** Up button on both keyboard and remote control */
+    readonly KEY_UP: number,
+    /** VOD button on remote control */
+    readonly KEY_VOD: number,
+    /** Volume Down button on remote control */
+    readonly KEY_VOLUMEDOWN: number,
+    /** Volume Up button on remote control */
+    readonly KEY_VOLUMEUP: number,
+    /** Yellow button on remote control */
+    readonly KEY_YELLOW: number,
+}
+
+/**
+ * Functions for network configuration.
+ */
+interface Network {
+    /** Link down */
+    readonly LINK_DOWN: number,
+    /** Link up */
+    readonly LINK_UP: number,
+    /** Network interface changed */
+    readonly NETWORK_INTERFACE_CHANGED: number,
+    /** Network Ready */
+    readonly NETWORK_READY: number,
+    /** Network Link Status Up */
+    readonly NETWORK_LINK_STATUS_UP: number,
+    /** Network Link Status Down */
+    readonly NETWORK_LINK_STATUS_DOWN: number,
+    /** Network Link Status Ethernet Up */
+    readonly NETWORK_LINK_STATUS_ETH_UP: number,
+    /** Network Link Status Ethernet Down */
+    readonly NETWORK_LINK_STATUS_ETH_DOWN: number,
+    /** Event received when ping() is succeed */
+    readonly NETWORK_PING_RESULT_UPDATED: number,
+    /** Event received when ping() is failed */
+    readonly NETWORK_PING_FAILED: number,
+    /** STB IP changed */
+    readonly NETWORK_IP_CHANGED: number,
+    /** Network Interface Card (NIC) Type */
+    nic_type: {
+        /** CAT5 */
+        readonly CAT5: number,
+        /** HomePNA */
+        readonly HPNA: number,
+        /** MoCA */
+        readonly MOCA: number,
+        /** VIF */
+        readonly VIF: number,
+        /** WiFi */
+        readonly WIFI: number
+    },
+    /**
+     * Register network event callback function.
+     * Only one callback function can be registered. Pass `null` as callback to unregister.
+     * @param callback Callback function.
+     * @param param An object to be passed as parameter when `callback()` is invoked.
+     */
+    setNetworkEvtCallback(callback: INetworkCallback, param?: any): void,
+    /**
+     * Get the Network Configuration
+     * @param key - Optional, one key from: auto_cfg_flags, current_active_wan,
+     * hostname, dns_1st, dns_2nd, gateway, ntp_server, ntp_last_contacted,
+     * dhcp_last_contacted, acs_last_contacted, num_of_nic, network, wifi_setting,
+     * ip_address, mac_address, netmask
+     * (ip_address, mac_address, netmask return the setting of active WAN only)
+     * @returns Complete object if no key is passed. OR object with pair `{ key: value }`
+     * for passed key.
+     *
+     * Example 1. - if no key, return `result` format is
+     * ```
+     * {
+     *    auto_cfg_flags: 1,
+     *    current_active_wan: "eth0",
+     *    ....
+     * }
+     * ```
+     * Example 2. - if key is "ip_address", return `result` format is
+     * ```
+     * {
+     *   "ip_address":"10.1.28.61"
+     * }
+     * ```
+     */
+    getConfig(): NetworkConfigWithResult<NetworkConfig>,
+    getConfig(key: 'auto_cfg_flags'): NetworkConfigWithResult<{ auto_cfg_flags: 0 | 1 }>
+    getConfig(key: 'current_active_wan'): NetworkConfigWithResult<{ current_active_wan: string }>
+    getConfig(key: 'hostname'): NetworkConfigWithResult<{ hostname: string }>
+    getConfig(key: 'dns_1st'): NetworkConfigWithResult<{ dns_1st: string }>
+    getConfig(key: 'dns_2nd'): NetworkConfigWithResult<{ dns_2nd: string }>
+    getConfig(key: 'gateway'): NetworkConfigWithResult<{ gateway: string }>
+    getConfig(key: 'ntp_server'): NetworkConfigWithResult<{ ntp_server: string }>
+    getConfig(key: 'ntp_last_contacted'): NetworkConfigWithResult<{ ntp_last_contacted: number }>
+    getConfig(key: 'dhcp_last_contacted'): NetworkConfigWithResult<{ dhcp_last_contacted: number }>
+    getConfig(key: 'acs_last_contacted'): NetworkConfigWithResult<{ acs_last_contacted: number }>
+    getConfig(key: 'num_of_nic'): NetworkConfigWithResult<{ num_of_nic: number }>
+    getConfig(key: 'network'): NetworkConfigWithResult<{ network: NetworkInterfaceCard[] }>
+    getConfig(key: 'wifi_setting'): NetworkConfigWithResult<{ wifi_setting: WifiSetting }>
+    getConfig(key: 'ip_address'): NetworkConfigWithResult<{ ip_address: string }>
+    getConfig(key: 'mac_address'): NetworkConfigWithResult<{ mac_address: string }>
+    getConfig(key: 'netmask'): NetworkConfigWithResult<{ netmask: string }>
+    /**
+     * Get current network link status
+     */
+    getLinkStatus(): LinkStatusResponse,
+}
+
+interface NetworkConfigWithResult<Result> {
+    /**
+     * Status, one of:
+     * - ENTONE.status.SUCCESS
+     * - ENTONE.status.INVALID_ARGUMENT
+     * - ENTONE.status.ERROR
+     */
+    status: string,
+    /** Network Configuration object */
+    result: Result,
+}
+
+interface NetworkConfig {
+    /** 1: DHCP connect, 0: Static connect */
+    auto_cfg_flags: 0 | 1,
+    /** Name of the active WAN NIC, e.g. "eth0" */
+    current_active_wan: string,
+    /** Host Name, e.g. "26-20812001" */
+    hostname: string,
+    /** First DNS IP Address, e.g. "192.168.1.22" */
+    dns_1st: string,
+    /** Second DNS IP Address, e.g. "192.168.1.23" */
+    dns_2nd: string,
+    /**  Gateway IP Address, e.g. "10.1.28.1" */
+    gateway: string,
+    /** NTP Server IP Address, e.g. "255.255.255.255" */
+    ntp_server: string,
+    /** NTP Last Contacted Time, e.g. 1358399210 */
+    ntp_last_contacted: number,
+    /** DHCP Last Contacted Time, e.g. 1358464754 */
+    dhcp_last_contacted: number,
+    /** ACS Last Contacted Time, e.g. 1358421621 */
+    acs_last_contacted: number,
+    /**  Number of NIC, e.g. 2 */
+    num_of_nic: number,
+    /** Array of Network Interface Cards */
+    network: NetworkInterfaceCard[],
+    /** Wifi setting */
+    wifi_setting: WifiSetting,
+}
+
+interface NetworkInterfaceCard {
+    /** NIC Name, e.g. "eth0" */
+    nic_name: string,
+    /** 1: cat5, 2: hpna, 4: wifi, 8: moca, 16: vif, e.g. 1 */
+    nic_type: number,
+    /** IP Address, e.g. "10.1.28.61" */
+    ip_address: string,
+    /** MAC Address, e.g. "00:03:e6:3f:83:60" */
+    mac_address: string,
+    /** NetMask, e.g. "255.255.255.0" */
+    netmask: string,
+}
+
+interface WifiSetting {
+    /** SSID, e.g. "acs-production" */
+    ssid: string,
+    /** Passphrase, e.g. "acs54321" */
+    passphrase: string,
+    /** Authentication type, e.g. "wpa2-aes" */
+    auth: string,
+    /** Key Index: 1-4, e.g. 1 */
+    key_index: number,
+}
+
+interface LinkStatusResponse {
+    result: {
+        /** Name of the active WAN NIC, e.g. "eth0" */
+        current_active_wan: string,
+    },
+    /**
+     * Network link status, one of:
+     * - ENTONE.network.LINK_DOWN
+     * - ENTONE.network.LINK_UP
+     */
+    link_status: number,
+}
+
+export interface INetworkCallback {
+    /**
+     * @param event Event object
+     * @param param An object passed as the second param in setNetworkEvtCallback()
+     */
+    (event: NetworkEvent, param?: any): void;
+}
+
+export interface NetworkEvent {
+    /**
+     * Event status, can be one of the following:
+     * - ENTONE.network.NETWORK_INTERFACE_CHANGED
+     * - ENTONE.network.NETWORK_READY
+     * - ENTONE.network.NETWORK_LINK_STATUS_UP
+     * - ENTONE.network.NETWORK_LINK_STATUS_DOWN
+     * - ENTONE.network.NETWORK_LINK_STATUS_ETH_UP
+     * - ENTONE.network.NETWORK_LINK_STATUS_ETH_DOWN
+     * - ENTONE.network.NETWORK_PING_RESULT_UPDATED
+     * - ENTONE.network.NETWORK_PING_FAILED
+     * - ENTONE.network.NETWORK_IP_CHANGED
+     */
+    status: number,
+}
+
+/**
+ * Functions for get/set general STB status.
+ */
+interface Stb {
+    /**
+     * Reboot STB
+     * @return Number -1 in case of error
+     */
+    reboot(): number,
+    /**
+     * Return hardware model of STB as a integer. e.g. 15 for Amulet2 F1
+     */
+    getHardwareModel(): number,
+    /**
+     * Return serial number of STB as a string
+     */
+    getSerialNumber(): string,
+    /**
+     * Return software version of STB as a string.
+     */
+    getSoftwareVersion(): string,
+    /**
+     * Get Audio Volume.
+     */
+    getAudioVolume(): {
+        /**
+         * The one of:
+         * - ENTONE.status.SUCCESS
+         * - ENTONE.status.ERROR
+         */
+        status_code: string,
+        /**
+         * Left volume percentage (0-100)
+         */
+        leftVolPercentage: number,
+        /**
+         * Right volume percentage (0-100)
+         */
+        rightVolPercentage: number,
+    }
+    /**
+     * Set Audio Volume.
+     * @param leftVolPercentage Left volume percentage (0-100)
+     * @param rightVolPercentage Right volume percentage (0-100)
+     * @param callback Callback function. Callback provided means asynchronous call,
+     * synchronous otherwise. Format of callback function: `callback({String} status)`
+     * @returns Status, one of:
+     * - ENTONE.status.SUCCESS
+     * - ENTONE.status.ERROR
+     * - ENTONE.status.INVALID_ARGUMENT
+     */
+    setAudioVolume(
+        leftVolPercentage: number, rightVolPercentage: number, callback?: (status: string) => void
+    ): string,
+    /**
+     * Get the current mute status.
+     */
+    getMute(): boolean,
+    /**
+     * Mute the audio.
+     * @param isMute Pass `true` to mute or `false` to unmute
+     * @return Status, one of:
+     * - ENTONE.status.SUCCESS
+     * - ENTONE.status.ERROR
+     */
+    mute(isMute: boolean): string,
+}
+
+/**
+ * Modes for user agent configuration.
+ */
+export type UserAgentMode = 'set' | 'append' | 'reset' | 'custom';
+
+/**
+ * Functions for browser control.
+ */
+interface Browser {
+    /**
+     * Config User Agent
+     * @param options Options object.
+     * Ex. `{ id: 0, user_agent_mode: "set", user_agent: "entone custom browser" }`
+     * @param options.id Tab ID.
+     * @param options.user_agent_mode One of string: "set" | "append" | "reset" | "custom".
+     * @param options.user_agent User agent string returned from browser.
+     * @return Status, one of:
+     * - ENTONE.status.SUCCESS
+     * - ENTONE.status.ERROR
+     */
+    configUserAgent(options: {
+        id: number,
+        user_agent_mode: UserAgentMode,
+        user_agent: string,
+    }): string,
+}

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

@@ -0,0 +1,73 @@
+/* eslint-disable sonarjs/no-duplicate-string */
+/**
+ * Map of hardware model of STB as a integer to model name
+ */
+export const EntoneDeviceModelName: Record<number, string> = {
+    1: 'Hydra 2',
+    2: 'HydraHD',
+    3: 'AmuletHD',
+    4: 'MagiHD',
+    5: 'Janus',
+    6: 'Amulight',
+    7: 'AmuletD',
+    8: 'AmuletD',
+    9: 'HydraHD',
+    10: 'Amulet 2',
+    11: 'Amulet 2',
+    12: 'Janus 2',
+    13: 'Janus 2',
+    14: 'HydraHD',
+    15: 'Amulet 2',
+    16: 'Amulet 2',
+    17: 'HydraHD',
+    18: 'Kamai',
+    19: 'Kamai',
+    20: 'Amulet G1',
+    21: 'Amulet G1',
+    22: 'Amulet G1',
+    23: 'Amulet G1',
+    24: 'Magi',
+    25: 'Kamai 400v2',
+    26: 'Kamai 500',
+    27: 'Amulet 500',
+    28: 'Magi 450',
+    29: 'Magi 400',
+    30: 'Magi 410',
+    31: 'Kamai 450',
+    32: 'Amulet 450m',
+    33: 'KamaiX',
+    34: 'Aria 500c',
+    35: 'Aria 500i',
+    36: 'Aria 500t',
+    37: 'XTV125',
+    38: 'XTV115',
+    39: 'Agora 550',
+    40: 'Aria 500i',
+    41: 'Amulet 600',
+    42: 'Kamai 600',
+    43: 'Kamai 500U',
+    44: 'Kamai 500Z',
+    45: 'Aria 550c',
+    48: 'Aria 500c',
+    49: 'Kamai 500X',
+    50: 'ZXV10_B700V3',
+    51: 'ZXV10_B700V3_DVR',
+    52: 'ZXV10_B703V3',
+    53: 'ZXV10_B703V3_DVR',
+    54: 'Kamai 650',
+    55: 'Kamai 650',
+    56: 'Kamai 650',
+    57: 'Amulet 650',
+    58: 'Amulet 650',
+    59: 'Amulet 650',
+    60: 'Amulet 650',
+    61: 'A160',
+    62: 'Aria 600',
+    63: 'Aria 600',
+    64: 'GX_PC680EK',
+    65: 'Aria 600',
+    66: 'Turksat',
+    67: 'Amulet 500',
+    70: 'PCCW6950',
+    71: 'PCCW6845',
+} as const;

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

@@ -0,0 +1 @@
+export { DeviceEntone } from './DeviceEntone';

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

@@ -0,0 +1,56 @@
+import * as KeyMap from '@24i/bigscreen-sdk/driver-base/keymap';
+import { IEntone } from './IEntone';
+
+declare const ENTONE: IEntone;
+
+export function getKeyMap() {
+    const EntoneInput = ENTONE.input;
+    KeyMap.overrideValues({
+        LEFT: { keyCode: EntoneInput.KEY_LEFT },
+        RIGHT: { keyCode: EntoneInput.KEY_RIGHT },
+        UP: { keyCode: EntoneInput.KEY_UP },
+        DOWN: { keyCode: EntoneInput.KEY_DOWN },
+        BACK: { keyCode: EntoneInput.KEY_BACK },
+        ENTER: { keyCode: EntoneInput.KEY_ENTER },
+
+        PLAY: { keyCode: EntoneInput.KEY_PLAY },
+        PAUSE: { keyCode: EntoneInput.KEY_PAUSE },
+        PLAYPAUSE: { keyCode: EntoneInput.KEY_PLAYPAUSE },
+        STOP: { keyCode: EntoneInput.KEY_STOP },
+        FF: { keyCode: EntoneInput.KEY_FASTFORWARD },
+        REW: { keyCode: EntoneInput.KEY_REWIND },
+        REC: { keyCode: EntoneInput.KEY_RECORD },
+
+        RED: { keyCode: EntoneInput.KEY_RED },
+        GREEN: { keyCode: EntoneInput.KEY_GREEN },
+        YELLOW: { keyCode: EntoneInput.KEY_YELLOW },
+        BLUE: { keyCode: EntoneInput.KEY_BLUE },
+
+        NUM_0: { keyCode: EntoneInput.KEY_0 },
+        NUM_1: { keyCode: EntoneInput.KEY_1 },
+        NUM_2: { keyCode: EntoneInput.KEY_2 },
+        NUM_3: { keyCode: EntoneInput.KEY_3 },
+        NUM_4: { keyCode: EntoneInput.KEY_4 },
+        NUM_5: { keyCode: EntoneInput.KEY_5 },
+        NUM_6: { keyCode: EntoneInput.KEY_6 },
+        NUM_7: { keyCode: EntoneInput.KEY_7 },
+        NUM_8: { keyCode: EntoneInput.KEY_8 },
+        NUM_9: { keyCode: EntoneInput.KEY_9 },
+
+        HOME: { keyCode: EntoneInput.KEY_HOME },
+        END: { keyCode: EntoneInput.KEY_LAST },
+        CHANNEL_UP: { keyCode: EntoneInput.KEY_CHANNELUP },
+        CHANNEL_DOWN: { keyCode: EntoneInput.KEY_CHANNELDOWN },
+        CHANNEL_LIST: { keyCode: EntoneInput.KEY_LIST },
+        CHANNEL_FAVOURITE: { keyCode: EntoneInput.KEY_FAVORITES },
+        VOL_UP: { keyCode: EntoneInput.KEY_VOLUMEUP },
+        VOL_DOWN: { keyCode: EntoneInput.KEY_VOLUMEDOWN },
+        MUTE: { keyCode: EntoneInput.KEY_MUTE },
+        TXT: { keyCode: EntoneInput.KEY_TELETEXT },
+        TOOLS: { keyCode: EntoneInput.KEY_OPTIONS },
+        EXIT: { keyCode: EntoneInput.KEY_EXIT },
+        INFO: { keyCode: EntoneInput.KEY_INFO },
+        GUIDE: { keyCode: EntoneInput.KEY_GUIDE },
+    });
+    return KeyMap.generateKeyCodeKeyMap();
+}