diff --git a/README.md b/README.md index 7e3bff0..9dc12b7 100644 --- a/README.md +++ b/README.md @@ -341,10 +341,10 @@ I also created a nice little command line tool called [mmon][mmon-github-url] ( | si.networkStats(iface,cb) | {...} | X | X | X | X | | current network stats of given interface
iface parameter is optional
defaults to first external network interface| | | iface | X | X | X | X | | interface | | | operstate | X | X | X | X | | up / down | -| | rx | X | X | X | X | | received bytes overall | +| | rx_bytes | X | X | X | X | | received bytes overall | | | rx_dropped | X | X | X | X | | received dropped overall | | | rx_errors | X | X | X | X | | received errors overall | -| | tx | X | X | X | X | | transferred bytes overall | +| | tx_bytes | X | X | X | X | | transferred bytes overall | | | tx_dropped | X | X | X | X | | transferred dropped overall | | | tx_errors | X | X | X | X | | transferred errors overall | | | rx_sec | X | X | X | X | | received bytes / second (* see notes) | diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 0000000..a2dad7b Binary files /dev/null and b/docs/assets/logo.png differ diff --git a/docs/assets/motherboard.jpg b/docs/assets/motherboard.jpg new file mode 100644 index 0000000..86e8074 Binary files /dev/null and b/docs/assets/motherboard.jpg differ diff --git a/docs/assets/trianglify.png b/docs/assets/trianglify.png new file mode 100644 index 0000000..b846ac8 Binary files /dev/null and b/docs/assets/trianglify.png differ diff --git a/docs/battery.html b/docs/battery.html new file mode 100644 index 0000000..24478a3 --- /dev/null +++ b/docs/battery.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Battery
+
+

In this section you will learn how to get battery information - if supported by system:

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

Battery Data

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.battery(cb){...}XXXXbattery information
hasbatteryXXXXindicates presence of battery
cyclecountXXnumbers of recharges
ischargingXXXXindicates if battery is charging
maxcapacityXXXmax capacity of battery
currentcapacityXXXcurrent capacity of battery
percentXXXXcharging level in percent
timeremainingXXminutes left (if discharging)
acconnectedXXXXAC connected
typeXXbattery type
modelXXmodel
manufacturerXXmanufacturer
serialXXbattery serial
+

Known issues

+

macOS - Temperature

+ +

To be able to measure temperature on macOS I created a little additional package. Due to some difficulties in NPM with optionalDependencies + I unfortunately was getting unexpected warnings on other platforms. So I decided to drop this optional dependency for macOS - so by default, + you will not get correct values.

+ +

But if you need to detect macOS temperature just run the following additional installation command:

+ +
$ npm install osx-temperature-sensor --save
+

systeminformation will then detect this additional library and return the temperature when calling systeminformations standard function cpuTemperature()

+ +

Windows Temperature

+ +

wmic - which is used to determine battery sometimes needs to be run with admin + privileges. So if you do not get any values, try to run it again with according privileges. If you still do not get any + values, your system might not support this feature.

+ +
+
+
+
+
+ +
+ + + + + + diff --git a/docs/contributors.html b/docs/contributors.html new file mode 100644 index 0000000..87e955e --- /dev/null +++ b/docs/contributors.html @@ -0,0 +1,105 @@ + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Contributors
+
+

Many thanks to all contributors. Really appreciate your support!

+ +

OSX Temperature: credits here are going to:

+ +

Many thanks also to all who provided help or filed an issue. This really helps improving this package!

+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/copyright.html b/docs/copyright.html new file mode 100644 index 0000000..c700fc8 --- /dev/null +++ b/docs/copyright.html @@ -0,0 +1,105 @@ + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Copyright Information
+
© 2019 Sebstian Hildebrandt, sebhildebrandt, +innovations
+
+
+
+
+
License MIT license
+
+

Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE.

+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/cpu.html b/docs/cpu.html new file mode 100644 index 0000000..a5a179b --- /dev/null +++ b/docs/cpu.html @@ -0,0 +1,469 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
CPU
+
+

In this section you will learn how to get CPU data including current speed and temperature:

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

CPU Data

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.cpu(cb){...}XXXXCPU information object
manufacturerXXXXe.g. 'Intel(R)'
brandXXXXe.g. 'Core(TM)2 Duo'
speedXXXXin GHz e.g. '3.40'
speedminXXXin GHz e.g. '0.80'
speedmaxXXXXin GHz e.g. '3.90'
coresXXXX# cores
physicalCoresXXXX# physical cores
processorsXXXX# processors
socketXXXsocket type e.g. "LGA1356"
vendorXXXXvendor ID
familyXXXXprocessor family
modelXXXXprocessor model
steppingXXXXprocessor stepping
revisionXXXrevision
voltageXvoltage
cacheXXXXcache in bytes (object)
cache.l1dXXXXL1D (data) size
cache.l1iXXXXL1I (instruction) size
cache.l2XXXXL2 size
cache.l3XXXXL3 size
si.cpuFlags(cb): stringXXXXCPU flags
si.cpuCache(cb){...}XXXXCPU cache sizes object
l1dXXXXL1D size
l1iXXXXL1I size
l2XXXXL2 size
l3XXXXL3 size
si.cpuCurrentspeed(cb){...}XXXXXcurrent CPU speed (GHz) object
avgXXXXXavg CPU speed (all cores)
minXXXXXmin CPU speed (all cores)
maxXXXXXmax CPU speed (all cores)
coresXXXXXCPU speed per core (array)
si.cpuTemperature(cb){...}XXX*XCPU temperature (if supported)
mainXXXXmain temperature (avg)
coresXXXXarray of temperatures
maxXXXXmax temperature
+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/docker.html b/docs/docker.html new file mode 100644 index 0000000..9944c6c --- /dev/null +++ b/docs/docker.html @@ -0,0 +1,519 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Docker
+
+

In this section you will learn how to get information about docker containers, stats and processes inside a docker container:

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

Container, Stats, Processes

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.dockerContainers(all, cb)[{...}]XXXXXreturns array of active/all docker containers
[0].idXXXXXID of container
[0].nameXXXXXname of container
[0].imageXXXXXname of image
[0].imageIDXXXXXID of image
[0].commandXXXXXcommand
[0].createdXXXXXcreation time
[0].stateXXXXXcreated, running, exited
[0].portsXXXXXarray of ports
[0].mountsXXXXXarray of mounts
si.dockerContainerStats(id, cb){...}XXXXXstatistics for a specific container
idXXXXXContainer ID
mem_usageXXXXXmemory usage in bytes
mem_limitXXXXXmemory limit (max mem) in bytes
mem_percentXXXXXmemory usage in percent
cpu_percentXXXXXcpu usage in percent
pidsXXXXXnumber of processes
netIO.rxXXXXXreceived bytes via network
netIO.wxXXXXXsent bytes via network
blockIO.rXXXXXbytes read from BlockIO
blockIO.wXXXXXbytes written to BlockIO
cpu_statsXXXXXdetailed cpu stats
percpu_statsXXXXXdetailed per cpu stats
memory_statsXXXXXdetailed memory stats
networksXXXXXdetailed network stats per interface
si.dockerContainerProcesses(id, cb)[{...}]XXXXXarray of processes inside a container
[0].pid_hostXXXXXprocess ID (host)
[0].ppidXXXXXparent process ID
[0].pgidXXXXXprocess group ID
[0].userXXXXXeffective user name
[0].ruserXXXXXreal user name
[0].groupXXXXXeffective group name
[0].rgroupXXXXXreal group name
[0].statXXXXXprocess state
[0].timeXXXXXaccumulated CPU time
[0].elapsedXXXXXelapsed running time
[0].niceXXXXXnice value
[0].rssXXXXXresident set size
[0].vszXXXXXvirtual size in Kbytes
[0].commandXXXXXcommand and arguments
si.dockerAll(cb){...}XXXXXlist of all containers including their stats
and processes in one single array
+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/filesystem.html b/docs/filesystem.html new file mode 100644 index 0000000..c7b5527 --- /dev/null +++ b/docs/filesystem.html @@ -0,0 +1,665 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Disks and File System
+
+

In this section you will learn how to get disks information, file system information disk I/O stats and file system stats:

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

Disk Layout, Block Devices and Disks IO

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.diskLayout(cb)[{...}]XXXphysical disk layout (array)
[0].typeXXXHD, SSD
[0].nameXXXdisk name
[0].vendorXXvendor/producer
[0].firmwareRevisionXXXfirmware revision
[0].serialNumXXXserial number
[0].interfaceTypeX
[0].sizeXXXsize in bytes
[0].totalCylindersXtotal cylinders
[0].totalHeadsXtotal heads
[0].totalTracksXtotal tracks
[0].tracksPerCylinderXtracks per cylinder
[0].sectorsPerTrackXsectors per track
[0].totalSectorsXtotal sectors
[0].bytesPerSectorXbytes per sector
[0].smartStatusXXXS.M.A.R.T Status (see Known Issues)
si.blockDevices(cb)[{...}]XXXreturns array of disks, partitions,
raids and roms
[0].nameXXXname
[0].typeXXXtype
[0].fstypeXXXfile system type (e.g. ext4)
[0].mountXXXmount point
[0].sizeXXXsize in bytes
[0].physicalXXXphysical type (HDD, SSD, CD/DVD)
[0].uuidXXXUUID
[0].labelXXXlabel
[0].modelXXmodel
[0].serialXXserial
[0].removableXXXserial
[0].protocolXXprotocol (SATA, PCI-Express, ...)
si.disksIO(cb){...}XXcurrent transfer stats
rIOXXread IOs on all mounted drives
wIOXXwrite IOs on all mounted drives
tIOXXwrite IOs on all mounted drives
rIO_secXXread IO per sec (* see notes)
wIO_secXXwrite IO per sec (* see notes)
tIO_secXXtotal IO per sec (* see notes)
msXXinterval length (for per second values)
+

File System and File System Stats

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.fsSize(cb)[{...}]XXXXreturns array of mounted file systems
[0].fsXXXXname of file system
[0].typeXXXXtype of file system
[0].sizeXXXXsizes in bytes
[0].usedXXXXused in bytes
[0].useXXXXused in %
[0].mountXXXXmount point
si.fsStats(cb){...}XXcurrent transfer stats
rxXXbytes read since startup
wxXXbytes written since startup
txXXtotal bytes read + written since startup
rx_secXXbytes read / second (* see notes)
wx_secXXbytes written / second (* see notes)
tx_secXXtotal bytes reads + written / second
msXXinterval length (for per second values)
+

Getting correct stats values

+ +

In disksIO() and fsStats() the + results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning with the second call of the function. + It is determined by calculating the difference of transferred bytes / IOs divided by the time between two calls of the function.

+ +

The first time you are calling one of this functions, you will get -1 for transfer rates. + The second time, you should then get statistics based on the time between the two calls ...

+ +

So basically, if you e.g. need a values for filesystem stats stats every second, your code should look like this:

+ +
const si = require('systeminformation');
+
+setInterval(function() {
+    si.fsStats().then(data => {
+        console.log(data);
+    })
+}, 1000)
+

Beginning with the second call, you get network transfer values per second.

+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/general.html b/docs/general.html new file mode 100644 index 0000000..7f67dda --- /dev/null +++ b/docs/general.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
General
+
+

In this section you will learn how to get general systeminformation data. We will also cover the "get-all" functions to get all data at once.

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

Lib-Version and Time/Timezone

+

The first two functions just gibe back system information library version and time/timezone information of your machine:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.version(): stringXXXXXlib version (no callback/promise)
si.time(){...}XXXXXobject (no callback/promise) with:
currentXXXXXlocal (server) time
uptimeXXXXXuptime
timezoneXXXXXe.g. GMT+0200
timezoneNameXXXXXe.g. CEST
+

Keep in mind, that there is another function si.versions() that will return versions of other system libraries and software packages

+

Get All At Once

+

The following three functions si.getStaticData(), si.getDynamicData() and si.getAllData() will return most of the available data in a single result object:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.getStaticData(cb){...}XXXXXall static data at once
si.getDynamicData(srv,iface,cb){...}XXXXXall dynamic data at once
si.getAllData(srv,iface,cb){...}XXXXXall data at once
+

Static data is all hardware related (or more or less constant) data like system, baseboard, bios, OS, versions, cpu, network interfces, memory and disk layout

+

Dynamic data will return user, cpu-speed, load, processes, services, temperature, file system, network and disk stats, ...

+

As not all funtions are supported in each operating system the result object might be different in each OS.

+

ATTENTION: Use this only if you really need ALL information. Especially on Windows this can take really long (up to 20 seconds) because the underlying WMIC command is very slow when using it the first time.

+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/gettingstarted.html b/docs/gettingstarted.html new file mode 100644 index 0000000..2f626a6 --- /dev/null +++ b/docs/gettingstarted.html @@ -0,0 +1,167 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Quick Start
+
+

Lightweight collection of 35+ functions to retrieve detailed hardware, system and OS information.

+
    +
  • simple to use
  • +
  • get detailed information about system, cpu, baseboard, battery, memory, disks/filesystem, network, docker, software, services and processes
  • +
  • supports Linux, macOS, partial Windows, FreeBSD and SunOS support
  • +
  • no npm dependencies (for production)
  • +
+ +

Core Concept

+

Node.js 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 definilely 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) and some Windows 7, Windows 10, FreeBSD 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.

