Skip to content

Commit

Permalink
3.13.0 Release
Browse files Browse the repository at this point in the history
  • Loading branch information
dbwiddis committed Jan 19, 2019
1 parent 12787d2 commit 2629d7f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 18 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
4.0.0 (in progress)
================
* [#756](https://github.com/oshi/oshi/pull/756): Require Java 8. - [@dbwiddis](https://github.com/dbwiddis).
* Your contribution here.

3.13.0 (1/18/2019)
================
* [#763](https://github.com/oshi/oshi/pull/763): Refactor PDH/WMI Fallback. - [@dbwiddis](https://github.com/dbwiddis).
* [#766](https://github.com/oshi/oshi/pull/766): Use query key to update counters in groups. - [@dbwiddis](https://github.com/dbwiddis).
* [#767](https://github.com/oshi/oshi/pull/767): Allow subclassing WmiQueryHandler with reflection. - [@dbwiddis](https://github.com/dbwiddis).
* [#769](https://github.com/oshi/oshi/pull/769): Close PDH handles after each query. - [@dbwiddis](https://github.com/dbwiddis).
* Your contribution here.

3.12.1 (12/31/2018), 3.12.2 (1/10/2019)
================
Expand Down
8 changes: 2 additions & 6 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@ Users should create a new instance of [SystemInfo](http://dblock.github.io/oshi/

Methods return a "snapshot" of current levels. To display values which change over time, it is intended that users poll for information no more frequently than one second. Disk and file system calls may incur some latency and should be polled less frequently.

What is the intended use of the oshi-json API?
========
Users should create a new instance of [SystemInfo](http://dblock.github.io/oshi/apidocs/oshi-json/SystemInfo.html) and optionally use the `get*()` methods to retrieve specific information. The `toCompactJSON()` or `toPretyJSON()` methods may then be used appropriate to provides access to the platform-specific JSON objects.

The `to*JSON()` methods take an optional `java.util.Properties` object as a parameter to filter or control the output. Users may use the provided `loadProperties()` method in the `PropertiesUtil` class to load a properties file from the classpath, or generate their own properties programmatically. The property values will correspond exactly to the JSON object tree, e.g., the `hardware.processor` property corresponds to the JSON tree's `hardware` attribute, an object with a `processor` attribute. Setting these properties to `false` will suppress output of that attribute (and its children, if applicable). A [sample configuration file](https://github.com/dblock/oshi/blob/master/oshi-json/src/test/resources/oshi.json.properties) is provided.
OSHI 4.X will overhaul this behavior; see the [UPGRADING.md](UPGRADING.md) document for more details.

Is the API compatible between versions?
========
Expand Down Expand Up @@ -39,6 +35,6 @@ The following generally summarizes known exceptions. If you have missing data th
* Windows sensor (temperature, fans, voltage) readings are drawn from Microsoft's Windows Management Instrumentation (WMI) API; however, most hardware manufacturers do not publish these readings to WMI. If a value is not available through the Microsoft API, Oshi will attempt to retrieve values as published by the [Open Hardware Monitor](http://openhardwaremonitor.org/) if it is running. Only temperature sensors are detected on FreeBSD using `coretemp`.
* Linux, Solaris, and FreeBSD may require either running as root/sudo or additional software installs for full capability, particularly HAL daemon (`hald`/`lshal`) and X (`xrandr`).

Will you implement feature X?
Will you implement ... ?
========
Maybe! If you can contribute all the code to implement the feature, it will almost certainly be added. Even if you can't code but can provide pointers to where the information can be found cross-platform, your feature has a good chance. Otherwise, you can always submit an issue to ask, but are at the mercy of the developers' time, enthusiasm level, and the availability of documentation for the feature.
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@ It doesn't require the installation of any additional native libraries and aims
cross-platform implementation to retrieve system information, such as OS version, processes,
memory & CPU usage, disks & partitions, devices, sensors, etc.

OSHI provides lightweight Java objects to enable the core functionality in the `oshi-core` module,
and extends that with flexible, configurable JSON-formatted data in the `oshi-json` module.

Supported platforms
---------------------------
Windows • Linux • Mac OS X • Unix (Solaris, FreeBSD)
Expand Down Expand Up @@ -58,22 +55,16 @@ Downloads
---------
| Stable Release Version | Current Development Version | Dependencies |
| ------------- | ------------- | ------------- |
| [oshi-core-3.12.2](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.github.oshi&a=oshi-core&v=3.12.2&e=jar) | [oshi-core-4.0.0-SNAPSHOT](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.oshi&a=oshi-core&v=4.0.0-SNAPSHOT&e=jar) | [JNA](https://github.com/java-native-access/jna)[SLF4J](http://www.slf4j.org/) |
| [oshi-json-3.12.2](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.github.oshi&a=oshi-json&v=3.12.2&e=jar) | [oshi-json-4.0.0-SNAPSHOT](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.oshi&a=oshi-json&v=4.0.0-SNAPSHOT&e=jar) | [javax.json](https://jsonp.java.net/download.html) |
| [oshi-core-3.13.0](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.github.oshi&a=oshi-core&v=3.13.0&e=jar) | [oshi-core-4.0.0-SNAPSHOT](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.oshi&a=oshi-core&v=4.0.0-SNAPSHOT&e=jar) | [JNA](https://github.com/java-native-access/jna)[SLF4J](http://www.slf4j.org/) |

Output
-------------
OSHI provides output directly via java methods or, for the `oshi-json` project, in JSON format for each of its interfaces.
OSHI provides output directly via java methods for each of its interfaces.
By periodically polling dynamic information (e.g., every second), users can calculate and track changes.

The `main()` method of [SystemInfoTest](https://github.com/oshi/oshi/blob/master/oshi-core/src/test/java/oshi/SystemInfoTest.java)
provides sample code demonstrating the use of `oshi-core` interfaces to retrieve information and calculate additional metrics such as the below examples.

For `oshi-json`, [SystemInfoTest](https://github.com/oshi/oshi/blob/master/oshi-json/src/test/java/oshi/SystemInfoTest.java)
enables the same capabilities via decorator classes.
See [oshi.json.properties](https://github.com/oshi/oshi/blob/master/oshi-json/src/test/resources/oshi.json.properties)
for a sample properties configuration file to customize JSON results.

General information about the operating system and computer system.
```
Apple macOS 10.12.3 (Sierra) build 16D32
Expand Down

0 comments on commit 2629d7f

Please sign in to comment.