Skip to content

Commit 982de77

Browse files
committed
Updated README.md
1 parent fb316aa commit 982de77

File tree

1 file changed

+16
-27
lines changed

1 file changed

+16
-27
lines changed

README.md

+16-27
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,21 @@ Because JRPiCam works by invoking the `raspistill` software, it is important tha
1010
instructions can be found [here](https://www.raspberrypi.org/documentation/configuration/camera.md).
1111

1212
# Using JRPiCam
13-
To use JRPiCam in your project, just download and unzip the most recent [release](https://github.com/Hopding/JRPiCam/releases/tag/v1.0.1), then add the `jrpicam-1.0.1.jar` file to your project's build path.
13+
To use JRPiCam in your project, just download and unzip the most recent [release](https://github.com/Hopding/JRPiCam/releases/tag/v1.1.0), then add the `jrpicam-1.1.0.jar` file to your project's build path.
1414

1515
The core component of JRPiCam is the `RPiCamera` class, which can be instantiated as follows:
1616
```java
17-
//Create a Camera that saves images to the Pi's Pictures directory.
17+
// Create a Camera that saves images to the Pi's Pictures directory.
1818
RPiCamera piCamera = new RPiCamera("/home/pi/Pictures");
1919
```
2020
Various options can be set on the camera by calling the appropriate methods:
2121
```java
22-
//Set Camera to produce 500x500 images.
23-
piCamera.setWidth(500);
24-
piCamera.setHeight(500);
25-
26-
//Adjust Camera's brightness setting.
27-
piCamera.setBrightness(75);
28-
29-
//Set Camera's exposure.
30-
piCamera.setExposure(Exposure.AUTO);
31-
32-
//Set Camera's timeout.
33-
piCamera.setTimeout(2);
34-
35-
//Add Raw Bayer data to image files created by Camera.
36-
piCamera.setAddRawBayer(true);
37-
38-
//Sets all Camera options to their default settings, overriding any changes previously made.
22+
piCamera.setWidth(500).setHeight(500) // Set Camera to produce 500x500 images.
23+
.setBrightness(75) // Adjust Camera's brightness setting.
24+
.setExposure(Exposure.AUTO) // Set Camera's exposure.
25+
.setTimeout(2) // Set Camera's timeout.
26+
.setAddRawBayer(true); // Add Raw Bayer data to image files created by Camera.
27+
// Sets all Camera options to their default settings, overriding any changes previously made.
3928
piCamera.setToDefaults();
4029
```
4130
Once the `RPiCamera` has been created, and the desired options have been adjusted, an image may be captured from the RPi Camera
@@ -65,26 +54,26 @@ The Javadoc for the project is hosted online [here](http://hopding.com/docs/jrpi
6554
# Examples
6655
The releases contain a number of example JARs (pre-built JARs of the classes in the `src/main/java/com/hopding/jrpicam/examples` directory) that can be executed on the RPi's terminal:
6756

68-
* `demo-view-1.0.1.jar`
69-
* `shoot-buffered-still-1.0.1.jar`
70-
* `shoot-still-1.0.1.jar`
71-
* `shoot-timelapse-1.0.1.jar`
57+
* `demo-view-1.1.0.jar`
58+
* `shoot-buffered-still-1.1.0.jar`
59+
* `shoot-still-1.1.0.jar`
60+
* `shoot-timelapse-1.1.0.jar`
7261

73-
`demo-view-1.0.1.jar` runs a demo gui program that illustrates some functions of JRPiCam. The rest of the examples show how to do things like take a still image, save it, load it into a buffer, and take a series of images.
62+
`demo-view-1.1.0.jar` runs a demo gui program that illustrates some functions of JRPiCam. The rest of the examples show how to do things like take a still image, save it, load it into a buffer, and take a series of images.
7463

75-
To run them, just download and unzip the most recent [release](https://github.com/Hopding/JRPiCam/releases/tag/v1.0.1), open it in a terminal, and run the following:
64+
To run them, just download and unzip the most recent [release](https://github.com/Hopding/JRPiCam/releases/tag/v1.1.0), open it in a terminal, and run the following:
7665
```
7766
$ java -jar examples/[jar name]
7867
```
7968
for example:
8069
```
81-
$ java -jar examples/demo-view-1.0.1.jar
70+
$ java -jar examples/demo-view-1.1.0.jar
8271
```
8372

8473
# Building the Project
8574
JRPiCam is structured as a Gradle project. It contains tasks to build the library JAR, the example JARs, and the Javadoc. To build the project, you must first clone or download the project repository, and open a terminal therein. Then, assuming you're using Windows' Powershell or Unix's Bash:
8675

87-
* To build the main library JAR (`jrpicam-1.0.1.jar`):
76+
* To build the main library JAR (`jrpicam-1.1.0.jar`):
8877
```
8978
$ ./gradlew jar
9079
```

0 commit comments

Comments
 (0)