added version 4 docs subfolder
This commit is contained in:
Sebastian Hildebrandt
parent
664b07abcc
commit
81de749f54
22
docs/v4/CODE_OF_CONDUCT.md
Normal file
22
docs/v4/CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,22 @@
|
||||
# Contributor Code of Conduct
|
||||
|
||||
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
|
||||
|
||||
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery
|
||||
* Personal attacks
|
||||
* Trolling or insulting/derogatory comments
|
||||
* Public or private harassment
|
||||
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
|
||||
* Other unethical or unprofessional conduct.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
|
||||
|
||||
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)
|
||||
12
docs/v4/CONTRIBUTING.md
Normal file
12
docs/v4/CONTRIBUTING.md
Normal file
@ -0,0 +1,12 @@
|
||||
## You want to contribute some code?
|
||||
|
||||
First of all: thank you for contributing to this repository. We are always looking for quality contributions and will be happy to accept your pull requests as long as they adhere to some basic rules:
|
||||
|
||||
* Please make sure that your contribution fits well in the project's context:
|
||||
* We are aiming to provide a high quality multi-platform system information library.
|
||||
* This package should stay without any dependencies on any external JavaScript library.
|
||||
|
||||
* Please assure that you are submitting quality code, specifically make sure that:
|
||||
* Your commits should not be breaking changes - if possible.
|
||||
* Your PR are well tested - if possible on multiple platforms / machines (please provide information against what systems it was tested).
|
||||
* If your commit needs a major version bump (breaking change), please leave a clear message in your comments. We try to keep the breaking changes as low as possible to avoid compatibility issues.
|
||||
BIN
docs/v4/assets/android-icon-192x192.png
Normal file
BIN
docs/v4/assets/android-icon-192x192.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.5 KiB |
BIN
docs/v4/assets/favicon-16x16.png
Normal file
BIN
docs/v4/assets/favicon-16x16.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.2 KiB |
BIN
docs/v4/assets/favicon-32x32.png
Normal file
BIN
docs/v4/assets/favicon-32x32.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.7 KiB |
BIN
docs/v4/assets/favicon-96x96.png
Normal file
BIN
docs/v4/assets/favicon-96x96.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
BIN
docs/v4/assets/logo.png
Normal file
BIN
docs/v4/assets/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
BIN
docs/v4/assets/logo_inv.png
Normal file
BIN
docs/v4/assets/logo_inv.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 59 KiB |
BIN
docs/v4/assets/motherboard.jpg
Normal file
BIN
docs/v4/assets/motherboard.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 67 KiB |
BIN
docs/v4/assets/title-empty.jpg
Normal file
BIN
docs/v4/assets/title-empty.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 81 KiB |
BIN
docs/v4/assets/title.jpg
Normal file
BIN
docs/v4/assets/title.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 343 KiB |
BIN
docs/v4/assets/trianglify.png
Normal file
BIN
docs/v4/assets/trianglify.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 144 KiB |
311
docs/v4/battery.html
Normal file
311
docs/v4/battery.html
Normal file
@ -0,0 +1,311 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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>designedcapacity</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>designed capacity of battery (mWh)</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 (mWh)</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 (mWh)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>capacityUnit</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>capacity unit (mWh if possible)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>voltage</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>current voltage of battery (V)</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>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.battery().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
hasbattery: true,
|
||||
cyclecount: 35,
|
||||
ischarging: false,
|
||||
designedcapacity: 64958,
|
||||
maxcapacity: 65865,
|
||||
currentcapacity: 64856,
|
||||
voltage: 12.767,
|
||||
capacityUnit: 'mWh',
|
||||
percent: 100,
|
||||
timeremaining: 551,
|
||||
acconnected: false,
|
||||
type: 'Li-ion',
|
||||
model: '',
|
||||
manufacturer: 'Apple',
|
||||
serial: 'F9Y19860Y9AH9XBAX'
|
||||
}</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2>Known issues</h2>
|
||||
<h4>Windows 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.</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
120
docs/v4/contributors.html
Normal file
120
docs/v4/contributors.html
Normal file
@ -0,0 +1,120 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<title>systeminformation</title>
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<nav class="nav">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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>
|
||||
<li>Rasmus Porsager <a href="https://github.com/porsager" rel="nofollow">porsager</a></li>
|
||||
<li>Nathan Patten <a href="https://github.com/nrpatten" rel="nofollow">nrpatten</a></li>
|
||||
<li>Juan Campuzano <a href="https://github.com/juancampuzano" rel="nofollow">juancampuzano</a></li>
|
||||
<li>Ricardo Polo <a href="https://github.com/ricardopolo" rel="nofollow">ricardopolo</a></li>
|
||||
<li>Miłosz Dźwigała <a href="https://github.com/mily20001" rel="nofollow">mily20001</a></li>
|
||||
<li>cconley717 <a href="https://github.com/cconley717" rel="nofollow">cconley717</a></li>
|
||||
</ul>
|
||||
<p>OSX Temperature: credits here are going to:</p>
|
||||
<ul>
|
||||
<li>Frank Stock <a href="https://github.com/pcafstockf" rel="nofollow">pcafstockf</a> for his work on <a href="https://github.com/pcafstockf/smc-reader" rel="nofollow">smc-reader</a></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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
115
docs/v4/copyright.html
Normal file
115
docs/v4/copyright.html
Normal file
@ -0,0 +1,115 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<title>systeminformation</title>
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<nav class="nav">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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">© 2021 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 "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:</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 "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
604
docs/v4/cpu.html
Normal file
604
docs/v4/cpu.html
Normal file
@ -0,0 +1,604 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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>governor</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>e.g. 'powersave'</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>efficiencyCores</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td># efficiency cores (ARM only)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>performanceCores</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td># performance cores (ARM only)</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. "LGA1356"</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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpu().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
manufacturer: 'Intel®',
|
||||
brand: 'Core™ i9-9900',
|
||||
vendor: 'GenuineIntel',
|
||||
family: '6',
|
||||
model: '158',
|
||||
stepping: '13',
|
||||
revision: '',
|
||||
voltage: '',
|
||||
speed: '3.10',
|
||||
speedmin: '0.80',
|
||||
speedmax: '5.00',
|
||||
governor: 'powersave',
|
||||
cores: 16,
|
||||
physicalCores: 8,
|
||||
processors: 1,
|
||||
socket: 'LGA1151',
|
||||
cache: { l1d: 262144, l1i: 262144, l2: 2, l3: 16 },
|
||||
flags: 'fpu vme de pse ...'
|
||||
}</pre>
|
||||
</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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpuFlags().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge
|
||||
</pre>
|
||||
</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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpuCache().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{ l1d: 262144, l1i: 262144, l2: 2, l3: 16 }
|
||||
</pre>
|
||||
</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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpuCurrentspeed().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
min: 0.86,
|
||||
max: 1.77,
|
||||
avg: 1.49,
|
||||
cores: [
|
||||
1.59, 1.71, 1.62, 1.57,
|
||||
1.66, 1.77, 1.74, 1.75,
|
||||
1.49, 1.51, 1.52, 1.59,
|
||||
1.56, 1.03, 0.86, 0.86
|
||||
]
|
||||
}
|
||||
</pre>
|
||||
</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>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.cpuTemperature().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{ main: 42, cores: [], max: 42 }
|
||||
</pre>
|
||||
</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
1089
docs/v4/docker.html
Normal file
1089
docs/v4/docker.html
Normal file
File diff suppressed because it is too large
Load Diff
BIN
docs/v4/favicon.ico
Normal file
BIN
docs/v4/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
896
docs/v4/filesystem.html
Normal file
896
docs/v4/filesystem.html
Normal file
@ -0,0 +1,896 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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].device</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>e.g. /dev/sda</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, NVMe</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].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].totalSectors</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>total sectors</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].bytesPerSector</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>bytes per sector</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>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>SATA, PCIe, ...</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></td>
|
||||
<td>[0].smartData</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>full S.M.A.R.T data from smartctl<br>requires at least smartmontools 7.0<br>(see Known Issues)</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.diskLayout().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
device: '/dev/nvme0n1',
|
||||
type: 'NVMe',
|
||||
name: 'SAMSUNG xxxxxxxxxxxx-xxxx',
|
||||
vendor: 'Samsung',
|
||||
size: 1024209543168,
|
||||
bytesPerSector: -1,
|
||||
totalCylinders: -1,
|
||||
totalHeads: -1,
|
||||
totalSectors: -1,
|
||||
totalTracks: -1,
|
||||
tracksPerCylinder: -1,
|
||||
sectorsPerTrack: -1,
|
||||
firmwareRevision: '',
|
||||
serialNum: '...serial....',
|
||||
interfaceType: 'PCIe',
|
||||
smartStatus: 'unknown',
|
||||
smartData: {
|
||||
json_format_version: [Array],
|
||||
smartctl: [Object],
|
||||
device: [Object],
|
||||
model_name: 'SAMSUNG xxxxxxxxxxxx-xxxx',
|
||||
serial_number: '...serial....',
|
||||
...
|
||||
}
|
||||
},
|
||||
{
|
||||
...
|
||||
}
|
||||
]</pre>
|
||||
</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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.blockDevices().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
name: 'nvme0n1',
|
||||
type: 'disk',
|
||||
fstype: '',
|
||||
mount: '',
|
||||
size: 1024209543168,
|
||||
physical: 'SSD',
|
||||
uuid: '',
|
||||
label: '',
|
||||
model: 'SAMSUNG xxxxxxxxxxxx-xxxx',
|
||||
serial: '... serial ...',
|
||||
removable: false,
|
||||
protocol: 'nvme',
|
||||
group: undefined
|
||||
},
|
||||
{
|
||||
...
|
||||
}
|
||||
]</pre>
|
||||
</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>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
setInterval(function() {
|
||||
si.disksIO().then(data => {
|
||||
console.log(data);
|
||||
})
|
||||
}, 1000)</code></pre class="example">
|
||||
<pre class="example">
|
||||
{ // first call
|
||||
rIO: 899825,
|
||||
wIO: 932331,
|
||||
tIO: 1832156,
|
||||
rIO_sec: -1,
|
||||
wIO_sec: -1,
|
||||
tIO_sec: -1,
|
||||
ms: 0
|
||||
}
|
||||
{ // second call
|
||||
rIO: 899863,
|
||||
wIO: 932331,
|
||||
tIO: 1832194,
|
||||
rIO_sec: 38.5395537525355,
|
||||
wIO_sec: 0,
|
||||
tIO_sec: 38.5395537525355,
|
||||
ms: 986
|
||||
}...</pre>
|
||||
</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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.fsSize().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
fs: '/dev/md2',
|
||||
type: 'ext4',
|
||||
size: 972577361920,
|
||||
used: 59142635520,
|
||||
use: 6.08,
|
||||
mount: '/'
|
||||
},
|
||||
{
|
||||
...
|
||||
}
|
||||
]</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.fsOpenFiles(cb)</td>
|
||||
<td>{...}</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>count max/allocated file descriptors</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>max</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>count max</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>allocated</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>count allocated</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>available</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>count available</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.fsOpenFiles().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
max: 6566555,
|
||||
allocated: 1856,
|
||||
available: 0
|
||||
}</pre>
|
||||
</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>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
setInterval(function() {
|
||||
si.fsStats().then(data => {
|
||||
console.log(data);
|
||||
})
|
||||
}, 1000)</code></pre class="example">
|
||||
<pre class="example">
|
||||
{ // first call
|
||||
rx: 14015849472,
|
||||
wx: 15316003328,
|
||||
tx: 29331852800,
|
||||
rx_sec: -1,
|
||||
wx_sec: -1,
|
||||
tx_sec: -1,
|
||||
ms: 0
|
||||
}
|
||||
{ // second call
|
||||
rx: 14015849472,
|
||||
wx: 15316007424,
|
||||
tx: 29331856896,
|
||||
rx_sec: 0,
|
||||
wx_sec: 4083.748753738784,
|
||||
tx_sec: 4083.748753738784,
|
||||
ms: 1003
|
||||
}...</pre>
|
||||
</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 file system 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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
361
docs/v4/general.html
Normal file
361
docs/v4/general.html
Normal file
@ -0,0 +1,361 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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" and "get-all" functions to get partial or all data with one single call.</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 give back systeminformation library version number and time/timezone information of your machine. These are the only two functions not returning a promise (so they are not async functions):</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 in number of seconds</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 Defined Result Object</h2>
|
||||
<p>Normally you would call each of the functions (where you want to get detailed system information) seperately. The docs pages contain a full reference (with examples) for each available function. But there is also another really handy way to get a self-defined result object in one single call:</p>
|
||||
<p>The <span class="code">si.get()</span> function is an alternative, where you can obtain several system information data in one call. You can define a json object which represents the data structure you are expecting and the <span class="code">si.get()</span> call will then return all of the requested 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>
|
||||
<tr>
|
||||
<td>si.get(valueObject,cb)</td>
|
||||
<td>{...}</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>get partial data at once<br>Specify return object for all<br>values that should be returned:</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
|
||||
// define all values, you want to get back
|
||||
valueObject = {
|
||||
cpu: '*',
|
||||
osInfo: 'platform, release',
|
||||
system: 'model, manufacturer'
|
||||
}
|
||||
|
||||
si.get(valueObject).then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
cpu: {
|
||||
manufacturer: 'Intel®',
|
||||
brand: 'Core™ i7-8569U',
|
||||
vendor: 'GenuineIntel',
|
||||
family: '6',
|
||||
model: '142',
|
||||
stepping: '10',
|
||||
revision: '',
|
||||
voltage: '',
|
||||
speed: '2.80',
|
||||
speedmin: '2.80',
|
||||
speedmax: '2.80',
|
||||
governor: '',
|
||||
cores: 8,
|
||||
physicalCores: 4,
|
||||
processors: 1,
|
||||
socket: '',
|
||||
cache: { l1d: 32768, l1i: 32768, l2: 262144, l3: 8388608 }
|
||||
},
|
||||
osInfo: {
|
||||
platform: 'darwin',
|
||||
release: '10.15.4'
|
||||
},
|
||||
system: {
|
||||
model: 'MacBookPro15,2',
|
||||
manufacturer: 'Apple Inc.'
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>The key names of the <span class="code">valueObject</span> must be exactly the same as the representing function within systeminformation.</p>
|
||||
<h3>Providing parameters to the get() function</h3>
|
||||
<p>Now you can also provide parameters to get() functions (where needed). Just pass the parameters in parentheses right after the wanted keys: have a look at the folloging example:</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>
|
||||
<tr>
|
||||
<td>si.get(valueObject,cb)</td>
|
||||
<td>{...}</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>example with parameters:<br>value in paretheses goes as parameter<br>to the given function:</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
|
||||
// define all values, you want to get back
|
||||
// here the value in paretheses goes as a parameter
|
||||
// to the processLoad function
|
||||
|
||||
valueObject = {
|
||||
processLoad: 'pids, cpu (postgres)'
|
||||
}
|
||||
si.get(valueObject).then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
processLoad: {
|
||||
pids: [
|
||||
640, 643, 654,
|
||||
655, 656, 657,
|
||||
658, 659
|
||||
],
|
||||
cpu: 0.63
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "*" for ALL services (linux/win only)<br>Pass "*" for ALL network interfaces</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<br>Specify services and interfaces to monitor<br>Defaults to first external network interface<br>Pass "*" for ALL services (linux/win only)<br>Pass "*" for ALL network interfaces</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
181
docs/v4/gettingstarted.html
Normal file
181
docs/v4/gettingstarted.html
Normal file
@ -0,0 +1,181 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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 40+ 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, OpenBSD, NetBSD 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 requires node.js version 4.0 and above.</p>
|
||||
|
||||
<p>I was able to test it on several Debian, Raspbian, Ubuntu distributions as well as macOS (Mavericks, Yosemite, El Captain, Sierra, High Sierra, Mojave) and some Windows 7, Windows 10, FreeBSD, OpenBSD, NetBSD and SunOS machines.
|
||||
Not all functions are supported on all operating systems. Have a look at the function reference in the docs to get further details.</p>
|
||||
<p>If you have comments, suggestions & 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>
|
||||
|
||||
<h3>Attention:</h3>
|
||||
<p>This library is supposed to be used as a <a href="https://nodejs.org/en/" rel="nofollow">node.js</a> backend/server-side library and will definilely not work within a browser.</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, Async 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>
|
||||
<p><strong>Issues</strong></p>
|
||||
<p>If you discover some empty or incorrect values, please be sure to first have a look at the <a href="issues.html">Known issues</a> section.</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
557
docs/v4/graphics.html
Normal file
557
docs/v4/graphics.html
Normal file
@ -0,0 +1,557 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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>...[0].subDeviceId</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - sub device ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].driverVersion</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - driver version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].name</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - name</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].pciBus</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - PCI bus ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].fanSpeed</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - fan speed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].memory total</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - memory total</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].memoryUsed</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - memory used</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].memoryFree</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - memory free</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].utilizationGpu</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - utilization GPU</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].utilizationMemory</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - utilization memory</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].temperatureGpu</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - temperature GPU</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].temperatureMemory</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - temperature memory</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].powerDraw</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - power draw</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].powerLimit</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - power limit</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].clockCore</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - clock core</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].clockMemory</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>(pptional nvidia-smi) - clock memory</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].vendor</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>monitor/display vendor</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].deviceName</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>e.g. \\.\DISPLAY1</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>X</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>X</td>
|
||||
<td></td>
|
||||
<td>e.g. DisplayPort, HDMI</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].sizex</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</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>X</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>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].currentResX</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>current pixel horizontal</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].currentResY</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>current pixel vertical</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].positionX</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>screen position X</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].positionY</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>screen position Y</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].currentRefreshRate</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>current screen refresh rate</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.graphics().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
controllers: [
|
||||
{
|
||||
vendor: 'Intel',
|
||||
model: 'Intel Iris Plus Graphics 655',
|
||||
bus: 'Built-In',
|
||||
vram: 1536,
|
||||
vramDynamic: true
|
||||
}
|
||||
],
|
||||
displays: [
|
||||
{
|
||||
vendor: '',
|
||||
model: 'Color LCD',
|
||||
main: true,
|
||||
builtin: false,
|
||||
connection: 'Internal',
|
||||
sizex: -1,
|
||||
sizey: -1,
|
||||
pixeldepth: 24,
|
||||
resolutionx: 2560,
|
||||
resolutiony: 1600,
|
||||
currentResX: 2560,
|
||||
currentResY: 1600,
|
||||
positionX: 0,
|
||||
positionY: 0,
|
||||
currentRefreshRate: -1
|
||||
}
|
||||
]
|
||||
}</pre>
|
||||
</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
2085
docs/v4/history.html
Normal file
2085
docs/v4/history.html
Normal file
File diff suppressed because it is too large
Load Diff
372
docs/v4/index.html
Normal file
372
docs/v4/index.html
Normal file
@ -0,0 +1,372 @@
|
||||
<!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">
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/typed.js/2.0.9/typed.min.js"></script>
|
||||
|
||||
<title>systeminformation</title>
|
||||
<script>
|
||||
let vh = window.innerHeight * 0.01;
|
||||
// Then we set the value in the --vh custom property to the root of the document
|
||||
document.documentElement.style.setProperty('--vh', `${vh}px`);
|
||||
|
||||
// We listen to the resize event
|
||||
// window.addEventListener('resize', () => {
|
||||
// // We execute the same script as before
|
||||
// let vh = window.innerHeight * 0.01;
|
||||
// document.documentElement.style.setProperty('--vh', `${vh}px`);
|
||||
// });
|
||||
function init() {
|
||||
typed();
|
||||
document.querySelector('.down').addEventListener('click', function () {
|
||||
scrollIt(
|
||||
document.querySelector('.quickstart'),
|
||||
600,
|
||||
'easeOutQuad',
|
||||
function () {
|
||||
console.log('READY')
|
||||
}
|
||||
);
|
||||
});
|
||||
getDownloads();
|
||||
}
|
||||
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();
|
||||
}
|
||||
function typed() {
|
||||
var options = {
|
||||
strings: ["System and OS information library for node.js", "Get detailed hardware, system & OS information.", "For Linux, macOS, Windows, FreeBSD, OpenBSD, NetBSD, SunOS"],
|
||||
typeSpeed: 60,
|
||||
loop: false,
|
||||
backDelay: 1200,
|
||||
|
||||
}
|
||||
var typed = new Typed('#typed', options);
|
||||
}
|
||||
function scrollIt(destination, duration = 200, easing = 'linear', callback) {
|
||||
|
||||
const easings = {
|
||||
linear(t) {
|
||||
return t;
|
||||
},
|
||||
easeInQuad(t) {
|
||||
return t * t;
|
||||
},
|
||||
easeOutQuad(t) {
|
||||
return t * (2 - t);
|
||||
},
|
||||
easeInOutQuad(t) {
|
||||
return t < 0.5 ? 2 * t * t : -1 + (4 - 2 * t) * t;
|
||||
},
|
||||
easeInCubic(t) {
|
||||
return t * t * t;
|
||||
},
|
||||
easeOutCubic(t) {
|
||||
return (--t) * t * t + 1;
|
||||
},
|
||||
easeInOutCubic(t) {
|
||||
return t < 0.5 ? 4 * t * t * t : (t - 1) * (2 * t - 2) * (2 * t - 2) + 1;
|
||||
},
|
||||
easeInQuart(t) {
|
||||
return t * t * t * t;
|
||||
},
|
||||
easeOutQuart(t) {
|
||||
return 1 - (--t) * t * t * t;
|
||||
},
|
||||
easeInOutQuart(t) {
|
||||
return t < 0.5 ? 8 * t * t * t * t : 1 - 8 * (--t) * t * t * t;
|
||||
},
|
||||
easeInQuint(t) {
|
||||
return t * t * t * t * t;
|
||||
},
|
||||
easeOutQuint(t) {
|
||||
return 1 + (--t) * t * t * t * t;
|
||||
},
|
||||
easeInOutQuint(t) {
|
||||
return t < 0.5 ? 16 * t * t * t * t * t : 1 + 16 * (--t) * t * t * t * t;
|
||||
}
|
||||
};
|
||||
|
||||
const start = window.pageYOffset;
|
||||
const startTime = 'now' in window.performance ? performance.now() : new Date().getTime();
|
||||
|
||||
const documentHeight = Math.max(document.body.scrollHeight, document.body.offsetHeight, document.documentElement.clientHeight, document.documentElement.scrollHeight, document.documentElement.offsetHeight);
|
||||
const windowHeight = window.innerHeight || document.documentElement.clientHeight || document.getElementsByTagName('body')[0].clientHeight;
|
||||
const destinationOffset = typeof destination === 'number' ? destination : destination.offsetTop;
|
||||
const destinationOffsetToScroll = Math.round(documentHeight - destinationOffset < windowHeight ? documentHeight - windowHeight : destinationOffset);
|
||||
|
||||
if ('requestAnimationFrame' in window === false) {
|
||||
window.scroll(0, destinationOffsetToScroll);
|
||||
if (callback) {
|
||||
callback();
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
function scroll() {
|
||||
const now = 'now' in window.performance ? performance.now() : new Date().getTime();
|
||||
const time = Math.min(1, ((now - startTime) / duration));
|
||||
const timeFunction = easings[easing](time);
|
||||
window.scroll(0, Math.ceil((timeFunction * (destinationOffsetToScroll - start)) + start));
|
||||
|
||||
if (window.pageYOffset === destinationOffsetToScroll) {
|
||||
if (callback) {
|
||||
callback();
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
requestAnimationFrame(scroll);
|
||||
}
|
||||
|
||||
scroll();
|
||||
}
|
||||
</script>
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<header class="bg-image-full">
|
||||
<div class="container">
|
||||
<a href="security.html" class="recommendation">Security advisory:<br>Update to v4.31.1</a>
|
||||
<img class="logo" src="assets/logo.png">
|
||||
<div class="title">systeminformation</div>
|
||||
<div class="subtitle"><span id="typed"></span></div>
|
||||
<div class="version">Current Version: <span id="version">4.34.9</span></div>
|
||||
<button class="btn btn-light" onclick="location.href='https://github.com/sebhildebrandt/systeminformation'">View on Github <i class=" fab fa-github"></i></button>
|
||||
</div>
|
||||
<div class="down">
|
||||
<button class="btn btn-primary mb-2" onclick="location.href='https://www.buymeacoffee.com/systeminfo'">Buy me a coffee <i class="far fa-mug-hot"></i></button>
|
||||
<br>Read Documentation<br>
|
||||
<i class="fal fa-caret-down caret"></i>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<section class="container quickstart">
|
||||
<div class="row">
|
||||
<div class="col-12 sectionheader index">
|
||||
<div class="title">Overview</div>
|
||||
<div class="subtitle">Lightweight collection of 40+ functions to retrieve detailed hardware, system and OS information. For Linux, macOS, partial Windows, FreeBSD, OpenBSD, NetBSD and SunOS support</div>
|
||||
<div class="npmicons">
|
||||
<a href="https://npmjs.org/package/systeminformation" rel="nofollow"><img src="https://camo.githubusercontent.com/df25636cbefadf18ca1532e3bdcd0d2794235e19/68747470733a2f2f696d672e736869656c64732e696f2f6e706d2f762f73797374656d696e666f726d6174696f6e2e7376673f7374796c653d666c61742d737175617265" alt="NPM Version" data-canonical-src="https://img.shields.io/npm/v/systeminformation.svg?style=flat-square" style="max-width:100%;"></a>
|
||||
<a href="https://david-dm.org/sebhildebrandt/systeminformation" rel="nofollow"><img src="https://camo.githubusercontent.com/69739c043c2be3a38545f105b89381a2a6310f59/68747470733a2f2f696d672e736869656c64732e696f2f64617669642f73656268696c64656272616e64742f73797374656d696e666f726d6174696f6e2e7376673f7374796c653d666c61742d737175617265" alt="deps status" data-canonical-src="https://img.shields.io/david/sebhildebrandt/systeminformation.svg?style=flat-square" style="max-width:100%;"></a>
|
||||
<a href="https://lgtm.com/projects/g/sebhildebrandt/systeminformation/context:javascript" rel="nofollow"><img src="https://camo.githubusercontent.com/08409d6fb3794545416e1a40ca75172b54d34692/68747470733a2f2f696d672e736869656c64732e696f2f6c67746d2f67726164652f6a6176617363726970742f672f73656268696c64656272616e64742f73797374656d696e666f726d6174696f6e2e7376673f7374796c653d666c61742d737175617265" alt="Code Quality: Javascript" data-canonical-src="https://img.shields.io/lgtm/grade/javascript/g/sebhildebrandt/systeminformation.svg?style=flat-square" style="max-width:100%;"></a>
|
||||
<a href="https://lgtm.com/projects/g/sebhildebrandt/systeminformation/alerts" rel="nofollow"><img src="https://camo.githubusercontent.com/66428127fdde80fc8247a0c1df4c651f3a6b1c0a/68747470733a2f2f696d672e736869656c64732e696f2f6c67746d2f616c657274732f672f73656268696c64656272616e64742f73797374656d696e666f726d6174696f6e2e7376673f7374796c653d666c61742d737175617265" alt="Total alerts" data-canonical-src="https://img.shields.io/lgtm/alerts/g/sebhildebrandt/systeminformation.svg?style=flat-square" style="max-width:100%;"></a>
|
||||
<a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://camo.githubusercontent.com/4b5966a2a252ee0f241a1e03b13417178eb4964f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265" alt="MIT license" data-canonical-src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" style="max-width:100%;"></a>
|
||||
</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">10,943</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">375</div>
|
||||
<div class="title">Dependents</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row justify-content-center sectionheader index">
|
||||
<div class="col-8">
|
||||
<hr>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row" id="docs">
|
||||
<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-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-download"></i></div>
|
||||
<div class="icontitle">Getting Started</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="general.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-th-list"></i></div>
|
||||
<div class="icontitle">General</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="system.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-server"></i></div>
|
||||
<div class="icontitle">System</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="cpu.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-microchip"></i></div>
|
||||
<div class="icontitle">CPU</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="memory.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-memory"></i></div>
|
||||
<div class="icontitle">Memory</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="battery.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-battery-half"></i></div>
|
||||
<div class="icontitle">Battery</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="graphics.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-desktop"></i></div>
|
||||
<div class="icontitle">Graphics</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="os.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-window"></i></div>
|
||||
<div class="icontitle">OS</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="processes.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-chart-line"></i></div>
|
||||
<div class="icontitle">Process/Service</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="filesystem.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-hdd"></i></div>
|
||||
<div class="icontitle">Disks / FS</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="network.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-network-wired"></i></div>
|
||||
<div class="icontitle">Network</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="wifi.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-wifi"></i></div>
|
||||
<div class="icontitle">Wifi</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="docker.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fab fa-docker"></i></div>
|
||||
<div class="icontitle">Docker</div>
|
||||
</div>
|
||||
</a>
|
||||
<a href="vbox.html" class="col-xl-3 col-lg-3 col-md-4 col-6 features">
|
||||
<div class="inner">
|
||||
<div class="icons"><i class="fal fa-box-open"></i></div>
|
||||
<div class="icontitle">Virtual Box</div>
|
||||
</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"><span class="bold">Security issues</span>: Please have a look at our <a href="security.html">security advisories</a></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></div>
|
||||
<div class="title-small">Upcoming ...</div>
|
||||
<div class="text"><span class="bold">MacOS on ARM</span> - new hardware already arrived and we made quite a few changes to support Apple silicon M1 chips. <a href="https://github.com/sebhildebrandt/systeminformation/issues/453">Current status is documented here.</a><br /></div>
|
||||
<div class="text"><span class="bold">Verion 5:</span> We are planning a new major version with some minor breaking changes and some additional features. We will try to make this available Q1 of 2021.<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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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) {
|
||||
init();
|
||||
}
|
||||
</script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
130
docs/v4/issues.html
Normal file
130
docs/v4/issues.html
Normal file
@ -0,0 +1,130 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<title>systeminformation</title>
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<nav class="nav">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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>
|
||||
<p>If you have smartmontools version >= 7.0 then you will get also full smart data in diskLayout()</p>
|
||||
|
||||
<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>Empty / incorrect values</h4>
|
||||
<p>If you discover empty or incorrect values, please keep in mind that some underlying commands need to be run under admin privileges. So if you run your scripts as normal users, not all system information values can be determined. For linux this is e.g. the case for `memLayout()`, advances `system()`, `bios()`, `baseboard()`, `cpu()`information, S.M.A.R.T. status and others... </p>
|
||||
|
||||
<h4>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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
69
docs/v4/main.js
Normal file
69
docs/v4/main.js
Normal file
@ -0,0 +1,69 @@
|
||||
function createMenu() {
|
||||
var menu = [
|
||||
[0, './#docs', 'Documentation'],
|
||||
[1, 'gettingstarted', 'Getting Started'],
|
||||
[1, 'general', 'General'],
|
||||
[1, 'system', 'System'],
|
||||
[1, 'cpu', 'CPU'],
|
||||
[1, 'memory', 'Memory'],
|
||||
[1, 'battery', 'Battery'],
|
||||
[1, 'graphics', 'Graphics'],
|
||||
[1, 'os', 'OS'],
|
||||
[1, 'processes', 'Processes / Services'],
|
||||
[1, 'filesystem', 'Disks / FS'],
|
||||
[1, 'network', 'Network'],
|
||||
[1, 'wifi', 'Wifi'],
|
||||
[1, 'docker', 'Docker'],
|
||||
[1, 'vbox', 'Virtual Box'],
|
||||
[1, 'statsfunctions', 'Observers / Stats'],
|
||||
[0, '', 'More'],
|
||||
[1, 'security', 'Security Advisories'],
|
||||
[1, 'issues', 'Known Issues'],
|
||||
[1, 'history', 'Version history'],
|
||||
[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 titleLink;
|
||||
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');
|
||||
menuParent.appendChild(titleElement);
|
||||
if (!item[1]) {
|
||||
titleLink = document.createElement('div');
|
||||
titleLink.innerText = item[2];
|
||||
} else {
|
||||
titleLink = document.createElement('a');
|
||||
titleLink.setAttribute('href', item[1] + (item[1].indexOf('#') >= 0 ? '' : '.html'));
|
||||
titleLink.innerText = item[2];
|
||||
}
|
||||
titleElement.appendChild(titleLink);
|
||||
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);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
429
docs/v4/memory.html
Normal file
429
docs/v4/memory.html
Normal file
@ -0,0 +1,429 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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>buffers</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>used by buffers</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>cached</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>used by cache</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>slab</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>used by slab</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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.mem().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
total: 67092135936,
|
||||
free: 65769291776,
|
||||
used: 1322844160,
|
||||
active: 1032495104,
|
||||
available: 66059640832,
|
||||
buffers: 63213568,
|
||||
cached: 800124928,
|
||||
slab: 268804096,
|
||||
buffcache: 1132142592,
|
||||
swaptotal: 8589930496,
|
||||
swapused: 0,
|
||||
swapfree: 8589930496
|
||||
}
|
||||
</pre>
|
||||
</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>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.memLayout().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
size: 34359738368,
|
||||
bank: 'BANK 0',
|
||||
type: 'DDR4',
|
||||
clockSpeed: 2667,
|
||||
formFactor: 'SODIMM',
|
||||
manufacturer: '029E',
|
||||
partNum: 'CMSX64.....',
|
||||
serialNum: '00000000',
|
||||
voltageConfigured: 1.2,
|
||||
voltageMin: 1.2,
|
||||
voltageMax: 1.2
|
||||
},
|
||||
{
|
||||
size: 34359738368,
|
||||
bank: 'BANK 2',
|
||||
type: 'DDR4',
|
||||
clockSpeed: 2667,
|
||||
formFactor: 'SODIMM',
|
||||
manufacturer: '029E',
|
||||
partNum: 'CMSX64.....',
|
||||
serialNum: '00000000',
|
||||
voltageConfigured: 1.2,
|
||||
voltageMin: 1.2,
|
||||
voltageMax: 1.2
|
||||
}
|
||||
]
|
||||
</pre>
|
||||
</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
816
docs/v4/network.html
Normal file
816
docs/v4/network.html
Normal file
@ -0,0 +1,816 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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 (objects)</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</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].ifaceName</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>interface name (differs on Windows)</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].ip4subnet</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>ip4 subnet mask</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].ip6subnet</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>ip6 subnet mask</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></td>
|
||||
<td>[0].virtual</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>true if virtual interface</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].operstate</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>up / down</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].type</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>wireless / wired</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].duplex</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>duplex (full/half)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].mtu</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>MUT maximum transmission unit</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].speed</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>Speed in Mbit / s</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].dhcp</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>IP address obtained by DHCP</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].dnsSuffix</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>DNS suffix</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].ieee8021xAuth</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>IEEE 802.1x Auth</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].ieee8021xState</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>IEEE 802.1x State</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].carrierChanges</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td># changes up/down</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.networkInterfaces().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
iface: 'lo0',
|
||||
ifaceName: 'lo0',
|
||||
ip4: '127.0.0.1',
|
||||
ip4subnet: '255.0.0.0',
|
||||
ip6: '::1',
|
||||
ip6subnet: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
|
||||
mac: '',
|
||||
internal: true,
|
||||
virtual: false,
|
||||
operstate: 'down',
|
||||
type: 'wired',
|
||||
duplex: 'full',
|
||||
mtu: 16384,
|
||||
speed: -1,
|
||||
dhcp: false,
|
||||
dnsSuffix: '',
|
||||
ieee8021xAuth: '',
|
||||
ieee8021xState: '',
|
||||
carrierChanges: 0
|
||||
},
|
||||
{
|
||||
iface: 'en0',
|
||||
ifaceName: 'en0',
|
||||
ip4: '192.168.0.27',
|
||||
ip4subnet: '255.255.255.0',
|
||||
ip6: 'fe80::134a:1e43:abc5:d413',
|
||||
ip6subnet: 'ffff:ffff:ffff:ffff::',
|
||||
mac: 'xx:xx:xx:xx:xx:xx',
|
||||
internal: false,
|
||||
virtual: false,
|
||||
operstate: 'up',
|
||||
type: 'wired',
|
||||
duplex: 'full',
|
||||
mtu: 1500,
|
||||
speed: 1000,
|
||||
dhcp: true,
|
||||
dnsSuffix: '',
|
||||
ieee8021xAuth: '',
|
||||
ieee8021xState: '',
|
||||
carrierChanges: 0
|
||||
}, ...
|
||||
]</pre>
|
||||
</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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.networkInterfaceDefault().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
eth0</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.networkGatewayDefault(cb)</td>
|
||||
<td>: string</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>get default network gateway</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.networkGatewayDefault().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
192.168.0.1</pre>
|
||||
</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 interfaces,<br />iface list: comma separated,<br />iface parameter is optional,<br />defaults to first external network interface,<br />pass '*' for all interfaces</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].iface</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>interface</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].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>[0].rx_bytes</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>[0].rx_dropped</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>received dropped overall</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].rx_errors</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>received errors overall</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].tx_bytes</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>[0].tx_dropped</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>transferred dropped overall</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].tx_errors</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>transferred errors overall</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].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>[0].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>[0].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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
setInterval(function() {
|
||||
si.networkStats().then(data => {
|
||||
console.log(data);
|
||||
})
|
||||
}, 1000)</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{ // first call
|
||||
iface: 'en0',
|
||||
operstate: 'up',
|
||||
rx_bytes: 1752866207,
|
||||
rx_dropped: 0,
|
||||
rx_errors: 0,
|
||||
tx_bytes: 180934681,
|
||||
tx_dropped: 0,
|
||||
tx_errors: 0,
|
||||
rx_sec: -1,
|
||||
tx_sec: -1,
|
||||
ms: 0
|
||||
}
|
||||
]
|
||||
[
|
||||
{ // second call
|
||||
iface: 'en0',
|
||||
operstate: 'up',
|
||||
rx_bytes: 1752866822,
|
||||
rx_dropped: 0,
|
||||
rx_errors: 0,
|
||||
tx_bytes: 180939820,
|
||||
tx_dropped: 0,
|
||||
tx_errors: 0,
|
||||
rx_sec: 624.3654822335026,
|
||||
tx_sec: 5217.258883248731,
|
||||
ms: 985
|
||||
}
|
||||
]...</pre>
|
||||
</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>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].pid</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>process ID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].process</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>process name</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.networkConnections().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
protocol: 'tcp4',
|
||||
localaddress: '192.168.0.27',
|
||||
localport: '55788',
|
||||
peeraddress: '163.128.xxx.xxx',
|
||||
peerport: '443',
|
||||
state: 'CLOSE_WAIT',
|
||||
pid: 702,
|
||||
process: ''
|
||||
},
|
||||
{
|
||||
protocol: 'tcp4',
|
||||
localaddress: '192.168.0.27',
|
||||
localport: '55761',
|
||||
peeraddress: '148.253.xxx.xxx',
|
||||
peerport: '22',
|
||||
state: 'ESTABLISHED',
|
||||
pid: 7267,
|
||||
process: ''
|
||||
},
|
||||
...
|
||||
]</pre>
|
||||
</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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.inetChecksite('google.com').then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
url: 'google.com',
|
||||
ok: true,
|
||||
status: 301,
|
||||
ms: 82
|
||||
}</pre>
|
||||
</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>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.inetLatency().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
13.484</pre>
|
||||
<pre><code class="js">// Example with given host IP address
|
||||
const si = require('systeminformation');
|
||||
si.inetLatency('216.58.207.142').then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
11.291</pre>
|
||||
</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
758
docs/v4/os.html
Normal file
758
docs/v4/os.html
Normal file
@ -0,0 +1,758 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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', 'win32', ...</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>fqdn</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>fully qualfied domain name</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>X</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>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>OS build version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>servicepack</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>service pack version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>uefi</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>OS uses UEFI on startup</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.osInfo().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
platform: 'darwin',
|
||||
distro: 'Mac OS X',
|
||||
release: '10.15.3',
|
||||
codename: 'macOS Catalina',
|
||||
kernel: '19.3.0',
|
||||
arch: 'x64',
|
||||
hostname: 'hostname.local',
|
||||
fqdn: 'hostname.local',
|
||||
codepage: 'UTF-8',
|
||||
logofile: 'apple',
|
||||
serial: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
|
||||
build: '19D76',
|
||||
servicepack: '',
|
||||
uefi: true
|
||||
}</pre>
|
||||
</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(apps, cb)</td>
|
||||
<td>{...}</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>version information of<br>node and dev software packages<br>optional apps param (string, <br>comma or space seperated)<br>only those apps are detected</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>kernel</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>os kernel version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>openssl</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>node openssl version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>systemOpenssl</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>os openssl version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>systemOpensslLib</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>openSSL, LibreSSL, ...</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>node</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>node version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>v8</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>v8 version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>npm</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>npm version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>yarn</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>yarn version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>pm2</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>pm2 version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>gulp</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>gulp version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>grunt</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>grunt version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>git</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>git version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>tsc</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>typescript version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>mysql</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>mysql version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>redis</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>redis version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>mongodb</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>mongodb version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>apache</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>apache version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>nginx</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>nginx version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>php</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>php version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>docker</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>docker version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>postfix</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>postfix version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>postgresql</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>postgresql version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>perl</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>perl version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>python</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>python version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>python3</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>python3 version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>java</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>java version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>gcc</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>gcc version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>virtualbox</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>virtualbox version</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.versions().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
kernel: '19.3.0',
|
||||
openssl: '1.1.1d',
|
||||
systemOpenssl: '2.8.3',
|
||||
systemOpensslLib: 'LibreSSL',
|
||||
node: '13.8.0',
|
||||
v8: '7.9.317.25-node.28',
|
||||
npm: '6.13.6',
|
||||
yarn: '',
|
||||
pm2: '',
|
||||
gulp: '',
|
||||
grunt: '',
|
||||
git: '2.21.1',
|
||||
tsc: '3.7.5',
|
||||
mysql: 'gpl)',
|
||||
redis: '',
|
||||
mongodb: '',
|
||||
apache: '2.4.41 (Unix)',
|
||||
nginx: '',
|
||||
php: '7.3.11',
|
||||
docker: '19.03.5',
|
||||
postfix: '3.2.2',
|
||||
postgresql: '12.1',
|
||||
perl: '5.18.4',
|
||||
python: '2.7.16',
|
||||
python3: '3.7.3',
|
||||
pip: '',
|
||||
pip3: '19.0.3',
|
||||
java: '',
|
||||
gcc: '4.2.1',
|
||||
virtualbox: ''
|
||||
}</pre>
|
||||
<h5>Example 2</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.versions('npm, php, postgresql').then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
npm: '6.13.6',
|
||||
php: '7.3.11',
|
||||
postgresql: '12.1'
|
||||
}</pre>
|
||||
</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>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.users().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
user: 'yourname',
|
||||
tty: 'ttys006',
|
||||
date: '2020-02-01',
|
||||
time: '21:20',
|
||||
ip: '',
|
||||
command: 'w -ih'
|
||||
},
|
||||
{
|
||||
user: 'othername',
|
||||
tty: 'ttys008',
|
||||
date: '2020-02-01',
|
||||
time: '21:20',
|
||||
ip: '',
|
||||
command: '-bash'
|
||||
}
|
||||
]</pre>
|
||||
</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
754
docs/v4/processes.html
Normal file
754
docs/v4/processes.html
Normal file
@ -0,0 +1,754 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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></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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.currentLoad().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
avgload: 0.23,
|
||||
currentload: 4.326328800988875,
|
||||
currentload_user: 2.595797280593325,
|
||||
currentload_system: 1.73053152039555,
|
||||
currentload_nice: 0,
|
||||
currentload_idle: 95.67367119901112,
|
||||
currentload_irq: 0,
|
||||
raw_currentload: 350,
|
||||
raw_currentload_user: 210,
|
||||
raw_currentload_system: 140,
|
||||
raw_currentload_nice: 0,
|
||||
raw_currentload_idle: 7740,
|
||||
raw_currentload_irq: 0,
|
||||
cpus: [
|
||||
{
|
||||
load: 13.725490196078432,
|
||||
load_user: 7.8431372549019605,
|
||||
load_system: 5.88235294117647,
|
||||
load_nice: 0,
|
||||
load_idle: 86.27450980392157,
|
||||
load_irq: 0,
|
||||
raw_load: 140,
|
||||
raw_load_user: 80,
|
||||
raw_load_system: 60,
|
||||
raw_load_nice: 0,
|
||||
raw_load_idle: 880,
|
||||
raw_load_irq: 0
|
||||
},
|
||||
...
|
||||
]
|
||||
}</pre>
|
||||
</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></td>
|
||||
<td>...[0].params</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>process params</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>...[0].path</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>process path</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.processes().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
all: 258,
|
||||
running: 1,
|
||||
blocked: 0,
|
||||
sleeping: 157,
|
||||
unknown: 0,
|
||||
list: [
|
||||
{
|
||||
pid: 1,
|
||||
parentPid: 0,
|
||||
name: 'init',
|
||||
pcpu: 0.04504576931569955,
|
||||
pcpuu: 0.04084113255431208,
|
||||
pcpus: 0.00420463676138747,
|
||||
pmem: 0,
|
||||
priority: 19,
|
||||
mem_vsz: 166144,
|
||||
mem_rss: 10684,
|
||||
nice: 0,
|
||||
started: '2020-02-08 10:18:15',
|
||||
state: 'sleeping',
|
||||
tty: '',
|
||||
user: 'root',
|
||||
command: 'init',
|
||||
params: '',
|
||||
path: '/sbin'
|
||||
},
|
||||
...
|
||||
]
|
||||
}</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.processLoad('nginx',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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.processLoad('nginx').then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
proc: 'nginx',
|
||||
pid: 11267,
|
||||
pids: [
|
||||
11251, 11252, 11253,
|
||||
11254, 11255, 11256,
|
||||
11257, 11258, 11259,
|
||||
11260, 11261, 11262,
|
||||
11263, 11264, 11265,
|
||||
11266, 11267
|
||||
],
|
||||
cpu: 0.01,
|
||||
mem: 0
|
||||
}</pre>
|
||||
</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 "*" 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>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.services('mysql, postgres').then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
name: 'mysql',
|
||||
running: true,
|
||||
startmode: '',
|
||||
pids: [ 152 ],
|
||||
pcpu: 0.3,
|
||||
pmem: 0
|
||||
},
|
||||
{
|
||||
name: 'postgres',
|
||||
running: true,
|
||||
startmode: '',
|
||||
pids: [ 1087, 1873 ],
|
||||
pcpu: 0,
|
||||
pmem: 0
|
||||
},
|
||||
]</pre>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4>Getting correct stats values</h4>
|
||||
|
||||
<p>In <span class="code">currentLoad()</span> the
|
||||
results are calculated correctly beginning with the <strong>second</strong> call of the function.
|
||||
It is determined by calculating the difference of cpu ticks between two calls of the function.</p>
|
||||
|
||||
<p>The first time you are calling one of this functions, you will get the load since cpu uptime.
|
||||
The second time, you should then get statistics based on cpu ticks between the two calls ...</p>
|
||||
|
||||
<p>So basically, your code should look like this:</p>
|
||||
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
|
||||
setInterval(function() {
|
||||
si.currentLoad().then(data => {
|
||||
console.log(data);
|
||||
})
|
||||
}, 1000)</code></pre>
|
||||
<p>Beginning with the second call, you get precise load values between the two calls.</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
144
docs/v4/security.html
Normal file
144
docs/v4/security.html
Normal file
@ -0,0 +1,144 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<title>systeminformation</title>
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<nav class="nav">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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">Security Advisories</div>
|
||||
<div class="text">
|
||||
<h2>Command Injection Vulnerability</h2>
|
||||
<p><span class="bold">Affected versions:</span>
|
||||
< 4.31.1<br>
|
||||
<span class="bold">Date:</span> 2020-12-11<br>
|
||||
<span class="bold">CVE indentifier</span> CVE-2020-26274, CVE-2020-28448
|
||||
</p>
|
||||
|
||||
<h4>Impact</h4>
|
||||
<p>Here we had an issue that there was a possibility to inject commands to the command line of your machine via systeminformation. Affected commands: <span class="code">inetLatency()</span>.</p>
|
||||
|
||||
<h4>Patch</h4>
|
||||
<p>Problem was fixed with a shell string sanitation fix. Please upgrade to version >= 4.31.1</p>
|
||||
|
||||
<h4>Workarround</h4>
|
||||
<p>If you cannot upgrade, be sure to check or sanitize service parameter strings that are passed to <span class="code">inetLatency()</span></p>
|
||||
|
||||
|
||||
<h2>command injection vulnerability - prototype pollution</h2>
|
||||
<p><span class="bold">Affected versions:</span>
|
||||
< 4.30.5<br>
|
||||
<span class="bold">Date:</span> 2020-11-26<br>
|
||||
<span class="bold">CVE indentifier</span> CVE-2020-26245
|
||||
</p>
|
||||
|
||||
<h4>Impact</h4>
|
||||
<p>Here we had an issue that there was a possibility to inject commands to the command line by property pollution on the string object. Affected commands: <span class="code">inetChecksite()</span>.</p>
|
||||
|
||||
<h4>Patch</h4>
|
||||
<p>Problem was fixed with a shell string sanitation fix as well as handling prototype polution. Please upgrade to version >= 4.30.5</p>
|
||||
|
||||
<h4>Workarround</h4>
|
||||
<p>If you cannot upgrade, be sure to check or sanitize service parameter strings that are passed to <span class="code">inetChecksite()</span></p>
|
||||
|
||||
|
||||
<h2>Command Injection Vulnerability</h2>
|
||||
<p><span class="bold">Affected versions:</span>
|
||||
< 4.27.11<br>
|
||||
<span class="bold">Date:</span> 2020-10-26<br>
|
||||
<span class="bold">CVE indentifier</span> CVE-2020-7752
|
||||
</p>
|
||||
|
||||
<h4>Impact</h4>
|
||||
<p>Here we had an issue that there was a possibility to inject commands to the command line of your machine via systeminformation. Affected commands: <span class="code">inetChecksite()</span>.</p>
|
||||
|
||||
<h4>Patch</h4>
|
||||
<p>Problem was fixed with a shell string sanitation fix. Please upgrade to version >= 4.27.11</p>
|
||||
|
||||
<h4>Workarround</h4>
|
||||
<p>If you cannot upgrade, be sure to check or sanitize service parameter strings that are passed to <span class="code">inetChecksite()</span></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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
170
docs/v4/statsfunctions.html
Normal file
170
docs/v4/statsfunctions.html
Normal file
@ -0,0 +1,170 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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">
|
||||
<h2>Getting correct stats values</h2>
|
||||
|
||||
<p>In <span class="code">fsStats()</span>, <span class="code">disksIO()</span>, <span class="code">currentLoad()</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><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>
|
||||
<h2>Observe System Parameters</h2>
|
||||
<p>systeminformation now allows you to easily observe system parameters: First you define a result object of system parameters you want to observe (see also decription of the <a href="general.html"><span class="code">si.get()</span> function here</a>):</p>
|
||||
<p>Then you just call an <span class="code">si.observe()</span> function with three parameters: your result object, the polling interval (in milliseconds) and a callback function. systeminformation will now observe the result object. Every time the result changes, your callback function is called. This callback function also gets the current value the observed system parameters 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>
|
||||
<tr>
|
||||
<td>si.observe(valueObject,interval,cb)</td>
|
||||
<td>-</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>Observe the defined value object,<br>call callback on changes:</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
|
||||
// define all values, you want to get back
|
||||
valueObject = {
|
||||
battery: 'acconnected'
|
||||
}
|
||||
|
||||
function usersCallback(data) {
|
||||
console.log('Power usage now: ' + (data.battery.acconnected ? 'AC' : 'battery'));
|
||||
}
|
||||
|
||||
// now define the observer function
|
||||
let observer = si.observe(valueObject, 1000, usersCallback);
|
||||
|
||||
// In this example we stop our observer function after 30 seconds
|
||||
setTimeout(() => {
|
||||
clearInterval(observer)
|
||||
}, 30000);</code></pre class="example">
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>The key names of the <span class="code">valueObject</span> must be exactly the same as the representing function in systeminformation.</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
670
docs/v4/styles.css
Normal file
670
docs/v4/styles.css
Normal file
@ -0,0 +1,670 @@
|
||||
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;
|
||||
min-height: 100%;
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
||||
|
||||
.bold {
|
||||
font-weight: 700;
|
||||
}
|
||||
|
||||
.bg-image-full {
|
||||
background: no-repeat center center scroll;
|
||||
background-color: #1A1F30;
|
||||
/* For browsers that do not support gradients */
|
||||
background-image: linear-gradient(210deg, #2A2D66, #060520);
|
||||
/* Standard syntax (must be last) */
|
||||
background-size: cover;
|
||||
-o-background-size: cover;
|
||||
height: 100vh;
|
||||
height: calc(var(--vh, 1vh) * 100);
|
||||
opacity: 0.95;
|
||||
display: -webkit-box;
|
||||
display: -ms-flexbox;
|
||||
display: flex;
|
||||
-webkit-box-pack: center;
|
||||
-ms-flex-pack: center;
|
||||
justify-content: center;
|
||||
text-align: center;
|
||||
-webkit-box-orient: vertical;
|
||||
-webkit-box-direction: normal;
|
||||
-ms-flex-direction: column;
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
.bg-image-full .container {
|
||||
text-align: center;
|
||||
-ms-flex-item-align: center;
|
||||
align-self: center;
|
||||
display: -webkit-box;
|
||||
display: -ms-flexbox;
|
||||
display: flex;
|
||||
-webkit-box-pack: center;
|
||||
-ms-flex-pack: center;
|
||||
justify-content: center;
|
||||
-webkit-box-orient: vertical;
|
||||
-webkit-box-direction: normal;
|
||||
-ms-flex-direction: column;
|
||||
flex-direction: column;
|
||||
-webkit-box-align: center;
|
||||
-ms-flex-align: center;
|
||||
align-items: center;
|
||||
-webkit-box-flex: 1;
|
||||
-ms-flex-positive: 1;
|
||||
flex-grow: 1;
|
||||
}
|
||||
|
||||
.bg-image-full .recommendation {
|
||||
position: absolute;
|
||||
top: 40px;
|
||||
right: -95px;
|
||||
z-index: 10;
|
||||
display: inline-block;
|
||||
width: 330px;
|
||||
text-align: center;
|
||||
padding: .25em 0;
|
||||
color: white;
|
||||
-webkit-transform: rotate(45deg);
|
||||
transform: rotate(45deg);
|
||||
background: #971d1d;
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 420px) {
|
||||
.bg-image-full .recommendation {
|
||||
font-size: 1.0rem;
|
||||
}
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 768px) {
|
||||
.bg-image-full .recommendation {
|
||||
font-size: 1.1rem;
|
||||
}
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 1024px) {
|
||||
.bg-image-full .recommendation {
|
||||
top: 50px;
|
||||
right: -75px;
|
||||
font-size: 1.2rem;
|
||||
}
|
||||
}
|
||||
|
||||
.bg-image-full .recommendation:hover {
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.bg-image-full .title {
|
||||
color: #fff;
|
||||
padding-top: 10px;
|
||||
font-size: 1.8rem;
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
@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.78rem;
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 375px) {
|
||||
.bg-image-full .subtitle {
|
||||
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: 375px) {
|
||||
.bg-image-full .text > a {
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
}
|
||||
|
||||
@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;
|
||||
margin-bottom: 10px;
|
||||
color: #fff;
|
||||
font-size: .9rem;
|
||||
}
|
||||
|
||||
@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;
|
||||
}
|
||||
}
|
||||
|
||||
.bg-image-full .down {
|
||||
text-align: center;
|
||||
color: #fff;
|
||||
font-size: 1.3rem;
|
||||
line-height: 1;
|
||||
margin-bottom: 15px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.bg-image-full .down .caret {
|
||||
font-size: 3rem;
|
||||
}
|
||||
|
||||
.nav {
|
||||
background: no-repeat center center scroll;
|
||||
background-color: #1A1F30;
|
||||
/* For browsers that do not support gradients */
|
||||
background-image: linear-gradient(210deg, #2A2D66, #060520);
|
||||
/* Standard syntax (must be last) */
|
||||
background-size: cover;
|
||||
-o-background-size: cover;
|
||||
height: 65px;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.nav .logo {
|
||||
width: 60px;
|
||||
margin-top: 12px;
|
||||
}
|
||||
|
||||
.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;
|
||||
}
|
||||
|
||||
.nav .github {
|
||||
display: none;
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 768px) {
|
||||
.nav .github {
|
||||
display: inline-block;
|
||||
}
|
||||
}
|
||||
|
||||
.nav .todocs {
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 768px) {
|
||||
.nav .todocs {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
|
||||
.features {
|
||||
text-align: center;
|
||||
color: #333;
|
||||
}
|
||||
|
||||
.features .inner {
|
||||
padding: 10px 0px;
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 768px) {
|
||||
.features .inner {
|
||||
padding: 15px 20px;
|
||||
}
|
||||
}
|
||||
|
||||
.features .inner .icons {
|
||||
display: block;
|
||||
font-size: 3rem;
|
||||
color: #bbb;
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 420px) {
|
||||
.features .inner .icons {
|
||||
font-size: 3.5rem;
|
||||
}
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 768px) {
|
||||
.features .inner .icons {
|
||||
font-size: 4rem;
|
||||
}
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 1024px) {
|
||||
.features .inner .icons {
|
||||
font-size: 5rem;
|
||||
}
|
||||
}
|
||||
|
||||
.features .inner .icontitle {
|
||||
font-size: 1.2rem;
|
||||
}
|
||||
|
||||
.features .inner:hover {
|
||||
background: #f4f4f4;
|
||||
color: #567adf;
|
||||
}
|
||||
|
||||
.features .inner:hover .icons {
|
||||
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 .npmicons {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.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 {
|
||||
margin: 0 0 10px 0;
|
||||
}
|
||||
|
||||
.index .text, .index .subtitle, .index .title, .index .title-small, .index .npmicons {
|
||||
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 .npmicons {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.table {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.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 .title a {
|
||||
width: 100%;
|
||||
color: #000;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.menu .title a:hover {
|
||||
color: #567adf;
|
||||
}
|
||||
|
||||
.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;
|
||||
}
|
||||
|
||||
.example td:first-child {
|
||||
background-color: #fff !important;
|
||||
}
|
||||
|
||||
.example td:last-child {
|
||||
background-color: #f8faff !important;
|
||||
}
|
||||
|
||||
.example h5 {
|
||||
padding-top: 5px;
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
.example pre {
|
||||
background-color: unset;
|
||||
}
|
||||
|
||||
.example pre .js {
|
||||
background-color: #f0f0f4;
|
||||
}
|
||||
|
||||
footer {
|
||||
background-color: #eee;
|
||||
margin-top: 30px;
|
||||
padding-top: 30px;
|
||||
padding-bottom: 30px;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
footer a {
|
||||
color: #000;
|
||||
}
|
||||
|
||||
footer .badge {
|
||||
color: #fff;
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
/*# sourceMappingURL=styles.css.map */
|
||||
9
docs/v4/styles.css.map
Normal file
9
docs/v4/styles.css.map
Normal file
File diff suppressed because one or more lines are too long
472
docs/v4/styles.scss
Normal file
472
docs/v4/styles.scss
Normal file
@ -0,0 +1,472 @@
|
||||
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;
|
||||
min-height: 100%;
|
||||
}
|
||||
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;
|
||||
}
|
||||
.bold {
|
||||
font-weight: 700;
|
||||
}
|
||||
.bg-image-full {
|
||||
background: no-repeat center center scroll;
|
||||
background-color: #1A1F30; /* For browsers that do not support gradients */
|
||||
background-image: linear-gradient(210deg, #2A2D66, #060520); /* Standard syntax (must be last) */
|
||||
|
||||
-webkit-background-size: cover;
|
||||
-moz-background-size: cover;
|
||||
background-size: cover;
|
||||
-o-background-size: cover;
|
||||
height: 100vh; //calc(100vh);
|
||||
height: calc(var(--vh, 1vh) * 100);
|
||||
opacity: 0.95;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
text-align: center;
|
||||
|
||||
// align-items: center;
|
||||
flex-direction: column;
|
||||
.container {
|
||||
text-align: center;
|
||||
align-self: center;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
flex-grow: 1;
|
||||
}
|
||||
.recommendation {
|
||||
position: absolute;
|
||||
top: 40px;
|
||||
right: -95px;
|
||||
z-index: 10;
|
||||
display: inline-block;
|
||||
width: 330px;
|
||||
text-align: center;
|
||||
padding: .25em 0;
|
||||
color: white;
|
||||
transform: rotate(45deg);
|
||||
background: rgb(151, 29, 29);
|
||||
font-size: 0.9rem;
|
||||
@media only screen and (min-width: 420px) {
|
||||
font-size: 1.0rem;
|
||||
}
|
||||
@media only screen and (min-width: 768px) {
|
||||
font-size: 1.1rem;
|
||||
}
|
||||
@media only screen and (min-width: 1024px) {
|
||||
top: 50px;
|
||||
right: -75px;
|
||||
font-size: 1.2rem;
|
||||
}
|
||||
&:hover {
|
||||
text-decoration: none;;
|
||||
}
|
||||
}
|
||||
.title {
|
||||
color: #fff;
|
||||
padding-top: 10px;
|
||||
font-size: 1.8rem;
|
||||
margin-bottom: 10px;
|
||||
@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.78rem;
|
||||
@media only screen and (min-width: 375px) {
|
||||
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: 375px) {
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
@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;
|
||||
margin-bottom: 10px;
|
||||
color: #fff;
|
||||
font-size: .9rem;
|
||||
@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;
|
||||
}
|
||||
}
|
||||
.down {
|
||||
text-align: center;
|
||||
color: #fff;
|
||||
font-size: 1.3rem;
|
||||
line-height: 1;
|
||||
margin-bottom: 15px;
|
||||
cursor: pointer;
|
||||
.caret {
|
||||
font-size: 3rem;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// a[ id="quickstart" ]:target ~ #main div.row {
|
||||
// transform: translateY( -500px );
|
||||
// }
|
||||
|
||||
// #quickstart {
|
||||
// background-color: #ff3333;
|
||||
// }
|
||||
.nav {
|
||||
background: no-repeat center center scroll;
|
||||
background-color: #1A1F30; /* For browsers that do not support gradients */
|
||||
background-image: linear-gradient(210deg, #2A2D66, #060520); /* Standard syntax (must be last) */
|
||||
-webkit-background-size: cover;
|
||||
-moz-background-size: cover;
|
||||
background-size: cover;
|
||||
-o-background-size: cover;
|
||||
height: 65px;
|
||||
position: relative;
|
||||
.logo {
|
||||
width: 60px;
|
||||
margin-top: 12px;
|
||||
}
|
||||
.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;
|
||||
}
|
||||
}
|
||||
}
|
||||
.github {
|
||||
display: none;
|
||||
@media only screen and (min-width: 768px) {
|
||||
display: inline-block;
|
||||
}
|
||||
}
|
||||
.todocs {
|
||||
display: inline-block;
|
||||
@media only screen and (min-width: 768px) {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
}
|
||||
.features {
|
||||
text-align: center;
|
||||
color: #333;
|
||||
.inner {
|
||||
padding: 10px 0px;
|
||||
@media only screen and (min-width: 768px) {
|
||||
padding: 15px 20px;
|
||||
}
|
||||
.icons {
|
||||
display: block;
|
||||
font-size: 3rem;
|
||||
color: #bbb;
|
||||
@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;
|
||||
}
|
||||
|
||||
&:hover {
|
||||
background: #f4f4f4;
|
||||
color: rgb(86, 122, 223);
|
||||
.icons {
|
||||
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;
|
||||
}
|
||||
}
|
||||
.npmicons {
|
||||
text-align: center;
|
||||
}
|
||||
.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 {
|
||||
margin: 0 0 10px 0;
|
||||
.text, .subtitle, .title, .title-small, .npmicons {
|
||||
text-align: center;
|
||||
}
|
||||
a {
|
||||
text-decoration: none;
|
||||
&:hover {
|
||||
text-decoration: none;
|
||||
color: rgb(86, 122, 223);
|
||||
}
|
||||
}
|
||||
}
|
||||
.left {
|
||||
.text, .subtitle, .title, .title-small .npmicons {
|
||||
text-align: left;
|
||||
}
|
||||
}
|
||||
.table {
|
||||
text-align: left;
|
||||
}
|
||||
ul {
|
||||
text-align: left;
|
||||
}
|
||||
.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;
|
||||
a {
|
||||
width: 100%;
|
||||
color: #000;
|
||||
text-decoration: none;
|
||||
&:hover {
|
||||
color: rgb(86, 122, 223);
|
||||
}
|
||||
}
|
||||
}
|
||||
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;
|
||||
}
|
||||
.example {
|
||||
td:first-child {
|
||||
background-color: #fff !important;
|
||||
}
|
||||
td:last-child {
|
||||
background-color: #f8faff !important;
|
||||
}
|
||||
h5 {
|
||||
padding-top: 5px;
|
||||
padding-left: 10px;
|
||||
}
|
||||
pre {
|
||||
background-color: unset;
|
||||
.js {
|
||||
background-color: #f0f0f4;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
footer {
|
||||
background-color: #eee;
|
||||
margin-top: 30px;
|
||||
padding-top: 30px;
|
||||
padding-bottom: 30px;
|
||||
position: relative;
|
||||
a {
|
||||
color: #000;
|
||||
}
|
||||
.badge {
|
||||
color: #fff;
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
}
|
||||
463
docs/v4/system.html
Normal file
463
docs/v4/system.html
Normal file
@ -0,0 +1,463 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>SKU number</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>virtual</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>is virtual machine</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>raspberry</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>Additional Raspberry-specific information<br>manufacturer, processor, type, revision<br>Raspberry only</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.system().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
manufacturer: 'Apple Inc.',
|
||||
model: 'MacBookPro13,2',
|
||||
version: '1.0',
|
||||
serial: 'C01xxxxxxxx',
|
||||
uuid: 'F87654-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
|
||||
sku: 'Mac-99878xxxx...',
|
||||
virtual: false,
|
||||
}
|
||||
</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.bios(cb)</td>
|
||||
<td>{...}</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>bios 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 class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.bios().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
vendor: 'American Megatrends Inc.',
|
||||
version: 'P4.20',
|
||||
releaseDate: '2019-09-05',
|
||||
revision: '5.13'
|
||||
}</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.baseboard(cb)</td>
|
||||
<td>{...}</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>baseboard 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>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.baseboard().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
manufacturer: 'ASRock',
|
||||
model: 'H310M-STX',
|
||||
version: '',
|
||||
serial: 'C80-xxxxxxxxxxx',
|
||||
assetTag: ''
|
||||
}</pre>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>si.chassis(cb)</td>
|
||||
<td>{...}</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>chassis 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>type</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>chassis type e.g. 'desktop'</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>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>sku</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>SKU number</td>
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.chassis().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
{
|
||||
manufacturer: 'Apple Inc.',
|
||||
model: 'MacBookPro13,2',
|
||||
type: '',
|
||||
version: '1.0',
|
||||
serial: 'C01xxxxxxxx',
|
||||
assetTag: 'Mac-99878xxxx...',
|
||||
sku: ''
|
||||
}</pre>
|
||||
</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
121
docs/v4/trademarks.html
Normal file
121
docs/v4/trademarks.html
Normal file
@ -0,0 +1,121 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<title>systeminformation</title>
|
||||
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<nav class="nav">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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>Ryzen</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>NetBSD</strong> is a registered trademark of The NetBSD 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>Virtual Box</strong> are registered trademarks of Oracle Corporation</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>
|
||||
<li><strong>Alpine</strong> is a trademark of Alpine Linux Development Team.</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
489
docs/v4/vbox.html
Normal file
489
docs/v4/vbox.html
Normal file
@ -0,0 +1,489 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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">Virtual Box</div>
|
||||
<div class="text">
|
||||
<p>In this section you will learn how to get information about virtual box VMs:</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>VMs</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.vboxInfo(cb)</td>
|
||||
<td>[{...}]</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>returns array of detailed info about all VMs</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>virtual box ID</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</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].running</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>vbox is running</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>started date time</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].runningSince</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>running since (secs)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].stopped</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>stopped date time</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].stoppedSince</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>stopped since (secs)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].guestOS</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>Guest OS</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].hardwareUUID</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>Hardware UUID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].memory</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>Memory in MB</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].vram</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>VRAM in MB</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].cpus</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>CPUs</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].cpuExepCap</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>CPU exec cap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].cpuProfile</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>CPU profile</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].chipset</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>chipset</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].firmware</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>firmware</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].pageFusion</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>page fusion</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].configFile</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>config file</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].snapshotFolder</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>snapshot folder</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].logFolder</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>log folder path</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].HPET</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>HPET</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].PAE</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>PAE</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].longMode</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>long mode</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].tripleFaultReset</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>triple fault reset</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].APIC</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>APIC</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].X2APIC</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X2APIC</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].ACPI</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>ACPI</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].IOAPIC</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>IOAPIC</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].biosAPICmode</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>BIOS APIC mode</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].bootMenuMode</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>boot menu Mode</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].bootDevice1</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>bootDevice1</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].bootDevice2</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>bootDevice2</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].bootDevice3</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>bootDevice3</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].bootDevice4</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>bootDevice4</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].timeOffset</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>time Offset</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].RTC</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>RTC</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
266
docs/v4/wifi.html
Normal file
266
docs/v4/wifi.html
Normal file
@ -0,0 +1,266 @@
|
||||
<!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>
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
||||
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
||||
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
||||
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
||||
|
||||
<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">
|
||||
<div class="container">
|
||||
<a href="."><img class="logo float-left" src="assets/logo.png">
|
||||
<div class="title float-left">systeminformation - Version 4</div>
|
||||
</a>
|
||||
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
||||
<div class="text float-right todocs"><a href="./#docs">Docs Overview</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">Wifi</div>
|
||||
<div class="text">
|
||||
<p>In this section you will learn how to get detailed information about available wifi networks:</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>Wifi Networks</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.wifiNetworks(cb)</td>
|
||||
<td>[{...}]</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td>array of available wifi networks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].ssid</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>Wifi network SSID</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].bssid</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>BSSID (mac)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].mode</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>mode</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].channel</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>channel</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].frequency</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>frequengy in MHz</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].signalLevel</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>signal level in dB</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].quality</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>quaility in %</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].security</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>array e.g. WPA, WPA-2</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].wpaFlags</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>X</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td>array of WPA flags</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>[0].rsnFlags</td>
|
||||
<td>X</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
<td>array of RDN flags
|
||||
</tr>
|
||||
<tr class="example">
|
||||
<td></td>
|
||||
<td colspan="7">
|
||||
<h5>Example</h5>
|
||||
<pre><code class="js">const si = require('systeminformation');
|
||||
si.wifiNetworks().then(data => console.log(data));</code></pre class="example">
|
||||
<pre class="example">
|
||||
[
|
||||
{
|
||||
ssid: 'INTERNAL-WIFI',
|
||||
bssid: 'ab:01:14:4f:d3:82',
|
||||
mode: '',
|
||||
channel: 44,
|
||||
frequency: 5220,
|
||||
signalLevel: -68,
|
||||
quality: 64,
|
||||
security: [ 'WPA', 'WPA2' ],
|
||||
wpaFlags: [ 'PSK/TKIP/TKIP', 'PSK/AES/TKIP' ],
|
||||
rsnFlags: []
|
||||
},
|
||||
{
|
||||
ssid: 'FREE Wifi',
|
||||
bssid: 'aa:14:e5:16:97:f3',
|
||||
mode: '',
|
||||
channel: 44,
|
||||
frequency: 5220,
|
||||
signalLevel: -50,
|
||||
quality: 100,
|
||||
security: [ 'WPA', 'WPA2' ],
|
||||
wpaFlags: [ 'PSK/TKIP/TKIP', 'PSK/AES/TKIP' ],
|
||||
rsnFlags: []
|
||||
},
|
||||
...
|
||||
]</pre>
|
||||
</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> </li>
|
||||
<li><a href="https://buymeacoff.ee/systeminfo" class="medium badge bg-primary"><i class="fas fa-coffee"></i> 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>
|
||||
<li><a href="../index.html">Version 5 Docs</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-lg-4 col-12">
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://www.plus-innovations.com">© 2021 Sebastian Hildebrandt, +innovations</a></li>
|
||||
<li><a href="copyright.html">Copyright & License</a></li>
|
||||
<li><a href="trademarks.html">Trademarks</a></li>
|
||||
<li> </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>
|
||||
Loading…
x
Reference in New Issue
Block a user