mike/systeminformation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
Sebastian Hildebrandt 2022-11-06 14:25:51 +01:00
parent 45e8ea392b
commit 2b1885f0f8
15 changed files with 666 additions and 660 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -46,7 +46,7 @@ We had to make **several interface changes** to keep systeminformation as consis
- `cpu()`: extended socket list (win)
- `cpu()`: added virtualization if cpu supports virtualization
- `cpu()`: now flags are part of this function
- `cpuTemperature()` added added socket and chipset temp (linux)
- `cpuTemperature()` added socket and chipset temp (linux)
- `disksIO()` added wait time (linux)
- `diskLayout()`: added USB drives (mac OS)
- `diskLayout()`: added S.M.R.R.T. (win)
@ -80,6 +80,7 @@ For major (breaking) changes - **version 4, 3 and 2** - see end of page.
| Version | Date | Comment |
| ------- | ---------- | --------------------------------------------------------------------------------------------------- |
| 5.12.13 | 2022-11-06 | updated docs |
| 5.12.12 | 2022-11-03 | fix typescript typings |
| 5.12.11 | 2022-10-27 | `wifiInterfaces()`, `wifiConnections` improved parsing (linux) |
| 5.12.10 | 2022-10-25 | `bluetooth()` adapted parsing to accept also new profile (mac OS) |

94
README.md
View File

