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

updated docs

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

3
CHANGELOG.md
View File

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

1272
README.md
View File

File diff suppressed because it is too large Load Diff

2
docs/docker.html
View File

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

8
docs/gettingstarted.html
View File

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

4
docs/graphics.html
View File

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

5
docs/history.html
View File

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

4
docs/index.html
View File

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

2
docs/issues.html
View File

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

2
docs/processes.html
View File

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

2
docs/v4/docker.html
View File

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

8
docs/v4/gettingstarted.html
View File

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

4
docs/v4/graphics.html
View File

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

2
docs/v4/processes.html
View File

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

4
docs/v4/wifi.html
View File

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

4
docs/wifi.html
View File

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