Skip to content

Commit 2978e08

Browse files
committed
Update READMEs
1 parent 4d1b4d2 commit 2978e08

File tree

5 files changed

+26
-14
lines changed

5 files changed

+26
-14
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@
66

77
The library uses the [Foreign Function & Memory API](https://github.com/openjdk/panama-foreign) to access native APIs of the underlying operating system. It is written entirely in Java and does not need JNI or any native third-party library. The *Foreign Function & Memory API* (aka as project Panama) is currently in preview and will leave preview with Java 22. Currently, it can be used with Java 19, Java 20 or Java 21 (with preview features enabled).
88

9+
| Version | Main New Features | Compatibility |
10+
| - | - | - |
11+
| 0.7.x | Prerelease: New setter/getter names for improved Kotlin support; Kotlin examples | JDK 21 |
12+
| 0.6.x | Support for JDK 21; better handling of composite devices on Windows | JDK 21 |
13+
| 0.5.x | Support for JDK 20; high-throuput I/O streams | JDK 20 |
14+
| 0.4.x | Early release | JDK 19 |
15+
916
*Note: The main branch and published versions ≥ 0.6.0 work with JDK 21 only. For JDK 20, use version 0.5.*. For JDK 19, use version 0.4.x.
1017

1118

@@ -133,13 +140,18 @@ The Foreign Function & Memory API has not been implemented for 32-bit operating
133140

134141
## Code generation
135142

136-
Many bindings for the native APIs have been generated with *jextract*. See the [jextract](java-does-usb/jextract) subdirectory for more information.
143+
Many bindings for the native APIs have been generated with *jextract*. See the [jextract](java-does-usb/jextract) subdirectory for more information. For functions that need to retain the error state (`errno` on Linux, `GetLastError()` on Windows), the bindings have been manually written as *jextract* does not support it.
137144

138145

139146

140147
## Testing
141148

142-
In order to run the unit tests, a special test device must be connected to the computer. See the [loopback-stm32](test-devices/loopback-stm32) directory.
149+
In order to run the unit tests, a special test device must be connected to the computer, which can be easily created from very inexpensive microcontroller boards. Two variants exist:
150+
151+
- [loopback-stm32](test-devices/loopback-stm32)
152+
- [composite-stm32](test-devices/composite-stm32)
153+
154+
The test device with the *loopback-stm32* code supports all tests. If the test device with the *composite-stm32* code is connected, some tests are skipped. However, if it is used, the correct handling of composite devices is verified.
143155

144156
Tests can be run from the command line:
145157

examples/bulk_transfer/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ This sample shows how to find a device, open it and transfer data from and to bu
44

55
## Prerequisites
66

7-
- Java 20
7+
- Java 21
88
- Apache Maven
99
- 64-bit operating system (Windows, macOS, Linux)
1010
- A USB device with bulk IN and OUT endpoints (e.g. the test device, see https://github.com/manuelbl/JavaDoesUSB/tree/main/test-devices/loopback-stm32)
1111

1212
## How to run
1313

14-
### Install Java 20
14+
### Install Java 21
1515

16-
Check that *Java 20* is installed:
16+
Check that *Java 21* is installed:
1717

1818
```shell
1919
$ java -version

examples/enumerate/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ This sample enumerates the connected USB devices and provides information about
44

55
## Prerequisites
66

7-
- Java 20
7+
- Java 21
88
- Apache Maven
99
- 64-bit operating system (Windows, macOS, Linux)
1010

1111
## How to run
1212

13-
### Install Java 20
13+
### Install Java 21
1414

15-
Check that *Java 20* is installed:
15+
Check that *Java 21* is installed:
1616

1717
```shell
1818
$ java -version

examples/monitor/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ This sample program monitors USB devices as they are connected and disconnected.
44

55
## Prerequisites
66

7-
- Java 20
7+
- Java 21
88
- Apache Maven
99
- 64-bit operating system (Windows, macOS, Linux)
1010

1111
## How to run
1212

13-
### Install Java 20
13+
### Install Java 21
1414

15-
Check that *Java 20* is installed:
15+
Check that *Java 21* is installed:
1616

1717
```shell
1818
$ java -version

examples/stm_dfu/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ Even though the DFU
66

77
## Prerequisites
88

9-
- Java 20
9+
- Java 21
1010
- Apache Maven
1111
- 64-bit operating system (Windows, macOS, Linux)
1212

1313
## How to run
1414

15-
### Install Java 20
15+
### Install Java 21
1616

17-
Check that *Java 20* is installed:
17+
Check that *Java 21* is installed:
1818

1919
```shell
2020
$ java -version

0 commit comments

Comments
 (0)