Sensey

Android library to make detecting gestures easy

View the Project on GitHub

Specs

Download API

Badges/Featured In

Android Arsenal Android Weekly Android Weekly AndroidSweets AndroidDev Digest AndroidDev Digest awesome-android

Also included in

Show some :heart:

GitHub stars GitHub forks GitHub watchers GitHub followers
Twitter Follow

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.

Go build awesome stuff with it! :smile:

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 Download

Setup

Initialize Sensey,under your onCreate() in the activity/service, call

Sensey.getInstance().init(context);

If you wish to alter the sampling period of data by Sensey, use the below init function

Sensey.getInstance().init(context,samplingPeriod)

where samplingPeriod can be anyone from the below options

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 detection for

Shake

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

};
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);
Sensey.getInstance().stopShakeDetection(shakeListener);

Movement

MovementDetector.MovementListener movementListener=new MovementDetector.MovementListener() {
   @Override public void onMovement() {
       // Movement detected, do something
   }
   
   @Override public void onStationary() {
       // Movement stopped, do something
   }

};
Sensey.getInstance().startMovementDetection(movementListener);

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

Sensey.getInstance().startMovementDetection(threshold,timeBeforeDeclaringStationary,movementListener);
Sensey.getInstance().stopMovementDetection(movementListener);

Chop

ChopDetector.ChopListener chopListener=new ChopDetector.ChopListener() {
   @Override public void onChop() {
       // Chop gesture detected, do something
   }
};
Sensey.getInstance().startChopDetection(chopListener);

If you want to modify the threshold and time for chop gesture, use

Sensey.getInstance().startChopDetection(threshold,timeForChopGesture,chopListener);
Sensey.getInstance().stopChopDetection(chopListener);

WristTwist

WristTwistDetector.WristTwistListener wristTwistListener=new WristTwistDetector.WristTwistListener() {
   @Override public void onWristTwist() {
       // Wrist Twist gesture detected, do something
   }
};
Sensey.getInstance().startWristTwistDetection(wristTwistListener);

If you want to modify the threshold and time for wrist twist gesture, use

Sensey.getInstance().startWristTwistDetection(threshold,timeForWristTwistGesture,wristTwistListener);
Sensey.getInstance().stopWristTwistDetection(wristTwistListener);

SoundLevel

SoundLevelDetector.SoundLevelListener soundLevelListener=new SoundLevelDetector.SoundLevelListener() {
   @Override public void onSoundDetected(float level) {
       //Sound Level in dB is detected, do something
   }
};
Sensey.getInstance().startSoundLevelDetection(soundLevelListener);
Sensey.getInstance().stopSoundLevelDetection(soundLevelListener);

Flip

FlipDetector.FlipListener flipListener=new FlipDetector.FlipListener() {
    @Override public void onFaceUp() {
       // Device Facing up
    }

    @Override public void onFaceDown() {
      // Device Facing down
    }
};
Sensey.getInstance().startFlipDetection(flipListener);
Sensey.getInstance().stopFlipDetection(flipListener);

RotationAngle

RotationAngleDetector.RotationAngleListener rotationAngleListener =new RotationAngleDetector.RotationAngleListener() {
    @Override
    public void onRotation(float angleInAxisX, float angleInAxisY, float angleInAxisZ) {
      // Do something with the angles, values are in degrees
  }
};
Sensey.getInstance().startRotationAngleDetection(rotationAngleListener);
Sensey.getInstance().stopRotationAngleDetection(rotationAngleListener);

TiltDirection

TiltDirectionDetector.TiltDirectionListener tiltDirectionListener=new TiltDirectionDetector.TiltDirectionListener() {
  @Override
  public void onTiltInAxisX(int direction) {
    // Do something with tilt direction on x-axis
  }

  @Override
  public void onTiltInAxisY(int direction) {
    // Do something with tilt direction on y-axis
  }

  @Override
  public void onTiltInAxisZ(int direction) {
    // Do something with tilt direction on z-axis
  }
};

where direction can have either of the value:TiltDirectionDetector.DIRECTION_CLOCKWISE or TiltDirectionDetector.DIRECTION_ANTICLOCKWISE

Sensey.getInstance().startTiltDirectionDetection(TiltDirectionListener);
Sensey.getInstance().stopTiltDirectionDetection(TiltDirectionListener);

Orientation