@ -34,7 +34,7 @@ This is amazing. Started as a small project just for myself, it now has > 15,000
## New Version 5.0
The new Version 5 is here - I spend several weeks finalizing this new version. Any support is highly appreciated - [Buy me a coffee](https://www.buymeacoffee.com/systeminfo)
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)
This next major version release 5.0 comes with new functionality and several improvements and changes (some of them are breaking changes!):
@ -43,13 +43,13 @@ This next major version release 5.0 comes with new functionality and several imp
- added dockerImages, dockerVolumes: get detailed information about docker images and volumes
- added printer: get information from detected printers
- added usb: get detailed usb controller and device information
- added wifi interfaces ans connections: extended wifi information
- added wifi interfaces and connections: extended wifi information
- better uuid function to get unique hardware and OS UUIDs
- better/extended cpu info detection
- better/extended system info detection
- Apple Silicon M1 support
- better Raspberry-PI detection
- systeminformation website updated and extendet with full documentation and examples [systeminformation.io][systeminformation-url]
- systeminformation website updated and extended with full documentation and examples [systeminformation.io][systeminformation-url]
- lot of minor improvements
Breaking Changes in version 5: you will see several breaking changes for the sake of a more consistent API interface and to be future proof. Read the [detailed version 5 changes][changes5-url].
@ -118,7 +118,7 @@ si.cpu()
- Version 5.9.0: `graphics()` added properties (macOS)
- Version 5.8.0: `disksIO()` added waitTime, waitPercent (linux)
- Version 5.7.0: `diskLayout()` added S.M.A.R.T for Windows (if installed)
- Version 5.6.0: `cpuTemperature()` added added socket and chipset temp (linux)
- Version 5.6.0: `cpuTemperature()` added socket and chipset temp (linux)
- Version 5.5.0: `dockerVolumes()` added
- Version 5.4.0: `dockerImages()` added
- Version 5.3.0: `osInfo()` added remoteSession (win only)
@ -131,7 +131,7 @@ You can find all changes here: [detailed changelog][changelog-url]
## Core concept
[Node.js][nodejs-url] comes with some basic OS information, but I always wanted a little more. So I came up to write this little library. This library is still work in progress. It is supposed to be used as a backend/server-side library (will definitely not work within a browser). It requires node.js version 4.0 and above.
[Node.js][nodejs-url] comes with some basic OS information, but I always wanted a little more. So I came up to write this little library. This library is still a work in progress. It is supposed to be used as a backend/server-side library (it will definitely not work within a browser). It requires node.js version 4.0 and above.
I was able to test it on several Debian, Raspbian, Ubuntu distributions as well as macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra, Mojave, Catalina, Big Sur) and some Windows 7, Windows 8, Windows 10, FreeBSD, OpenBSD, NetBSD and SunOS machines. Not all functions are supported on all operating systems. Have a look at the function reference in the docs to get further details.
@ -150,7 +150,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 1. General
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ------------ | ------------- | ----- | --- | --- | --- | --- | --------------------------------- |
| si.version() | : string | X | X | X | X | X | lib version (no callback/promise) |
| si.time() | {...} | X | X | X | X | X | (no callback/promise) |
| | current | X | X | X | X | X | local (server) time |
@ -161,7 +161,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 2. System (HW)
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ---------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------------- |
| si.system(cb) | {...} | X | X | X | X | | hardware information |
| | manufacturer | X | X | X | X | | e.g. 'MSI' |
| | model | X | X | X | X | | model/product e.g. 'MS-7823' |
@ -198,8 +198,8 @@ Full function reference with examples can be found at [https://systeminformation
#### 3. CPU
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| si.cpu(cb) | {...} | X | X | X | X | | CPU information|
| ---------------------- | ---------------- | ----- | --- | --- | --- | --- | ----------------------------------- |
| si.cpu(cb) | {...} | X | X | X | X | | CPU information |
| | manufacturer | X | X | X | X | | e.g. 'Intel(R)' |
| | brand | X | X | X | X | | e.g. 'Core(TM)2 Duo' |
| | speed | X | X | X | X | | in GHz e.g. '3.40' |
@ -225,13 +225,13 @@ Full function reference with examples can be found at [https://systeminformation
| | cache.l1i | X | X | X | X | | L1I (instruction) size |
| | cache.l2 | X | X | X | X | | L2 size |
| | cache.l3 | X | X | X | X | | L3 size |
| si.cpuFlags(cb) | : string | X | X | X | X | | CPU flags|
| si.cpuFlags(cb) | : string | X | X | X | X | | CPU flags |
| si.cpuCache(cb) | {...} | X | X | X | X | | CPU cache sizes |
| | l1d | X | X | X | X | | L1D size |
| | l1i | X | X | X | X | | L1I size |
| | l2 | X | X | X | X | | L2 size |
| | l3 | X | X | X | X | | L3 size |
| si.cpuCurrentSpeed(cb) | {...} | X | X | X | X | X | current CPU speed (in GHz)|
| si.cpuCurrentSpeed(cb) | {...} | X | X | X | X | X | current CPU speed (in GHz) |
| | avg | X | X | X | X | X | avg CPU speed (all cores) |
| | min | X | X | X | X | X | min CPU speed (all cores) |
| | max | X | X | X | X | X | max CPU speed (all cores) |
@ -246,8 +246,8 @@ Full function reference with examples can be found at [https://systeminformation
#### 4. Memory
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| si.mem(cb) | {...} | X | X | X | X | X | Memory information (in bytes)|
| ---------------- | --------------------- | ----- | --- | --- | --- | --- | -------------------------------------- |
| si.mem(cb) | {...} | X | X | X | X | X | Memory information (in bytes) |
| | total | X | X | X | X | X | total memory in bytes |
| | free | X | X | X | X | X | not used in bytes |
| | used | X | X | X | X | X | used (incl. buffers/cache) |
@ -276,7 +276,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 5. Battery
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| -------------- | ---------------- | ----- | --- | --- | --- | --- | --------------------------------- |
| si.battery(cb) | {...} | X | X | X | X | | battery information |
| | hasBattery | X | X | X | X | | indicates presence of battery |
| | cycleCount | X | | X | | | numbers of recharges |
@ -294,21 +294,21 @@ Full function reference with examples can be found at [https://systeminformation
| | manufacturer | X | | X | | | manufacturer |
| | serial | X | | X | | | battery serial |
* See known issues if you have problem with macOS temperature or windows temperature
* See known issues if you have a problem with macOS temperature or windows temperature
#### 6. Graphics
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| --------------- | ------------------------- | ----- | --- | --- | --- | --- | ------------------------------------------- |
| si.graphics(cb) | {...} | X | | X | X | | arrays of graphics controllers and displays |
| | controllers[]| X | | X | X | | graphics controllers array |
| | controllers[] | X | | X | X | | graphics controllers array |
| | ...[0].vendor | X | | X | X | | e.g. ATI |
| | ...[0].vendorId | | | X | | | vendor ID |
| | ...[0].model | X | | X | X | | graphics controller model |
| | ...[0].deviceId | | | X | | | device ID |
| | ...[0].bus | X | | X | X | | on which bus (e.g. PCIe) |
| | ...[0].vram | X | | X | X | | VRAM size (in MB) |
| | ...[0].vramDynamic | X | | X | X | | true if dynamicly allocated ram |
| | ...[0].vramDynamic | X | | X | X | | true if dynamically allocated ram |
| | ...[0].external | | | X | | | is external GPU |
| | ...[0].cores | | | X | | | Apple silicon only |
| | ...[0].metalVersion | | | X | | | Apple Metal Version |
@ -320,8 +320,8 @@ Full function reference with examples can be found at [https://systeminformation
| | ...[0].productionYear | | | X | | | production year |
| | ...[0].serial | | | X | | | serial number |
| | ...[0].displayId | | | X | | | display ID |
| | ...[0].main | X | | X | X| | true if main monitor |
| | ...[0].builtin | X | | X | | | true if built in monitor |
| | ...[0].main | X | | X | X | | true if main monitor |
| | ...[0].builtin | X | | X | | | true if built-in monitor |
| | ...[0].connection | X | | X | X | | e.g. DisplayPort or HDMI |
| | ...[0].sizeX | X | | | X | | size in mm horizontal |
| | ...[0].sizeY | X | | | X | | size in mm vertical |
@ -337,7 +337,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 7. Operating System
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| --------------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| si.osInfo(cb) | {...} | X | X | X | X | X | OS information |
| | platform | X | X | X | X | X | 'linux', 'darwin', 'win32', ... |
| | distro | X | X | X | X | X | |
@ -372,7 +372,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 8. Current Load, Processes & Services
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ------------------------------------ | ----------------- | ----- | --- | --- | --- | --- | --------------------------------------------------------------------------------------- |
| si.currentLoad(cb) | {...} | X | | X | X | X | CPU-Load |
| | avgLoad | X | | X | | X | average load |
| | currentLoad | X | | X | X | X | CPU load in % |
@ -398,7 +398,7 @@ Full function reference with examples can be found at [https://systeminformation
| | ...[0].cpuu | X | X | | X | | process % CPU usage (user) |
| | ...[0].cpus | X | X | | X | | process % CPU usage (system) |
| | ...[0].mem | X | X | X | X | X | process memory % |
| | ...[0].priority | X | X | X | X | X | process priotity |
| | ...[0].priority | X | X | X | X | X | process priority |
| | ...[0].memVsz | X | X | X | X | X | process virtual memory size |
| | ...[0].memRss | X | X | X | X | X | process mem resident set size |
| | ...[0].nice | X | X | X | | X | process nice value |
@ -430,7 +430,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 9. File System
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ------------------- | --------------------- | ----- | --- | --- | --- | --- | ------------------------------------------------------------------------ |
| si.diskLayout(cb) | [{...}] | X | | X | X | | physical disk layout (array) |
| | [0].device | X | | X | | | e.g. /dev/sda |
| | [0].type | X | | X | X | | HD, SSD, NVMe |
@ -501,7 +501,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 10. USB
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ---------- | ---------------- | ----- | --- | --- | --- | --- | ------------------------ |
| si.usb(cb) | [{...}] | X | X | X | X | | get detected USB devices |
| | [0].bus | X | | | | | USB bus |
| | [0].deviceId | X | | | | | bus device id |
@ -510,7 +510,7 @@ Full function reference with examples can be found at [https://systeminformation
| | [0].type | X | | X | X | | name |
| | [0].removable | | | X | | | is removable |
| | [0].vendor | X | | X | | | vendor |
| | [0].manufacturer | X | | X | X | | manifacturer |
| | [0].manufacturer | X | | X | X | | manufacturer |
| | [0].maxPower | X | | | | | max power |
| | [0].default | X | | X | X | | is default printer |
| | [0].serialNumber | | | X | | | serial number |
@ -518,7 +518,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 11. Printer
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| -------------- | ------------- | ----- | --- | --- | --- | --- | -------------------------- |
| si.printer(cb) | [{...}] | X | X | X | X | | get printer information |
| | [0].id | X | | X | X | | internal id |
| | [0].name | X | | X | X | | name |
@ -533,7 +533,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 12. Audio
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ------------ | ----------------- | ----- | --- | --- | --- | --- | ------------------------------------- |
| si.audio(cb) | [{...}] | X | X | X | X | | get printer information |
| | [0].id | X | | X | X | | internal id |
| | [0].name | X | | X | X | | name |
@ -551,7 +551,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 13. Network related functions
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ------------------------------ | ------------------ | ----- | --- | --- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| si.networkInterfaces(cb) | [{...}] | X | X | X | X | X | array of network interfaces<br>With the 'default' parameter it returns<br>only the default interface |
| | [0].iface | X | X | X | X | X | interface |
| | [0].ifaceName | X | X | X | X | X | interface name (differs on Windows) |
@ -587,7 +587,7 @@ Full function reference with examples can be found at [https://systeminformation
| | [0].rx_sec | X | X | X | X | | received bytes / second (* see notes) |
| | [0].tx_sec | X | X | X | X | | transferred bytes per second (* see notes) |
| | [0].ms | X | X | X | X | | interval length (for per second values) |
| si.networkConnections(cb) | [{...}] | X | X | X | X | | current network network connections<br>returns an array of all connections|
| si.networkConnections(cb) | [{...}] | X | X | X | X | | current network network connections<br>returns an array of all connections |
| | [0].protocol | X | X | X | X | | tcp or udp |
| | [0].localAddress | X | X | X | X | | local address |
| | [0].localPort | X | X | X | X | | local port |
@ -601,20 +601,20 @@ Full function reference with examples can be found at [https://systeminformation
| | ok | X | X | X | X | X | status code OK (2xx, 3xx) |
| | status | X | X | X | X | X | status code |
| | ms | X | X | X | X | X | response time in ms |
| si.inetLatency(host, cb) | : number | X | X | X | X | X | response-time (ms) to external resource<br>host parameter is optional (default 8.8.8.8)|
| si.inetLatency(host, cb) | : number | X | X | X | X | X | response-time (ms) to external resource<br>host parameter is optional (default 8.8.8.8) |
#### 14. Wifi
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ---------------------- | --------------- | ----- | --- | --- | --- | --- | --------------------------------- |
| si.wifiNetworks(cb) | [{...}] | X | | X | X | | array of available wifi networks |
| | [0].ssid | X | | X | X | | Wifi network SSID |
| | [0].bssid | X | | X | X | | BSSID (mac) |
| | [0].mode | X | | | | | mode |
| | [0].channel | X | | X | X | | channel |
| | [0].frequency | X | | X | X | | frequengy in MHz |
| | [0].frequency | X | | X | X | | frequency in MHz |
| | [0].signalLevel | X | | X | X | | signal level in dB |
| | [0].quality | X | | X | X | | quaility in % |
| | [0].quality | X | | X | X | | quality in % |
| | [0].security | X | | X | X | | array e.g. WPA, WPA-2 |
| | [0].wpaFlags | X | | X | X | | array of WPA flags |
| | [0].rsnFlags | X | | | | | array of RDN flags |
@ -632,16 +632,16 @@ Full function reference with examples can be found at [https://systeminformation
| | [0].bssid | X | | X | X | | BSSID (mac) |
| | [0].mode | X | | | | | mode |
| | [0].channel | X | | X | X | | channel |
| | [0].frequency | X | | X | X | | frequengy in MHz |
| | [0].frequency | X | | X | X | | frequency in MHz |
| | [0].signalLevel | X | | X | X | | signal level in dB |
| | [0].quality | X | | X | X | | quaility in % |
| | [0].quality | X | | X | X | | quality in % |
| | [0].security | X | | X | X | | array e.g. WPA, WPA-2 |
| | [0].txRate | X | | X | X | | transfer rate MBit/s |
#### 15. Bluetooth
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ----------------------- | ------------------ | ----- | --- | --- | --- | --- | ------------------------ |
| si.bluetoothDevices(cb) | [{...}] | X | | X | X | | ... |
| | [0].device | | | X | | | device name |
| | [0].name | X | | X | X | | name |
@ -649,13 +649,13 @@ Full function reference with examples can be found at [https://systeminformation
| | [0].macHost | X | | X | | | MAC address host |
| | [0].batteryPercent | | | X | | | battery level percent |
| | [0].manufacturer | | | X | X | | manufacturer |
| | [0].type | X | | X | X | | typoe of bluetooth device |
| | [0].type | X | | X | X | | type of bluetooth device |
| | [0].connected | X | | X | | | is connected |
#### 16. Docker
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ----------------------------------- | ------------------- | ----------------------------------- | --- | --- | --- | --- | ------------------------------------------------------------------------------------------------------------- |
| si.dockerInfo(cb) | {...} | X | X | X | X | X | returns general docker info |
| | id | X | X | X | X | X | Docker ID |
| | containers | X | X | X | X | X | number of containers |
@ -666,7 +666,7 @@ Full function reference with examples can be found at [https://systeminformation
| | driver | X | X | X | X | X | driver (e.g. 'devicemapper', 'overlay2') |
| | memoryLimit | X | X | X | X | X | has memory limit |
| | swapLimit | X | X | X | X | X | has swap limit |
| | kernelMemory | X | X | X | X | X | has kernal memory |
| | kernelMemory | X | X | X | X | X | has kernel memory |
| | cpuCfsPeriod | X | X | X | X | X | has CpuCfsPeriod |
| | cpuCfsQuota | X | X | X | X | X | has CpuCfsQuota |
| | cpuShares | X | X | X | X | X | has CPUShares |
@ -737,7 +737,7 @@ Full function reference with examples can be found at [https://systeminformation
| | [0].state | X | X | X | X | X | created, running, exited |
| | [0].ports | X | X | X | X | X | array of ports |
| | [0].mounts | X | X | X | X | X | array of mounts |
| si.dockerContainerStats(ids, cb) | [{...}] | X | X | X | X | X | statistics for specific containers<br>container IDs: space or comma separated,<br>pass '*' for all containers|
| si.dockerContainerStats(ids, cb) | [{...}] | X | X | X | X | X | statistics for specific containers<br>container IDs: space or comma separated,<br>pass '*' for all containers |
| | [0].id | X | X | X | X | X | Container ID |
| | [0].memUsage | X | X | X | X | X | memory usage in bytes |
| | [0].memLimit | X | X | X | X | X | memory limit (max mem) in bytes |
@ -780,7 +780,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 17. Virtual Box
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| --------------- | -------------------- | ----- | --- | --- | --- | --- | -------------------------------------- |
| si.vboxInfo(cb) | [{...}] | X | X | X | X | X | returns array general virtual box info |
| | [0].id | X | X | X | X | X | virtual box ID |
| | [0].name | X | X | X | X | X | name |
@ -822,7 +822,7 @@ Full function reference with examples can be found at [https://systeminformation
#### 16. "Get All / Observe" - functions
| Function | Result object | Linux | BSD | Mac | Win | Sun | Comments |
| --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- |
| ----------------------------------- | ------------- | ----- | --- | --- | --- | --- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| si.getStaticData(cb) | {...} | X | X | X | X | X | all static data at once |
| si.getDynamicData(srv,iface,cb) | {...} | X | X | X | X | X | all dynamic data at once<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "*" for ALL services (linux/win only)<br>Pass "*" for ALL network interfaces |
| si.getAllData(srv,iface,cb) | {...} | X | X | X | X | X | all data at once<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "*" for ALL services (linux/win only)<br>Pass "*" for ALL network interfaces |
@ -840,7 +840,7 @@ const si = require('systeminformation');
si.cpu(function(data) {
console.log('CPU Information:');
console.log('- manufucturer: ' + data.manufacturer);
console.log('- manufacturer: ' + data.manufacturer);
console.log('- brand: ' + data.brand);
console.log('- speed: ' + data.speed);
console.log('- cores: ' + data.cores);
@ -861,7 +861,7 @@ const si = require('systeminformation');
si.cpu()
.then(data => {
console.log('CPU Information:');
console.log('- manufucturer: ' + data.manufacturer);
console.log('- manufacturer: ' + data.manufacturer);
console.log('- brand: ' + data.brand);
console.log('- speed: ' + data.speed);
console.log('- cores: ' + data.cores);
@ -884,7 +884,7 @@ async function cpuData() {
try {
const data = await si.cpu();
console.log('CPU Information:');
console.log('- manufucturer: ' + data.manufacturer);
console.log('- manufacturer: ' + data.manufacturer);
console.log('- brand: ' + data.brand);
console.log('- speed: ' + data.speed);
console.log('- cores: ' + data.cores);
@ -932,7 +932,7 @@ e.g. on DEBIAN based systems by running `sudo apt-get install lm-sensors`
To be able to detect S.M.A.R.T. status on Linux you need to install `smartmontools`. On DEBIAN based Linux distributions you can install it by running `sudo apt-get install smartmontools`
#### Windows Encoding Issues
I now reimplemented all windows functions to avoid encoding problems (special chacarters). And as Windows 11 now droppend `wmic` support, I had to move completely to `powershell`. Be sure that powershell version 5+ is installed on your machine. On older Windows versions (7, 8) you might still see encoding problems due to the old powershell version.
I now reimplemented all windows functions to avoid encoding problems (special chacarters). And as Windows 11 now dropped `wmic` support, I had to move completely to `powershell`. Be sure that powershell version 5+ is installed on your machine. On older Windows versions (7, 8) you might still see encoding problems due to the old powershell version.
## *: Additional Notes
In `fsStats()`, `disksIO()` and `networkStats()` the results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning

2
docs/docker.html
View File

@ -175,7 +175,7 @@
<td>X</td>
<td>X</td>
<td>X</td>
<td>has kernal memory</td>
<td>has kernel memory</td>
</tr>
<tr>
<td></td>

8
docs/gettingstarted.html
View File

@ -58,7 +58,7 @@
<h2>Core Concept</h2>
<p><a href="https://nodejs.org/en/" rel="nofollow">Node.js</a> comes with some basic OS information, but I always wanted a little more. So I came up to write this
little library. This library is still work in progress. It requires node.js version 4.0 and above.</p>
little library. This library is still a work in progress. It requires node.js version 4.0 and above.</p>
<p>I was able to test it on several Debian, Raspbian, Ubuntu distributions as well as macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra, Mojave, Catalina, Big Sur) and some Windows 7, Windows 8, Windows 10, FreeBSD, OpenBSD, NetBSD and SunOS machines.
Not all functions are supported on all operating systems. Have a look at the function reference in the docs to get further details.</p>
@ -88,7 +88,7 @@ si.cpu()
si.cpu(function(data) {
console.log('CPU Information:');
console.log('- manufucturer: ' + data.manufacturer);
console.log('- manufacturer: ' + data.manufacturer);
console.log('- brand: ' + data.brand);
console.log('- speed: ' + data.speed);
console.log('- cores: ' + data.cores);
@ -103,7 +103,7 @@ si.cpu(function(data) {
si.cpu()
.then(data => {
console.log('CPU Information:');
console.log('- manufucturer: ' + data.manufacturer);
console.log('- manufacturer: ' + data.manufacturer);
console.log('- brand: ' + data.brand);
console.log('- speed: ' + data.speed);
console.log('- cores: ' + data.cores);
@ -119,7 +119,7 @@ async function cpuData() {
try {
const data = await si.cpu();
console.log('CPU Information:');
console.log('- manufucturer: ' + data.manufacturer);
console.log('- manufacturer: ' + data.manufacturer);
console.log('- brand: ' + data.brand);
console.log('- speed: ' + data.speed);
console.log('- cores: ' + data.cores);

4
docs/graphics.html
View File

@ -135,7 +135,7 @@
<td>X</td>
<td>X</td>
<td></td>
<td>true if dynamicly allocated ram</td>
<td>true if dynamically allocated ram</td>
</tr>
<tr>
<td></td>
@ -445,7 +445,7 @@
<td>X</td>
<td></td>
<td></td>
<td>true if built in monitor</td>
<td>true if built-in monitor</td>
</tr>
<tr>
<td></td>

5
docs/history.html
View File

@ -57,6 +57,11 @@
</tr>
</thead>
<tbody>
<tr>
<th scope="row">5.12.13</th>
<td>2022-11-06</td>
<td>updated docs</td>
</tr>
<tr>
<th scope="row">5.12.12</th>
<td>2022-11-03</td>

4
docs/index.html
View File

@ -170,7 +170,7 @@
<img class="logo" src="assets/logo.png" alt="logo">
<div class="title">systeminformation</div>
<div class="subtitle"><span id="typed"></span>&nbsp;</div>
<div class="version">New Version: <span id="version">5.12.12</span></div>
<div class="version">New Version: <span id="version">5.12.13</span></div>
<button class="btn btn-light" onclick="location.href='https://github.com/sebhildebrandt/systeminformation'">View on Github <i class=" fab fa-github"></i></button>
</div>
<div class="down">
@ -214,7 +214,7 @@
<div class="title">Downloads last month</div>
</div>
<div class="col-xl-4 col-lg-4 col-md-4 col-12">
<div class="numbers">585</div>
<div class="numbers">586</div>
<div class="title">Dependents</div>
</div>
</div>

2
docs/issues.html
View File

@ -86,7 +86,7 @@
<p>If you discover empty or incorrect values, please keep in mind that some underlying commands need to be run under admin privileges. So if you run your scripts as normal users, not all system information values can be determined. For linux this is e.g. the case for `memLayout()`, advances `system()`, `bios()`, `baseboard()`, `cpu()`information, S.M.A.R.T. status and others... </p>
<h4>Encoding issues - Windows</h4>
<p>I now reimplemented all windows functions to avoid encoding problems (special chacarters). And as Windows 11 also droppend <span class="code">wmic</span> support, I had to move completely to <span class="code">powershell</span>. Be sure that powershell version 5+ is installed on your machine. On older Windows versions (7, 8) you might still see encoding problems due to the old powershell version.</p>
<p>I now reimplemented all windows functions to avoid encoding problems (special chacarters). And as Windows 11 also dropped <span class="code">wmic</span> support, I had to move completely to <span class="code">powershell</span>. Be sure that powershell version 5+ is installed on your machine. On older Windows versions (7, 8) you might still see encoding problems due to the old powershell version.</p>
<h4>Finding New Issues</h4>
<p>If you still have problems, please feel free to open an issue on our <a href="https://github.com/sebhildebrandt/systeminformation/issues">github page</a></p>

2
docs/processes.html
View File

@ -365,7 +365,7 @@ si.currentLoad().then(data => console.log(data));</code></pre class="example">
<td>X</td>
<td>X</td>
<td>X</td>
<td>process priotity</td>
<td>process priority</td>
</tr>
<tr>
<td></td>

2
docs/v4/docker.html
View File

@ -174,7 +174,7 @@
<td>X</td>
<td>X</td>
<td>X</td>
<td>has kernal memory</td>
<td>has kernel memory</td>
</tr>
<tr>
<td></td>

8
docs/v4/gettingstarted.html
View File

@ -57,7 +57,7 @@
<h2>Core Concept</h2>
<p><a href="https://nodejs.org/en/" rel="nofollow">Node.js</a> comes with some basic OS information, but I always wanted a little more. So I came up to write this
little library. This library is still work in progress. It requires node.js version 4.0 and above.</p>
little library. This library is still a work in progress. It requires node.js version 4.0 and above.</p>
<p>I was able to test it on several Debian, Raspbian, Ubuntu distributions as well as macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra, Mojave) and some Windows 7, Windows 10, FreeBSD, OpenBSD, NetBSD and SunOS machines.
Not all functions are supported on all operating systems. Have a look at the function reference in the docs to get further details.</p>
@ -85,7 +85,7 @@ si.cpu()
si.cpu(function(data) {
console.log('CPU Information:');
console.log('- manufucturer: ' + data.manufacturer);
console.log('- manufacturer: ' + data.manufacturer);
console.log('- brand: ' + data.brand);
console.log('- speed: ' + data.speed);
console.log('- cores: ' + data.cores);
@ -102,7 +102,7 @@ si.cpu(function(data) {
si.cpu()
.then(data => {
console.log('CPU Information:');
console.log('- manufucturer: ' + data.manufacturer);
console.log('- manufacturer: ' + data.manufacturer);
console.log('- brand: ' + data.brand);
console.log('- speed: ' + data.speed);
console.log('- cores: ' + data.cores);
@ -118,7 +118,7 @@ async function cpuData() {
try {
const data = await si.cpu();
console.log('CPU Information:');
console.log('- manufucturer: ' + data.manufacturer);
console.log('- manufacturer: ' + data.manufacturer);
console.log('- brand: ' + data.brand);
console.log('- speed: ' + data.speed);
console.log('- cores: ' + data.cores);

4
docs/v4/graphics.html
View File

@ -134,7 +134,7 @@
<td>X</td>
<td>X</td>
<td></td>
<td>true if dynamicly allocated ram</td>
<td>true if dynamically allocated ram</td>
</tr>
<tr>
<td></td>
@ -354,7 +354,7 @@
<td>X</td>
<td></td>
<td></td>
<td>true if built in monitor</td>
<td>true if built-in monitor</td>
</tr>
<tr>
<td></td>

2
docs/v4/processes.html
View File

@ -364,7 +364,7 @@ si.currentLoad().then(data => console.log(data));</code></pre class="example">
<td>X</td>
<td>X</td>
<td>X</td>
<td>process priotity</td>
<td>process priority</td>
</tr>
<tr>
<td></td>

4
docs/v4/wifi.html
View File

@ -124,7 +124,7 @@
<td>X</td>
<td>X</td>
<td></td>
<td>frequengy in MHz</td>
<td>frequency in MHz</td>
</tr>
<tr>
<td></td>
@ -144,7 +144,7 @@
<td>X</td>
<td>X</td>
<td></td>
<td>quaility in %</td>
<td>quality in %</td>
</tr>
<tr>
<td></td>

4
docs/wifi.html
View File

@ -125,7 +125,7 @@
<td>X</td>
<td>X</td>
<td></td>
<td>frequengy in MHz</td>
<td>frequency in MHz</td>
</tr>
<tr>
<td></td>
@ -145,7 +145,7 @@
<td>X</td>
<td>X</td>
<td></td>
<td>quaility in %</td>
<td>quality in %</td>
</tr>
<tr>
<td></td>