Skip to content

Commit

Permalink
Merge pull request #2 from sebhildebrandt/master
Browse files Browse the repository at this point in the history
Update
  • Loading branch information
EffectRenan committed Mar 27, 2021
2 parents e64cb03 + b36d252 commit 16eae0c
Show file tree
Hide file tree
Showing 34 changed files with 1,283 additions and 613 deletions.
96 changes: 57 additions & 39 deletions CHANGELOG.md
Expand Up @@ -6,6 +6,8 @@

- `audio()` detailed audio information
- `bluetoothDevices()` detailed information detected bluetooth devices
- `dockerImages()` detailed information docker images
- `dockerVolumes()` detailed information docker volumes
- `printers()` detailed printer information
- `usb()` detailed USB information
- `wifiInterfaces()` detected Wi-Fi interfaces
Expand Down Expand Up @@ -44,6 +46,8 @@ 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)
- `diskLayout()`: added USB drives (mac OS)
- `fsSize()`: added available
- `fsSize()`: improved calculation of used
- `getData()`: support for passing parameters and filters (see section General / getData)
Expand All @@ -53,6 +57,7 @@ We had to make **several interface changes** to keep systeminformation as consis
- `memoryLayout()`: added ECC flag
- `osInfo()`: better fqdn (win)
- `osinfo()`: added hypervizor if hyper-v is enabled (win only)
- `osInfo()`: added remoteSession (win only)
- `system()`: better Raspberry PI detection
- `system()`: added virtual and virtualHost (if system is virtual instance)
- `uuid()`: better value support
Expand All @@ -72,45 +77,58 @@ For major (breaking) changes - **version 4, 3 and 2** - see end of page.