OrientationDetector.OrientationListener orientationListener=new OrientationDetector.OrientationListener() {
  @Override public void onTopSideUp() {
     // Top side of device is up
  }

  @Override public void onBottomSideUp() {
     // Bottom side of device is up
  }

  @Override public void onRightSideUp() {
     // Right side of device is up
  }

  @Override public void onLeftSideUp() {
     // Left side of device is up       
  }
};
Sensey.getInstance().startOrientationDetection(orientationListener);
Sensey.getInstance().stopOrientationDetection(orientationListener);

Proximity

ProximityDetector.ProximityListener proximityListener=new ProximityDetector.ProximityListener() {
   @Override public void onNear() {
        // Near to device
   }

   @Override public void onFar() {
        // Far from device
   }
};
Sensey.getInstance().startProximityDetection(proximityListener);
Sensey.getInstance().stopProximityDetection(proximityListener);

Wave

WaveDetector.WaveListener waveListener=new WaveDetector.WaveListener() {
   @Override public void onWave() {
        // Wave of hand gesture detected
   }
};
Sensey.getInstance().startWaveDetection(waveListener);
Sensey.getInstance().stopWaveDetection(waveListener);

Light

LightDetector.LightListener lightListener=new LightDetector.LightListener() {
   @Override public void onDark() {
      // Dark
   }

   @Override public void onLight() {
      // Not Dark
   }
};
Sensey.getInstance().startLightDetection(lightListener);
Sensey.getInstance().stopLightDetection(lightListener);

For Touch based gestures

IMPORTANT : Implement this to intercept touch actions in activity by overriding the dispatchTouchEvent.

 @Override public boolean dispatchTouchEvent(MotionEvent event) {
    // Setup onTouchEvent for detecting type of touch gesture
    Sensey.getInstance().setupDispatchTouchEvent(event);
    return super.dispatchTouchEvent(event);
 }

PinchScale

PinchScaleDetector.PinchScaleListener pinchScaleListener=new PinchScaleDetector.PinchScaleListener() {
   @Override public void onScale(ScaleGestureDetector scaleGestureDetector, boolean isScalingOut) {
        if (isScalingOut) {
           // Scaling Out;
        } else {
          // Scaling In
        }
   }

   @Override public void onScaleStart(ScaleGestureDetector scaleGestureDetector) {
          // Scaling Started
   }

   @Override public void onScaleEnd(ScaleGestureDetector scaleGestureDetector) {
          // Scaling Stopped
   }
};
Sensey.getInstance().startPinchScaleDetection(pinchScaleListener);
Sensey.getInstance().stopPinchScaleDetection();

Don’t forget to implement dispatchTouchEvent() as explained here

TouchType

TouchTypeDetector.TouchTypListener touchTypListener=new TouchTypeDetector.TouchTypListener() {
   @Override public void onTwoFingerSingleTap() {
         // Two finger single tap
   }

   @Override public void onThreeFingerSingleTap() {
         // Three finger single tap
   }

   @Override public void onDoubleTap() {
         // Double tap
   }

   @Override public void onScroll(int scrollDirection) {
     switch (scrollDirection) {
      case TouchTypeDetector.SCROLL_DIR_UP:
        // Scrolling Up
        break;
      case TouchTypeDetector.SCROLL_DIR_DOWN:
        // Scrolling Down
        break;
      case TouchTypeDetector.SCROLL_DIR_LEFT:
        // Scrolling Left
        break;
      case TouchTypeDetector.SCROLL_DIR_RIGHT:
        // Scrolling Right
        break;
      default:
        // Do nothing
        break;
    }
   }

   @Override public void onSingleTap() {
         // Single tap
   }

   @Override public void onSwipe(int swipeDirection) {
     switch (swipeDirection) {
      case TouchTypeDetector.SWIPE_DIR_UP:
        // Swipe Up
        break;
      case TouchTypeDetector.SWIPE_DIR_DOWN:
        // Swipe Down
        break;
      case TouchTypeDetector.SWIPE_DIR_LEFT:
        // Swipe Left
        break;
      case TouchTypeDetector.SWIPE_DIR_RIGHT:
        // Swipe Right
        break;
      default:
        //do nothing
        break;
    }
   }

   @Override public void onLongPress() {
         // Long press
   }
};
Sensey.getInstance().startTouchTypeDetection(touchTypListener);
Sensey.getInstance().stopTouchTypeDetection();

Don’t forget to implement dispatchTouchEvent() as explained here

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!

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 :coffee:

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.