Skip to content

Commit 0483a60

Browse files
Updated Readme
Added credits and reorganized slightly to bunch related topics together and add more detail.
1 parent 90a29a8 commit 0483a60

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Pixy2JavaAPI
22
Pixy2 API ported to Java for FIRST Robotics RoboRIO
33

4-
Supported link types: SPI, I2C (Untested), UART/Serial (Untested)
4+
Port by PseudoResonance (Josh Otake) with help from other various contributors.
55

6-
New link types can be easily added by implementing Link
6+
Thank you for your support and usage of this API!
77

88
[Original Pixy2 Code for C++ Arduino](https://github.com/charmedlabs/pixy2/tree/master/src/host/arduino/libraries/Pixy2)
99

@@ -15,7 +15,7 @@ The maven repository is located at: https://nexus.otake.pw/repository/maven-publ
1515

1616
Add `maven { url 'https://nexus.otake.pw/repository/maven-public/' }` under `repositories`
1717

18-
Add `compile 'pw.otake.pseudoresonance:pixy2-java-api:1.1'` under `dependencies` Replace `1.1` with the current version of the API.
18+
Add `compile 'pw.otake.pseudoresonance:pixy2-java-api:1.3.4'` under `dependencies` Replace `1.3.4` with the current version of the API.
1919

2020
Your `build.gradle` should resemble this:
2121

@@ -42,10 +42,18 @@ dependencies {
4242
## Using the API
4343
First create a Pixy2 camera object with `Pixy2 pixy = Pixy2.createInstance(link)` and supply the link type of your choosing. Next, initialize the Pixy2 camera with `pixy.init(arg)`. You can either omit arg, your add a value based on the link type.
4444

45-
The Pixy2 can now be called on with the various provided methods as outlined in the documentation and on the Pixy2 website.
45+
The Pixy2 can now be called on with the various provided methods as outlined in the documentation included in the code and on the Pixy2 website.
46+
47+
Wiki with more detailed usage instructions and example code will be added in the future.
48+
49+
---
50+
## Supported Links to Communicate with Pixy
51+
SPI, I2C (Untested), UART/Serial (Untested)
52+
53+
New link types can be easily added for future hardware, or other Java-based projects by implementing [Link](https://github.com/PseudoResonance/Pixy2JavaAPI/blob/master/src/main/java/io/github/pseudoresonance/pixy2api/links/Link.java)
4654

4755
---
48-
## Connecting Pixy2 to RoboRIO
56+
## Wiring Pixy2 to RoboRIO
4957
SPI is the recommended link type due to it's higher data transfer rate as well as better implementation in the WPILib API which helps with efficiency.
5058

5159
### SPI

0 commit comments

Comments
 (0)