+

If you have comments, suggestions & reports, please feel free to contact me on github!

+

I also created a nice little command line tool called mmon (micro-monitor) for Linux and macOS, also available via github and npm

+ + +

Installation

+
$ npm install systeminformation --save
+

Usage

+

All functions (except version and time) are implemented as asynchronous functions. Here a small example how to use them:

+
const si = require('systeminformation');
+
+// promises style - new since version 3
+si.cpu()
+    .then(data => console.log(data))
+    .catch(error => console.error(error));
+
+

Callback, Promises, Awync Await

+

Remember: all functions (except version and time) are implemented as asynchronous functions! There are now three ways to consume them:

+

Callback Style

+
const si = require('systeminformation');
+
+si.cpu(function(data) {
+    console.log('CPU Information:');
+    console.log('- manufucturer: ' + data.manufacturer);
+    console.log('- brand: ' + data.brand);
+    console.log('- speed: ' + data.speed);
+    console.log('- cores: ' + data.cores);
+    console.log('- physical cores: ' + data.physicalCores);
+    console.log('...');
+})

+

Promise Style

+

Promises style is new since version 3.0.

+ +

When omitting callback parameter (cb), then you can use all function in a promise oriented way. All functions (exept of version and time) are returning a promise, that you can consume:

+
const si = require('systeminformation');
+
+si.cpu()
+    .then(data => {
+        console.log('CPU Information:');
+        console.log('- manufucturer: ' + data.manufacturer);
+        console.log('- brand: ' + data.brand);
+        console.log('- speed: ' + data.speed);
+        console.log('- cores: ' + data.cores);
+        console.log('- physical cores: ' + data.physicalCores);
+        console.log('...');
+    })
+    .catch(error => console.error(error));

+

Async/Await Style

+

Since node v7.6 you can also use the async / await pattern. The above example would then look like this:

+
const si = require('systeminformation');
+
+async function cpuData() {
+    try {
+        const data = await si.cpu();
+        console.log('CPU Information:');
+        console.log('- manufucturer: ' + data.manufacturer);
+        console.log('- brand: ' + data.brand);
+        console.log('- speed: ' + data.speed);
+        console.log('- cores: ' + data.cores);
+        console.log('- physical cores: ' + data.physicalCores);
+        console.log('...');
+    } catch (e) {
+        console.log(e)
+    }
+}

+ +
+
+
+
+
+ +
+ + + + + + diff --git a/docs/graphics.html b/docs/graphics.html new file mode 100644 index 0000000..ec08528 --- /dev/null +++ b/docs/graphics.html @@ -0,0 +1,279 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Graphics
+
+

In this section you will learn how to get information about installed graphics conrollers and connected displays:

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

Graphics Controllers, Displays

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.graphics(cb){...}XXXarrays of graphics controllers and displays
controllers[]XXXgraphics controllers array
...[0].modelXXXgraphics controller model
...[0].vendorXXXe.g. ATI
...[0].busXXXon which bus (e.g. PCIe)
...[0].vramXXXVRAM size (in MB)
...[0].vramDynamicXXXtrue if dynamicly allocated ram
displays[]XXXmonitor/display Array
...[0].modelXXXmonitor/display Model
...[0].mainXXtrue if main monitor
...[0].builtinXXtrue if built in monitor
...[0].connectionXXe.g. DisplayPort or HDMI
...[0].sizexXXsize in mm horizontal
...[0].sizeyXXsize in mm vertical
...[0].pixeldepthXXXcolor depth in bits
...[0].resolutionxXXXpixel horizontal
...[0].resolutionyXXXpixel vertical
+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/history.html b/docs/history.html new file mode 100644 index 0000000..af69d19 --- /dev/null +++ b/docs/history.html @@ -0,0 +1,1076 @@ + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Version History
+
+

Major (breaking) Changes - Version 4

+
    +
  • ... will be released soon ...
  • +
+

Major (breaking) Changes - Version 3

+
    +
  • works only with node.js v4.0.0 and above (using now internal ES6 promise function, arrow functions, ...)
  • +
  • Promises. As you can see in the documentation, you can now also use it in a promise oriented way. But callbacks are still supported.
  • +
  • Async/Await. Due to the promises support, systeminformation also works perfectly with the `async/await` pattern (available in node.js v7.6.0 and above). See example in the docs.
  • +
+

