@aiot-toolkit/emulator 2.0.5-widget-provider-beta.2 → 2.0.6-alpha.0

package/lib/static/proto/rtc_service.proto

@@ -1,117 +1,117 @@
-// Copyright (C) 2018 The Android Open Source Project
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-// Note that if you add/remove methods in this file you must update
-// the metrics sql as well by running ./android/scripts/gen-grpc-sql.py
-//
-// Please group deleted methods in a block including the date (MM/DD/YY)
-// it was removed. This enables us to easily keep metrics around after removal
-//
-// List of deleted methods
-// rpc iWasDeleted (03/12/12)
-// ...
-syntax = "proto3";
-
-option java_multiple_files = true;
-option java_package = "com.android.emulator.control";
-option objc_class_prefix = "AEC";
-
-package android.emulation.control;
-import "google/protobuf/empty.proto";
-
-// An RTC service lets you interact with the emulator through WebRTC
-// Note that this is currently an experimental feature, and that the
-// service definition might change without notice. Use at your own risk!
-//
-// The following endpoints are needed to establish the webrtc protocol
-// Due to limitiations in Javascript we cannot make use of bidirectional
-// endpoints See this [blog](https://grpc.io/blog/state-of-grpc-web) for
-// details.
-service Rtc {
-  // This function will generate a new identifier that the client
-  // should use for further interaction. It will initiate the
-  // JSEP protocol on the server side.
-  rpc requestRtcStream(google.protobuf.Empty) returns (RtcId) {}
-
-  // Sends the given JsepMsg to the server. The RtcId in the
-  // message should point to an active stream negotiation in
-  // progress, otherwise the message will be ignored.
-  rpc sendJsepMessage(JsepMsg) returns (google.protobuf.Empty) {}
-
-  // Reads an available jsep messages for the given client id,
-  // blocking until one becomes available. Do not use the polling version
-  // above if you opt for this one.
-  //
-  // The ice candidates for example will trickle in on this callback,
-  // as will the SDP negotation.
-  rpc receiveJsepMessages(RtcId) returns (stream JsepMsg) {}
-
-
-  // [DEPRECATED] This is only here as the go grpc webproxy used
-  // by fuchsia does not support server side streaming. This method
-  // will be removed in the future and should not be relied upon.
-  //
-  // Reads an available jsep messages for the given client id,
-  // blocking until one becomes available. Do not use the polling version
-  // above if you opt for this one.
-  //
-  // The ice candidates for example will trickle in on this callback,
-  // as will the SDP negotation.
-  rpc receiveJsepMessage(RtcId) returns (JsepMsg) {}
-}
-
-message RtcId {
-  // The unique identifier of this connection. You will have to use the
-  // same identifier when sending/receiving messages. The server will
-  // generate a guid when receiving the start message.
-  string guid = 1;
-}
-
-message JsepMsg {
-  // The unique identifier of this connection. You will have to use the
-  // same identifier when sending/receiving messages. The server will
-  // generate a guid when receiving the start message.
-  RtcId id = 1;
-  // The JSON payload. This usually can be directly handled by the
-  // Javascript library.
-  //
-  // The dictionary can contain the following properties
-  //
-  // - bye:
-  //        You can hang up now. No new message expected for you.
-  //        The server has stopped the RTC stream.
-  //
-  // - start:
-  //        An RTCConfiguration dictionary providing options to
-  //        configure the new connection. This can include the
-  //        turn configuration the serve is using. This dictionary can be
-  //        passed in directly to the
-  //        [RTCPeerConnection](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)
-  //        object.
-  //
-  // - candidate:
-  //        The WebRTC API's RTCIceCandidateInit dictionary, which
-  //        contains the information needed to fundamentally describe an
-  //        RTCIceCandidate. See
-  //        [RTCIceCandidate](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate)
-  //        and [Session
-  //        Lifetime](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API/Session_lifetime)
-  //        for more details.
-  //
-  // - sdp:
-  //        RTCSessionDescriptionInit dictionary containing the values
-  //        to that can be assigned to a
-  //        [RTCSessionDescription](https://developer.mozilla.org/en-US/docs/Web/API/RTCSessionDescription)
-  string message = 2;
-}
+// Copyright (C) 2018 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Note that if you add/remove methods in this file you must update
+// the metrics sql as well by running ./android/scripts/gen-grpc-sql.py
+//
+// Please group deleted methods in a block including the date (MM/DD/YY)
+// it was removed. This enables us to easily keep metrics around after removal
+//
+// List of deleted methods
+// rpc iWasDeleted (03/12/12)
+// ...
+syntax = "proto3";
+
+option java_multiple_files = true;
+option java_package = "com.android.emulator.control";
+option objc_class_prefix = "AEC";
+
+package android.emulation.control;
+import "google/protobuf/empty.proto";
+
+// An RTC service lets you interact with the emulator through WebRTC
+// Note that this is currently an experimental feature, and that the
+// service definition might change without notice. Use at your own risk!
+//
+// The following endpoints are needed to establish the webrtc protocol
+// Due to limitiations in Javascript we cannot make use of bidirectional
+// endpoints See this [blog](https://grpc.io/blog/state-of-grpc-web) for
+// details.
+service Rtc {
+  // This function will generate a new identifier that the client
+  // should use for further interaction. It will initiate the
+  // JSEP protocol on the server side.
+  rpc requestRtcStream(google.protobuf.Empty) returns (RtcId) {}
+
+  // Sends the given JsepMsg to the server. The RtcId in the
+  // message should point to an active stream negotiation in
+  // progress, otherwise the message will be ignored.
+  rpc sendJsepMessage(JsepMsg) returns (google.protobuf.Empty) {}
+
+  // Reads an available jsep messages for the given client id,
+  // blocking until one becomes available. Do not use the polling version
+  // above if you opt for this one.
+  //
+  // The ice candidates for example will trickle in on this callback,
+  // as will the SDP negotation.
+  rpc receiveJsepMessages(RtcId) returns (stream JsepMsg) {}
+
+
+  // [DEPRECATED] This is only here as the go grpc webproxy used
+  // by fuchsia does not support server side streaming. This method
+  // will be removed in the future and should not be relied upon.
+  //
+  // Reads an available jsep messages for the given client id,
+  // blocking until one becomes available. Do not use the polling version
+  // above if you opt for this one.
+  //
+  // The ice candidates for example will trickle in on this callback,
+  // as will the SDP negotation.
+  rpc receiveJsepMessage(RtcId) returns (JsepMsg) {}
+}
+
+message RtcId {
+  // The unique identifier of this connection. You will have to use the
+  // same identifier when sending/receiving messages. The server will
+  // generate a guid when receiving the start message.
+  string guid = 1;
+}
+
+message JsepMsg {
+  // The unique identifier of this connection. You will have to use the
+  // same identifier when sending/receiving messages. The server will
+  // generate a guid when receiving the start message.
+  RtcId id = 1;
+  // The JSON payload. This usually can be directly handled by the
+  // Javascript library.
+  //
+  // The dictionary can contain the following properties
+  //
+  // - bye:
+  //        You can hang up now. No new message expected for you.
+  //        The server has stopped the RTC stream.
+  //
+  // - start:
+  //        An RTCConfiguration dictionary providing options to
+  //        configure the new connection. This can include the
+  //        turn configuration the serve is using. This dictionary can be
+  //        passed in directly to the
+  //        [RTCPeerConnection](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)
+  //        object.
+  //
+  // - candidate:
+  //        The WebRTC API's RTCIceCandidateInit dictionary, which
+  //        contains the information needed to fundamentally describe an
+  //        RTCIceCandidate. See
+  //        [RTCIceCandidate](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidate)
+  //        and [Session
+  //        Lifetime](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API/Session_lifetime)
+  //        for more details.
+  //
+  // - sdp:
+  //        RTCSessionDescriptionInit dictionary containing the values
+  //        to that can be assigned to a
+  //        [RTCSessionDescription](https://developer.mozilla.org/en-US/docs/Web/API/RTCSessionDescription)
+  string message = 2;
+}

