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

adding website

Browse Source
This commit is contained in:
Sebastian Hildebrandt 2019-01-09 20:40:33 +01:00
parent d016e87eb8
commit a9f346a69a
42 changed files with 7300 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -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<br>iface parameter is optional<br>defaults to first external network interface| | si.networkStats(iface,cb) | {...} | X | X | X | X | | current network stats of given interface<br>iface parameter is optional<br>defaults to first external network interface|
| | iface | X | X | X | X | | interface | | | iface | X | X | X | X | | interface |
| | operstate | X | X | X | X | | up / down | | | 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_dropped | X | X | X | X | | received dropped overall |
| | rx_errors | X | X | X | X | | received errors 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_dropped | X | X | X | X | | transferred dropped overall |
| | tx_errors | X | X | X | X | | transferred errors overall | | | tx_errors | X | X | X | X | | transferred errors overall |
| | rx_sec | X | X | X | X | | received bytes / second (* see notes) | | | rx_sec | X | X | X | X | | received bytes / second (* see notes) |

BIN
docs/assets/logo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 58 KiB

BIN
docs/assets/motherboard.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 67 KiB

BIN
docs/assets/trianglify.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 144 KiB

257
docs/battery.html Normal file
View File

@ -0,0 +1,257 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Battery</div>
<div class="text">
<p>In this section you will learn how to get battery information - if supported by system:</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>Battery Data</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.battery(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>battery information</td>
</tr>
<tr>
<td></td>
<td>hasbattery</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>indicates presence of battery</td>
</tr>
<tr>
<td></td>
<td>cyclecount</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>numbers of recharges</td>
</tr>
<tr>
<td></td>
<td>ischarging</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>indicates if battery is charging</td>
</tr>
<tr>
<td></td>
<td>maxcapacity</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>max capacity of battery</td>
</tr>
<tr>
<td></td>
<td>currentcapacity</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>current capacity of battery</td>
</tr>
<tr>
<td></td>
<td>percent</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>charging level in percent</td>
</tr>
<tr>
<td></td>
<td>timeremaining</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>minutes left (if discharging)</td>
</tr>
<tr>
<td></td>
<td>acconnected</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>AC connected</td>
</tr>
<tr>
<td></td>
<td>type</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>battery type</td>
</tr>
<tr>
<td></td>
<td>model</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>model</td>
</tr>
<tr>
<td></td>
<td>manufacturer</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>manufacturer</td>
</tr>
<tr>
<td></td>
<td>serial</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>battery serial</td>
</tr>
</tbody>
</table>
<h2>Known issues</h2>
<h4>macOS - Temperature</h4>
<p>To be able to measure temperature on macOS I created a little additional package. Due to some difficulties in NPM with <span class="code">optionalDependencies</span>
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.</p>
<p>But if you need to detect macOS temperature just run the following additional installation command:</p>
<pre>$ npm install osx-temperature-sensor --save</pre>
<p>systeminformation will then detect this additional library and return the temperature when calling systeminformations standard function <span class="code">cpuTemperature()</span></p>
<h4>Windows Temperature</h4>
<p><span class="code">wmic</span> - 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. </p>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

105
docs/contributors.html Normal file
View File

@ -0,0 +1,105 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader left">
<div class="title">Contributors</div>
<div class="text">
<p>Many thanks to all contributors. Really appreciate your support!</p>
<ul>
<li>Guillaume Legrain <a href="https://github.com/glegrain" rel="nofollow">glegrain</a></li>
<li>Riccardo Novaglia <a href="https://github.com/richy24" rel="nofollow">richy24</a></li>
<li>Quentin Busuttil <a href="https://github.com/Buzut" rel="nofollow">Buzut</a></li>
<li>lapsio <a href="https://github.com/lapsio" rel="nofollow">lapsio</a></li>
<li>csy <a href="https://github.com/csy1983" rel="nofollow">csy</a></li>
<li>Tiago Roldão <a href="https://github.com/tiagoroldao" rel="nofollow">tiagoroldao</a></li>
<li>dragonjet <a href="https://github.com/dragonjet" rel="nofollow">dragonjet</a></li>
<li>Adam Reis <a href="https://github.com/adamreisnz" rel="nofollow">adamreisnz</a></li>
<li>Jimi M <a href="https://github.com/ItsJimi" rel="nofollow">ItsJimi</a></li>
<li>Git² <a href="https://github.com/GitSquared" rel="nofollow">GitSquared</a></li>
<li>weiyin <a href="https://github.com/weiyin" rel="nofollow">weiyin</a></li>
<li>Jorai Rijsdijk <a href="https://github.com/Erackron" rel="nofollow">Erackron</a></li>
</ul>
<p>OSX Temperature: credits here are going to:</p>
<ul>
<li>Massimiliano Marcon <a href="https://github.com/mmarcon" rel="nofollow">mmarcon</a> for his work on <a href="https://github.com/mmarcon/node-smc" rel="nofollow">smc-code</a></li>
<li>Sébastien Lavoie <a href="https://github.com/lavoiesl" rel="nofollow">lavoiesl</a> for his work on <a href="https://github.com/lavoiesl/osx-cpu-temp" rel="nofollow">osx-cpu-temp</a> code.</li>
</ul>
<p>Many thanks also to all who provided help or filed an issue. This really helps improving this package!</p>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

105
docs/copyright.html Normal file
View File

@ -0,0 +1,105 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Copyright Information</div>
<div class="text">&copy; 2019 Sebstian Hildebrandt, <a href="https://github.com/sebhildebrandt/"> <i class="fab fa-github"></i> sebhildebrandt</a>, <a href="https://www.plus-innovations.com"><i class="fal fa-globe"></i> +innovations</a></div>
</div>
</div>
<div class="row">
<div class="col-12 sectionheader">
<div class="title">License <img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></div>
<div class="text">
<p>Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the &quot;Software&quot;), 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:</p>
<p>The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, 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.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

469
docs/cpu.html Normal file
View File

