vibrator for android v < 4.0

README.rst

@@ -26,7 +26,7 @@ GPS                                X             X             X
 Notifications                      X             X                 X       X   X
 Text to speech                     X             X             X   X       X   X
 Email (open mail client)                         X             X   X       X   X
-Vibrator                                         X
+Vibrator                           X             X
 Sms (send messages)                X             X
 Compass                            X             X             X
 Unique ID (IMEI or SN)             X             X             X   X       X   X

examples/vibrator/main.py

@@ -1,11 +1,7 @@
-
+"""Plyer Vibrator Example."""
 from kivy.app import App
-from kivy.uix.boxlayout import BoxLayout
-from kivy.uix.button import Button
 from kivy.lang import Builder
-from kivy.properties import StringProperty, BooleanProperty
-
-from plyer import vibrator
+from kivy.uix.boxlayout import BoxLayout
 
 Builder.load_string('''
 #:import vibrator plyer.vibrator
@@ -39,11 +35,15 @@
 
 
 class VibrationInterface(BoxLayout):
+    """Root Widget."""
     pass
 
 
 class VibrationApp(App):
+    """Main Application."""
+
     def build(self):
+        """Return root widget."""
         return VibrationInterface()
 
     def on_pause(self):

plyer/facades.py

@@ -251,7 +251,7 @@ def vibrate(self, time=1):
     def _vibrate(self, **kwargs):
         raise NotImplementedError()
 
-    def pattern(self, pattern=[0, 1], repeat=-1):
+    def pattern(self, pattern=(0, 1), repeat=-1):
         '''Ask the vibrator to vibrate with the given pattern, with an
         optional repeat.
 

plyer/platforms/android/vibrator.py

@@ -1,34 +1,52 @@
-from jnius import autoclass, cast
+"""Implementation Vibrator for Android."""
+from jnius import autoclass
 from plyer.facades import Vibrator
 from plyer.platforms.android import activity
+from plyer.platforms.android import SDK_INT
 
 Intent = autoclass('android.content.Intent')
 Context = autoclass('android.content.Context')
 vibrator = activity.getSystemService(Context.VIBRATOR_SERVICE)
 
 
 class AndroidVibrator(Vibrator):
-    def _vibrate(self, **kwargs):
-        time = kwargs.get('time')
+    """Android Vibrator class.
 
+    Supported features:
+        * vibrate for some period of time.
+        * vibrate from given pattern.
+        * cancel vibration.
+        * check whether Vibrator exists.
+
+    .. warning::
+        Feature check if Vibrator exists works only for
+        Android ver. 3.0.x (SDK >= 11) and above. For android with SDK < 11
+        it just returns `None`.
+
+    """
+
+    def _vibrate(self, time=1):
         if vibrator:
             vibrator.vibrate(int(1000 * time))
 
-    def _pattern(self, **kwargs):
-        pattern = kwargs.get('pattern')
-        repeat = kwargs.get('repeat')
-
+    def _pattern(self, pattern=(0, 1), repeat=-1):
         pattern = [int(1000 * time) for time in pattern]
 
         if vibrator:
             vibrator.vibrate(pattern, repeat)
 
-    def _exists(self, **kwargs):
-        return vibrator.hasVibrator()
+    def _exists(self):
+        if SDK_INT >= 11:
+            return vibrator.hasVibrator()
+        return
 
-    def _cancel(self, **kwargs):
+    def _cancel(self):
         vibrator.cancel()
 
 
 def instance():
+    """Returns Vibrator with android features.
+
+    :return: instance of class AndroidVibrator
+    """
     return AndroidVibrator()