Skip to content

Commit 740dffb

Browse files
committed
Updated README.md to reflect latest changes.
1 parent af0838e commit 740dffb

1 file changed

Lines changed: 16 additions & 9 deletions

File tree

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Anki Drive SDK for Java
22

33
The Anki Drive SDK for Java is an implementation of the message protocols
4-
and data parsing routines necessary for communicating with Anki Drive vehicles.
4+
and data parsing routines necessary for communicating with Anki Drive and Overdrive vehicles. This library is an updated
5+
version of the one found [adessoAG/anki-drive-java](https://github.com/adessoAG/anki-drive-java).
56

67
*See [anki/drive-sdk](https://github.com/anki/drive-sdk) for the official
78
SDK written in C.*
89

910
### Disclaimer
10-
The authors of this software are in no way affiliated to Anki.
11+
The authors of this software are in no way affiliated to Anki nor adesso AG.
1112
All naming rights for Anki, Anki Drive and Anki Overdrive are property of
12-
[Anki](http://anki.com).
13+
[Anki](http://anki.com), initial concept and implementation of the Java version by the folks at adesso.
1314

1415
This is a forked repository from [adessoAG/anki-drive-java](https://github.com/adessoAG/anki-drive-java), which, sadly,
1516
appears to be abandoned. We are maintaining this SDK to serve our [tenbergen/Automotive-CPS](https://github.com/tenbergen/Automotive-CPS) project.
@@ -37,7 +38,6 @@ To install the SDK and all required dependencies run the following commands:
3738
```
3839
git clone https://github.com/tenbergen/anki-drive-java
3940
cd anki-drive-java
40-
npm install
4141
./gradlew build
4242
```
4343

@@ -59,18 +59,23 @@ Once connected, if your cars time out follow these steps:
5959
3. Select “Reset the Bluetooth module” from the Debug menu list
6060
4. Once finished reboot your Mac
6161

62-
### On Linux
62+
### On Linux / Raspberry Pi
6363

6464
Optional Dependency node-usb will not be installed. So, run:
6565
```
6666
sudo apt-get install libudev-dev
6767
```
6868

69+
### On Windows
70+
71+
Node.js server is currently not supported on Windows. However, you can run the Node.js server on a Linux device change
72+
`edu.oswego.cs.CPSLab.AnkiConnectionTest` to connect to the IP of the Raspberry Pi instead of `localhost`.
73+
6974
## Usage
7075

7176
Start the Node.js gateway service:
7277
```
73-
./gradlew server
78+
sudo ./gradlew server
7479
```
7580

7681
### Add the Java library
@@ -84,11 +89,11 @@ repositories {
8489
8590
dependencies {
8691
// <Git commit-ish>: commit hash or tag
87-
compile 'com.github.adessoAG:anki-drive-java:<Git commit-ish>'
92+
compile 'com.github.tenbergen:anki-drive-java:-SNAPSHOT'
8893
}
8994
```
9095

91-
For the Maven instructions see the [JitPack.io website](https://jitpack.io/#adessoAG/anki-drive-java).
96+
For the Maven instructions see the [JitPack.io website](https://jitpack.io/tenbergen/anki-drive-java).
9297

9398
### API usage
9499

@@ -114,5 +119,7 @@ edu.oswego.cs.CPSLab.AnkiConnectionTest
114119

115120
## Contributing
116121

117-
Contributions are always welcome! Feel free to fork this repository and submit
122+
WINDOWS SERVER WANTED!
123+
124+
Other contributions are welcome as well. Feel free to fork this repository and submit
118125
a pull request.

0 commit comments

Comments
 (0)