@ -0,0 +1,469 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">CPU</div>
<div class="text">
<p>In this section you will learn how to get CPU data including current speed and temperature:</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>CPU Data</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.cpu(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>CPU information object</td>
</tr>
<tr>
<td></td>
<td>manufacturer</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>e.g. 'Intel(R)'</td>
</tr>
<tr>
<td></td>
<td>brand</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>e.g. 'Core(TM)2 Duo'</td>
</tr>
<tr>
<td></td>
<td>speed</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>in GHz e.g. '3.40'</td>
</tr>
<tr>
<td></td>
<td>speedmin</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>in GHz e.g. '0.80'</td>
</tr>
<tr>
<td></td>
<td>speedmax</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>in GHz e.g. '3.90'</td>
</tr>
<tr>
<td></td>
<td>cores</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td># cores</td>
</tr>
<tr>
<td></td>
<td>physicalCores</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td># physical cores</td>
</tr>
<tr>
<td></td>
<td>processors</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td># processors</td>
</tr>
<tr>
<td></td>
<td>socket</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>socket type e.g. &quot;LGA1356&quot;</td>
</tr>
<tr>
<td></td>
<td>vendor</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>vendor ID</td>
</tr>
<tr>
<td></td>
<td>family</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>processor family</td>
</tr>
<tr>
<td></td>
<td>model</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>processor model</td>
</tr>
<tr>
<td></td>
<td>stepping</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>processor stepping</td>
</tr>
<tr>
<td></td>
<td>revision</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>revision</td>
</tr>
<tr>
<td></td>
<td>voltage</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td>voltage</td>
</tr>
<tr>
<td></td>
<td>cache</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>cache in bytes (object)</td>
</tr>
<tr>
<td></td>
<td>cache.l1d</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>L1D (data) size</td>
</tr>
<tr>
<td></td>
<td>cache.l1i</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>L1I (instruction) size</td>
</tr>
<tr>
<td></td>
<td>cache.l2</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>L2 size</td>
</tr>
<tr>
<td></td>
<td>cache.l3</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>L3 size</td>
</tr>
<tr>
<td>si.cpuFlags(cb)</td>
<td>: string</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>CPU flags</td>
</tr>
<tr>
<td>si.cpuCache(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>CPU cache sizes object</td>
</tr>
<tr>
<td></td>
<td>l1d</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>L1D size</td>
</tr>
<tr>
<td></td>
<td>l1i</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>L1I size</td>
</tr>
<tr>
<td></td>
<td>l2</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>L2 size</td>
</tr>
<tr>
<td></td>
<td>l3</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>L3 size</td>
</tr>
<tr>
<td>si.cpuCurrentspeed(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>current CPU speed (GHz) object</td>
</tr>
<tr>
<td></td>
<td>avg</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>avg CPU speed (all cores)</td>
</tr>
<tr>
<td></td>
<td>min</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>min CPU speed (all cores)</td>
</tr>
<tr>
<td></td>
<td>max</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>max CPU speed (all cores)</td>
</tr>
<tr>
<td></td>
<td>cores</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>CPU speed per core (array)</td>
</tr>
<tr>
<td>si.cpuTemperature(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X*</td>
<td>X</td>
<td></td>
<td>CPU temperature (if supported)</td>
</tr>
<tr>
<td></td>
<td>main</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>main temperature (avg)</td>
</tr>
<tr>
<td></td>
<td>cores</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>array of temperatures</td>
</tr>
<tr>
<td></td>
<td>max</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>max temperature</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

519
docs/docker.html Normal file
View File

@ -0,0 +1,519 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Docker</div>
<div class="text">
<p>In this section you will learn how to get information about docker containers, stats and processes inside a docker container:</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>Container, Stats, Processes</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.dockerContainers(all, cb)</td>
<td>[{...}]</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>returns array of active/all docker containers</td>
</tr>
<tr>
<td></td>
<td>[0].id</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>ID of container</td>
</tr>
<tr>
<td></td>
<td>[0].name</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>name of container</td>
</tr>
<tr>
<td></td>
<td>[0].image</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>name of image</td>
</tr>
<tr>
<td></td>
<td>[0].imageID</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>ID of image</td>
</tr>
<tr>
<td></td>
<td>[0].command</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>command</td>
</tr>
<tr>
<td></td>
<td>[0].created</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>creation time</td>
</tr>
<tr>
<td></td>
<td>[0].state</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>created, running, exited</td>
</tr>
<tr>
<td></td>
<td>[0].ports</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>array of ports</td>
</tr>
<tr>
<td></td>
<td>[0].mounts</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>array of mounts</td>
</tr>
<tr>
<td>si.dockerContainerStats(id, cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>statistics for a specific container</td>
</tr>
<tr>
<td></td>
<td>id</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>Container ID</td>
</tr>
<tr>
<td></td>
<td>mem_usage</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>memory usage in bytes</td>
</tr>
<tr>
<td></td>
<td>mem_limit</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>memory limit (max mem) in bytes</td>
</tr>
<tr>
<td></td>
<td>mem_percent</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>memory usage in percent</td>
</tr>
<tr>
<td></td>
<td>cpu_percent</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>cpu usage in percent</td>
</tr>
<tr>
<td></td>
<td>pids</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>number of processes</td>
</tr>
<tr>
<td></td>
<td>netIO.rx</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>received bytes via network</td>
</tr>
<tr>
<td></td>
<td>netIO.wx</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>sent bytes via network</td>
</tr>
<tr>
<td></td>
<td>blockIO.r</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>bytes read from BlockIO</td>
</tr>
<tr>
<td></td>
<td>blockIO.w</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>bytes written to BlockIO</td>
</tr>
<tr>
<td></td>
<td>cpu_stats</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>detailed cpu stats</td>
</tr>
<tr>
<td></td>
<td>percpu_stats</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>detailed per cpu stats</td>
</tr>
<tr>
<td></td>
<td>memory_stats</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>detailed memory stats</td>
</tr>
<tr>
<td></td>
<td>networks</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>detailed network stats per interface</td>
</tr>
<tr>
<td>si.dockerContainerProcesses(id, cb)</td>
<td>[{...}]</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>array of processes inside a container</td>
</tr>
<tr>
<td></td>
<td>[0].pid_host</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process ID (host)</td>
</tr>
<tr>
<td></td>
<td>[0].ppid</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>parent process ID</td>
</tr>
<tr>
<td></td>
<td>[0].pgid</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process group ID</td>
</tr>
<tr>
<td></td>
<td>[0].user</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>effective user name</td>
</tr>
<tr>
<td></td>
<td>[0].ruser</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>real user name</td>
</tr>
<tr>
<td></td>
<td>[0].group</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>effective group name</td>
</tr>
<tr>
<td></td>
<td>[0].rgroup</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>real group name</td>
</tr>
<tr>
<td></td>
<td>[0].stat</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process state</td>
</tr>
<tr>
<td></td>
<td>[0].time</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>accumulated CPU time</td>
</tr>
<tr>
<td></td>
<td>[0].elapsed</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>elapsed running time</td>
</tr>
<tr>
<td></td>
<td>[0].nice</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>nice value</td>
</tr>
<tr>
<td></td>
<td>[0].rss</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>resident set size</td>
</tr>
<tr>
<td></td>
<td>[0].vsz</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>virtual size in Kbytes</td>
</tr>
<tr>
<td></td>
<td>[0].command</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>command and arguments</td>
</tr>
<tr>
<td>si.dockerAll(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>list of all containers including their stats<br />and processes in one single array</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

665
docs/filesystem.html Normal file
View File

@ -0,0 +1,665 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Disks and File System</div>
<div class="text">
<p>In this section you will learn how to get disks information, file system information disk I/O stats and file system stats:</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>Disk Layout, Block Devices and Disks IO</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.diskLayout(cb)</td>
<td>[{...}]</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>physical disk layout (array)</td>
</tr>
<tr>
<td></td>
<td>[0].type</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>HD, SSD</td>
</tr>
<tr>
<td></td>
<td>[0].name</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>disk name</td>
</tr>
<tr>
<td></td>
<td>[0].vendor</td>
<td>X</td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>vendor/producer</td>
</tr>
<tr>
<td></td>
<td>[0].firmwareRevision</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>firmware revision</td>
</tr>
<tr>
<td></td>
<td>[0].serialNum</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>serial number</td>
</tr>
<tr>
<td></td>
<td>[0].interfaceType</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td></td>
</tr>
<tr>
<td></td>
<td>[0].size</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>size in bytes</td>
</tr>
<tr>
<td></td>
<td>[0].totalCylinders</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>total cylinders</td>
</tr>
<tr>
<td></td>
<td>[0].totalHeads</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>total heads</td>
</tr>
<tr>
<td></td>
<td>[0].totalTracks</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>total tracks</td>
</tr>
<tr>
<td></td>
<td>[0].tracksPerCylinder</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>tracks per cylinder</td>
</tr>
<tr>
<td></td>
<td>[0].sectorsPerTrack</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>sectors per track</td>
</tr>
<tr>
<td></td>
<td>[0].totalSectors</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>total sectors</td>
</tr>
<tr>
<td></td>
<td>[0].bytesPerSector</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>bytes per sector</td>
</tr>
<tr>
<td></td>
<td>[0].smartStatus</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>S.M.A.R.T Status (see Known Issues)</td>
</tr>
<tr>
<td>si.blockDevices(cb)</td>
<td>[{...}]</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>returns array of disks, partitions,<br />raids and roms</td>
</tr>
<tr>
<td></td>
<td>[0].name</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>name</td>
</tr>
<tr>
<td></td>
<td>[0].type</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>type</td>
</tr>
<tr>
<td></td>
<td>[0].fstype</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>file system type (e.g. ext4)</td>
</tr>
<tr>
<td></td>
<td>[0].mount</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>mount point</td>
</tr>
<tr>
<td></td>
<td>[0].size</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>size in bytes</td>
</tr>
<tr>
<td></td>
<td>[0].physical</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>physical type (HDD, SSD, CD/DVD)</td>
</tr>
<tr>
<td></td>
<td>[0].uuid</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>UUID</td>
</tr>
<tr>
<td></td>
<td>[0].label</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>label</td>
</tr>
<tr>
<td></td>
<td>[0].model</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>model</td>
</tr>
<tr>
<td></td>
<td>[0].serial</td>
<td>X</td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>serial</td>
</tr>
<tr>
<td></td>
<td>[0].removable</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>serial</td>
</tr>
<tr>
<td></td>
<td>[0].protocol</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>protocol (SATA, PCI-Express, ...)</td>
</tr>
<tr>
<td>si.disksIO(cb)</td>
<td>{...}</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>current transfer stats</td>
</tr>
<tr>
<td></td>
<td>rIO</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>read IOs on all mounted drives</td>
</tr>
<tr>
<td></td>
<td>wIO</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>write IOs on all mounted drives</td>
</tr>
<tr>
<td></td>
<td>tIO</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>write IOs on all mounted drives</td>
</tr>
<tr>
<td></td>
<td>rIO_sec</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>read IO per sec (* see notes)</td>
</tr>
<tr>
<td></td>
<td>wIO_sec</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>write IO per sec (* see notes)</td>
</tr>
<tr>
<td></td>
<td>tIO_sec</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>total IO per sec (* see notes)</td>
</tr>
<tr>
<td></td>
<td>ms</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>interval length (for per second values)</td>
</tr>
</tbody>
</table>
<h2>File System and File System Stats</h2>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.fsSize(cb)</td>
<td>[{...}]</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>returns array of mounted file systems</td>
</tr>
<tr>
<td></td>
<td>[0].fs</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>name of file system</td>
</tr>
<tr>
<td></td>
<td>[0].type</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>type of file system</td>
</tr>
<tr>
<td></td>
<td>[0].size</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>sizes in bytes</td>
</tr>
<tr>
<td></td>
<td>[0].used</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>used in bytes</td>
</tr>
<tr>
<td></td>
<td>[0].use</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>used in %</td>
</tr>
<tr>
<td></td>
<td>[0].mount</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>mount point</td>
</tr>
<tr>
<td>si.fsStats(cb)</td>
<td>{...}</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>current transfer stats</td>
</tr>
<tr>
<td></td>
<td>rx</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>bytes read since startup</td>
</tr>
<tr>
<td></td>
<td>wx</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>bytes written since startup</td>
</tr>
<tr>
<td></td>
<td>tx</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>total bytes read + written since startup</td>
</tr>
<tr>
<td></td>
<td>rx_sec</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>bytes read / second (* see notes)</td>
</tr>
<tr>
<td></td>
<td>wx_sec</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>bytes written / second (* see notes)</td>
</tr>
<tr>
<td></td>
<td>tx_sec</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>total bytes reads + written / second</td>
</tr>
<tr>
<td></td>
<td>ms</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>interval length (for per second values)</td>
</tr>
</tbody>
</table>
<h4>Getting correct stats values</h4>
<p>In <span class="code">disksIO()</span> and <span class="code">fsStats()</span> the
results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning with the <strong>second</strong> 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.</p>
<p>The first time you are calling one of this functions, you will get <span class="code">-1</span> for transfer rates.
The second time, you should then get statistics based on the time between the two calls ...</p>
<p>So basically, if you e.g. need a values for filesystem stats stats every second, your code should look like this:</p>
<pre><code class="js">const si = require('systeminformation');
setInterval(function() {
si.fsStats().then(data => {
console.log(data);
})
}, 1000)</code></pre>
<p>Beginning with the second call, you get network transfer values per second.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

222
docs/general.html Normal file
View File

@ -0,0 +1,222 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">General</div>
<div class="text">
<p>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.</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>Lib-Version and Time/Timezone</h2>
<p>The first two functions just gibe back system information library version and time/timezone information of your machine:</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.version()</td>
<td>: string</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>lib version (no callback/promise)</td>
</tr>
<tr>
<td>si.time()</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>object (no callback/promise) with:</td>
</tr>
<tr>
<td></td>
<td>current</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>local (server) time</td>
</tr>
<tr>
<td></td>
<td>uptime</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>uptime</td>
</tr>
<tr>
<td></td>
<td>timezone</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>e.g. GMT+0200</td>
</tr>
<tr>
<td></td>
<td>timezoneName</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>e.g. CEST</td>
</tr>
</tbody>
</table>
<p>Keep in mind, that there is another function <span class="code">si.versions()</span> that will return versions of other system libraries and software packages</p>
<h2>Get All At Once</h2>
<p>The following three functions <span class="code">si.getStaticData()</span>, <span class="code">si.getDynamicData()</span> and <span class="code">si.getAllData()</span> will return most of the available data in a single result object:</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.getStaticData(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>all static data at once</td>
</tr>
<tr>
<td>si.getDynamicData(srv,iface,cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>all dynamic data at once</td>
</tr>
<tr>
<td>si.getAllData(srv,iface,cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>all data at once</td>
</tr>
</tbody>
</table>
<p><strong>Static data</strong> is all hardware related (or more or less constant) data like system, baseboard, bios, OS, versions, cpu, network interfces, memory and disk layout</p>
<p><strong>Dynamic data</strong> will return user, cpu-speed, load, processes, services, temperature, file system, network and disk stats, ... </p>
<p>As not all funtions are supported in each operating system the result object might be different in each OS.</p>
<p><strong>ATTENTION</strong>: Use this only if you really need ALL information. Especially on Windows this can take really long (up to 20 seconds) because the underlying <span class="code">WMIC</span> command is very slow when using it the first time.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

167
docs/gettingstarted.html Normal file
View File

@ -0,0 +1,167 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Quick Start</div>
<div class="text">
<p>Lightweight collection of 35+ functions to retrieve detailed hardware, system and OS information.</p>
<ul>
<li>simple to use</li>
<li>get detailed information about system, cpu, baseboard, battery, memory, disks/filesystem, network, docker, software, services and processes</li>
<li>supports Linux, macOS, partial Windows, FreeBSD and SunOS support</li>
<li>no npm dependencies (for production)</li>
</ul>
<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 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.</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) 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.</p>
<p>If you have comments, suggestions &amp; reports, please feel free to contact me on <a href="https://github.com/sebhildebrandt/systeminformation/issues">github</a>!</p>
<p>I also created a nice little command line tool called <a href="https://github.com/sebhildebrandt/mmon" rel="nofollow">mmon</a> (micro-monitor) for Linux and macOS, also available via <a href="https://github.com/sebhildebrandt/mmon" rel="nofollow">github</a> and <a href="https://npmjs.org/package/mmon" rel="nofollow">npm</a></p>
<h2>Installation</h2>
<pre>$ npm install systeminformation --save</pre>
<h2>Usage</h2>
<p>All functions (except <span class="code">version</span> and <span class="code">time</span>) are implemented as asynchronous functions. Here a small example how to use them:</p>
<pre><code class="js">const si = require('systeminformation');
// promises style - new since version 3
si.cpu()
.then(data => console.log(data))
.catch(error => console.error(error));
</code></pre>
<h2>Callback, Promises, Awync Await</h2>
<p>Remember: all functions (except <span class="code">version</span> and <span class="code">time</span>) are implemented as asynchronous functions! There are now three ways to consume them:</p>
<p><strong>Callback Style</strong></p>
<pre><code class="js">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('...');
})</code></pre><br>
<p><strong>Promise Style</strong></p>
<p>Promises style is new since version 3.0.<p></p>
<p>When omitting callback parameter (cb), then you can use all function in a promise oriented way. All functions (exept of <span class="code">version</span> and <span class="code">time</span>) are returning a promise, that you can consume:</p>
<pre><code class="js">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));</code></pre><br>
<p><strong>Async/Await Style</strong></p>
<p>Since node v7.6 you can also use the async / await pattern. The above example would then look like this:</p>
<pre><code class="js">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)
}
}</code></pre><br>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

279
docs/graphics.html Normal file
View File

@ -0,0 +1,279 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Graphics</div>
<div class="text">
<p>In this section you will learn how to get information about installed graphics conrollers and connected displays:</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>Graphics Controllers, Displays</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.graphics(cb)</td>
<td>{...}</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>arrays of graphics controllers and displays</td>
</tr>
<tr>
<td></td>
<td>controllers[]</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>graphics controllers array</td>
</tr>
<tr>
<td></td>
<td>...[0].model</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>graphics controller model</td>
</tr>
<tr>
<td></td>
<td>...[0].vendor</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>e.g. ATI</td>
</tr>
<tr>
<td></td>
<td>...[0].bus</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>on which bus (e.g. PCIe)</td>
</tr>
<tr>
<td></td>
<td>...[0].vram</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>VRAM size (in MB)</td>
</tr>
<tr>
<td></td>
<td>...[0].vramDynamic</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>true if dynamicly allocated ram</td>
</tr>
<tr>
<td></td>
<td>displays[]</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>monitor/display Array</td>
</tr>
<tr>
<td></td>
<td>...[0].model</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>monitor/display Model</td>
</tr>
<tr>
<td></td>
<td>...[0].main</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>true if main monitor</td>
</tr>
<tr>
<td></td>
<td>...[0].builtin</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>true if built in monitor</td>
</tr>
<tr>
<td></td>
<td>...[0].connection</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>e.g. DisplayPort or HDMI</td>
</tr>
<tr>
<td></td>
<td>...[0].sizex</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>size in mm horizontal</td>
</tr>
<tr>
<td></td>
<td>...[0].sizey</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td>size in mm vertical</td>
</tr>
<tr>
<td></td>
<td>...[0].pixeldepth</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>color depth in bits</td>
</tr>
<tr>
<td></td>
<td>...[0].resolutionx</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>pixel horizontal</td>
</tr>
<tr>
<td></td>
<td>...[0].resolutiony</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>pixel vertical</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

1076
docs/history.html Normal file
View File

File diff suppressed because it is too large Load Diff

196
docs/index.html
View File

@ -1,16 +1,194 @@
<!DOCTYPE html> <!doctype html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <!-- Required meta tags -->
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="ie=edge"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>systeminformation</title>
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<title>systeminformation</title>
<script>
function numberWithCommas(x) {
return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ",");
}
function getDownloads() {
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function () {
if (this.readyState == 4 && this.status == 200) {
var downloads = JSON.parse(this.responseText);
document.getElementById("downloads").innerHTML = numberWithCommas(downloads.downloads);
}
};
xhttp.open("GET", "https://api.npmjs.org/downloads/point/last-month/systeminformation", true);
xhttp.send();
}
function getVersion() {
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function () {
if (this.readyState == 4 && this.status == 200) {
var package = JSON.parse(this.responseText);
document.getElementById("version").innerHTML = package.version;
}
};
xhttp.open("GET", "https://registry.npmjs.org/systeminformation/latest", true);
xhttp.send();
}
</script>
</head> </head>
<body> <body onload="getDownloads()">
<h1>systeminformation</h1> <header class="bg-image-full" style="background-image: url('./assets/motherboard.jpg');">
<p>Simple system and OS information library for node.js</p> <img class="logo" src="assets/logo.png">
<div class="title">systeminformation</div>
<div class="subtitle">Simple system and OS information library for node.js</div>
<div class="version">Current Version: <span id="version">4.0.0</span></div>
<div class="text"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</header>
<section class="container">
<div class="row">
<div class="col-12 sectionheader index">
<div class="title">Quick Start</div>
<div class="subtitle">Lightweight collection of 35+ functions to retrieve detailed hardware, system and OS information. For Linux, macOS, partial Windows, FreeBSD and SunOS support</div>
</div>
</div>
<div class="row justify-content-center sectionheader index">
<div class="col-8">
<hr>
</div>
</div>
<div class="row number-section">
<div class="col-xl-4 col-lg-4 col-md-4 col-12">
<div class="numbers">7,676</div>
<div class="title">Lines of code</div>
</div>
<div class="col-xl-4 col-lg-4 col-md-4 col-12">
<div id="downloads" class="numbers">...</div>
<div class="title">Downloads last month</div>
</div>
<div class="col-xl-4 col-lg-4 col-md-4 col-12">
<div class="numbers">115</div>
<div class="title">Dependends</div>
</div>
</div>
<div class="row justify-content-center sectionheader index">
<div class="col-8">
<hr>
</div>
</div>
<div class="row">
<div class="col-12 sectionheader index">
<div class="title">Documentation</div>
<div class="subtitle">Detailed documentation and reference for Version 4.x.x</div>
</div>
</div>
<div class="row index">
<a href="gettingstarted.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-download"></i></div>
<div class="icontitle">Getting Started</div>
</a>
<a href="general.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-th-list"></i></div>
<div class="icontitle">General</div>
</a>
<a href="system.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-server"></i></div>
<div class="icontitle">System</div>
</a>
<a href="cpu.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-microchip"></i></div>
<div class="icontitle">CPU</div>
</a>
<a href="memory.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-memory"></i></div>
<div class="icontitle">Memory</div>
</a>
<a href="battery.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-battery-half"></i></div>
<div class="icontitle">Battery</div>
</a>
<a href="filesystem.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-hdd"></i></div>
<div class="icontitle">Disks / FS</div>
</a>
<a href="graphics.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-desktop"></i></div>
<div class="icontitle">Graphics</div>
</a>
<a href="os.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-window"></i></div>
<div class="icontitle">OS</div>
</a>
<a href="network.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-network-wired"></i></div>
<div class="icontitle">Network</div>
</a>
<a href="processes.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fal fa-chart-line"></i></div>
<div class="icontitle">Processes / Load</div>
</a>
<a href="docker.html" class="col-xl-3 col-lg-4 col-md-4 col-6 features">
<div class="icons"><i class="fab fa-docker"></i></div>
<div class="icontitle">Docker</div>
</a>
</div>
<div class="row justify-content-center sectionheader index">
<div class="col-8">
<hr>
</div>
</div>
<div class="row">
<div class="col-12 sectionheader index">
<div class="title-small">Issues</div>
<div class="text">If you run into problems, please check out <a href="issues.html">known issues page</a> first. 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><br /><br /><br /></div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<!-- Optional JavaScript -->
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script>
window.onload = function (e) {
getDownloads();
}
</script>
</body> </body>
</html> </html>

