systeminformation 5.18.14 → 5.19.0

package/README.md

@@ -31,11 +31,15 @@
 ## The Systeminformation Project
 This is amazing. Started as a small project just for myself, it now has > 15,000 lines of code, > 600 versions published, up to 6 mio downloads per month, > 150 mio downloads overall. #1 NPM ranking for backend packages. Thank you to all who contributed to this project!
 
-## New Version 5.0
+## Please support this project ... ☕️
+
+Over the past few years I spent **over 2.000 hours** working on this project and invested in hardware to be able to test on different platforms. Currently I am working very hard on the next **new version 6.0** completely rewritten in TypeScript and with a lot of new features. Any support is highly appreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo).
+
+**Your contribution** make it possible for me to keep working on this project, add new features and support more platforms. Thank you in advance!
 
-The new Version 5 is here - I spent several weeks finalizing this new version. Any support is highly appreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo)
+## New Version 5.0
 
-This next major version release 5.0 comes with new functionality and several improvements and changes (some of them are breaking changes!):
+The new Version 5 is here - this next major version release 5.0 comes with new functionality and several improvements and changes (some of them are breaking changes!):
 
 - added audio: get detailed audio device information
 - added bluetooth: get detailed bluetooth device information
@@ -75,9 +79,22 @@ npm install systeminformation --save
 or simpler
 
 ```bash
-npm install systeminformation
+npm i systeminformation
 ```
 
+### Give it a try with `npx`?
+
+You just want to give it a try - right from your command line without installing it? Here is how you can call it with `npx`:
+
+```
+# get basic system info (System, OS, CPU)
+npx systeminformation info
+
+# obtain all static data - may take up to 30 seconds
+npx systeminformation
+```
+
+
 #### Still need Version 4?
 
 If you need version 4 (for compatibility reasons), you can install version 4 (latest release) like this
@@ -111,6 +128,7 @@ si.cpu()
 
 (last 7 major and minor version releases)
 
+- Version 5.19.0: `currentLoad()` added steal and guest time (linux)
 - Version 5.18.0: `fsSize()` added optional drive parameter
 - Version 5.17.0: `graphics()` added positionX, positionY (mac OS)
 - Version 5.16.0: `fsSize()` added rw property

package/lib/cli.js

@@ -17,15 +17,75 @@
 // Dependencies
 // ----------------------------------------------------------------------------------
 const si = require('./index');
+const lib_version = require('../package.json').version;
+
+function capFirst(string) {
+  return string[0].toUpperCase() + string.slice(1);
+}
+
+function printLines(obj) {
+  for (const property in obj) {
+    console.log(capFirst(property) + '                    '.substring(0, 17 - property.length) + ': ' + (obj[property] || ''));
+  }
+  console.log();
+}
+
+function info() {
+  console.log('┌─────────────────────────────────────────────────────────────────────────────────────────┐');
+  console.log('│  SYSTEMINFORMATION                                                                                                  '.substring(0, 80 - lib_version.length) + 'Version: ' + lib_version + ' │');
+  console.log('└─────────────────────────────────────────────────────────────────────────────────────────┘');
+
+  si.osInfo().then(res => {
+    console.log();
+    console.log('Operating System:');
+    console.log('──────────────────────────────────────────────────────────────────────────────────────────');
+    delete res.serial;
+    delete res.servicepack;
+    delete res.logofile;
+    delete res.fqdn;
+    delete res.uefi;
+    printLines(res);
+    si.system().then(res => {
+      console.log('System:');
+      console.log('──────────────────────────────────────────────────────────────────────────────────────────');
+      delete res.serial;
+      delete res.uuid;
+      delete res.sku;
+      delete res.uuid;
+      printLines(res);
+      si.cpu().then(res => {
+        console.log('CPU:');
+        console.log('──────────────────────────────────────────────────────────────────────────────────────────');
+        delete res.cache;
+        delete res.governor;
+        delete res.flags;
+        delete res.virtualization;
+        delete res.revision;
+        delete res.voltage;
+        delete res.vendor;
+        delete res.speedMin;
+        delete res.speedMax;
+        printLines(res);
+      });
+    });
+  });
+}
 
 // ----------------------------------------------------------------------------------
 // Main
 // ----------------------------------------------------------------------------------
 (function () {
-  si.getStaticData().then(
-    ((data) => {
-      data.time = si.time();
-      console.log(JSON.stringify(data, null, 2));
-    }
-    ));
+  const args = process.argv.slice(2);
+
+  if (args[0] === 'info') {
+    info();
+  } else {
+    si.getStaticData().then(
+      ((data) => {
+        data.time = si.time();
+        console.log(JSON.stringify(data, null, 2));
+      }
+      ));
+  }
+
 })();

