Sensey

Additional

Language
Java
Version
1.9.0 (Dec 12, 2020)
Created
Nov 12, 2015
Updated
Dec 13, 2020 (Retired)
Owner
Nishant Srivastava (nisrulz)
Contributors
Nishant Srivastava (nisrulz)
Mikhail Spitsin (programmerr47)
jonathan-caryl
3
Activity
Badge
Generate
Download
Source code
APK file

Advertisement

Sensey

Android library which makes playing with sensor events & detecting gestures a breeze.

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


Built with ❤︎ by Nishant Srivastava and contributors


Screenshot of sample app

Supported gestures/events

Gesture Methods Usage
Flip onFaceUp
onFaceDown
Link
Light onDark
onLight
Link
Orientation onTopSideUp
onBottomSideUp
onLeftSideUp
onRightSideUp
Link
PinchScale onScale
onScaleStart
onScaleEnd
Link
Proximity onNear
onFar
Link
Shake onShakeDetected
onShakeStopped
Link
Wave onWave Link
Chop onChop Link
WristTwist onWristTwist Link
Movement onMovement
onStationary
Link
SoundLevel onSoundDetected Link
RotationAngle onRotation Link
TiltDirection onTiltInAxisX
onTiltInAxisY
onTiltInAxisZ
Link
Scoop onScooped Link
PickupDevice onDevicePickedUp
onDevicePutDown
Link
Steps stepInformation Link
TouchType onDoubleTap
onScroll(direction)
onSingleTap
onSwipeLeft
onSwipeRight
onLongPress
onTwoFingerSingleTap
onThreeFingerSingleTap
Link

Changelog

Starting with 1.0.1, Changes exist in the releases tab.

Including in your project

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

implementation '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. This project uses a modified version of Grandcentrix's code style, so please use the same when editing this project.
  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!

References of Sensey

Sensey is being used in production apps as well as research & development for thesis at universities.

Click here for the full list of references

License

Licensed under the Apache License, Version 2.0, click here for the full license.

Author & Contributors

This project was created by Nishant Srivastava but hopefully developed and maintained by many others. See the the list of contributors here.

Ways You Can Help/Support this project

Thanks for your interest in this software ❤️