| Version | Date | Comment |
| -------------- | -------------- | -------- |
| 5.3.3 | 2020-02-15 | `dockerContainerStats()` fixed ID splitting |
| 5.3.2 | 2020-02-15 | `inetLatency()` `ineChecksite()` fixed possible security issue (file://) |
| 5.3.1 | 2020-02-14 | `inetLatency()` `ineChecksite()` `servcices()` `processes()` fixed possible security issue (arrays) |
| 5.3.0 | 2020-02-12 | `osInfo()` added remoteSession (windows) |
| 5.2.7 | 2020-02-12 | `fsStats()`, `blockDevices()` improved linux |
| 5.2.6 | 2020-02-12 | `inetLatency()` fixed possible DOS intrusion |
| 5.2.5 | 2020-02-11 | `processes()` fixed truncated params (linux) |
| 5.2.4 | 2020-02-11 | `currentLoad()` fixed issue |
| 5.2.3 | 2020-02-11 | `diskLayout()` added USB drives (mac OS) |
| 5.2.2 | 2020-02-11 | code cleanup, updated docs |
| 5.2.1 | 2020-02-10 | `system()` fixed issue virtual detect (linux) |
| 5.2.0 | 2020-02-10 | `wifiInterfces()` and `wifiConnections()` added |
| 5.1.2 | 2020-02-08 | fixed node 4 compatibility issue |
| 5.1.1 | 2020-02-08 | `baseboard()` added memMax, memSlots, smaller improvements Raspberry |
| 5.1.0 | 2020-02-08 | `memLayout()` added ECC flag, `bios()` added language, features (linux) |
| 5.0.11 | 2020-02-07 | `fsSize()` fixed windows WSL issue |
| 5.0.10 | 2020-02-06 | `getDynamicData()` fixed windows WSL issue |
| 5.0.9 | 2020-02-02 | `fsSize()` fixed parsing edge case issue mac OS |
| 5.0.8 | 2020-01-30 | typescript typings fix cpuCurrentSpeed |
| 5.0.7 | 2020-01-29 | `fsSize()` available fixed windows and typescript typings |
| 5.0.6 | 2020-01-28 | `osinfo()` added hypervisor (win only) |
| 5.0.5 | 2020-01-27 | `networkInterfaces()` type detection improved (win) |
| 5.0.4 | 2020-01-27 | `cpu()` improved manufacturer decoding (linux) |
| 5.0.3 | 2020-01-27 | `cpu()` fix virtualization, `wifi()` fix raspberry |
| 5.0.2 | 2020-01-26 | updated typescript typings |
| 5.0.1 | 2020-01-26 | code cleanup |
| 5.0.0 | 2020-01-26 | new major version 5 release |
| 4.34.9 | 2020-01-25 | `graphics()` virtual controller vram value fix (win) |
| 4.34.8 | 2020-01-25 | `graphics()` controller subDeviceId fix (win) |
| 4.34.7 | 2020-01-13 | `services()` improved service discovery (linux) |
| 4.34.6 | 2020-01-12 | `networkInterfaces()` catch errors |
| 4.34.5 | 2020-01-07 | `networkInterfaceDefault()` fixed CMD popup (windows) |
| 4.34.4 | 2020-01-06 | `system()` fixed vitrual catch error |
| 4.34.3 | 2020-01-06 | `graphics()` fixed non nvidia-smi controllers (win) |
| 4.34.2 | 2020-01-05 | `system()` uuid lowercase as in uuid() |
| 4.34.1 | 2020-01-05 | `graphics()` nvidia-smi detection improved |
| 4.34.0 | 2020-01-05 | `system()` added flag virtual |
| 4.33.8 | 2020-01-04 | `virtualBox()` fix issue windows host |
| 4.33.7 | 2020-01-04 | `graphics()` nvidia-smi detection improved |
| 5.6.8 | 2021-03-22 | typescript definitions fix `wifiInterfces()`, `wifiConnections()` |
| 5.6.7 | 2021-03-16 | `inetLatency()` `ineChecksite()` schema validation |
| 5.6.6 | 2021-03-16 | code refactoring |
| 5.6.5 | 2021-03-15 | `cpuTemperature()` fix (linux) |
| 5.6.4 | 2021-03-15 | `sanitizeShellString()` and other security improvements |
| 5.6.3 | 2021-03-14 | `sanitizeShellString()` improvement |
| 5.6.2 | 2021-03-10 | `networkInterfaces()` `cpu()` improvement (win) |
| 5.6.1 | 2021-03-03 | `get()` fixed issue boolean parameters |
| 5.6.0 | 2021-03-03 | `cpuTemperature()` added socket and chipset temp (linux) |
| 5.5.0 | 2021-02-25 | `dockerVolumes()` added |
| 5.4.0 | 2021-02-24 | `dockerImages()` added |
| 5.3.5 | 2021-02-23 | `dockerContainerStats()` fixed parameter * |
| 5.3.4 | 2021-02-20 | `sanitizeShellString()` optimized strict sanitation |
| 5.3.3 | 2021-02-15 | `dockerContainerStats()` fixed ID splitting |
| 5.3.2 | 2021-02-15 | `inetLatency()` `ineChecksite()` fixed possible security issue (file://) |
| 5.3.1 | 2021-02-14 | `inetLatency()` `ineChecksite()` `servcices()` `processes()` fixed possible security issue (arrays) |
| 5.3.0 | 2021-02-12 | `osInfo()` added remoteSession (windows) |
| 5.2.7 | 2021-02-12 | `fsStats()`, `blockDevices()` improved linux |
| 5.2.6 | 2021-02-12 | `inetLatency()` fixed possible DOS intrusion |
| 5.2.5 | 2021-02-11 | `processes()` fixed truncated params (linux) |
| 5.2.4 | 2021-02-11 | `currentLoad()` fixed issue |
| 5.2.3 | 2021-02-11 | `diskLayout()` added USB drives (mac OS) |
| 5.2.2 | 2021-02-11 | code cleanup, updated docs |
| 5.2.1 | 2021-02-10 | `system()` fixed issue virtual detect (linux) |
| 5.2.0 | 2021-02-10 | `wifiInterfces()` and `wifiConnections()` added |
| 5.1.2 | 2021-02-08 | fixed node 4 compatibility issue |
| 5.1.1 | 2021-02-08 | `baseboard()` added memMax, memSlots, smaller improvements Raspberry |
| 5.1.0 | 2021-02-08 | `memLayout()` added ECC flag, `bios()` added language, features (linux) |
| 5.0.11 | 2021-02-07 | `fsSize()` fixed windows WSL issue |
| 5.0.10 | 2021-02-06 | `getDynamicData()` fixed windows WSL issue |
| 5.0.9 | 2021-02-02 | `fsSize()` fixed parsing edge case issue mac OS |
| 5.0.8 | 2021-01-30 | typescript typings fix cpuCurrentSpeed |
| 5.0.7 | 2021-01-29 | `fsSize()` available fixed windows and typescript typings |
| 5.0.6 | 2021-01-28 | `osinfo()` added hypervisor (win only) |
| 5.0.5 | 2021-01-27 | `networkInterfaces()` type detection improved (win) |
| 5.0.4 | 2021-01-27 | `cpu()` improved manufacturer decoding (linux) |
| 5.0.3 | 2021-01-27 | `cpu()` fix virtualization, `wifi()` fix raspberry |
| 5.0.2 | 2021-01-26 | updated typescript typings |
| 5.0.1 | 2021-01-26 | code cleanup |
| 5.0.0 | 2021-01-26 | new major version 5 release |
| 4.34.9 | 2021-01-25 | `graphics()` virtual controller vram value fix (win) |
| 4.34.8 | 2021-01-25 | `graphics()` controller subDeviceId fix (win) |
| 4.34.7 | 2021-01-13 | `services()` improved service discovery (linux) |
| 4.34.6 | 2021-01-12 | `networkInterfaces()` catch errors |
| 4.34.5 | 2021-01-07 | `networkInterfaceDefault()` fixed CMD popup (windows) |
| 4.34.4 | 2021-01-06 | `system()` fixed vitrual catch error |
| 4.34.3 | 2021-01-06 | `graphics()` fixed non nvidia-smi controllers (win) |
| 4.34.2 | 2021-01-05 | `system()` uuid lowercase as in uuid() |
| 4.34.1 | 2021-01-05 | `graphics()` nvidia-smi detection improved |
| 4.34.0 | 2021-01-05 | `system()` added flag virtual |
| 4.33.8 | 2021-01-04 | `virtualBox()` fix issue windows host |
| 4.33.7 | 2021-01-04 | `graphics()` nvidia-smi detection improved |
| 4.33.6 | 2021-01-02 | `dockerContainerStats()` fix `tx` changed to `wx` as documented |
| 4.33.5 | 2020-12-30 | `graphics()` vram (nvidia-smi) |
| 4.33.4 | 2020-12-28 | `typescript` typings fix |
Expand Down
39 changes: 34 additions & 5 deletions README.md
Expand Up @@ -30,7 +30,7 @@
[![Sponsoring][sponsor-badge]][sponsor-url]
[![MIT license][license-img]][license-url]

This is amazing. Started as a small project just for myself, it now has > 10,000 lines of code, > 400 versions published, > 3 mio downloads per month, > 30 mio downloads overall. Thank you to all who contributed to this project!
This is amazing. Started as a small project just for myself, it now has > 10,000 lines of code, > 400 versions published, up to 3 mio downloads per month, > 30 mio downloads overall. Thank you to all who contributed to this project!

## New Version 5.0

Expand All @@ -40,6 +40,7 @@ This next major version release 5.0 comes with new functionality and several imp

- added audio: get detailed audio device information
- added bluetooth: get detailed bluetooth device information
- added dockerImages, dockerVolumes: get detailed information about docker images and volumes
- added printer: get information from detected printers
- added usb: get detailed usb controller and device information
- added wifi interfaces ans connections: extended wifi information
Expand Down Expand Up @@ -102,14 +103,13 @@ si.cpu()

(last 7 major and minor version releases)

- Version 5.6.0: `cpuTemperature()` added added socket and chipset temp (linux)
- Version 5.5.0: `dockerVolumes()` added
- Version 5.4.0: `dockerImages()` added
- Version 5.3.0: `osInfo()` added remoteSession (win only)
- Version 5.2.0: `wifiInterfaces()` and `wifiConnections()` added
- Version 5.1.0: `memLayout()` added ECC flag, `bios()` added language, features (linux)
- Version 5.0.0: new version 5 - attention there are some breaking changes. See [detailed version 5 changes here][changes5-url].
- Version 4.34.0: `system()` added flag virtual (linux, windows)
- Version 4.33.0: `graphics()` added nvidia-smi support (linux, windows)
- Version 4.32.0: `graphics()` added clinfo support (linux)
- Version 4.31.0: `osInfo()` added FQDN
- ...

You can find all changes here: [detailed changelog][changelog-url]
Expand Down Expand Up @@ -223,6 +223,8 @@ Full function reference with examples can be found at [https://systeminformation
| | main | X | X | X | X | | main temperature (avg) |
| | cores | X | X | X | X | | array of temperatures |
| | max | X | X | X | X | | max temperature |
| | socket | X | | | | | array socket temperatures |
| | chipset | X | | | | | chipset temperature |

#### 4. Memory

Expand Down Expand Up @@ -668,6 +670,25 @@ Full function reference with examples can be found at [https://systeminformation
| | isolation | X | X | X | X | X | isolation |
| | initBinary | X | X | X | X | X | init binary |
| | productLicense | X | X | X | X | X | product license |
| si.dockerImages(all, cb) | [{...}] | X | X | X | X | X | returns array of top level/all docker images |
| | [0].id | X | X | X | X | X | image ID |
| | [0].container | X | X | X | X | X | container ID |
| | [0].comment | X | X | X | X | X | comment |
| | [0].os | X | X | X | X | X | OS |
| | [0].architecture | X | X | X | X | X | architecture |
| | [0].parent | X | X | X | X | X | parent ID |
| | [0].dockerVersion | X | X | X | X | X | docker version |
| | [0].size | X | X | X | X | X | image size |
| | [0].sharedSize | X | X | X | X | X | shared size |
| | [0].virtualSize | X | X | X | X | X | virtual size |
| | [0].author | X | X | X | X | X | author |
| | [0].created | X | X | X | X | X | created date / time |
| | [0].containerConfig | X | X | X | X | X | container config object |
| | [0].graphDriver | X | X | X | X | X | graph driver object |
| | [0].repoDigests | X | X | X | X | X | repo digests array |
| | [0].repoTags | X | X | X | X | X | repo tags array |
| | [0].config | X | X | X | X | X | config object |
| | [0].rootFS | X | X | X | X | X | root fs object |
| si.dockerContainers(all, cb) | [{...}] | X | X | X | X | X | returns array of active/all docker containers |
| | [0].id | X | X | X | X | X | ID of container |
| | [0].name | X | X | X | X | X | name of container |
Expand Down Expand Up @@ -713,6 +734,14 @@ Full function reference with examples can be found at [https://systeminformation
| | [0].rss | X | X | X | X | X | resident set size |
| | [0].vsz | X | X | X | X | X | virtual size in Kbytes |
| | [0].command | X | X | X | X | X | command and arguments |
| si.dockerVolumes(cb) | [{...}] | returns array of all docker volumes |
| | [0].name | X | X | X | X | X | volume name |
| | [0].driver | X | X | X | X | X | driver |
| | [0].labels | X | X | X | X | X | labels object |
| | [0].mountpoint | X | X | X | X | X | mountpoint |
| | [0].options | X | X | X | X | X | options |
| | [0].scope | X | X | X | X | X | scope |
| | [0].created | X | X | X | X | X | created at |
| si.dockerAll(cb) | {...} | X | X | X | X | X | list of all containers including their stats<br>and processes in one single array |

#### 17. Virtual Box
Expand Down
1 change: 1 addition & 0 deletions docs/changes.html
Expand Up @@ -173,6 +173,7 @@ <h4>Other Improvements and Changes</h4>
<li><span class="code">cpu()</span>: extended socket list (win)</li>
<li><span class="code">cpu()</span>: added <span class="code">virtualization</span> if cpu supports virtualization</li>
<li><span class="code">cpu()</span>: now <span class="code">flags</span> are part of this function</li>
<li><span class="code">cpuTemperature()</span>: added socket and chipset temperature (linux)</li>
<li><span class="code">fsSize()</span>: added <span class="code">available</span></li>
<li><span class="code">fsSize()</span>: improved calculation of <span class="code">used</span></li>
<li><span class="code">getData()</span>: support for passing parameters and filters (see <a href="general.html">section General / getData</a>)</li>
Expand Down
31 changes: 30 additions & 1 deletion docs/cpu.html
Expand Up @@ -545,14 +545,43 @@ <h5>Example</h5>
<td></td>
<td>max temperature</td>
</tr>
<tr>
<td></td>
<td>socket</td>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td>array socket temperatures</td>
</tr>
<tr>
<td></td>
<td>chipset</td>
<td>X</td>
<td></td>
<td></td>
<td></td>
<td></td>
<td>chipset 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 }
{
main: 42,
cores: [
34, 35, 33, 32,
37, 32, 35, 33
],
max: 42,
socket: [ 16.8, 27.8 ],
chipset: 49
}
</pre>
</tr>
</tbody>
Expand Down

0 comments on commit 16eae0c

Please sign in to comment.