diff --git a/Documentation/index.rst b/Documentation/index.rst index 6a64472157552953eea360994aa5a957368d5c88..1cbba07da9e948adfe3a5bb67fce17b0698f26ce 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -23,6 +23,7 @@ Last but not least, if you want to start hacking the lower-level firmware, the pycardium/overview pycardium/color pycardium/leds + pycardium/vibra .. toctree:: :maxdepth: 1 diff --git a/Documentation/pycardium/vibra.rst b/Documentation/pycardium/vibra.rst new file mode 100644 index 0000000000000000000000000000000000000000..096e200c0984c8bbb9395b687338c90b69153fb0 --- /dev/null +++ b/Documentation/pycardium/vibra.rst @@ -0,0 +1,30 @@ +``vibra`` - Vibration Motor +=========================== + +.. py:function:: vibra.vibrate(millis) + + Turn on the vibration motor for a certain duration. + + **Example**: + + .. code-block:: python + + import vibra + + # Turn on vibration motor for 60 ms + vibra.vibrate(60) + + :param int millis: Duration for the vibration motor to be on. + + +.. py:function:: vibra.set(state) + + Permanently set the state of the vibration motor to either *on* or *off*. + + .. warning:: + + If your code for some reason crashes between turning the motor on and + back off again, the motor will continue running. Consider using + :py:func:`vibra.vibrate` instead. + + :param bool state: ``True`` to turn on, ``False`` to turn the motor off.