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-03-14 06:43:55 +01:00
parent cbe6e430b4
commit bd704b2907
6 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -905,10 +905,10 @@ $ npm install osx-temperature-sensor --save
#### Windows Temperature, Battery, ... #### Windows Temperature, Battery, ...
`wmic` - which is used to determine temperature and battery sometimes needs to be run with admin `get-WmiObject` - 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. 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. 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. In some cases we also discovered that `get-WmiObject` returned incorrect temperature values.
#### Linux Temperature #### Linux Temperature

2
docs/battery.html
View File

@ -267,7 +267,7 @@ si.battery().then(data => console.log(data));</code></pre class="example">
<h2>Known issues</h2> <h2>Known issues</h2>
<h4>Windows Battery</h4> <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 <p><span class="code">get-WmiObject</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 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> values, your system might not support this feature.</p>

2
docs/cpu.html
View File

@ -603,7 +603,7 @@ si.cpuTemperature().then(data => console.log(data));</code></pre class="example"
<h4>Windows Temperature</h4> <h4>Windows Temperature</h4>
<p><span class="code">wmic</span> - which is used to determine battery sometimes needs to be run with admin <p><span class="code">get-WmiObject</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 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> values, your system might not support this feature. </p>
</div> </div>

2
docs/general.html
View File

@ -364,7 +364,7 @@ si.get(valueObject).then(data => console.log(data));</code></pre class="example"
<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>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><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>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> <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">get-WmiObject</span> command is very slow when using it the first time.</p>
</div> </div>
</div> </div>
</div> </div>

6
docs/issues.html
View File

@ -59,9 +59,9 @@
<h4>Windows Temperature, Battery, ...</h4> <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 <p><span class="code">get-WmiObject</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 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> values, your system might not support this feature. In some cases we also discovered that get-WmiObject returned incorrect temperature values.</p>
<h4>Linux Temperature</h4> <h4>Linux Temperature</h4>
@ -70,7 +70,7 @@
<h4>Windows, macOS - CPU Speed</h4> <h4>Windows, macOS - CPU Speed</h4>
<p><span class="code">node.js</span> and <span class="code">wmic</span> are not able to determine correct CPU current speed on windows and macOS. <p><span class="code">node.js</span> and <span class="code">get-WmiObject</span> are not able to determine correct CPU current speed on windows and macOS.
This means, you will have constant values here on both platforms for all processor cores in <span class="code">cpuCurrentSpeed()</span>.</p> This means, you will have constant values here on both platforms for all processor cores in <span class="code">cpuCurrentSpeed()</span>.</p>
<h4>Linux S.M.A.R.T. Status</h4> <h4>Linux S.M.A.R.T. Status</h4>

2
test/ci.js
View File

@ -5,7 +5,7 @@ const testWithTimeout = async (fn) => {
(async () => { (async () => {
const timeout = setTimeout(() => { const timeout = setTimeout(() => {
reject('Test Timeout'); reject('Test Timeout');
}, 120000); }, 240000);
const result = await fn(); const result = await fn();
clearTimeout(timeout); clearTimeout(timeout);
return resolve(result); return resolve(result);