package/lib/static/proto/ui_controller_service.proto

@@ -0,0 +1,147 @@
+// Copyright 2020 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+option java_multiple_files = true;
+option java_package = "com.android.emulator.control";
+option objc_class_prefix = "AEC";
+
+package android.emulation.control;
+import "google/protobuf/empty.proto";
+
+service UiController {
+    // PaneEntry specifies which pane will be selected when
+    // the extended control is shown. If the extended is visible already,
+    // this method will set visibilityChangedto to false.
+    rpc showExtendedControls(PaneEntry) returns (ExtendedControlsStatus) {}
+    // this method has no effect if the extended controls are hidden.
+    // In that case, visibilityChanged will be set to false;
+    rpc closeExtendedControls(google.protobuf.Empty)
+            returns (ExtendedControlsStatus) {}
+    rpc setUiTheme(ThemingStyle) returns (google.protobuf.Empty) {}
+
+    // Returns the user configuration of the running emulator. The user
+    // configuration contains information about the user interface.
+    rpc getUserConfig(google.protobuf.Empty) returns (UserConfig) {}
+}
+
+message UserConfigEntry {
+    string key = 1;
+    string value = 2;
+}
+
+// The user configuration of the running emulator as
+// key value pairs. This contains the data you normally find
+// in emulator-user.ini
+message UserConfig {
+    repeated UserConfigEntry entries = 1;
+}
+
+message ThemingStyle {
+    enum Style {
+        LIGHT = 0;
+        DARK = 1;
+        CONTRAST = 2;
+    }
+    Style style = 1;
+}
+
+message ExtendedControlsStatus {
+    bool visibilityChanged = 1;
+}
+
+// The pixel coordinates are resolution independent, meaning the coordinates
+// are independent from the pixel grid, resulting in a graphical user
+// interface that is displayed at a consistent location, regardless of the
+// resolution of the screen.
+//
+// For technical details: https://doc.qt.io/qt-5/highdpi.html
+//
+// Some things to note:
+//
+// - You cannot move a window offscreen.
+// - There is a padding of around 10px around the frame.
+//
+// This means that moving to (0, 0) or (10, 10) will have the same result.
+// This means that anchoring might not exactly behave as requested.
+message WindowPosition {
+    // Anchor that is used to determine horizontal window placement.
+    enum HorizontalAnchor {
+        LEFT = 0;  // The x coordinate will be treated as the left edge of the
+                   // window.
+        HCENTER = 1;  // The x coordinate will be treated as the middle between
+                      // the left and right edges of the window.
+        RIGHT = 2;    // The x coordinate will be treated as the right edge of
+                      // the window.
+    }
+
+    // Anchor that is used to determine vertical window placement.
+    enum VerticalAnchor {
+        TOP = 0;      // The y coordinate will be treated as the top edge of the
+                      // window.
+        VCENTER = 1;  // The y coordinate will be treated as the middle between
+                      // the top and bottom edges of the window.
+        BOTTOM = 3;   // The y coordinate will be treated as the bottom edge of
+                      // the window.
+    }
+
+    // Corresponds to the x and y coordinate of the window geometry. The window
+    // geometry includes the window frame.
+    // See: https://doc.qt.io/qt-5/application-windows.html#window-geometry for
+    // details and pecularities on linux.
+    uint32 x = 1;
+    uint32 y = 2;
+
+    HorizontalAnchor horizontalAnchor = 3;
+    VerticalAnchor verticalAnchor = 4;
+}
+
+message PaneEntry {
+    enum PaneIndex {
+        // When specified as KEEP_CURRENT, extended controls will display the
+        // current pane.
+        // If it is the first time for extended controls to be shown, LOCATION
+        // will be used.
+        KEEP_CURRENT = 0;
+        // Referenced from
+        // external/qemu/android/android-emu/android/skin/qt/extended-window-styles.h
+        LOCATION = 1;
+        MULTIDISPLAY = 2;
+        CELLULAR = 3;
+        BATTERY = 4;
+        CAMERA = 5;
+        TELEPHONE = 6;
+        DPAD = 7;
+        TV_REMOTE = 8;
+        ROTARY = 9;
+        MICROPHONE = 10;
+        FINGER = 11;
+        VIRT_SENSORS = 12;
+        SNAPSHOT = 13;
+        BUGREPORT = 14;
+        RECORD = 15;
+        GOOGLE_PLAY = 16;
+        SETTINGS = 17;
+        HELP = 18;
+        CAR = 19;
+        CAR_ROTARY = 20;
+        SENSOR_REPLAY = 21;
+    };
+    PaneIndex index = 1;
+
+    // Set the window position to the specified coordinates if no coordinates are
+    // present in the AVD, otherwise this value will be igonred.
+    WindowPosition position = 2;
+}

