:mod:`thingz_accel`
===================

.. py:module:: thingz_accel

.. autoapi-nested-parse::

   Thingz accelerometer






.. py:class:: Accel

   Control Galaxia's accelerometer

   .. py:method:: get_x() -> float

      :return: the acceleration value of x axis in mG
      :rtype: float


   .. py:method:: get_y() -> float

      :return: the acceleration value of y axis in mG
      :rtype: float


   .. py:method:: get_z() -> float

      :return: the acceleration value of z axis in mG
      :rtype: float


   .. py:method:: get_values() -> list

      :return: the acceleration values of the 3 axis in a list. Index 0 is X, 1 is Y, 2 is Z
      :rtype: list


   .. py:method:: current_gesture() -> str

      Get the current gesture. Can be on of the following value:

      * up

      * down

      * left

      * right

      * face up

      * face down

      * freefall

      * 3g

      * 6g

      * 8g

      * shake

      * none

      :return: the current gesture
      :rtype: str


   .. py:method:: is_gesture(gesture: str) -> bool

      :param str gesture: the gesture to test
      :return: True if the current gesture is the gesture receive as parameter
      :rtype: bool


   .. py:method:: was_gesture(gesture: str) -> bool

      :param str gesture: the gesture to test
      :return: True if the gesture has been active since the last call to this function
      :rtype: bool


   .. py:method:: get_gestures() -> list

      :return: The history of gesture. The most recent is listed last
      :rtype: list


   .. py:method:: on_gesture(gesture: str, callback: Callable[Optional[str]]) -> None

      Register a callaback bind to press event

      :param str gesture: The gesture to bind the callback to
      :param Callable[Optional[str]] callback: The function to call when the event occurs. When called the gesture will be passed as paramater



.. py:class:: Compass

   Control Galaxia's magnetometer

   .. py:method:: get_x() -> float

      :return: the magnetic field value of x axis in uT
      :rtype: float


   .. py:method:: get_y() -> float

      :return: the magnetic field value of y axis in uT
      :rtype: float


   .. py:method:: get_x() -> float

      :return: the magnetic field value of z axis in uT
      :rtype: float


   .. py:method:: get_values() -> list

      :return: the magnetic field values of the 3 axis in a list. Index 0 is X, 1 is Y, 2 is Z
      :rtype: list


   .. py:method:: heading() -> float

      :return: the current heading
      :rtype: float


   .. py:method:: calibrate(hard_time: int, soft_time: int) -> None

      Calibrate the magnetometer. During the calibration the board has to be rotated in all the direction.

      :param int hard_time: Time to spend  in the first step of the calibration, value is in seconds
      :param int soft_time: Time to spend  in the second step of the calibration, value is in seconds