This toolkit helps beginners to be up and running with ADK 2012 without difficulties.
If you have any ideas to improve this toolkit, go to contribution section.
ADK toolkit exposes an AdkManager to manage UsbManager and UsbAccessory. In this way
you don't need to fully understand any background concepts about how ADK works. Anyhow don't forget
to read the ADK official documentation.
If you need support please send a message to the Android ADK Toolkit group.
If you want to contribute, just follow the guidelines.
Note: full documentation has more usage options. Check Usage section for more details.
This library is available on MavenCentral and JCenter (which is now the default repository
used in Android) so you can add this dependency directly in your build.gradle:
dependencies {
compile 'me.palazzetti:adktoolkit:0.3.0'
}
Create res/xml/usb_accessory_filter.xml configuration file to identify your accessory:
<resources>
<usb-accessory
version="0.1.0"
model="External-Droid"
manufacturer="Example, Inc."/>
</resources>Declare in your manifest that your application requires USB accessory support:
<manifest>
<uses-feature android:name="android.hardware.usb.accessory" android:required="true"/>
<!-- ... -->
</manifest>Then add in your activity block this ADK intent filter:
<manifest ...>
<application ...>
<activity ...>
<!-- ... -->
<!-- Adk Intent Filter -->
<intent-filter>
<action android:name="android.hardware.usb.action.USB_ACCESSORY_ATTACHED" />
</intent-filter>
<meta-data android:name="android.hardware.usb.action.USB_ACCESSORY_ATTACHED"
android:resource="@xml/usb_accessory_filter"/>
</activity>
</application>
</manifest>To use this toolkit initialize an AdkManager in your Activity onCreate callback and then
open your accessory in the onResume callback:
private AdkManager mAdkManager;
@Override
protected void onCreate(Bundle savedInstanceState) {
// ...
mAdkManager = new AdkManager(this);
}
@Override
protected void onResume() {
super.onResume();
mAdkManager.open();
}You can use the below methods to access your accessory:
// Write
mAdkManager.write("Hello from Android!");
// Read
AdkMessage response = mAdkManager.read();
System.out.println(response.getString());
// Could outputs: "Hello from Arduino!"This README just provides basic information to show quickly how this library works. You can check the full documentation on Read the Docs.
New features
- Updated to latest gradle version
1.0.0 - Added
AdkMessageclass, which exposes the rawbyte[]array with some utility methods to get string, byte, int and float representations - Issue #13: refactoring
AdkManagerto expose a common interface forread()andwrite() - Issue #16:
AdkManagerconstructor now accept anActivitycontext to initialize the accessory
Backwards incompatible changes from 0.2.x
- removed
writeSerial(String text) - removed
writeSerial(int value) - removed
readSerial() - removed
readString() - removed
readByte()
writeSerialnow accept bothbyteandStringvaluesreadSerialis now deprecated and default toreadStringmethod- Added
readStringandreadByteso you can readStringandbytevalues from the serial port
Bugfixes
- Fixed documentation: #9
FileInputStreamandFileOutputStreamareprotectedso they can be mocked easily during testing- Testing with Mockito
Bugfixes
- Better input/output stream management to avoid NullPointerException on Accessory loading
Backwards incompatible changes in 0.2.0
- Some class/method names are misleading so readText/sendText become readSerial/writeSerial and closeAdk/resumeAdk become close/open
AdkReceiverhas been removed because the actual implementation of read/write can handle multiple char
- ADK fast constructor
- Simple default implementation of Broadcast receiver and IntentFilter
- Writing and reading features available
- Simple AsyncTask support
- Android ADK rover
- UDOO light bulb
- Mobile tanker an Android application powered by OpenCV
If you're interested to list your project here, feel free to submit a pull request.
- Application code: FreeBSD (see
LICENSEfile)