package/lib/cpu.js

@@ -36,6 +36,8 @@ let _current_cpu = {
   system: 0,
   idle: 0,
   irq: 0,
+  steal: 0,
+  guest: 0,
   load: 0,
   tick: 0,
   ms: 0,
@@ -45,12 +47,16 @@ let _current_cpu = {
   currentLoadNice: 0,
   currentLoadIdle: 0,
   currentLoadIrq: 0,
+  currentLoadSteal: 0,
+  currentLoadGuest: 0,
   rawCurrentLoad: 0,
   rawCurrentLoadUser: 0,
   rawCurrentLoadSystem: 0,
   rawCurrentLoadNice: 0,
   rawCurrentLoadIdle: 0,
-  rawCurrentLoadIrq: 0
+  rawCurrentLoadIrq: 0,
+  rawCurrentLoadSteal: 0,
+  rawCurrentLoadGuest: 0
 };
 let _cpus = [];
 let _corecount = 0;
@@ -1559,15 +1565,44 @@ function getLoad() {
       let now = Date.now() - _current_cpu.ms;
       if (now >= 200) {
         _current_cpu.ms = Date.now();
-        const cpus = os.cpus();
+        const cpus = os.cpus().map(function (cpu) {
+          cpu.times.steal = 0;
+          cpu.times.guest = 0;
+          return cpu;
+        });
         let totalUser = 0;
         let totalSystem = 0;
         let totalNice = 0;
         let totalIrq = 0;
         let totalIdle = 0;
+        let totalSteal = 0;
+        let totalGuest = 0;
         let cores = [];
         _corecount = (cpus && cpus.length) ? cpus.length : 0;
 
+        // linux: try to get other cpu stats
+        if (_linux) {
+          try {
+            const lines = execSync('cat /proc/stat 2>/dev/null | grep cpu').split('\n');
+            if (lines.length > 1) {
+              lines.shift();
+              if (lines.length === cpus.length) {
+                for (let i = 0; i < lines.length; i++) {
+                  let parts = lines[i].split(' ');
+                  if (parts.length >= 10) {
+                    const steal = parseFloat(parts[8]) || 0;
+                    const guest = parseFloat(parts[9]) || 0;
+                    cpus[i].times.steal = steal;
+                    cpus[i].times.guest = guest;
+                  }
+                }
+              }
+            }
+          } catch (e) {
+            util.noop();
+          }
+        }
+
         for (let i = 0; i < _corecount; i++) {
           const cpu = cpus[i].times;
           totalUser += cpu.user;
@@ -1575,6 +1610,8 @@ function getLoad() {
           totalNice += cpu.nice;
           totalIdle += cpu.idle;
           totalIrq += cpu.irq;
+          totalSteal += cpu.steal || 0;
+          totalGuest += cpu.guest || 0;
           let tmpTick = (_cpus && _cpus[i] && _cpus[i].totalTick ? _cpus[i].totalTick : 0);
           let tmpLoad = (_cpus && _cpus[i] && _cpus[i].totalLoad ? _cpus[i].totalLoad : 0);
           let tmpUser = (_cpus && _cpus[i] && _cpus[i].user ? _cpus[i].user : 0);
@@ -1582,9 +1619,11 @@ function getLoad() {
           let tmpNice = (_cpus && _cpus[i] && _cpus[i].nice ? _cpus[i].nice : 0);
           let tmpIdle = (_cpus && _cpus[i] && _cpus[i].idle ? _cpus[i].idle : 0);
           let tmpIrq = (_cpus && _cpus[i] && _cpus[i].irq ? _cpus[i].irq : 0);
+          let tmpSteal = (_cpus && _cpus[i] && _cpus[i].steal ? _cpus[i].steal : 0);
+          let tmpGuest = (_cpus && _cpus[i] && _cpus[i].guest ? _cpus[i].guest : 0);
           _cpus[i] = cpu;
-          _cpus[i].totalTick = _cpus[i].user + _cpus[i].sys + _cpus[i].nice + _cpus[i].irq + _cpus[i].idle;
-          _cpus[i].totalLoad = _cpus[i].user + _cpus[i].sys + _cpus[i].nice + _cpus[i].irq;
+          _cpus[i].totalTick = _cpus[i].user + _cpus[i].sys + _cpus[i].nice + _cpus[i].irq + _cpus[i].steal + _cpus[i].guest + _cpus[i].idle;
+          _cpus[i].totalLoad = _cpus[i].user + _cpus[i].sys + _cpus[i].nice + _cpus[i].irq + _cpus[i].steal + _cpus[i].guest;
           _cpus[i].currentTick = _cpus[i].totalTick - tmpTick;
           _cpus[i].load = (_cpus[i].totalLoad - tmpLoad);
           _cpus[i].loadUser = (_cpus[i].user - tmpUser);
@@ -1592,6 +1631,8 @@ function getLoad() {
           _cpus[i].loadNice = (_cpus[i].nice - tmpNice);
           _cpus[i].loadIdle = (_cpus[i].idle - tmpIdle);
           _cpus[i].loadIrq = (_cpus[i].irq - tmpIrq);
+          _cpus[i].loadSteal = (_cpus[i].steal - tmpSteal);
+          _cpus[i].loadGuest = (_cpus[i].guest - tmpGuest);
           cores[i] = {};
           cores[i].load = _cpus[i].load / _cpus[i].currentTick * 100;
           cores[i].loadUser = _cpus[i].loadUser / _cpus[i].currentTick * 100;
@@ -1599,15 +1640,19 @@ function getLoad() {
           cores[i].loadNice = _cpus[i].loadNice / _cpus[i].currentTick * 100;
           cores[i].loadIdle = _cpus[i].loadIdle / _cpus[i].currentTick * 100;
           cores[i].loadIrq = _cpus[i].loadIrq / _cpus[i].currentTick * 100;
+          cores[i].loadSteal = _cpus[i].loadSteal / _cpus[i].currentTick * 100;
+          cores[i].loadGuest = _cpus[i].loadGuest / _cpus[i].currentTick * 100;
           cores[i].rawLoad = _cpus[i].load;
           cores[i].rawLoadUser = _cpus[i].loadUser;
           cores[i].rawLoadSystem = _cpus[i].loadSystem;
           cores[i].rawLoadNice = _cpus[i].loadNice;
           cores[i].rawLoadIdle = _cpus[i].loadIdle;
           cores[i].rawLoadIrq = _cpus[i].loadIrq;
+          cores[i].rawLoadSteal = _cpus[i].loadSteal;
+          cores[i].rawLoadGuest = _cpus[i].loadGuest;
         }
-        let totalTick = totalUser + totalSystem + totalNice + totalIrq + totalIdle;
-        let totalLoad = totalUser + totalSystem + totalNice + totalIrq;
+        let totalTick = totalUser + totalSystem + totalNice + totalIrq + totalSteal + totalGuest + totalIdle;
+        let totalLoad = totalUser + totalSystem + totalNice + totalIrq + totalSteal + totalGuest;
         let currentTick = totalTick - _current_cpu.tick;
         result = {
           avgLoad: avgLoad,
@@ -1617,12 +1662,16 @@ function getLoad() {
           currentLoadNice: (totalNice - _current_cpu.nice) / currentTick * 100,
           currentLoadIdle: (totalIdle - _current_cpu.idle) / currentTick * 100,
           currentLoadIrq: (totalIrq - _current_cpu.irq) / currentTick * 100,
+          currentLoadSteal: (totalSteal - _current_cpu.steal) / currentTick * 100,
+          currentLoadGuest: (totalGuest - _current_cpu.guest) / currentTick * 100,
           rawCurrentLoad: (totalLoad - _current_cpu.load),
           rawCurrentLoadUser: (totalUser - _current_cpu.user),
           rawCurrentLoadSystem: (totalSystem - _current_cpu.system),
           rawCurrentLoadNice: (totalNice - _current_cpu.nice),
           rawCurrentLoadIdle: (totalIdle - _current_cpu.idle),
           rawCurrentLoadIrq: (totalIrq - _current_cpu.irq),
+          rawCurrentLoadSteal: (totalSteal - _current_cpu.steal),
+          rawCurrentLoadGuest: (totalGuest - _current_cpu.guest),
           cpus: cores
         };
         _current_cpu = {
@@ -1631,6 +1680,8 @@ function getLoad() {
           system: totalSystem,
           idle: totalIdle,
           irq: totalIrq,
+          steal: totalSteal,
+          guest: totalGuest,
           tick: totalTick,
           load: totalLoad,
           ms: _current_cpu.ms,
@@ -1640,12 +1691,16 @@ function getLoad() {
           currentLoadNice: result.currentLoadNice,
           currentLoadIdle: result.currentLoadIdle,
           currentLoadIrq: result.currentLoadIrq,
+          currentLoadSteal: result.currentLoadSteal,
+          currentLoadGuest: result.currentLoadGuest,
           rawCurrentLoad: result.rawCurrentLoad,
           rawCurrentLoadUser: result.rawCurrentLoadUser,
           rawCurrentLoadSystem: result.rawCurrentLoadSystem,
           rawCurrentLoadNice: result.rawCurrentLoadNice,
           rawCurrentLoadIdle: result.rawCurrentLoadIdle,
           rawCurrentLoadIrq: result.rawCurrentLoadIrq,
+          rawCurrentLoadSteal: result.rawCurrentLoadSteal,
+          rawCurrentLoadGuest: result.rawCurrentLoadGuest,
         };
       } else {
         let cores = [];
@@ -1663,6 +1718,8 @@ function getLoad() {
           cores[i].rawLoadNice = _cpus[i].loadNice;
           cores[i].rawLoadIdle = _cpus[i].loadIdle;
           cores[i].rawLoadIrq = _cpus[i].loadIrq;
+          cores[i].rawLoadSteal = _cpus[i].loadSteal;
+          cores[i].rawLoadGuest = _cpus[i].loadGuest;
         }
         result = {
           avgLoad: avgLoad,
@@ -1672,12 +1729,16 @@ function getLoad() {
           currentLoadNice: _current_cpu.currentLoadNice,
           currentLoadIdle: _current_cpu.currentLoadIdle,
           currentLoadIrq: _current_cpu.currentLoadIrq,
+          currentLoadSteal: _current_cpu.currentLoadSteal,
+          currentLoadGuest: _current_cpu.currentLoadGuest,
           rawCurrentLoad: _current_cpu.rawCurrentLoad,
           rawCurrentLoadUser: _current_cpu.rawCurrentLoadUser,
           rawCurrentLoadSystem: _current_cpu.rawCurrentLoadSystem,
           rawCurrentLoadNice: _current_cpu.rawCurrentLoadNice,
           rawCurrentLoadIdle: _current_cpu.rawCurrentLoadIdle,
           rawCurrentLoadIrq: _current_cpu.rawCurrentLoadIrq,
+          rawCurrentLoadSteal: _current_cpu.rawCurrentLoadSteal,
+          rawCurrentLoadGuest: _current_cpu.rawCurrentLoadGuest,
           cpus: cores
         };
       }

package/lib/index.d.ts

@@ -591,12 +591,16 @@ export namespace Systeminformation {
     currentLoadNice: number;
     currentLoadIdle: number;
     currentLoadIrq: number;
+    currentLoadSteal: number;
+    currentLoadGuest: number;
     rawCurrentLoad: number;
     rawCurrentLoadUser: number;
     rawCurrentLoadSystem: number;
     rawCurrentLoadNice: number;
     rawCurrentLoadIdle: number;
     rawCurrentLoadIrq: number;
+    rawCurrentLoadSteal: number;
+    rawCurrentLoadGuest: number;
     cpus: CurrentLoadCpuData[];
   }
 
@@ -607,12 +611,16 @@ export namespace Systeminformation {
     loadNice: number;
     loadIdle: number;
     loadIrq: number;
+    loadSteal: number;
+    loadGuest: number;
     rawLoad: number;
     rawLoadUser: number;
     rawLoadSystem: number;
     rawLoadNice: number;
     rawLoadIdle: number;
     rawLoadIrq: number;
+    rawLoadSteal: number;
+    rawLoadGuest: number;
   }
 
   interface ProcessesData {

package/lib/wifi.js

@@ -345,6 +345,7 @@ function parseWifiDarwin(wifiObj) {
       const signalLevel = wifiItem.RSSI;
       let security = [];
       let wpaFlags = [];
+      let ssid = wifiItem.SSID_STR || '';
       if (wifiItem.WPA_IE) {
         security.push('WPA');
         if (wifiItem.WPA_IE.IE_KEY_WPA_UCIPHERS) {
@@ -365,9 +366,12 @@ function parseWifiDarwin(wifiObj) {
           });
         }
       }
+      // if (wifiItem.SSID) {
+      //   ssid = Buffer.from(wifiItem.SSID, 'base64').toString('utf8');
+      // }
       result.push({
-        ssid: wifiItem.SSID_STR,
-        bssid: wifiItem.BSSID,
+        ssid,
+        bssid: wifiItem.BSSID || '',
         mode: '',
         channel: wifiItem.CHANNEL,
         frequency: wifiFrequencyFromChannel(wifiItem.CHANNEL),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "systeminformation",
-  "version": "5.18.14",
+  "version": "5.19.0",
   "description": "Advanced, lightweight system and OS information library",
   "license": "MIT",
   "author": "Sebastian Hildebrandt <hildebrandt@plus-innovations.com> (https://plus-innovations.com)",