package/lib/typing/Instance.js

@@ -4,9 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.IStartOrigin = void 0;
-/**
- * 如果指定了 serialPort 则必须同时指定 grpcPort
- * 否则
+/**
+ * 如果指定了 serialPort 则必须同时指定 grpcPort
+ * 否则
  */
 let IStartOrigin = exports.IStartOrigin = /*#__PURE__*/function (IStartOrigin) {
   IStartOrigin["Terminal"] = "terminal";

package/lib/typing/Vvd.d.ts

@@ -4,8 +4,7 @@ export interface IVvdResourcePaths {
     imageHome?: string;
 }
 export declare enum IVvdArchType {
-    arm = "arm",
-    arm64 = "arm64"
+    arm = "arm"
 }
 export declare enum VelaImageType {
     VELA_MIWEAR_MINISOUND_5 = "vela-miwear-minisound-5.0",
@@ -37,6 +36,7 @@ export interface EmulatorPart {
         height: string;
         x: string;
         y: string;
+        corner_radius: string;
         shape?: string;
         flavor?: string;
         density?: string;
@@ -103,7 +103,7 @@ export declare enum SDKParts {
     MODEM_SIMULATOR = "modem_simulator"
 }
 export declare enum VELAHOME {
-    SDK = ".export",
+    SDK = ".vela/sdk",
     VVD = ".vela/vvd"
 }
 export type SDKDownloadOpt = {

package/lib/typing/Vvd.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports.VelaImageType = exports.VELAHOME = exports.SDKParts = exports.IVvdArchType = void 0;
 let IVvdArchType = exports.IVvdArchType = /*#__PURE__*/function (IVvdArchType) {
   IVvdArchType["arm"] = "arm";
-  IVvdArchType["arm64"] = "arm64";
   return IVvdArchType;
 }({});
 let VelaImageType = exports.VelaImageType = /*#__PURE__*/function (VelaImageType) {
@@ -27,7 +26,7 @@ let SDKParts = exports.SDKParts = /*#__PURE__*/function (SDKParts) {
   return SDKParts;
 }({});
 let VELAHOME = exports.VELAHOME = /*#__PURE__*/function (VELAHOME) {
-  VELAHOME["SDK"] = ".export";
+  VELAHOME["SDK"] = ".vela/sdk";
   VELAHOME["VVD"] = ".vela/vvd";
   return VELAHOME;
 }({});

package/lib/utils/file.d.ts

@@ -0,0 +1,8 @@
+/**
+ *  @param mode Optional modifiers that specify the behavior of the copy operation. It is possible to create a mask consisting of the bitwise OR of two or more values (e.g. fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE)
+ */
+export declare function copyDir(source: string, target: string, mode?: number): Promise<void>;
+/**
+ *  @param mode Optional modifiers that specify the behavior of the copy operation. It is possible to create a mask consisting of the bitwise OR of two or more values (e.g. fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE)
+ */
+export declare function copyDirSync(source: string, target: string, mode?: number): void;

package/lib/utils/file.js

@@ -1 +1,48 @@
-"use strict";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.copyDir = copyDir;
+exports.copyDirSync = copyDirSync;
+var _path = _interopRequireDefault(require("path"));
+var _promises = _interopRequireDefault(require("fs/promises"));
+var _fs = _interopRequireDefault(require("fs"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ *  @param mode Optional modifiers that specify the behavior of the copy operation. It is possible to create a mask consisting of the bitwise OR of two or more values (e.g. fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE)
+ */
+async function copyDir(source, target, mode) {
+  const entries = await _promises.default.readdir(source, {
+    withFileTypes: true
+  });
+  await _promises.default.mkdir(target, {
+    recursive: true
+  });
+  await Promise.all(entries.map(entry => {
+    const srcPath = _path.default.join(source, entry.name);
+    const destPath = _path.default.join(target, entry.name);
+    return entry.isDirectory() ? copyDir(srcPath, destPath, mode) : _promises.default.copyFile(srcPath, destPath, mode);
+  }));
+}
+
+/**
+ *  @param mode Optional modifiers that specify the behavior of the copy operation. It is possible to create a mask consisting of the bitwise OR of two or more values (e.g. fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE)
+ */
+function copyDirSync(source, target, mode) {
+  _fs.default.mkdirSync(target, {
+    recursive: true
+  });
+  const entries = _fs.default.readdirSync(source, {
+    withFileTypes: true
+  });
+  for (const entry of entries) {
+    const srcPath = _path.default.join(source, entry.name);
+    const destPath = _path.default.join(target, entry.name);
+    if (entry.isDirectory()) {
+      copyDirSync(srcPath, destPath, mode);
+    } else {
+      _fs.default.copyFileSync(srcPath, destPath, mode);
+    }
+  }
+}

package/lib/utils/index.js

@@ -24,9 +24,9 @@ const cpuArch = {
   x86_64: 'x86_64'
 };
 
-/** 获取mac电脑的CPU架构
- * node 15.0.0之后，m1芯片的mac的os.arch()才是arm64，在这之前都是x86
- * 所以15.0.0之前无法通过os.arch()区分，也无法通过execSync('uname -m')区分
+/** 获取mac电脑的CPU架构
+ * node 15.0.0之后，m1芯片的mac的os.arch()才是arm64，在这之前都是x86
+ * 所以15.0.0之前无法通过os.arch()区分，也无法通过execSync('uname -m')区分
  */
 function getSystemArch() {
   const platform = _os.default.platform();
@@ -56,8 +56,8 @@ function killProcessByPid(pid) {
   }
 }
 
-/**
- * 根据命令杀死进程
+/**
+ * 根据命令杀死进程
  */
 async function killProcessByCmd(cmd) {
   if (!cmd) return;
@@ -76,11 +76,11 @@ async function sleep(time) {
   return new Promise(resolve => setTimeout(resolve, time));
 }
 
-/**
- * 重复执行某个任务直到成功，或者超过最大次数
- * @param task 任务，需要返回 bool 值表示是否执行成功
- * @param {Number=} maxCount 最大重试次数
- * @param {number=} duration 每次重试的间隔
+/**
+ * 重复执行某个任务直到成功，或者超过最大次数
+ * @param task 任务，需要返回 bool 值表示是否执行成功
+ * @param {Number=} maxCount 最大重试次数
+ * @param {number=} duration 每次重试的间隔
  */
 async function tryRun(task) {
   let maxCount = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 5;
@@ -90,11 +90,11 @@ async function tryRun(task) {
   return Boolean(await task()) || (await delayRun(() => tryRun(task, maxCount, duration, currentCount + 1), duration));
 }
 
-/**
- * 延迟执行某个任务
- * @param task
- * @param duration
- * @returns
+/**
+ * 延迟执行某个任务
+ * @param task
+ * @param duration
+ * @returns
  */
 async function delayRun(task) {
   let duration = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 1000;
@@ -105,10 +105,10 @@ async function delayRun(task) {
   });
 }
 
-/**
- * 为avdPort寻找一个不被占用的端口
- * 端口号必须是偶数且在5555和5585之间
- * @returns {number}
+/**
+ * 为avdPort寻找一个不被占用的端口
+ * 端口号必须是偶数且在5555和5585之间
+ * @returns {number}
  */
 async function getEvenPort() {
   const startPort = 5556;

package/lib/vvd/grpc/index.d.ts

@@ -1,27 +1,36 @@
 import { Readable } from 'stream';
-import { MouseEvent } from './types/MouseEvent';
-import { GrpcKeyboardEvent } from './types/KeyEvent';
 import { GrpcClient } from './types/GrpcClient';
 import { EmulatorConfig } from '../../emulatorutil/running';
 import { Metadata } from '@grpc/grpc-js';
-export default class GrpcEmulator {
+import { ImageFormat, KeyboardEvent, LogMessage, MouseEvent, SensorValue } from './types/proto-types';
+import { UiControllerClient } from './types/UiControllerClient';
+import { ConnectivityState } from '@grpc/grpc-js/build/src/connectivity-state';
+export declare class GrpcEmulator {
     eConf: EmulatorConfig;
-    protoPath: string;
+    protoPath: string[];
     client: GrpcClient;
+    uiClient: UiControllerClient;
     connected: boolean;
     token: string;
     authMate: Metadata;
     deadline: Date;
     controller: any;
     screenshotStream?: Readable;
-    constructor(eConf: EmulatorConfig, protoPath: string);
+    logcatStream?: Readable;
+    state: ConnectivityState;
+    constructor(eConf: EmulatorConfig, protoPath: string[]);
     close(): void;
     getAuthMeta(): Metadata;
     waitForReady(): Promise<boolean>;
-    startStream(onStreamScreenshot: (buffer: Buffer) => void): Promise<void>;
+    streamScreenshot(imageFormat?: ImageFormat): Promise<Readable>;
     getScreenshot(): Promise<Buffer>;
     getStatus(): Promise<unknown>;
     sendMouse(message: MouseEvent): void;
-    sendKey(data: GrpcKeyboardEvent): void;
+    sendKey(data: KeyboardEvent): void;
+    showExtendedControls(paneIndex?: number): Promise<unknown>;
+    closeExtendedControls(): Promise<unknown>;
+    setSensor(sensorValue: SensorValue): Promise<unknown>;
+    getSensor(sensorValue: SensorValue): Promise<unknown>;
+    streamLogcat(params?: LogMessage): Promise<Readable>;
 }
 export declare function createGrpcClient(eConf: EmulatorConfig): GrpcEmulator;