116
docs/issues.html Normal file
View File

@ -0,0 +1,116 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Known Issues</div>
<div class="text">
<h4>macOS - Temperature</h4>
<p>To be able to measure temperature on macOS I created a little additional package. Due to some difficulties in NPM with <span class="code">optionalDependencies</span>
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.</p>
<p>But if you need to detect macOS temperature just run the following additional installation command:</p>
<pre>$ npm install osx-temperature-sensor --save</pre>
<p>systeminformation will then detect this additional library and return the temperature when calling systeminformations standard function <span class="code">cpuTemperature()</span></p>
<h4>Windows Temperature, Battery, ...</h4>
<p><span class="code">wmic</span> - 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.</p>
<h4>Linux Temperature</h4>
<p>In some cases you need to install the linux <span class="code">sensors</span> package to be able to measure temperature e.g. on DEBIAN based systems by running</p>
<pre>$ sudo apt-get install lm-sensors</pre>
<h4>Linux S.M.A.R.T. Status</h4>
<p>To be able to detect S.M.A.R.T. status on Linux you need to install <span class="code">smartmontools</span>. On DEBIAN based linux distributions you can install it by running:</p>
<pre>$ sudo apt-get install smartmontools</pre>
<h4>Stats Functions</h4>
<p>To get correct values with <span class="code">fsStats()</span>, <span class="code">disksIO()</span> and <span class="code">networkStats()</span> please check <a href="statsfunctions.html">this guide</a></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>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

