README.md

Overview

Sample project of SDKs from Onyx-Intl, including onyxsdk-base, onyxsdk-scribble, onyxsdk-pen

To use the SDK, please include the following dependencies in your build.gradle:

    implementation('com.onyx.android.sdk:onyxsdk-device:1.1.11')
    implementation('com.onyx.android.sdk:onyxsdk-pen:1.2.1')

The onyxsdk-scribble SDK has a dependency on the dbflow library which is hosted in the jitpack repository. This can be added in your project's build.gradle with the following entry:

    maven { url "https://jitpack.io" }
    
    maven { url "http://repo.boox.com/repository/maven-public/" }
    

Demo

This repository contains the following examples:

1. Screen

• EPDDemoActivity: basic demo of refreshing the EPD Screen with the EpdController
• FrontLightDemoActivity: demo of FrontLightController. If a device includes a frontLight, the screen brightness can be adjusted.
• FullScreenDemoActivity: demontrates full screen switching. The DeviceUtils.setFullScreenOnResume(this, fullscreen) API call is supported on all devices.

2. Storage (SD Card)

• EnvironmentDemoActivity: shows how to use DeviceEnvironment to access internal storage or the removable SD card

3. Inking

The following examples demonstrate the use of the onyxsdk-pen APIs.

Any type of view can be a drawing target, e.g. a SurfaceView or a WebView. Relative coordinates appropriate to the the view being used are provided.

• ScribbleTouchHelperDemoActivity is an example demonstrating the use of TouchHelper, a simplified drawing API, with a SurfaceView. On touch-enabled devices, fingers can be used for drawing.

• ScribbleWebViewDemoActivity: shows how a WebView can be used to load a Web page and then apply ink to it

The SDK also provides additional functionality such as a move eraser, inking on multiple views, and saving ink strokes.

• ScribbleMoveEraserDemoActivity: using the move eraser

• ScribbleMultipleScribbleViewActivity: inking with multiple views

4. Screensaver

• ScreensaverActivity: setting a screensaver

5. Settings

• OpenSettingActivity: opening a settings page

6. Misc API

• DictionaryUtil can be used to query the dictionary. For details see DictionaryActivity

7. App Open Guide

• AppOpenGuide: opening an app using the Android Debug Bridge (adb)

PRs Welcome

All contributions towards documentation, adding/improving unit tests, and examples are appreciated.

• Please comment as much as possible.
• Commit message format should follow AngularJS's commit message convention..
• Please keep changes for each commit as small as possible.