From 52ebe5d9a5a9cab60a971cbe902695db07ab5c48 Mon Sep 17 00:00:00 2001 From: Sebastian Hildebrandt Date: Thu, 11 Feb 2021 09:38:07 +0100 Subject: [PATCH] updated docs --- CHANGELOG.md | 31 +++++++++++++++++++++++++------ README.md | 4 ++-- lib/system.js | 2 +- 3 files changed, 28 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 02ec399..febda87 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,8 @@ # Changelog -### Major Changes - Version 5 +## Major Changes - Version 5 -**New Functions** +#### New Functions - `audio()` detailed audio information - `bluetoothDevices()` detailed information detected bluetooth devices @@ -11,13 +11,32 @@ - `wifiInterfaces()` detected Wi-Fi interfaces - `wifiConnections()` active Wi-Fi connections -**Breaking Changes** +#### Breaking Changes **Be aware**, that the new version 5.x **is NOT fully backward compatible** to version 4.x ... -We had to make several interface changes to keep systeminformation as consistent as possible. We highly recommend to go [through the complete list](https://systeminformation.io/changes.html) and adapt your own code to be again compatible to the new version 5. +We had to make **several interface changes** to keep systeminformation as consistent as possible. We highly [recommend to go through the complete list](https://systeminformation.io/changes.html) and adapt your own code to be again compatible to the new version 5. -**Other Improvements and Changes** +| Function | Old | New (V5) | Comments | +| --------------- | ------------------ | ------------------ | ------------------ | +| unsupported values | -1 | null | values which are unknown or
unsupported on platform | +| `battery()` | hasbattery
cyclecount
ischarging
designedcapacity
maxcapacity
acconnected
timeremaining | hasBattery
cycleCount
isCharging
designedCapacity
maxCapacity
acConnected
timeRemaining | pascalCase conformity | +| `blockDevices()` | fstype | fsType | pascalCase conformity | +| `cpu()` | speedmin
speedmax | speedMin
speedMax | pascalCase conformity | +| `cpu().speed`
`cpu().speedMin`
`cpu().speedMax` | string values | now returning
numerical values | better value handling | +| `cpuCurrentspeed()` | | cpuCurrentSpeed() | function name changed
pascalCase conformity | +| `currentLoad()` | avgload
currentload
currentload_user
currentload_system
currentload_nice
currentload_idle
currentload_irq
raw_currentload | avgLoad
currentLoad
currentLoadUser
currentLoadSystem
currentLoadNice
currentLoadIdle
currentLoadIrq
rawCurrentLoad | pascalCase conformity | +| `dockerContainerStats()` | mem_usage
mem_limit
mem_percent
cpu_percent
cpu_stats
precpu_stats
memory_stats | memUsage
memLimit
memPercent
cpuPercent
cpuStats
precpuStats
memoryStats | pascalCase conformity | +| `dockerContainerProcesses()` | pid_host | pidHost | pascalCase conformity | +| `graphics().display` | pixeldepth
resolutionx
resolutiony
sizex
sizey | pixelDepth
resolutionX
resolutionY
sizeX
sizeY | pascalCase conformity | +| `networkConnections()` | localaddress
localport
peeraddress
peerport | localAddress
localPort
peerAddress
peerPort | pascalCase conformity | +| `networkInterfaces()` | carrier_changes | carrierChanges | pascalCase conformity | +| `processes()` | mem_vsz
mem_rss
pcpu
pcpuu
pcpus
pmem | memVsz
memRss
cpu
cpuu
cpus
mem | pascalCase conformity
renamed attributes | +| `processLoad()` | result as object | result as array of objects | function now allows to provide more than
one process (as a comma separated list) | +| `services()` | pcpu
pmem | cpu
mem | renamed attributes | +| `vbox()` | HPET
PAE
APIC
X2APIC
ACPI
IOAPIC
biosAPICmode
TRC | hpet
pae
apic
x2Apic
acpi
ioApic
biosApicMode
rtc | pascalCase conformity | + +#### Other Improvements and Changes - `baseboard(): added memMax, memSlots - `bios()`: added language and features (linux) @@ -42,7 +61,7 @@ We had to make several interface changes to keep systeminformation as consistent - `Apple M1 Silicon extended support (now everything supported except of cpu temperature) - `updated TypeScript definitions -**Test Full Version 5 Functionality** +#### Test Full Version 5 Functionality If you want to see all function results on your machine, please head over to (Testing section)[https://systeminformation.io/tests.html]. We implemented a tiny test suite where you can easily go through all functions and test resuls on your machine without coding. diff --git a/README.md b/README.md index d614a0c..866808f 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ [![Sponsoring][sponsor-badge]][sponsor-url] [![MIT license][license-img]][license-url] -This is amazing. Started as a small project just for myself, it now has > 10,000 lines of code, > 400 versions published, up to 3 mio downloads per month, > 30 mio downloads overall. Thank you to all who contributed to this project! +This is amazing. Started as a small project just for myself, it now has > 10,000 lines of code, > 400 versions published, > 3 mio downloads per month, > 30 mio downloads overall. Thank you to all who contributed to this project! ## New Version 5.0 @@ -101,13 +101,13 @@ si.cpu() (last 7 major and minor version releases) +- Version 5.2.0: `wifiInterfaces()` and `wifiConnections()` added - Version 5.1.0: `memLayout()` added ECC flag, `bios()` added language, features (linux) - Version 5.0.0: new version 5 - attention there are some breaking changes. See [detailed version 5 changes here][changes5-url]. - Version 4.34.0: `system()` added flag virtual (linux, windows) - Version 4.33.0: `graphics()` added nvidia-smi support (linux, windows) - Version 4.32.0: `graphics()` added clinfo support (linux) - Version 4.31.0: `osInfo()` added FQDN -- Version 4.30.0: `get()` added possibility to provide parameters - ... You can find all changes here: [detailed changelog][changelog-url] diff --git a/lib/system.js b/lib/system.js index 599118f..762da34 100644 --- a/lib/system.js +++ b/lib/system.js @@ -159,7 +159,7 @@ function system(callback) { result.model = 'Docker Container'; } try { - const stdout = execSync('dmesg | grep -iE "virtual|hypervisor" | grep -iE "vmware|qemu|kvm|xen"'); + const stdout = execSync('dmesg 2>/dev/null | grep -iE "virtual|hypervisor" | grep -iE "vmware|qemu|kvm|xen"'); // detect virtual machines let lines = stdout.toString().split('\n'); if (lines.length > 0) {