Mirv / sensey

:zap: [Android Library] Detecting gestures in a snap

Specs

Badges/Featured In

Also included in

• Blog Post: I could not find a simple Gesture Detection android library, so I built one
• Best Android Libraries for Developers
• COBE’s Top 5 Android Libraries — September 2016
• DZone Post
• Codepath's Must Have Libraries
• Awesome Android Newsletter
  • Issue 5
  • Issue 21
• Changelog Weekly Issue #115

Show some ❤️

Android library which makes detecting gestures a breeze.

The library is built for simplicity and ease of use. It eliminates most boilerplate code for dealing with setting up gesture detection on Android.

Changelog

Starting with 1.0.1, Changes exist in the releases tab.

Supported gestures

1. Flip
   • onFaceUp
   • onFaceDown
2. Light
   • onDark
   • onLight
3. Orientation
   • onTopSideUp
   • onBottomSideUp
   • onLeftSideUp
   • onRightSideUp
4. PinchScale
   • OnScale
   • OnScaleStart
   • OnScaleEnd
5. Proximity
   • onNear
   • onFar
6. Shake
7. Wave
8. Chop
9. WristTwist
10. Movement
11. SoundLevel
12. RotationAngle
13. TiltDirection
14. TouchType
    • onDoubleTap
    • onScroll(direction)
    • onSingleTap
    • onSwipeLeft
    • onSwipeRight
    • onLongPress
    • onTwoFingerSingleTap
    • onThreeFingerSingleTap

Including in your project

Sensey is available in the Jcenter, so getting it as simple as adding it as a dependency

compile 'com.github.nisrulz:sensey:{latest version}'

where {latest version} corresponds to published version in

Simple example

• To initialize Sensey under your `onCreate()`` in the activity/service, call

Sensey.getInstance().init(context);

• To stop Sensey, under your onDestroy() in the activity/service, call

 // *** IMPORTANT ***
 // Stop Sensey and release the context held by it
 Sensey.getInstance().stop();

• Next to enable shake detection

  • Create an instance of ShakeListener

  ShakeDetector.ShakeListener shakeListener=new ShakeDetector.ShakeListener() {
      @Override public void onShakeDetected() {
         // Shake detected, do something
     }
  
     @Override public void onShakeStopped() {
         // Shake stopped, do something
     }
  };

  • Now to start listening for Shake gesture, pass the instance shakeListener to startShakeDetection() function

  Sensey.getInstance().startShakeDetection(shakeListener);

  If you want to modify the threshold and time before declaring that shake gesture is stopped, use

  Sensey.getInstance().startShakeDetection(threshold,timeBeforeDeclaringShakeStopped,shakeListener);

  • To stop listening for Shake gesture, pass the instance shakeListener to stopShakeDetection() function

  Sensey.getInstance().stopShakeDetection(shakeListener);

📃 For more info , check the Wiki Docs

Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:

1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
2. If its a feature, bugfix, or anything please only change code to what you specify.
3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
4. Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.
5. Check for existing issues first, before filing an issue.
6. Have fun!

Apps using Sensey

If you are using Sensey in your app and would like to be listed here, please let me know by opening a new issue!

• Push-Ups

Created & Maintained By

Nishant Srivastava (@nisrulz)

If you found this library helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕

License

Copyright 2016 Nishant Srivastava

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.