summaryrefslogtreecommitdiff
path: root/external/plyer/facades/compass.py
diff options
context:
space:
mode:
Diffstat (limited to 'external/plyer/facades/compass.py')
-rw-r--r--external/plyer/facades/compass.py37
1 files changed, 37 insertions, 0 deletions
diff --git a/external/plyer/facades/compass.py b/external/plyer/facades/compass.py
new file mode 100644
index 0000000..aed4bbf
--- /dev/null
+++ b/external/plyer/facades/compass.py
@@ -0,0 +1,37 @@
+class Compass(object):
+ '''Compass facade.
+
+ .. versionadded:: 1.2.0
+ '''
+
+ @property
+ def orientation(self):
+ '''Property that returns values of the current compass
+ (magnetic field) sensors, as a (x, y, z) tuple.
+ Returns (None, None, None) if no data is currently available.
+ '''
+ return self.get_orientation()
+
+ def enable(self):
+ '''Activate the compass sensor.
+ '''
+ self._enable()
+
+ def disable(self):
+ '''Disable the compass sensor.
+ '''
+ self._disable()
+
+ def get_orientation(self):
+ return self._get_orientation()
+
+ # private
+
+ def _enable(self):
+ raise NotImplementedError()
+
+ def _disable(self):
+ raise NotImplementedError()
+
+ def _get_orientation(self):
+ raise NotImplementedError()