Full version history

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VersionDateComment
3.54.02018-12-30added TypeScript type definitions
3.53.12018-12-29versions() bug fix nginx version
3.53.02018-12-29versions() added perl, python, gcc
3.52.72018-12-29versions() bug fix macOS detection
3.52.62018-12-28versions() bug fix macOS
3.52.52018-12-28preparing automated tests, travis-ci integration, added dev-dependencies
3.52.42018-12-27graphics().controllers bugfix linux
3.52.32018-12-27os().codepage bugfix
3.52.22018-12-17code cleanup
3.52.12018-12-17inetChecksite() bugfix windows
3.52.02018-12-15cpu() added physical cores, processors, socket type
3.51.42018-12-05versions() bugfix, optimization postgres
3.51.32018-11-27mem() refactoring parsing linux, code cleanup
3.51.22018-11-26mem() bugfix parsing free output linux
3.51.12018-11-26processLoad() bugfix windows
3.51.02018-11-25processLoad() added for windows
3.50.32018-11-25processLoad(), services() fixed cpu data (linux)
3.50.22018-11-23network mac adresses: ip support fix
3.50.12018-11-23services() added possibility to specify ALL services "*" for win
3.50.02018-11-23services() added possibility to specify ALL services "*" for linux
3.49.42018-11-21battery() timeremaining optimization (linux) thanks to Jorai Rijsdijk
3.49.32018-11-20memLayout() optimized parsing (win)
3.49.22018-11-19code cleanup
3.49.12018-11-19cpu().brand removed extra spaces, tabs
3.49.02018-11-19added system uuid() (os specific), versions() added postgresql
3.48.42018-11-18windows: garbled output because of codepage
3.48.32018-11-18dockerContainerStats() fixed issue cpu_percent win
3.48.22018-11-18dockerContainerStats() fixed issue cpu_percent, win exec
3.48.12018-11-17docker...() fixed issue parsing docker socket JSON
3.48.02018-11-17diskLayout() better interface detection (WIN), osInfo() added build, serial
3.47.02018-11-06versions() added docker, postfix
3.46.02018-11-05fixed issue versions(), added system openssl version
3.45.102018-11-03fixed issue battery(), modified package.json - files
3.45.92018-10-22fixed node 4 incompatibility
3.45.82018-10-22system() fix Raspberry Pi detection
3.45.72018-10-05fixed typos
3.45.62018-09-12mem() bug parsing linux in other languages
3.45.52018-09-07diskLayout() tiny bug S.M.A.R.T status windows
3.45.42018-09-06added icon to README.md
3.45.32018-09-06diskLayout() optimized media type detection (HD, SSD) on Windows
3.45.22018-09-05updated imags shields icons
3.45.12018-09-05updated documentation
3.45.02018-09-04diskLayout() added smartStatus
3.44.22018-08-28added code quality badges
3.44.12018-08-28code cleanup
3.44.02018-08-25battery() bugfix & added type, model, manufacturer, serial
3.43.02018-08-25cpuCurrentspeed() added cpu speed for all cores
3.42.102018-08-25processes() optimized start time parsing
3.42.92018-08-08cpuTemperature() optimized parsing
3.42.82018-08-03updated docs
3.42.72018-08-03processes() optimized parsing ps name
3.42.62018-08-03processes() bugfix parsing ps linux
3.42.52018-08-03processes() bugfix parsing ps linux
3.42.42018-07-09cpuTemperature() bugfix parsing negative values
3.42.32018-07-05services() bugfix not finding services with capital letters
3.42.22018-07-03users() optimized results if lack of permissions
3.42.12018-07-03versions() bugfix git version macOS
3.42.02018-06-01processes() added parent process PID
3.41.42018-05-28windows exec WMIC in try catch
3.41.32018-05-13improved SunOS support getStaticData(), getDynamicData()
3.41.22018-05-13bugfix system() and flags() Raspberry Pi
3.41.12018-05-11updated docs
3.41.02018-05-11system() Raspberry Pi bugfix and extended detection, added partial SunOS support
3.40.12018-05-10bugfix system().sku (windows)
3.40.02018-04-29extended versions() (php, redis, mongodb)
3.39.02018-04-29added versions().mysql and versions().nginx, starting SunOS> support (untested)
3.38.02018-04-06added battery().acconnected
3.37.122018-04-05another optimization battery().ischarging for macOS
3.37.112018-04-05another optimization battery().ischarging for macOS
3.37.102018-04-05battery().ischarging optimized for macOS
3.37.92018-04-03optimized processes(), bugfix networkInterfaceDefault()
3.37.82018-03-25optimized networkDefaultInterface() detection, fixed network operstate> MacOS
3.37.72018-03-13celebrating 4th birthday
3.37.62018-03-12updated docs: fixed diskLayout>and mamlayout>
3.37.52018-03-12added support for ip> instead of ifconfig>
3.37.42018-02-22bugfix windows processes(), disklayout()
3.37.32018-02-19added windows exec windowsHide option
3.37.22018-02-15fixed bug battery().percent for macOS
3.37.12018-02-13fixed bug battery().ischarging for macOS
3.37.02018-02-11extended FreeBSD support networkStats()
3.36.02018-02-11extended FreeBSD support networkConnections()
3.35.02018-02-11extended FreeBSD support processLoad()
3.34.12018-02-11updated docs
3.34.02018-02-10first partial FreeBSD support
3.33.152018-01-21optimized OSX battery
3.33.142018-01-17bugfix diskLayout() (Windows)
3.33.132018-01-12bugfix memLayout() (Windows)
3.33.122017-12-25fixed typos
3.33.112017-12-17updated docs
3.33.102017-12-14bugfix WMIC blockDevice parse (Windows 7)
3.33.92017-12-14bugfix WMIC not found (Windows)
3.33.82017-12-02bugfix diskLayout().size (OSX)
3.33.72017-11-28bugfix diskLayout().size
3.33.62017-11-16bugfix diskLayout().size
3.33.52017-11-09code cleanup
3.33.42017-11-09bugfix graphics controller win (bytes)
3.33.32017-11-08bugfix cpu speed arm - type
3.33.22017-11-08bugfix cpu speed arm
3.33.12017-11-07improved bios and main board information
3.33.02017-11-07added bios and main board information
3.32.42017-11-02AMD cpu base frequencies table also for windows
3.32.32017-11-02code cleanup, AMD cpu base frequencies table
3.32.22017-11-01bugfix JSON.parse error blockDevices()
3.32.12017-10-23updated docs
3.32.02017-10-23extended memLayout() - added manufacturer
3.31.42017-10-21updated README.md
3.31.32017-10-21bugfix graphics(), fixed typo README.md
3.31.22017-10-16bugfix graphics() vendor and model parsing linux VGA/3D
3.31.12017-10-16bugfix graphics() vendor and model parsing linux
3.31.02017-10-15extended windows support cpuFlags() (partially)
3.30.62017-10-05updated community profile
3.30.52017-10-05bugfix users() - parsing values on windows
3.30.42017-10-03bugfix cpuTemperature() - parsing values on windows
3.30.32017-10-03bugfix cpuTemperature() - max value on windows
3.30.22017-09-26bugfix networkInterfaces() - optimized ip6 address selection
3.30.12017-09-21bugfix/typo inetChecksite()
3.30.02017-09-21extended versions() (added yarn, gulp, grunt, tsc, git)
3.29.02017-09-15extended windows support services(), optimized diskLayout() (OSX), bugfixes
3.28.02017-09-14extended windows support processes()
3.27.12017-09-13updated Raspberry version detection system() (Pi 3, Zero)
3.27.02017-09-12added raw data to currentLoad(), fixed networkInterfaces() MAC problem node 8.x
3.26.22017-09-01removed redundant code
3.26.12017-08-23fixed cpu().speed windows / AMD, updated docs
3.26.02017-08-21extended getDynamicData() (windows), updated docs
3.25.12017-08-07updated docs
3.25.02017-08-07improved windows support networkStats(), cpuCache(), bug fix getStaticData()
3.24.02017-08-05extended windows support networkStats(), networkConnections()
3.23.72017-07-11bug fix diskLayout()
3.23.62017-07-11added cpuFlags() to getStaticData(), bug fix graphics() (Win)
3.23.52017-06-29bug fix inetChecksite()
3.23.42017-06-24bug fix getDynamicData(), getAllData() - mem
3.23.32017-06-23updated docs
3.23.22017-06-23bug fix battery (windows)
3.23.12017-06-22updated docs
3.23.02017-06-22added memLayout, diskLayout, extended windows support (inetChecksite
3.22.02017-06-19extended windows support (users, inetLatency)
3.21.02017-06-18extended time (timezone), extended windows support (battery, getAll...)
3.20.12017-06-17updated docs
3.20.02017-06-16extend WIN support (cpu, cpuCache, cpuCurrentspeed, mem, networkInterfaces, docker)
3.19.02017-06-12OSX temperature now an optional dependency
3.18.02017-05-27extended cpu info (vendor, family, model, stepping, revision, cache, speedmin/max)
3.17.32017-04-29minor fix (blockDevices data array, Windows)
3.17.22017-04-24minor fix (removed console.log)
3.17.12017-04-23fixed bugs fsSize(win), si.processes (command), si.osinfo(win)
3.17.02017-02-19windows support for some first functions, extended process list (linux
3.16.02017-01-19blockDevices: added removable attribute + fix
3.15.12017-01-17minor cpuTemperature fix (OSX)
3.15.02017-01-15added cpuTemperature also for OSX
3.14.02017-01-14added currentLoad per cpu/core, cpu cache and cpu flags
3.13.02016-11-23added shell (returns standard shell)
3.12.02016-11-17refactoring and extended currentLoad
3.11.22016-11-16blockDevices: improved for older lsblk versions
3.11.12016-11-16fixed small bug in blockDevices
3.11.02016-11-15blockDevices for OSX and extended blockDevices
3.10.22016-11-14bug fix fsSize on OSX
3.10.12016-11-14optimization fsStats, disksIO, networkStats
3.10.02016-11-12added blockDevices, fixed fsSize, added file system type
3.9.02016-11-11added MAC address to networkInterfaces, fixed currentLoad
3.8.12016-11-04updated docs
3.8.02016-11-04added dockerContainerProcesses
3.7.12016-11-03code refactoring
3.7.02016-11-02extended docker stats, and no longer relying on curl
3.6.02016-09-14added versions (kernel, ssl, node, npm, pm2, ...)
3.5.12016-09-14bugfix graphics info
3.5.02016-09-14added graphics info (controller, display)
3.4.42016-09-02tiny fixes system.model, getDefaultNetworkInterface
3.4.32016-09-02tiny bug fix fsStats, disksIO OSX
3.4.22016-09-01improved default network interface
3.4.12016-08-30updated docs
3.4.02016-08-30rewritten processes current cpu usage
3.3.02016-08-24process list added to processes
3.2.12016-08-19updated docs, improvement system
3.2.02016-08-19added battery information
3.1.12016-08-18improved system and os detection (vm, ...), bugfix disksIO
3.1.02016-08-18added Docker stats
3.0.12016-08-17Bug-Fix disksIO, users, updated docs
3.0.02016-08-03new major version 3.0
2.0.52016-03-02changed .gitignore
2.0.42016-02-22tiny correction - removed double quotes CPU brand, ...
2.0.32016-02-22optimized cpuCurrentspeed
2.0.22016-02-22added CoreOS identification
2.0.12016-01-07minor patch
2.0.02016-01-07new major version 2.0
1.0.72015-11-27fixed: si.network_speed()
1.0.62015-09-17fixed: si.users()
1.0.52015-09-14updated dependencies
1.0.42015-07-18updated docs
1.0.32015-07-18bugfix cpu cores
1.0.22015-07-18bugfix cpu_currentspeed, cpu_temperature
1.0.12015-07-18documentation update
1.0.02015-07-18bug-fixes, version bump, published as npm component
0.0.32014-04-14bug-fix (cpu_speed)
0.0.22014-03-14Optimization FS-Speed & CPU current speed
0.0.12014-03-13initial release
+
+
+
+
+
+ +
+ + + + + + + diff --git a/docs/index.html b/docs/index.html index 6b77f22..aaa6e7c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,16 +1,194 @@ - + - - - - systeminformation + + + + + + + + + + systeminformation + + - -

systeminformation

-

Simple system and OS information library for node.js

+ +
+ +
systeminformation
+
Simple system and OS information library for node.js
+
Current Version: 4.0.0
+
View on Github
+
+ +
+
+
+
Quick Start
+
Lightweight collection of 35+ functions to retrieve detailed hardware, system and OS information. For Linux, macOS, partial Windows, FreeBSD and SunOS support
+
+
+
+
+
+
+
+
+
+
7,676
+
Lines of code
+
+
+
...
+
Downloads last month
+
+
+
115
+
Dependends
+
+
+
+
+
+
+
+
+
+
Documentation
+
Detailed documentation and reference for Version 4.x.x
+
+
+
+ +
+
Getting Started
+
+ +
+
General
+
+ +
+
System
+
+ +
+
CPU
+
+ +
+
Memory
+
+ +
+
Battery
+
+ +
+
Disks / FS
+
+ +
+
Graphics
+
+ +
+
OS
+
+ +
+
Network
+
+ +
+
Processes / Load
+
+ +
+
Docker
+
+
+
+
+
+
+
+
+
+
Issues
+
If you run into problems, please check out known issues page first. If you still have problems, please feel free to open an issue on our github page


+
+
+
+ + + + + - \ No newline at end of file + diff --git a/docs/issues.html b/docs/issues.html new file mode 100644 index 0000000..aedc13c --- /dev/null +++ b/docs/issues.html @@ -0,0 +1,116 @@ + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Known Issues
+
+

macOS - Temperature

+ +

To be able to measure temperature on macOS I created a little additional package. Due to some difficulties in NPM with optionalDependencies + I unfortunately was getting unexpected warnings on other platforms. So I decided to drop this optional dependency for macOS - so by default, + you will not get correct values.

+ +

But if you need to detect macOS temperature just run the following additional installation command:

+ +
$ npm install osx-temperature-sensor --save
+

systeminformation will then detect this additional library and return the temperature when calling systeminformations standard function cpuTemperature()

+ +

Windows Temperature, Battery, ...

+ +

wmic - which is used to determine temperature and battery sometimes needs to be run with admin + privileges. So if you do not get any values, try to run it again with according privileges. If you still do not get any + values, your system might not support this feature. In some cases we also discovered that wmic returned incorrect temperature values.

+ +

Linux Temperature

+ +

In some cases you need to install the linux sensors package to be able to measure temperature e.g. on DEBIAN based systems by running

+
$ sudo apt-get install lm-sensors
+ +

Linux S.M.A.R.T. Status

+ +

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
+ +

Stats Functions

+

To get correct values with fsStats(), disksIO() and networkStats() please check this guide

+ +

Finding New Issues

+

If you still have problems, please feel free to open an issue on our github page

+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/main.js b/docs/main.js new file mode 100644 index 0000000..a504cce --- /dev/null +++ b/docs/main.js @@ -0,0 +1,57 @@ +function createMenu() { + var menu = [ + [0, '', 'Documentation'], + [1, 'gettingstarted', 'Getting Started'], + [1, 'general', 'General'], + [1, 'system', 'System'], + [1, 'cpu', 'CPU'], + [1, 'memory', 'Memory'], + [1, 'battery', 'Battery'], + [1, 'filesystem', 'Disks / FS'], + [1, 'graphics', 'Graphics'], + [1, 'os', 'OS'], + [1, 'network', 'Network'], + [1, 'processes', 'Processes / Services'], + [1, 'docker', 'Docker'], + [0, '', 'More'], + [1, 'history', 'Version history'], + [1, 'issues', 'Known Issues'], + [1, 'statsfunctions', 'Stats Functions'], + [1, 'copyright', 'Copyright & License'], + [1, 'contributors', 'Contributors'], + [1, 'trademarks', 'Trademarks'], + ]; + + var path = window.location.pathname; + var page = path.split("/").pop().replace('.html', ''); + + var menuParent = document.getElementById('menu'); + var titleElement; + var ulElement; + var hrElement; + var liElement; + var aElement; + for (let item of menu) { + if (item[0] === 0) { + titleElement = document.createElement('div'); + titleElement.classList.add("title"); + titleElement.innerText = item[2]; + menuParent.appendChild(titleElement); + hrElement = document.createElement('hr'); + titleElement.appendChild(hrElement); + ulElement = document.createElement('ul'); + titleElement.appendChild(ulElement); + } else { + liElement = document.createElement('li'); + if (page === item[1]) { + liElement.classList.add("active"); + } + aElement = document.createElement('a'); + aElement.setAttribute('href', item[1] + '.html'); + aElement.innerText = item[2]; + ulElement.appendChild(liElement); + liElement.appendChild(aElement); + } + } +} + diff --git a/docs/memory.html b/docs/memory.html new file mode 100644 index 0000000..eb344bb --- /dev/null +++ b/docs/memory.html @@ -0,0 +1,329 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Memory
+
+

In this section you will learn how to get overall memory information (usage by OS) and memory module layout:

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

System Memory and Memory Layout

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.mem(cb){...}XXXXXMemory information (object)
totalXXXXXtotal memory in bytes
freeXXXXXnot used in bytes
usedXXXXXused (incl. buffers/cache)
activeXXXXXused actively (excl. buffers/cache)
buffcacheXXXXused by buffers+cache
availableXXXXXpotentially available (total - active)
swaptotalXXXXX
swapusedXXXXX
swapfreeXXXXX
si.memLayout(cb)[{...}]XXXXMemory Layout (array of objects)
[0].sizeXXXXsize in bytes
[0].bankXXXmemory bank
[0].typeXXXXmemory type
[0].clockSpeedXXXXclock speed
[0].formFactorXXXform factor
[0].manufacturerXXXXmanufacturer
[0].partNumXXXXpart number
[0].serialNumXXXXserial number
[0].voltageConfiguredXXXvoltage conf.
[0].voltageMinXXXvoltage min
[0].voltageMaxXXXvoltage max
+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/network.html b/docs/network.html new file mode 100644 index 0000000..df10446 --- /dev/null +++ b/docs/network.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Network
+
+

In this section you will learn how to get detailed information about network interfaces, network connections and statistics as well as some internet related information (latency, check availability of site):

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

Network Interfaces, Network Stats, Network Connections

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.networkInterfaces(cb)[{...}]XXXXXarray of network interfaces
[0].ifaceXXXXXinterface name
[0].ip4XXXXXip4 address
[0].ip6XXXXXip6 address
[0].macXXXXXMAC address
[0].internalXXXXXtrue if internal interface
si.networkInterfaceDefault(cb): stringXXXXXget name of default network interface
si.networkStats(iface,cb){...}XXXXcurrent network stats of given interface
iface parameter is optional
defaults to first external network interface
ifaceXXXXinterface
operstateXXXXup / down
rxXXXXreceived bytes overall
txXXXXtransferred bytes overall
rx_secXXXXreceived bytes / second (* see notes)
tx_secXXXXtransferred bytes per second (* see notes)
msXXXXinterval length (for per second values)
si.networkConnections(cb)[{...}]XXXXcurrent network network connections
returns an array of all connections
[0].protocolXXXXtcp or udp
[0].localaddressXXXXlocal address
[0].localportXXXXlocal port
[0].peeraddressXXXXpeer address
[0].peerportXXXXpeer port
[0].stateXXXXlike ESTABLISHED, TIME_WAIT, ...
+

Site availability, Internet Latency

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.inetChecksite(url, cb){...}XXXXXresponse-time (ms) to fetch given URL
urlXXXXXgiven url
okXXXXXstatus code OK (2xx, 3xx)
statusXXXXXstatus code
msXXXXXresponse time in ms
si.inetLatency(host, cb): numberXXXXXresponse-time (ms) to external resource
host parameter is optional (default 8.8.8.8)
+

Getting correct stats values

+ +

In networkStats() the + results / sec. values (rx_sec, tx_sec, ...) are calculated correctly beginning with the second call of the function. + It is determined by calculating the difference of transferred bytes / IOs divided by the time between two calls of the function.

+ +

The first time you are calling one of this functions, you will get -1 for transfer rates. + The second time, you should then get statistics based on the time between the two calls ...

+ +

So basically, if you e.g. need a values for filesystem stats stats every second, your code should look like this:

+ +
const si = require('systeminformation');
+
+setInterval(function() {
+    si.networkStats().then(data => {
+        console.log(data);
+    })
+}, 1000)
+

Beginning with the second call, you get network transfer values per second.

+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/os.html b/docs/os.html new file mode 100644 index 0000000..b2772a7 --- /dev/null +++ b/docs/os.html @@ -0,0 +1,339 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
OS
+
+

In this section you will learn how to get information about the installed operating system, versions of installed development specific software packages, shell and users online:

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

Operating System, Shell, Versions, Users

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.osInfo(cb){...}XXXXXOS information
platformXXXXX'Linux', 'Darwin', 'Windows'
distroXXXXX
releaseXXXXX
codenameX
kernelXXXXXkernel release - same as os.release()
archXXXXXsame as os.arch()
hostnameXXXXXsame as os.hostname()
codepageXXXXOS build version
logofileXXXXXe.g. 'apple', 'debian', 'fedora', ...
serialXXXOS/Host serial number
buildXXOS build version
si.uuid(cb){...}XXXXXobject of several UUIDs
osXXXXos specific UUID
si.shell(cb): stringXXXstandard shell
si.versions(cb){...}XXXXXversion information (kernel, ssl, node, ...)
si.users(cb)[{...}]XXXXXarray of users online
[0].userXXXXXuser name
[0].ttyXXXXXterminal
[0].dateXXXXXlogin date
[0].timeXXXXXlogin time
[0].ipXXXXip address (remote login)
[0].commandXXXXlast command or shell
+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/processes.html b/docs/processes.html new file mode 100644 index 0000000..f3329b1 --- /dev/null +++ b/docs/processes.html @@ -0,0 +1,579 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Processes and Services
+
+

In this section you will learn how to get information about current load, running processes and installed services:

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

Current Load, Processes, Services

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.currentLoad(cb){...}XXXXCPU-Load
avgloadXXXXaverage load
currentloadXXXXCPU load in %
currentload_userXXXXCPU load user in %
currentload_systemXXXXCPU load system in %
currentload_niceXXXXCPU load nice in %
currentload_idleXXXXCPU load idle in %
currentload_irqXXXXCPU load system in %
raw_currentload...XXXXCPU load raw values (ticks)
cpus[]XXXXcurrent loads per CPU in % + raw ticks
si.fullLoad(cb): integerXXXCPU full load since bootup in %
si.processes(cb){...}XXXXX# running processes
allXXXXX# of all processes
runningXXXXX# of all processes running
blockedXXXXX# of all processes blocked
sleepingXXXXX# of all processes sleeping
unknownX# of all processes unknown status
list[]XXXXXlist of all processes incl. details
...[0].pidXXXXXprocess PID
...[0].parentPidXXXXXparent process PID
...[0].nameXXXXXprocess name
...[0].pcpuXXXXXprocess % CPU usage
...[0].pcpuuXXXprocess % CPU usage (user)
...[0].pcpusXXXprocess % CPU usage (system)
...[0].pmemXXXXXprocess memory %
...[0].priorityXXXXXprocess priotity
...[0].mem_vszXXXXXprocess virtual memory size
...[0].mem_rssXXXXXprocess mem resident set size
...[0].niceXXXXprocess nice value
...[0].startedXXXXXprocess start time
...[0].stateXXXXXprocess state (e.g. sleeping)
...[0].ttyXXXXtty from which process was started
...[0].userXXXXuser who started process
...[0].commandXXXXXprocess starting command
si.processLoad('apache2',cb){...}XXXXdetailed information about given process
procXXXXprocess name
pidXXXXPID
pidsXXXXadditional pids
cpuXXXXprocess % CPU
memXXXXprocess % MEM
si.services('mysql, apache2', cb)[{...}]XXXXpass comma separated string of services
pass "*" for ALL services (linux/win only)
[0].nameXXXXname of service
[0].runningXXXXtrue / false
[0].startmodeXmanual, automatic, ...
[0].pidsXXXpids
[0].pcpuXXXprocess % CPU
[0].pmemXXXprocess % MEM
+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/statsfunctions.html b/docs/statsfunctions.html new file mode 100644 index 0000000..5915f62 --- /dev/null +++ b/docs/statsfunctions.html @@ -0,0 +1,104 @@ + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Stats Functions
+
+

Getting correct stats values

+ +

In fsStats(), disksIO() and networkStats() the + results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning with the second call of the function. + It is determined by calculating the difference of transferred bytes / IOs divided by the time between two calls of the function.

+ +

The first time you are calling one of this functions, you will get -1 for transfer rates. + The second time, you should then get statistics based on the time between the two calls ...

+ +

So basically, if you e.g. need a values for network stats every second, your code should look like this:

+ +
const si = require('systeminformation');
+
+setInterval(function() {
+    si.networkStats().then(data => {
+        console.log(data);
+    })
+}, 1000)
+

Beginning with the second call, you get network transfer values per second.

+ +
+
+
+
+
+ +
+ + + + + + diff --git a/docs/styles.css b/docs/styles.css new file mode 100644 index 0000000..ce8c2e8 --- /dev/null +++ b/docs/styles.css @@ -0,0 +1,520 @@ +body { + font-family: -apple-system, BlinkMacSystemFont, "segoe ui", Roboto, Helvetica, Arial, sans-serif, "apple color emoji", "segoe ui emoji", "segoe ui symbol"; + font-weight: 300; + -webkit-font-smoothing: antialiased; +} + +h1, h2, h3, h4 { + font-family: -apple-system, BlinkMacSystemFont, "segoe ui", Roboto, Helvetica, Arial, sans-serif, "apple color emoji", "segoe ui emoji", "segoe ui symbol"; + font-weight: 300; +} + +.center { + text-align: center; +} + +.bg-image-full { + background: no-repeat center center scroll; + background-size: cover; + -o-background-size: cover; + height: 280px; + opacity: 0.95; + filter: alpha(opacity=90); + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-pack: center; + -ms-flex-pack: center; + justify-content: center; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + -webkit-box-orient: vertical; + -webkit-box-direction: normal; + -ms-flex-direction: column; + flex-direction: column; +} + +@media only screen and (min-width: 420px) { + .bg-image-full { + height: 360px; + } +} + +@media only screen and (min-width: 768px) { + .bg-image-full { + height: 400px; + } +} + +@media only screen and (min-width: 1024px) { + .bg-image-full { + height: 450px; + } +} + +@media only screen and (min-width: 1200px) { + .bg-image-full { + height: 550px; + } +} + +.bg-image-full .title { + color: #fff; + padding-top: 10px; + font-size: 1.8rem; +} + +@media only screen and (min-width: 420px) { + .bg-image-full .title { + font-size: 2.4rem; + } +} + +@media only screen and (min-width: 768px) { + .bg-image-full .title { + font-size: 3.2rem; + } +} + +@media only screen and (min-width: 1024px) { + .bg-image-full .title { + font-size: 4rem; + } +} + +.bg-image-full .logo { + width: 100px; +} + +@media only screen and (min-width: 420px) { + .bg-image-full .logo { + width: 120px; + } +} + +@media only screen and (min-width: 768px) { + .bg-image-full .logo { + width: 160px; + } +} + +@media only screen and (min-width: 1024px) { + .bg-image-full .logo { + width: 200px; + } +} + +.bg-image-full .subtitle { + text-align: center; + color: #bbb; + font-size: 0.9rem; +} + +@media only screen and (min-width: 420px) { + .bg-image-full .subtitle { + font-size: 1rem; + } +} + +@media only screen and (min-width: 768px) { + .bg-image-full .subtitle { + font-size: 1.1rem; + } +} + +@media only screen and (min-width: 1024px) { + .bg-image-full .subtitle { + font-size: 1.3rem; + } +} + +.bg-image-full .text > a { + text-align: center; + color: #fff; + font-size: 0.9rem; +} + +.bg-image-full .text > a:hover { + color: #aaa; + text-decoration: none; +} + +@media only screen and (min-width: 420px) { + .bg-image-full .text > a { + font-size: 1rem; + } +} + +@media only screen and (min-width: 768px) { + .bg-image-full .text > a { + font-size: 1rem; + } +} + +@media only screen and (min-width: 1024px) { + .bg-image-full .text > a { + font-size: 1.1rem; + } +} + +.bg-image-full .version { + text-align: center; + color: #fff; + font-size: .8rem; +} + +@media only screen and (min-width: 420px) { + .bg-image-full .version { + font-size: .9rem; + } +} + +@media only screen and (min-width: 768px) { + .bg-image-full .version { + font-size: 1rem; + } +} + +@media only screen and (min-width: 1024px) { + .bg-image-full .version { + font-size: 1.1rem; + } +} + +.nav { + background: no-repeat center center scroll; + background-size: cover; + -o-background-size: cover; + height: 65px; + position: relative; +} + +.nav .logo { + width: 60px; + margin-top: 10px; +} + +.nav .title { + display: none; + color: #fff; + font-size: 1.2rem; + margin-left: 15px; + margin-top: 18px; +} + +@media only screen and (min-width: 768px) { + .nav .title { + display: inline-block; + } +} + +@media only screen and (min-width: 1024px) { + .nav .title { + font-size: 1.2rem; + } +} + +.nav .text { + margin-top: 18px; +} + +.nav .text a { + color: #fff; + margin-top: 12px; + font-size: 1.0rem; +} + +@media only screen and (min-width: 1023px) { + .nav .text a { + margin-top: 10px; + font-size: 1.2rem; + } +} + +.nav .text a:hover { + color: #aaa; + text-decoration: none; +} + +.features { + text-align: center; + padding: 15px 20px; + color: #333; +} + +.features:hover { + color: #567adf; +} + +.sectionheader .title { + text-align: center; + padding-top: 20px; + font-size: 2rem; +} + +@media only screen and (min-width: 420px) { + .sectionheader .title { + font-size: 2.3rem; + } +} + +@media only screen and (min-width: 768px) { + .sectionheader .title { + text-align: left; + padding-top: 25px; + font-size: 2.6rem; + } +} + +@media only screen and (min-width: 1024px) { + .sectionheader .title { + padding-top: 30px; + font-size: 3rem; + } +} + +.sectionheader .title-small { + text-align: center; + font-size: 1.4rem; +} + +@media only screen and (min-width: 420px) { + .sectionheader .title-small { + font-size: 1.6rem; + } +} + +@media only screen and (min-width: 768px) { + .sectionheader .title-small { + text-align: left; + padding-top: 25px; + font-size: 1.8rem; + } +} + +@media only screen and (min-width: 1024px) { + .sectionheader .title-small { + padding-top: 30px; + font-size: 2rem; + } +} + +.sectionheader .subtitle { + text-align: center; + font-size: .9rem; +} + +@media only screen and (min-width: 420px) { + .sectionheader .subtitle { + font-size: 1rem; + } +} + +@media only screen and (min-width: 768px) { + .sectionheader .subtitle { + text-align: left; + font-size: 1.1rem; + } +} + +@media only screen and (min-width: 1024px) { + .sectionheader .subtitle { + font-size: 1.3rem; + } +} + +.sectionheader .text { + text-align: center; + padding-top: 10px; +} + +@media only screen and (min-width: 768px) { + .sectionheader .text { + text-align: left; + } +} + +.sectionheader hr { + margin-top: 40px; + margin-bottom: 0px; + border: 1px solid #ddd; +} + +.index .text, .index .subtitle, .index .title, .index .title-small { + text-align: center; +} + +.index a { + text-decoration: none; +} + +.index a:hover { + text-decoration: none; + color: #567adf; +} + +.left .text, .left .subtitle, .left .title, .left .title-small { + text-align: left; +} + +.table { + text-align: left; +} + +ul { + text-align: left; +} + +.icons { + display: block; + font-size: 3rem; + color: #aaa; +} + +.icons:hover { + color: #567adf; +} + +@media only screen and (min-width: 420px) { + .icons { + font-size: 3.5rem; + } +} + +@media only screen and (min-width: 768px) { + .icons { + font-size: 4rem; + } +} + +@media only screen and (min-width: 1024px) { + .icons { + font-size: 5rem; + } +} + +.icontitle { + font-size: 1.2rem; +} + +.number-section { + margin-top: 40px; + text-align: center; +} + +.number-section .numbers { + font-size: 2rem; +} + +@media only screen and (min-width: 420px) { + .number-section .numbers { + font-size: 2.4rem; + } +} + +@media only screen and (min-width: 768px) { + .number-section .numbers { + font-size: 2.8rem; + } +} + +.number-section .title { + color: #999; + font-size: 1rem; +} + +@media only screen and (min-width: 420px) { + .number-section .title { + font-size: 1.1rem; + } +} + +@media only screen and (min-width: 768px) { + .number-section .title { + font-size: 1.2rem; + } +} + +.menu { + display: none; +} + +@media only screen and (min-width: 768px) { + .menu { + margin-top: 30px; + display: inline-block; + } +} + +.menu .title { + margin: 25px 0 5px 0; + color: #000; +} + +.menu hr { + margin: 5px 0; +} + +.menu ul { + list-style-type: none; + margin: 0; + padding: 0; +} + +.menu ul li { + padding: 2px 0; +} + +.menu ul li a { + width: 100%; + color: #666; + text-decoration: none; +} + +.menu ul li a:hover { + color: #567adf; +} + +.menu ul li.active > a { + color: #567adf; +} + +.code { + font-family: Menlo, "dejavu sans mono", "lucida console", monospace; + -webkit-font-smoothing: antialiased; + font-size: 14px; + font-style: normal; + font-variant: normal; + font-weight: 400; + display: inline-block; + background-color: #eee; + margin: 0; + padding: 0 5px; +} + +pre { + padding: 4px 10px 4px 10px; + font-family: Menlo, "dejavu sans mono", "lucida console", monospace; + -webkit-font-smoothing: antialiased; + font-size: 13px; + font-style: normal; + font-variant: normal; + font-weight: 400; + line-height: 18px; + background-color: #eee; + width: 100%; + text-align: left; +} + +footer { + background-color: #eee; + margin-top: 30px; + padding-top: 30px; + padding-bottom: 30px; +} + +footer a { + color: #000; +} +/*# sourceMappingURL=styles.css.map */ \ No newline at end of file diff --git a/docs/styles.css.map b/docs/styles.css.map new file mode 100644 index 0000000..a2edb31 --- /dev/null +++ b/docs/styles.css.map @@ -0,0 +1,9 @@ +{ + "version": 3, + "mappings": "AAAA,AAAA,IAAI,CAAC;EACD,WAAW,EAAE,6IAA6I;EAC1J,WAAW,EAAE,GAAG;EAChB,sBAAsB,EAAE,WAAW;CACtC;;AACD,AAAA,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;EACX,WAAW,EAAE,6IAA6I;EAC1J,WAAW,EAAE,GAAG;CACnB;;AACD,AAAA,OAAO,CAAC;EACJ,UAAU,EAAE,MAAM;CACrB;;AACD,AAAA,cAAc,CAAC;EACX,UAAU,EAAE,8BAA8B;EAC1C,uBAAuB,EAAE,KAAK;EAC9B,oBAAoB,EAAE,KAAK;EAC3B,eAAe,EAAE,KAAK;EACtB,kBAAkB,EAAE,KAAK;EACzB,MAAM,EAAE,KAAK;EACb,OAAO,EAAE,IAAI;EACb,MAAM,EAAE,iBAAiB;EACzB,OAAO,EAAE,IAAI;EACb,eAAe,EAAE,MAAM;EACvB,WAAW,EAAE,MAAM;EACnB,cAAc,EAAE,MAAM;CAqFzB;;AApFG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAb5C,AAAA,cAAc,CAAC;IAcP,MAAM,EAAE,KAAK;GAmFpB;;;AAjFG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAhB5C,AAAA,cAAc,CAAC;IAiBP,MAAM,EAAE,KAAK;GAgFpB;;;AA9EG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EAnB7C,AAAA,cAAc,CAAC;IAoBP,MAAM,EAAE,KAAK;GA6EpB;;;AA3EG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EAtB7C,AAAA,cAAc,CAAC;IAuBP,MAAM,EAAE,KAAK;GA0EpB;;;AAjGD,AAyBI,cAzBU,CAyBV,MAAM,CAAC;EACH,KAAK,EAAE,IAAI;EACX,WAAW,EAAE,IAAI;EACjB,SAAS,EAAE,MAAM;CAUpB;;AATG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EA7BhD,AAyBI,cAzBU,CAyBV,MAAM,CAAC;IAKC,SAAS,EAAE,MAAM;GAQxB;;;AANG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAhChD,AAyBI,cAzBU,CAyBV,MAAM,CAAC;IAQC,SAAS,EAAE,MAAM;GAKxB;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EAnCjD,AAyBI,cAzBU,CAyBV,MAAM,CAAC;IAWC,SAAS,EAAE,IAAI;GAEtB;;;AAtCL,AAuCI,cAvCU,CAuCV,KAAK,CAAC;EACF,KAAK,EAAE,KAAK;CAUf;;AATG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAzChD,AAuCI,cAvCU,CAuCV,KAAK,CAAC;IAGE,KAAK,EAAE,KAAK;GAQnB;;;AANG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EA5ChD,AAuCI,cAvCU,CAuCV,KAAK,CAAC;IAME,KAAK,EAAE,KAAK;GAKnB;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EA/CjD,AAuCI,cAvCU,CAuCV,KAAK,CAAC;IASE,KAAK,EAAE,KAAK;GAEnB;;;AAlDL,AAmDI,cAnDU,CAmDV,SAAS,CAAC;EACN,UAAU,EAAE,MAAM;EAClB,KAAK,EAAE,IAAI;EACX,SAAS,EAAE,MAAM;CAUpB;;AATG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAvDhD,AAmDI,cAnDU,CAmDV,SAAS,CAAC;IAKF,SAAS,EAAE,IAAI;GAQtB;;;AANG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EA1DhD,AAmDI,cAnDU,CAmDV,SAAS,CAAC;IAQF,SAAS,EAAE,MAAM;GAKxB;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EA7DjD,AAmDI,cAnDU,CAmDV,SAAS,CAAC;IAWF,SAAS,EAAE,MAAM;GAExB;;;AAhEL,AAiEI,cAjEU,CAiEV,KAAK,GAAG,CAAC,CAAC;EACN,UAAU,EAAE,MAAM;EAClB,KAAK,EAAE,IAAI;EACX,SAAS,EAAE,MAAM;CAcpB;;AAlFL,AAqEQ,cArEM,CAiEV,KAAK,GAAG,CAAC,AAIJ,MAAM,CAAC;EACJ,KAAK,EAAE,IAAI;EACX,eAAe,EAAE,IAAI;CACxB;;AACD,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAzEhD,AAiEI,cAjEU,CAiEV,KAAK,GAAG,CAAC,CAAC;IASF,SAAS,EAAE,IAAI;GAQtB;;;AANG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EA5EhD,AAiEI,cAjEU,CAiEV,KAAK,GAAG,CAAC,CAAC;IAYF,SAAS,EAAE,IAAI;GAKtB;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EA/EjD,AAiEI,cAjEU,CAiEV,KAAK,GAAG,CAAC,CAAC;IAeF,SAAS,EAAE,MAAM;GAExB;;;AAlFL,AAmFI,cAnFU,CAmFV,QAAQ,CAAC;EACL,UAAU,EAAE,MAAM;EAClB,KAAK,EAAE,IAAI;EACX,SAAS,EAAE,KAAK;CAUnB;;AATG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAvFhD,AAmFI,cAnFU,CAmFV,QAAQ,CAAC;IAKD,SAAS,EAAE,KAAK;GAQvB;;;AANG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EA1FhD,AAmFI,cAnFU,CAmFV,QAAQ,CAAC;IAQD,SAAS,EAAE,IAAI;GAKtB;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EA7FjD,AAmFI,cAnFU,CAmFV,QAAQ,CAAC;IAWD,SAAS,EAAE,MAAM;GAExB;;;AAGL,AAAA,IAAI,CAAC;EACD,UAAU,EAAE,8BAA8B;EAC1C,uBAAuB,EAAE,KAAK;EAC9B,oBAAoB,EAAE,KAAK;EAC3B,eAAe,EAAE,KAAK;EACtB,kBAAkB,EAAE,KAAK;EACzB,MAAM,EAAE,IAAI;EACZ,QAAQ,EAAE,QAAQ;CAmCrB;;AA1CD,AAQI,IARA,CAQA,KAAK,CAAC;EACF,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,IAAI;CACnB;;AAXL,AAYI,IAZA,CAYA,MAAM,CAAC;EACH,OAAO,EAAE,IAAI;EACb,KAAK,EAAE,IAAI;EACX,SAAS,EAAE,MAAM;EACjB,WAAW,EAAE,IAAI;EACjB,UAAU,EAAE,IAAI;CAOnB;;AANG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAlBhD,AAYI,IAZA,CAYA,MAAM,CAAC;IAOC,OAAO,EAAE,YAAY;GAK5B;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EArBjD,AAYI,IAZA,CAYA,MAAM,CAAC;IAUC,SAAS,EAAE,MAAM;GAExB;;;AAxBL,AAyBI,IAzBA,CAyBA,KAAK,CAAC;EACF,UAAU,EAAE,IAAI;CAenB;;AAzCL,AA4BQ,IA5BJ,CAyBA,KAAK,CAGD,CAAC,CAAC;EACE,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,IAAI;EAChB,SAAS,EAAE,MAAM;CASpB;;AARG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EAhCrD,AA4BQ,IA5BJ,CAyBA,KAAK,CAGD,CAAC,CAAC;IAKM,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,MAAM;GAMxB;;;AAxCT,AAoCY,IApCR,CAyBA,KAAK,CAGD,CAAC,AAQI,MAAM,CAAC;EACJ,KAAK,EAAE,IAAI;EACX,eAAe,EAAE,IAAI;CACxB;;AAIb,AAAA,SAAS,CAAC;EACN,UAAU,EAAE,MAAM;EAClB,OAAO,EAAE,SAAS;EAClB,KAAK,EAAE,IAAI;CAId;;AAPD,AAII,SAJK,AAIJ,MAAM,CAAC;EACJ,KAAK,EAAE,OAAiB;CAC3B;;AAEL,AACI,cADU,CACV,MAAM,CAAC;EACH,UAAU,EAAE,MAAM;EAClB,WAAW,EAAE,IAAI;EACjB,SAAS,EAAE,IAAI;CAalB;;AAZG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EALhD,AACI,cADU,CACV,MAAM,CAAC;IAKC,SAAS,EAAE,MAAM;GAWxB;;;AATG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EARhD,AACI,cADU,CACV,MAAM,CAAC;IAQC,UAAU,EAAE,IAAI;IAChB,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,MAAM;GAMxB;;;AAJG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EAbjD,AACI,cADU,CACV,MAAM,CAAC;IAaC,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;GAEtB;;;AAjBL,AAkBI,cAlBU,CAkBV,YAAY,CAAC;EACT,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,MAAM;CAapB;;AAZG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EArBhD,AAkBI,cAlBU,CAkBV,YAAY,CAAC;IAIL,SAAS,EAAE,MAAM;GAWxB;;;AATG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAxBhD,AAkBI,cAlBU,CAkBV,YAAY,CAAC;IAOL,UAAU,EAAE,IAAI;IAChB,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,MAAM;GAMxB;;;AAJG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EA7BjD,AAkBI,cAlBU,CAkBV,YAAY,CAAC;IAYL,WAAW,EAAE,IAAI;IACjB,SAAS,EAAE,IAAI;GAEtB;;;AAjCL,AAkCI,cAlCU,CAkCV,SAAS,CAAC;EACN,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,KAAK;CAWnB;;AAVG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EArChD,AAkCI,cAlCU,CAkCV,SAAS,CAAC;IAIF,SAAS,EAAE,IAAI;GAStB;;;AAPG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAxChD,AAkCI,cAlCU,CAkCV,SAAS,CAAC;IAOF,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,MAAM;GAKxB;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EA5CjD,AAkCI,cAlCU,CAkCV,SAAS,CAAC;IAWF,SAAS,EAAE,MAAM;GAExB;;;AA/CL,AAgDI,cAhDU,CAgDV,KAAK,CAAC;EACF,UAAU,EAAE,MAAM;EAClB,WAAW,EAAE,IAAI;CAIpB;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAnDhD,AAgDI,cAhDU,CAgDV,KAAK,CAAC;IAIE,UAAU,EAAE,IAAI;GAEvB;;;AAtDL,AAuDI,cAvDU,CAuDV,EAAE,CAAC;EACC,UAAU,EAAE,IAAI;EAChB,aAAa,EAAE,GAAG;EAClB,MAAM,EAAE,cAAc;CACzB;;AAEL,AACI,MADE,CACF,KAAK,EADT,MAAM,CACK,SAAS,EADpB,MAAM,CACgB,MAAM,EAD5B,MAAM,CACwB,YAAY,CAAC;EACnC,UAAU,EAAE,MAAM;CACrB;;AAHL,AAII,MAJE,CAIF,CAAC,CAAC;EACE,eAAe,EAAE,IAAI;CAKxB;;AAVL,AAMQ,MANF,CAIF,CAAC,AAEI,MAAM,CAAC;EACJ,eAAe,EAAE,IAAI;EACrB,KAAK,EAAE,OAAiB;CAC3B;;AAGT,AACI,KADC,CACD,KAAK,EADT,KAAK,CACM,SAAS,EADpB,KAAK,CACiB,MAAM,EAD5B,KAAK,CACyB,YAAY,CAAC;EACnC,UAAU,EAAE,IAAI;CACnB;;AAEL,AAAA,MAAM,CAAC;EACH,UAAU,EAAE,IAAI;CACnB;;AACD,AAAA,EAAE,CAAC;EACC,UAAU,EAAE,IAAI;CACnB;;AACD,AAAA,MAAM,CAAC;EACH,OAAO,EAAE,KAAK;EACd,SAAS,EAAE,IAAI;EACf,KAAK,EAAE,IAAI;CAad;;AAhBD,AAII,MAJE,AAID,MAAM,CAAC;EACJ,KAAK,EAAE,OAAiB;CAC3B;;AACD,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAP5C,AAAA,MAAM,CAAC;IAQC,SAAS,EAAE,MAAM;GAQxB;;;AANG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAV5C,AAAA,MAAM,CAAC;IAWC,SAAS,EAAE,IAAI;GAKtB;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,MAAM;EAb7C,AAAA,MAAM,CAAC;IAcC,SAAS,EAAE,IAAI;GAEtB;;;AACD,AAAA,UAAU,CAAC;EACP,SAAS,EAAE,MAAM;CAEpB;;AACD,AAAA,eAAe,CAAC;EACZ,UAAU,EAAE,IAAI;EAChB,UAAU,EAAE,MAAM;CAoBrB;;AAtBD,AAGI,eAHW,CAGX,QAAQ,CAAC;EACL,SAAS,EAAE,IAAI;CAOlB;;AANG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EALhD,AAGI,eAHW,CAGX,QAAQ,CAAC;IAGD,SAAS,EAAE,MAAM;GAKxB;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EARhD,AAGI,eAHW,CAGX,QAAQ,CAAC;IAMD,SAAS,EAAE,MAAM;GAExB;;;AAXL,AAYI,eAZW,CAYX,MAAM,CAAC;EACH,KAAK,EAAE,IAAI;EACX,SAAS,EAAE,IAAI;CAOlB;;AANG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAfhD,AAYI,eAZW,CAYX,MAAM,CAAC;IAIC,SAAS,EAAE,MAAM;GAKxB;;;AAHG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAlBhD,AAYI,eAZW,CAYX,MAAM,CAAC;IAOC,SAAS,EAAE,MAAM;GAExB;;;AAEL,AAAA,KAAK,CAAC;EACF,OAAO,EAAE,IAAI;CA+BhB;;AA9BG,MAAM,MAAM,MAAM,MAAM,SAAS,EAAE,KAAK;EAF5C,AAAA,KAAK,CAAC;IAGE,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,YAAY;GA4B5B;;;AAhCD,AAMI,KANC,CAMD,MAAM,CAAC;EACH,MAAM,EAAE,YAAY;EACpB,KAAK,EAAE,IAAI;CACd;;AATL,AAUI,KAVC,CAUD,EAAE,CAAC;EACC,MAAM,EAAE,KAAK;CAChB;;AAZL,AAaI,KAbC,CAaD,EAAE,CAAC;EACC,eAAe,EAAE,IAAI;EACrB,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,CAAC;CAeb;;AA/BL,AAiBQ,KAjBH,CAaD,EAAE,CAIE,EAAE,CAAC;EACC,OAAO,EAAE,KAAK;CAYjB;;AA9BT,AAmBY,KAnBP,CAaD,EAAE,CAIE,EAAE,CAEE,CAAC,CAAC;EACE,KAAK,EAAE,IAAI;EACX,KAAK,EAAE,IAAI;EACX,eAAe,EAAE,IAAI;CAIxB;;AA1Bb,AAuBgB,KAvBX,CAaD,EAAE,CAIE,EAAE,CAEE,CAAC,AAII,MAAM,CAAC;EACJ,KAAK,EAAE,OAAiB;CAC3B;;AAzBjB,AA2BY,KA3BP,CAaD,EAAE,CAIE,EAAE,AAUG,OAAO,GAAG,CAAC,CAAC;EACT,KAAK,EAAE,OAAiB;CAC3B;;AAIb,AAAA,KAAK,CAAC;EACF,WAAW,EAAE,sDAAsD;EACnE,sBAAsB,EAAE,WAAW;EACnC,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,MAAM;EAClB,YAAY,EAAE,MAAM;EACpB,WAAW,EAAE,GAAG;EAChB,OAAO,EAAE,YAAY;EACrB,gBAAgB,EAAE,IAAI;EACtB,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,KAAK;CACjB;;AACD,AAAA,GAAG,CAAC;EACA,OAAO,EAAE,iBAAiB;EAC1B,WAAW,EAAE,sDAAsD;EACnE,sBAAsB,EAAE,WAAW;EACnC,SAAS,EAAE,IAAI;EACf,UAAU,EAAE,MAAM;EAClB,YAAY,EAAE,MAAM;EACpB,WAAW,EAAE,GAAG;EAChB,WAAW,EAAE,IAAI;EACjB,gBAAgB,EAAE,IAAI;EACtB,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,IAAI;CACnB;;AACD,AAAA,MAAM,CAAC;EACH,gBAAgB,EAAE,IAAI;EACtB,UAAU,EAAE,IAAI;EAChB,WAAW,EAAE,IAAI;EACjB,cAAc,EAAE,IAAI;CAIvB;;AARD,AAKI,MALE,CAKF,CAAC,CAAC;EACE,KAAK,EAAE,IAAI;CACd", + "sources": [ + "styles.scss" + ], + "names": [], + "file": "styles.css" +} \ No newline at end of file diff --git a/docs/styles.scss b/docs/styles.scss new file mode 100644 index 0000000..55be523 --- /dev/null +++ b/docs/styles.scss @@ -0,0 +1,357 @@ +body { + font-family: -apple-system, BlinkMacSystemFont, "segoe ui", Roboto, Helvetica, Arial, sans-serif, "apple color emoji", "segoe ui emoji", "segoe ui symbol"; + font-weight: 300; + -webkit-font-smoothing: antialiased; +} +h1, h2, h3, h4 { + font-family: -apple-system, BlinkMacSystemFont, "segoe ui", Roboto, Helvetica, Arial, sans-serif, "apple color emoji", "segoe ui emoji", "segoe ui symbol"; + font-weight: 300; +} +.center { + text-align: center; +} +.bg-image-full { + background: no-repeat center center scroll; + -webkit-background-size: cover; + -moz-background-size: cover; + background-size: cover; + -o-background-size: cover; + height: 280px; + opacity: 0.95; + filter: alpha(opacity=90); + display: flex; + justify-content: center; + align-items: center; + flex-direction: column; + @media only screen and (min-width: 420px) { + height: 360px; + } + @media only screen and (min-width: 768px) { + height: 400px; + } + @media only screen and (min-width: 1024px) { + height: 450px; + } + @media only screen and (min-width: 1200px) { + height: 550px; + } + .title { + color: #fff; + padding-top: 10px; + font-size: 1.8rem; + @media only screen and (min-width: 420px) { + font-size: 2.4rem; + } + @media only screen and (min-width: 768px) { + font-size: 3.2rem; + } + @media only screen and (min-width: 1024px) { + font-size: 4rem; + } + } + .logo { + width: 100px; + @media only screen and (min-width: 420px) { + width: 120px; + } + @media only screen and (min-width: 768px) { + width: 160px; + } + @media only screen and (min-width: 1024px) { + width: 200px; + } + } + .subtitle { + text-align: center; + color: #bbb; + font-size: 0.9rem; + @media only screen and (min-width: 420px) { + font-size: 1rem; + } + @media only screen and (min-width: 768px) { + font-size: 1.1rem; + } + @media only screen and (min-width: 1024px) { + font-size: 1.3rem; + } + } + .text > a { + text-align: center; + color: #fff; + font-size: 0.9rem; + &:hover { + color: #aaa; + text-decoration: none; + } + @media only screen and (min-width: 420px) { + font-size: 1rem; + } + @media only screen and (min-width: 768px) { + font-size: 1rem; + } + @media only screen and (min-width: 1024px) { + font-size: 1.1rem; + } + } + .version { + text-align: center; + color: #fff; + font-size: .8rem; + @media only screen and (min-width: 420px) { + font-size: .9rem; + } + @media only screen and (min-width: 768px) { + font-size: 1rem; + } + @media only screen and (min-width: 1024px) { + font-size: 1.1rem; + } + } +} + +.nav { + background: no-repeat center center scroll; + -webkit-background-size: cover; + -moz-background-size: cover; + background-size: cover; + -o-background-size: cover; + height: 65px; + position: relative; + .logo { + width: 60px; + margin-top: 10px; + } + .title { + display: none; + color: #fff; + font-size: 1.2rem; + margin-left: 15px; + margin-top: 18px; + @media only screen and (min-width: 768px) { + display: inline-block; + } + @media only screen and (min-width: 1024px) { + font-size: 1.2rem; + } + } + .text { + margin-top: 18px; + + a { + color: #fff; + margin-top: 12px; + font-size: 1.0rem; + @media only screen and (min-width: 1023px) { + margin-top: 10px; + font-size: 1.2rem; + } + &:hover { + color: #aaa; + text-decoration: none; + } + } + } +} +.features { + text-align: center; + padding: 15px 20px; + color: #333; + &:hover { + color: rgb(86, 122, 223); + } +} +.sectionheader { + .title { + text-align: center; + padding-top: 20px; + font-size: 2rem; + @media only screen and (min-width: 420px) { + font-size: 2.3rem; + } + @media only screen and (min-width: 768px) { + text-align: left; + padding-top: 25px; + font-size: 2.6rem; + } + @media only screen and (min-width: 1024px) { + padding-top: 30px; + font-size: 3rem; + } + } + .title-small { + text-align: center; + font-size: 1.4rem; + @media only screen and (min-width: 420px) { + font-size: 1.6rem; + } + @media only screen and (min-width: 768px) { + text-align: left; + padding-top: 25px; + font-size: 1.8rem; + } + @media only screen and (min-width: 1024px) { + padding-top: 30px; + font-size: 2rem; + } + } + .subtitle { + text-align: center; + font-size: .9rem; + @media only screen and (min-width: 420px) { + font-size: 1rem; + } + @media only screen and (min-width: 768px) { + text-align: left; + font-size: 1.1rem; + } + @media only screen and (min-width: 1024px) { + font-size: 1.3rem; + } + } + .text { + text-align: center; + padding-top: 10px; + @media only screen and (min-width: 768px) { + text-align: left; + } + } + hr { + margin-top: 40px; + margin-bottom: 0px; + border: 1px solid #ddd; + } +} +.index { + .text, .subtitle, .title, .title-small { + text-align: center; + } + a { + text-decoration: none; + &:hover { + text-decoration: none; + color: rgb(86, 122, 223); + } + } +} +.left { + .text, .subtitle, .title, .title-small { + text-align: left; + } +} +.table { + text-align: left; +} +ul { + text-align: left; +} +.icons { + display: block; + font-size: 3rem; + color: #aaa; + &:hover { + color: rgb(86, 122, 223); + } + @media only screen and (min-width: 420px) { + font-size: 3.5rem; + } + @media only screen and (min-width: 768px) { + font-size: 4rem; + } + @media only screen and (min-width: 1024px) { + font-size: 5rem; + } +} +.icontitle { + font-size: 1.2rem; + // color: #000; +} +.number-section { + margin-top: 40px; + text-align: center; + .numbers { + font-size: 2rem; + @media only screen and (min-width: 420px) { + font-size: 2.4rem; + } + @media only screen and (min-width: 768px) { + font-size: 2.8rem; + } + } + .title { + color: #999; + font-size: 1rem; + @media only screen and (min-width: 420px) { + font-size: 1.1rem; + } + @media only screen and (min-width: 768px) { + font-size: 1.2rem; + } + } +} +.menu { + display: none; + @media only screen and (min-width: 768px) { + margin-top: 30px; + display: inline-block; + } + .title { + margin: 25px 0 5px 0; + color: #000; + } + hr { + margin: 5px 0; + } + ul { + list-style-type: none; + margin: 0; + padding: 0; + li { + padding: 2px 0; + a { + width: 100%; + color: #666; + text-decoration: none; + &:hover { + color: rgb(86, 122, 223); + } + } + &.active > a { + color: rgb(86, 122, 223); + } + } + } +} +.code { + font-family: Menlo, "dejavu sans mono", "lucida console", monospace; + -webkit-font-smoothing: antialiased; + font-size: 14px; + font-style: normal; + font-variant: normal; + font-weight: 400; + display: inline-block; + background-color: #eee; + margin: 0; + padding: 0 5px; +} +pre { + padding: 4px 10px 4px 10px; + font-family: Menlo, "dejavu sans mono", "lucida console", monospace; + -webkit-font-smoothing: antialiased; + font-size: 13px; + font-style: normal; + font-variant: normal; + font-weight: 400; + line-height: 18px; + background-color: #eee; + width: 100%; + text-align: left; +} +footer { + background-color: #eee; + margin-top: 30px; + padding-top: 30px; + padding-bottom: 30px; + a { + color: #000; + } +} \ No newline at end of file diff --git a/docs/system.html b/docs/system.html new file mode 100644 index 0000000..996afc8 --- /dev/null +++ b/docs/system.html @@ -0,0 +1,289 @@ + + + + + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
System (Hardware)
+
+

In this section you will learn how to get basic system hardware data. We will cover the system, baseboard and bios:

+

For function reference and examples we assume, that we imported systeminformation as follows:

+
const si = require('systeminformation');
+

System

+

All functions in this section return a promise or can be called with a callback function (parameter cb in the function reference)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FunctionResult objectLinuxBSDMacWinSunComments
si.system(cb){...}XXXXhardware information
manufacturerXXXXe.g. 'MSI' or 'DELL'
modelXXXXmodel/product e.g. 'MS-7823'
versionXXXXversion e.g. '1.0'
serialXXXXserial number
uuidXXXXUUID
skuXXXSKU number
si.bios(cb){...}XXXXhardware information
vendorXXXXe.g. 'AMI'
versionXXXversion
releaseDateXXXrelease date
revisionXXXrevision
si.baseboard(cb){...}XXXXhardware information
manufacturerXXXXe.g. 'ASUS'
modelXXXXmodel / product name
versionXXXXversion
serialXXXXserial number
assetTagXXXXasset tag
+
+
+
+
+
+ +
+ + + + + + diff --git a/docs/trademarks.html b/docs/trademarks.html new file mode 100644 index 0000000..0d53447 --- /dev/null +++ b/docs/trademarks.html @@ -0,0 +1,107 @@ + + + + + + + + + + + + + + + systeminformation + + + + + + +
+
+ +
+
+
+
Trademarks
+
+

The following trademarks are the properties of their respective owners as listed below. Should any trademark attribution be missing, mistaken or erroneous, please contact us as soon as possible for rectification.

+
    +
  • Node.js is a trademark of Joyent Inc.
  • +
  • Linux is a registered trademark of Linus Torvalds
  • +
  • Apple, macOS, OS X are registered trademarks of Apple Inc.
  • +
  • Windows is a registered trademark of Microsoft Corporation
  • +
  • Intel is a trademark of Intel Corporation
  • +
  • AMD is a trademark of Advanced Micro Devices Inc.
  • +
  • Raspberry Pi is a trademark of the Raspberry Pi Foundation
  • +
  • Debian is a trademark of the Debian Project
  • +
  • FreeBSD is a registered trademark of The FreeBSD Foundation
  • +
  • Docker is a trademark of Docker, Inc.
  • +
  • Ubuntu is a trademark of Canonical Ltd.
  • +
  • CentOS is a trademark of Read Hat Inc.
  • +
  • Sun, Solaris, OpenSolaris are registered trademarks of Sun Microsystems
  • +
  • BSD is a registered trademark of UUnet Technologies, Inc.
  • +
  • UNIX is a registered trademark of The Open Group.
  • +
  • NVIDIA is a registered trademark of NVIDIA Corporation.
  • +
  • MSI is a registered trademark Micro-Star International Co.
  • +
  • DELL is a registered trademark of Dell Inc.
  • +
  • ASUS is a registered trademark of ASUSTeK Computer.
  • +
+

All other trademarks are the property of their respective owners.

+
+
+
+
+
+ +
+ + + + + + diff --git a/lib/battery.js b/lib/battery.js index 2a8a583..758bda4 100644 --- a/lib/battery.js +++ b/lib/battery.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/cpu.js b/lib/cpu.js index f48e0e5..eb473d9 100644 --- a/lib/cpu.js +++ b/lib/cpu.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/docker.js b/lib/docker.js index d00e78f..4556553 100644 --- a/lib/docker.js +++ b/lib/docker.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/dockerSocket.js b/lib/dockerSocket.js index 12e0ac2..4718d44 100644 --- a/lib/dockerSocket.js +++ b/lib/dockerSocket.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/filesystem.js b/lib/filesystem.js index 5a3ad8e..6fb7eee 100644 --- a/lib/filesystem.js +++ b/lib/filesystem.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/graphics.js b/lib/graphics.js index dc0810d..c72056c 100644 --- a/lib/graphics.js +++ b/lib/graphics.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/index.js b/lib/index.js index 75a1e2e..4939af0 100644 --- a/lib/index.js +++ b/lib/index.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // Contributors: Guillaume Legrain (https://github.com/glegrain) diff --git a/lib/internet.js b/lib/internet.js index dd96007..51b7b76 100644 --- a/lib/internet.js +++ b/lib/internet.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/memory.js b/lib/memory.js index 7171669..d34ee1f 100644 --- a/lib/memory.js +++ b/lib/memory.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/network.js b/lib/network.js index cd2e993..00d1deb 100644 --- a/lib/network.js +++ b/lib/network.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT @@ -368,7 +368,7 @@ function networkInterfaces(callback) { type = detail.type; } }); - if (iface.toLowerCase().indexOf('wlan') >= 0 || ifaceName.toLowerCase().indexOf('wlan') >= 0 || ifaceName.toLowerCase().indexOf('wireless') >= 0) { + if (dev.toLowerCase().indexOf('wlan') >= 0 || ifaceName.toLowerCase().indexOf('wlan') >= 0 || ifaceName.toLowerCase().indexOf('wireless') >= 0) { type = 'wireless'; } } diff --git a/lib/osinfo.js b/lib/osinfo.js index 3074171..0d91667 100644 --- a/lib/osinfo.js +++ b/lib/osinfo.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/processes.js b/lib/processes.js index 8ff59f3..01817a3 100644 --- a/lib/processes.js +++ b/lib/processes.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/system.js b/lib/system.js index c91b8f4..d03b7fc 100644 --- a/lib/system.js +++ b/lib/system.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/users.js b/lib/users.js index 7302c39..9593c8f 100644 --- a/lib/users.js +++ b/lib/users.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT diff --git a/lib/util.js b/lib/util.js index ccc0205..489a684 100644 --- a/lib/util.js +++ b/lib/util.js @@ -4,7 +4,7 @@ // ---------------------------------------------------------------------------------- // Description: System Information - library // for Node.js -// Copyright: (c) 2014 - 2018 +// Copyright: (c) 2014 - 2019 // Author: Sebastian Hildebrandt // ---------------------------------------------------------------------------------- // License: MIT