Merge pull request #61 from GoogleChromeLabs/byron/thermal

Introduce getThermalInfo

Author: BaiiYuan

src/README.md

@@ -461,6 +461,18 @@ Source:
 | length_seconds | number | Length of time to run the routine for.                                                    |
 | file_size_mb   | number | Test file size, in mega bytes, to test with DiskRead routine. Maximum file size is 10 GB. |
 
+### ThermalSensorInfo
+| Property Name      | Type   | Description                                                             |
+| ------------------ | ------ | ----------------------------------------------------------------------- |
+| name               | string | Name of the thermal sensor.                                             |
+| temperatureCelsius | number | Temperature detected by the thermal sensor in celsius.                  |
+| source             | string | Where the thermal sensor is detected from. ("ec", "sysFs" or "unknown") |
+
+### ThermalInfo
+| Property Name  | Type                       | Description                                                            |
+| -------------- | -------------------------- | ---------------------------------------------------------------------- |
+| thermalSensors | Array\<ThermalSensorInfo\> | An array containing all the information retrieved for thermal sensors. |
+
 ## Functions
 ### dpsl.telemetry.*
 | Function Name                   | Definition                                | Permission needed to access                                          | Released in `dpsl` version |
@@ -479,6 +491,7 @@ Source:
 | getMarketingInfo                | () => Promise\<MarketingInfo\>            | `os.telemetry`                                                       | 1.3.4                      |
 | getUsbBusInfo                   | () => Promise\<UsbDevicesInfo\>           | `os.telemetry`, `os.attached_device_info`                            | 1.3.5                      |
 | getDisplayInfo                  | () => Promise\<DisplayInfo\>              | `os.telemetry`                                                       | 1.3.6                      |
+| getThermalInfo                  | () => Promise\<ThermalInfo\>              | `os.telemetry`                                                       | 1.4.1                      |
 
 ### dpsl.diagnostics.*
 | Function Name        | Definition                      | Permission needed to access | Released in `dpsl` version |

src/__tests__/dpsl.test.js

@@ -476,6 +476,85 @@ describe('dpsl.telemetry tests', () => {
               done();
             });
       });
+
+  test('dpsl.telemetry.getThermalInfo() returns correct data',
+      (done) => {
+        // Mock the global chrome object.
+        const expectedThermalInfo = {
+          'thermalSensors': [
+            {
+              'name': 'TSR0',
+              'source': 'sysFs',
+              'temperatureCelsius': 39.8,
+            },
+            {
+              'name': 'x86_pkg_temp',
+              'source': 'sysFs',
+              'temperatureCelsius': 51,
+            },
+            {
+              'name': 'TSR3',
+              'source': 'sysFs',
+              'temperatureCelsius': 35.8,
+            },
+            {
+              'name': 'TSR1',
+              'source': 'sysFs',
+              'temperatureCelsius': 36.8,
+            },
+            {
+              'name': 'INT3400 Thermal',
+              'source': 'sysFs',
+              'temperatureCelsius': 20,
+            },
+            {
+              'name': 'TCPU',
+              'source': 'sysFs',
+              'temperatureCelsius': 52,
+            },
+            {
+              'name': 'TSR2',
+              'source': 'sysFs',
+              'temperatureCelsius': 39.8,
+            },
+            {
+              'name': 'Charger',
+              'source': 'ec',
+              'temperatureCelsius': 39.85000000000002,
+            },
+            {
+              'name': 'PP3300 Regulator',
+              'source': 'ec',
+              'temperatureCelsius': 36.85000000000002,
+            },
+            {
+              'name': 'DDR and SOC',
+              'source': 'ec',
+              'temperatureCelsius': 39.85000000000002,
+            },
+            {
+              'name': 'Fan',
+              'source': 'ec',
+              'temperatureCelsius': 35.85000000000002,
+            },
+          ],
+        };
+        const chrome = {
+          os: {
+            telemetry: {
+              getThermalInfo: () => expectedThermalInfo,
+            },
+          },
+        };
+        global.chrome = chrome;
+
+        dpsl.telemetry.getThermalInfo()
+            .then((thermalInfo) => {
+              expect(thermalInfo)
+                  .toEqual(expectedThermalInfo);
+              done();
+            });
+      });
 });
 
 

src/telemetry_requester.js

@@ -240,6 +240,21 @@ class DPSLTelemetryRequester {
 
     return chrome.os.telemetry.getDisplayInfo();
   }
+
+  /**
+   * Requests Thermal information.
+   * @return { !Promise<!dpsl.ThermalInfo> }
+   * @public
+   */
+  async getThermalInfo() {
+    const functionName = 'getThermalInfo';
+    if (!isSupported(functionName)) {
+      throw new MethodNotFoundError(API_NAME, functionName,
+          /* chromeVersion */ 127);
+    }
+
+    return chrome.os.telemetry.getThermalInfo();
+  }
 }
 
 module.exports = {

src/types.js

@@ -316,6 +316,18 @@ dpsl.UsbBusInfo;
  */
 dpsl.DisplayInfo;
 
+/**
+ * Response message containing Thermal Info
+ * @typedef {{
+ *   thermalSensors: Array<{
+ *     name: string,
+ *     temperatureCelsius: number,
+ *     source: string,
+ *   }>,
+ * }}
+ */
+dpsl.ThermalInfo;
+
 ///////////////////// dpsl.diagnostics.* type definitions //////////////////////
 
 /**