57
docs/main.js Normal file
View File

@ -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);
}
}
}

329
docs/memory.html Normal file
View File

@ -0,0 +1,329 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Memory</div>
<div class="text">
<p>In this section you will learn how to get overall memory information (usage by OS) and memory module layout:</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>System Memory and Memory Layout</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.mem(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>Memory information (object)</td>
</tr>
<tr>
<td></td>
<td>total</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>total memory in bytes</td>
</tr>
<tr>
<td></td>
<td>free</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>not used in bytes</td>
</tr>
<tr>
<td></td>
<td>used</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>used (incl. buffers/cache)</td>
</tr>
<tr>
<td></td>
<td>active</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>used actively (excl. buffers/cache)</td>
</tr>
<tr>
<td></td>
<td>buffcache</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td>used by buffers+cache</td>
</tr>
<tr>
<td></td>
<td>available</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>potentially available (total - active)</td>
</tr>
<tr>
<td></td>
<td>swaptotal</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
</tr>
<tr>
<td></td>
<td>swapused</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
</tr>
<tr>
<td></td>
<td>swapfree</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
</tr>
<tr>
<td>si.memLayout(cb)</td>
<td>[{...}]</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>Memory Layout (array of objects)</td>
</tr>
<tr>
<td></td>
<td>[0].size</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>size in bytes</td>
</tr>
<tr>
<td></td>
<td>[0].bank</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>memory bank</td>
</tr>
<tr>
<td></td>
<td>[0].type</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>memory type</td>
</tr>
<tr>
<td></td>
<td>[0].clockSpeed</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>clock speed</td>
</tr>
<tr>
<td></td>
<td>[0].formFactor</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>form factor</td>
</tr>
<tr>
<td></td>
<td>[0].manufacturer</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>manufacturer</td>
</tr>
<tr>
<td></td>
<td>[0].partNum</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>part number</td>
</tr>
<tr>
<td></td>
<td>[0].serialNum</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>serial number</td>
</tr>
<tr>
<td></td>
<td>[0].voltageConfigured</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>voltage conf.</td>
</tr>
<tr>
<td></td>
<td>[0].voltageMin</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>voltage min</td>
</tr>
<tr>
<td></td>
<td>[0].voltageMax</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>voltage max</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

425
docs/network.html Normal file
View File

@ -0,0 +1,425 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Network</div>
<div class="text">
<p>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):</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>Network Interfaces, Network Stats, Network Connections</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.networkInterfaces(cb)</td>
<td>[{...}]</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>array of network interfaces</td>
</tr>
<tr>
<td></td>
<td>[0].iface</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>interface name</td>
</tr>
<tr>
<td></td>
<td>[0].ip4</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>ip4 address</td>
</tr>
<tr>
<td></td>
<td>[0].ip6</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>ip6 address</td>
</tr>
<tr>
<td></td>
<td>[0].mac</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>MAC address</td>
</tr>
<tr>
<td></td>
<td>[0].internal</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>true if internal interface</td>
</tr>
<tr>
<td>si.networkInterfaceDefault(cb)</td>
<td>: string</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>get name of default network interface</td>
</tr>
<tr>
<td>si.networkStats(iface,cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>current network stats of given interface<br />iface parameter is optional<br />defaults to first external network interface</td>
</tr>
<tr>
<td></td>
<td>iface</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>interface</td>
</tr>
<tr>
<td></td>
<td>operstate</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>up / down</td>
</tr>
<tr>
<td></td>
<td>rx</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>received bytes overall</td>
</tr>
<tr>
<td></td>
<td>tx</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>transferred bytes overall</td>
</tr>
<tr>
<td></td>
<td>rx_sec</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>received bytes / second (* see notes)</td>
</tr>
<tr>
<td></td>
<td>tx_sec</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>transferred bytes per second (* see notes)</td>
</tr>
<tr>
<td></td>
<td>ms</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>interval length (for per second values)</td>
</tr>
<tr>
<td>si.networkConnections(cb)</td>
<td>[{...}]</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>current network network connections<br />returns an array of all connections</td>
</tr>
<tr>
<td></td>
<td>[0].protocol</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>tcp or udp</td>
</tr>
<tr>
<td></td>
<td>[0].localaddress</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>local address</td>
</tr>
<tr>
<td></td>
<td>[0].localport</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>local port</td>
</tr>
<tr>
<td></td>
<td>[0].peeraddress</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>peer address</td>
</tr>
<tr>
<td></td>
<td>[0].peerport</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>peer port</td>
</tr>
<tr>
<td></td>
<td>[0].state</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>like ESTABLISHED, TIME_WAIT, ...</td>
</tr>
</tbody>
</table>
<h2>Site availability, Internet Latency</h2>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.inetChecksite(url, cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>response-time (ms) to fetch given URL</td>
</tr>
<tr>
<td></td>
<td>url</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>given url</td>
</tr>
<tr>
<td></td>
<td>ok</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>status code OK (2xx, 3xx)</td>
</tr>
<tr>
<td></td>
<td>status</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>status code</td>
</tr>
<tr>
<td></td>
<td>ms</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>response time in ms</td>
</tr>
<tr>
<td>si.inetLatency(host, cb)</td>
<td>: number</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>response-time (ms) to external resource<br />host parameter is optional (default 8.8.8.8)</td>
</tr>
</tbody>
</table>
<h4>Getting correct stats values</h4>
<p>In <span class="code">networkStats()</span> the
results / sec. values (rx_sec, tx_sec, ...) are calculated correctly beginning with the <strong>second</strong> 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.</p>
<p>The first time you are calling one of this functions, you will get <span class="code">-1</span> for transfer rates.
The second time, you should then get statistics based on the time between the two calls ...</p>
<p>So basically, if you e.g. need a values for filesystem stats stats every second, your code should look like this:</p>
<pre><code class="js">const si = require('systeminformation');
setInterval(function() {
si.networkStats().then(data => {
console.log(data);
})
}, 1000)</code></pre>
<p>Beginning with the second call, you get network transfer values per second.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

339
docs/os.html Normal file
View File

@ -0,0 +1,339 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">OS</div>
<div class="text">
<p>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:</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>Operating System, Shell, Versions, Users</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.osInfo(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>OS information</td>
</tr>
<tr>
<td></td>
<td>platform</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>'Linux', 'Darwin', 'Windows'</td>
</tr>
<tr>
<td></td>
<td>distro</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
</tr>
<tr>
<td></td>
<td>release</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
</tr>
<tr>
<td></td>
<td>codename</td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td></td>
<td>kernel</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>kernel release - same as os.release()</td>
</tr>
<tr>
<td></td>
<td>arch</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>same as os.arch()</td>
</tr>
<tr>
<td></td>
<td>hostname</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>same as os.hostname()</td>
</tr>
<tr>
<td></td>
<td>codepage</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>OS build version</td>
</tr>
<tr>
<td></td>
<td>logofile</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>e.g. 'apple', 'debian', 'fedora', ...</td>
</tr>
<tr>
<td></td>
<td>serial</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>OS/Host serial number</td>
</tr>
<tr>
<td></td>
<td>build</td>
<td></td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>OS build version</td>
</tr>
<tr>
<td>si.uuid(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>object of several UUIDs</td>
</tr>
<tr>
<td></td>
<td>os</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>os specific UUID</td>
</tr>
<tr>
<td>si.shell(cb)</td>
<td>: string</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td></td>
<td>standard shell</td>
</tr>
<tr>
<td>si.versions(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>version information (kernel, ssl, node, ...)</td>
</tr>
<tr>
<td>si.users(cb)</td>
<td>[{...}]</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>array of users online</td>
</tr>
<tr>
<td></td>
<td>[0].user</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>user name</td>
</tr>
<tr>
<td></td>
<td>[0].tty</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>terminal</td>
</tr>
<tr>
<td></td>
<td>[0].date</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>login date</td>
</tr>
<tr>
<td></td>
<td>[0].time</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>login time</td>
</tr>
<tr>
<td></td>
<td>[0].ip</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td>ip address (remote login)</td>
</tr>
<tr>
<td></td>
<td>[0].command</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td>last command or shell</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

579
docs/processes.html Normal file
View File

@ -0,0 +1,579 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Processes and Services</div>
<div class="text">
<p>In this section you will learn how to get information about current load, running processes and installed services:</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>Current Load, Processes, Services</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.currentLoad(cb)</td>
<td>{...}</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>CPU-Load</td>
</tr>
<tr>
<td></td>
<td>avgload</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>average load</td>
</tr>
<tr>
<td></td>
<td>currentload</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>CPU load in %</td>
</tr>
<tr>
<td></td>
<td>currentload_user</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>CPU load user in %</td>
</tr>
<tr>
<td></td>
<td>currentload_system</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>CPU load system in %</td>
</tr>
<tr>
<td></td>
<td>currentload_nice</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>CPU load nice in %</td>
</tr>
<tr>
<td></td>
<td>currentload_idle</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>CPU load idle in %</td>
</tr>
<tr>
<td></td>
<td>currentload_irq</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>CPU load system in %</td>
</tr>
<tr>
<td></td>
<td>raw_currentload...</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>CPU load raw values (ticks)</td>
</tr>
<tr>
<td></td>
<td>cpus[]</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>current loads per CPU in % + raw ticks</td>
</tr>
<tr>
<td>si.fullLoad(cb)</td>
<td>: integer</td>
<td>X</td>
<td></td>
<td>X</td>
<td>X</td>
<td></td>
<td>CPU full load since bootup in %</td>
</tr>
<tr>
<td>si.processes(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td># running processes</td>
</tr>
<tr>
<td></td>
<td>all</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td># of all processes</td>
</tr>
<tr>
<td></td>
<td>running</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td># of all processes running</td>
</tr>
<tr>
<td></td>
<td>blocked</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td># of all processes blocked</td>
</tr>
<tr>
<td></td>
<td>sleeping</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td># of all processes sleeping</td>
</tr>
<tr>
<td></td>
<td>unknown</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td># of all processes unknown status</td>
</tr>
<tr>
<td></td>
<td>list[]</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>list of all processes incl. details</td>
</tr>
<tr>
<td></td>
<td>...[0].pid</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process PID</td>
</tr>
<tr>
<td></td>
<td>...[0].parentPid</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>parent process PID</td>
</tr>
<tr>
<td></td>
<td>...[0].name</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process name</td>
</tr>
<tr>
<td></td>
<td>...[0].pcpu</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process % CPU usage</td>
</tr>
<tr>
<td></td>
<td>...[0].pcpuu</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>process % CPU usage (user)</td>
</tr>
<tr>
<td></td>
<td>...[0].pcpus</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>process % CPU usage (system)</td>
</tr>
<tr>
<td></td>
<td>...[0].pmem</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process memory %</td>
</tr>
<tr>
<td></td>
<td>...[0].priority</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process priotity</td>
</tr>
<tr>
<td></td>
<td>...[0].mem_vsz</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process virtual memory size</td>
</tr>
<tr>
<td></td>
<td>...[0].mem_rss</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process mem resident set size</td>
</tr>
<tr>
<td></td>
<td>...[0].nice</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td>process nice value</td>
</tr>
<tr>
<td></td>
<td>...[0].started</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process start time</td>
</tr>
<tr>
<td></td>
<td>...[0].state</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process state (e.g. sleeping)</td>
</tr>
<tr>
<td></td>
<td>...[0].tty</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td>tty from which process was started</td>
</tr>
<tr>
<td></td>
<td>...[0].user</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td>user who started process</td>
</tr>
<tr>
<td></td>
<td>...[0].command</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>process starting command</td>
</tr>
<tr>
<td>si.processLoad('apache2',cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>detailed information about given process</td>
</tr>
<tr>
<td></td>
<td>proc</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>process name</td>
</tr>
<tr>
<td></td>
<td>pid</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>PID</td>
</tr>
<tr>
<td></td>
<td>pids</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>additional pids</td>
</tr>
<tr>
<td></td>
<td>cpu</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>process % CPU</td>
</tr>
<tr>
<td></td>
<td>mem</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>process % MEM</td>
</tr>
<tr>
<td>si.services('mysql, apache2', cb)</td>
<td>[{...}]</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>pass comma separated string of services<br />pass &quot;*&quot; for ALL services (linux/win only)</td>
</tr>
<tr>
<td></td>
<td>[0].name</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>name of service</td>
</tr>
<tr>
<td></td>
<td>[0].running</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>true / false</td>
</tr>
<tr>
<td></td>
<td>[0].startmode</td>
<td></td>
<td></td>
<td></td>
<td>X</td>
<td></td>
<td>manual, automatic, ...</td>
</tr>
<tr>
<td></td>
<td>[0].pids</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td></td>
<td>pids</td>
</tr>
<tr>
<td></td>
<td>[0].pcpu</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td></td>
<td>process % CPU</td>
</tr>
<tr>
<td></td>
<td>[0].pmem</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td></td>
<td>process % MEM</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

104
docs/statsfunctions.html Normal file
View File

@ -0,0 +1,104 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">Stats Functions</div>
<div class="text">
<h4>Getting correct stats values</h4>
<p>In <span class="code">fsStats()</span>, <span class="code">disksIO()</span> and <span class="code">networkStats()</span> the
results / sec. values (rx_sec, IOPS, ...) are calculated correctly beginning with the <strong>second</strong> 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.</p>
<p>The first time you are calling one of this functions, you will get <span class="code">-1</span> for transfer rates.
The second time, you should then get statistics based on the time between the two calls ...</p>
<p>So basically, if you e.g. need a values for network stats every second, your code should look like this:</p>
<pre>const si = require('systeminformation');
setInterval(function() {
si.networkStats().then(data => {
console.log(data);
})
}, 1000)</pre>
<p>Beginning with the second call, you get network transfer values per second.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

520
docs/styles.css Normal file
View File

@ -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 */

9
docs/styles.css.map Normal file
View File

File diff suppressed because one or more lines are too long

357
docs/styles.scss Normal file
View File

@ -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;
}
}

289
docs/system.html Normal file
View File

@ -0,0 +1,289 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader">
<div class="title">System (Hardware)</div>
<div class="text">
<p>In this section you will learn how to get basic system hardware data. We will cover the system, baseboard and bios:</p>
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
<pre><code class="js">const si = require('systeminformation');</code></pre>
<h2>System</h2>
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
<table class="table table-sm table-bordered table-striped">
<thead>
<tr>
<th>Function</th>
<th>Result object</th>
<th>Linux</th>
<th>BSD</th>
<th>Mac</th>
<th>Win</th>
<th>Sun</th>
<th>Comments</th>
</tr>
</thead>
<tbody>
<tr>
<td>si.system(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>hardware information</td>
</tr>
<tr>
<td></td>
<td>manufacturer</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>e.g. 'MSI' or 'DELL'</td>
</tr>
<tr>
<td></td>
<td>model</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>model/product e.g. 'MS-7823'</td>
</tr>
<tr>
<td></td>
<td>version</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>version e.g. '1.0'</td>
</tr>
<tr>
<td></td>
<td>serial</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>serial number</td>
</tr>
<tr>
<td></td>
<td>uuid</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>UUID</td>
</tr>
<tr>
<td></td>
<td>sku</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>SKU number</td>
</tr>
<tr>
<td>si.bios(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>hardware information</td>
</tr>
<tr>
<td></td>
<td>vendor</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>e.g. 'AMI'</td>
</tr>
<tr>
<td></td>
<td>version</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>version</td>
</tr>
<tr>
<td></td>
<td>releaseDate</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>release date</td>
</tr>
<tr>
<td></td>
<td>revision</td>
<td>X</td>
<td>X</td>
<td></td>
<td>X</td>
<td></td>
<td>revision</td>
</tr>
<tr>
<td>si.baseboard(cb)</td>
<td>{...}</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>hardware information</td>
</tr>
<tr>
<td></td>
<td>manufacturer</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>e.g. 'ASUS'</td>
</tr>
<tr>
<td></td>
<td>model</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>model / product name</td>
</tr>
<tr>
<td></td>
<td>version</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>version</td>
</tr>
<tr>
<td></td>
<td>serial</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>serial number</td>
</tr>
<tr>
<td></td>
<td>assetTag</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td>X</td>
<td></td>
<td>asset tag</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

107
docs/trademarks.html Normal file
View File

@ -0,0 +1,107 @@
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
<link rel="stylesheet" href="styles.css">
<script src="main.js"></script>
<title>systeminformation</title>
</head>
<body>
<nav class="nav" style="background-image: url('./assets/trianglify.png');">
<div class="container">
<a href="/"><img class="logo float-left" src="assets/logo.png">
<div class="title float-left">systeminformation</div>
</a>
<div class="text float-right"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
</div>
</nav>
<section class="container">
<div class="row">
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
</div>
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
<div class="row">
<div class="col-12 sectionheader left">
<div class="title">Trademarks</div>
<div class="text">
<p>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.</p>
<ul>
<li><strong>Node.js</strong> is a trademark of Joyent Inc.</li>
<li><strong>Linux</strong> is a registered trademark of Linus Torvalds</li>
<li><strong>Apple, macOS, OS X</strong> are registered trademarks of Apple Inc.</li>
<li><strong>Windows</strong> is a registered trademark of Microsoft Corporation</li>
<li><strong>Intel</strong> is a trademark of Intel Corporation</li>
<li><strong>AMD</strong> is a trademark of Advanced Micro Devices Inc.</li>
<li><strong>Raspberry Pi</strong> is a trademark of the Raspberry Pi Foundation</li>
<li><strong>Debian</strong> is a trademark of the Debian Project</li>
<li><strong>FreeBSD</strong> is a registered trademark of The FreeBSD Foundation</li>
<li><strong>Docker</strong> is a trademark of Docker, Inc.</li>
<li><strong>Ubuntu</strong> is a trademark of Canonical Ltd.</li>
<li><strong>CentOS</strong> is a trademark of Read Hat Inc.</li>
<li><strong>Sun, Solaris, OpenSolaris</strong> are registered trademarks of Sun Microsystems</li>
<li><strong>BSD</strong> is a registered trademark of UUnet Technologies, Inc.</li>
<li><strong>UNIX</strong> is a registered trademark of The Open Group.</li>
<li><strong>NVIDIA</strong> is a registered trademark of NVIDIA Corporation.</li>
<li><strong>MSI</strong> is a registered trademark Micro-Star International Co.</li>
<li><strong>DELL</strong> is a registered trademark of Dell Inc.</li>
<li><strong>ASUS</strong> is a registered trademark of ASUSTeK Computer.</li>
</ul>
<p>All other trademarks are the property of their respective owners.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
<footer class="container-fluid">
<div class="container">
<div class="row">
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="/">Home</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
<li><a href="contributors.html">Contributors</a></li>
<li><a href="sponsoring.html">Buy me a coffee</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="gettingstarted.html">Quick Start</a></li>
<li><a href="issues.html">Known Issues</a></li>
<li><a href="statsfunctions.html">Stats Functions</a></li>
<li><a href="history.html">Version history</a></li>
</ul>
</div>
<div class="col-lg-4 col-12">
<ul class="list-unstyled">
<li><a href="https://www.plus-innovations.com">&copy; 2019 Sebastian Hildebrandt, +innovations</a></li>
<li><a href="/copyright.html">Copyright &amp; License</a></li>
<li><a href="/trademarks.html">Trademarks</a></li>
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
</ul>
</div>
</div>
</div>
</footer>
<script>
window.onload = function (e) {
createMenu();
}
</script>
</body>
</html>

2
lib/battery.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/cpu.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/docker.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/dockerSocket.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/filesystem.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/graphics.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/index.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Contributors: Guillaume Legrain (https://github.com/glegrain) // Contributors: Guillaume Legrain (https://github.com/glegrain)

2
lib/internet.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/memory.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

4
lib/network.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT
@ -368,7 +368,7 @@ function networkInterfaces(callback) {
type = detail.type; 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'; type = 'wireless';
} }
} }

2
lib/osinfo.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/processes.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/system.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/users.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT

2
lib/util.js
View File

@ -4,7 +4,7 @@
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// Description: System Information - library // Description: System Information - library
// for Node.js // for Node.js
// Copyright: (c) 2014 - 2018 // Copyright: (c) 2014 - 2019
// Author: Sebastian Hildebrandt // Author: Sebastian Hildebrandt
// ---------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------
// License: MIT // License: MIT