Giter VIP home page Giter VIP logo

anki-drive-java's Introduction

Anki Drive SDK for Java

The Anki Drive SDK for Java is an implementation of the message protocols and data parsing routines necessary for communicating with Anki Drive vehicles.

See anki/drive-sdk for the official SDK written in C.

Disclaimer

The authors of this software are in no way affiliated to Anki. All naming rights for Anki, Anki Drive and Anki Overdrive are property of Anki.

About

Unfortunately, there is currently no cross-platform Java library to interface with Bluetooth LE devices.

This project therefore requires a Node.js gateway service to handle low-level communication with the Anki vehicles. All data processing and message parsing is carried out in Java code.

Prerequisites

To build and use the SDK in your own project you will need:

  • Java JDK (>= 1.8.0)
  • a compatible Bluetooth 4.0 interface with LE support

Installation

To install the SDK and all required dependencies run the following commands:

git clone https://github.com/yeckey/anki-drive-java
cd anki-drive-java
./gradlew build

Usage

Start the Node.js gateway service:

./gradlew npm_run

Add the Java library

To get the Java library into your build:

// add JitPack.io as a repository
repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    // <Git commit-ish>: commit hash or tag
    compile 'com.github.adessoAG:anki-drive-java:<Git commit-ish>'
}

For the Maven instructions see the JitPack.io website.

API usage

Create a AnkiConnector object:

AnkiConnector anki = new AnkiConnector("localhost", 5000);

Start scanning for vehicles:

List<Vehicle> vehicles = anki.findVehicles();

Contributing

Contributions are always welcome! Feel free to fork this repository and submit a pull request.

anki-drive-java's People

Contributors

jonasheinisch avatar thetric avatar thombergs avatar yeckey avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

anki-drive-java's Issues

add stable releases to be used with jitpack

When using jitpack, you have to provide stable releases for the users, so they don't always take the latests "snapshot" version. It should be enough to create tags through the GitHub UI and provide information in the readme on how the user can find out which releases are available by pointing them to the tags list.

add CI build integration

Add integration to Travis CI by providing a travis.yml and configure GitHub to automatically run a CI build on a commit to master an for each Pull Request.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.