updated docs

This commit is contained in:
Sebastian Hildebrandt 2017-06-23 12:51:02 +02:00
parent b6a7f5c381
commit 8e1af4c65a
2 changed files with 11 additions and 10 deletions

View File

@ -98,6 +98,7 @@ Other changes
| Version | Date | Comment | | Version | Date | Comment |
| -------------- | -------------- | -------- | | -------------- | -------------- | -------- |
| 3.23.3 | 2017-06-23 | updated docs |
| 3.23.2 | 2017-06-23 | bug fix `battery` (windows) | | 3.23.2 | 2017-06-23 | bug fix `battery` (windows) |
| 3.23.1 | 2017-06-22 | updated docs | | 3.23.1 | 2017-06-22 | updated docs |
| 3.23.0 | 2017-06-22 | added `memLayout`, `diskLayout`, extended windows support (`inetChecksite`)| | 3.23.0 | 2017-06-22 | added `memLayout`, `diskLayout`, extended windows support (`inetChecksite`)|

View File

@ -437,13 +437,13 @@ si.networkStats('eth1')
.catch(error => console.error(error)); .catch(error => console.error(error));
``` ```
### About Temperature ### Known Issues
#### OSX #### OSX - Temperature Sensor
Due to some difficulties in NPM with `optionalDependencies` I unfortunately To be able to measure temperature on OSX I created a litte additional package. Due to some difficulties
was getting unexpected warnings on other platforms. So I decided to drop temperature in NPM with `optionalDependencies` I unfortunately was getting unexpected warnings on other platforms.
measurement for OSX - or more specific the automatic installation of the needed dependency. So I decided to drop this optional dependencies for OSX - so by default, you will not get correct values.
But if you need to detect OSX temperature just run the following additional But if you need to detect OSX temperature just run the following additional
installation command: installation command:
@ -454,14 +454,14 @@ $ npm install osx-temperature-sensor --save
`systeminformation` will then detect this additional library and return the temperature when calling systeminformations standard function `cpuTemperature()` `systeminformation` will then detect this additional library and return the temperature when calling systeminformations standard function `cpuTemperature()`
#### Windows #### Windows Temperature, Battery, ...
`wmic` - which is used to determine the temperature sometimes needs to be run with admin `wmic` - which is used to determine temperature and battery sometimes needs to be run with admin
privileges. So if you do not get any temperature value, 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 values. In some cases we also discovered that `wmic` returned incorrect temperature values.
#### Linux #### Linux Temperature
In some cases you need to install the linux `sensors` package to be able to measure temperature In some cases you need to install the linux `sensors` package to be able to measure temperature
e.g. on DEBIAN based systems by running `sudo apt-get install lm-sensors` e.g. on DEBIAN based systems by running `sudo apt-get install lm-sensors`