bhi160.rst 3.25 KB
Newer Older
koalo's avatar
koalo committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
.. py:module:: bhi160

``bhi160`` - Sensor Fusion
==========================
.. versionadded:: 1.4

Supports the BHI160 sensor on the card10 for accelerometer, gyroscope...

**Example**:

.. code-block:: python

   import bhi160
   import utime
Rahix's avatar
Rahix committed
15

koalo's avatar
koalo committed
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
   bhi = bhi160.BHI160Orientation()

    while True:
        samples = bhi.read()
        print(samples)
        utime.sleep(0.5)


.. class:: bhi160.BHI160Orientation(sample_rate,dynamic_range,callback,sample_buffer_len)

    Orientation of the BHI160

    Parameters:
        sample_rate: int, optional
            Sample rate (default is 4)
        dynamic_range: int, optional
            Dynamic range (default is 2)
        callback: callable, optional
            Call this callback when enough data is collected (default is None)

            .. todo:: The callback functionality is untested, so do not be confused if it does not work.
        sample_buffer_len: int, optional
            Length of sample buffer (default is 200)

   .. py:method:: read():

   Read sensor values

   :returns: Collected sensor values as list

   .. py:method:: close():

   Close the connection to the sensor

Rahix's avatar
Rahix committed
50

koalo's avatar
koalo committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
.. class:: bhi160.BHI160Accelerometer

    Accelerometer of the BHI160

    Parameters:
        sample_rate: int, optional
            Sample rate (default is 4)
        dynamic_range: int, optional
            Dynamic range (default is 2)
        callback: callable, optional
            Call this callback when enough data is collected (default is None)

            .. todo:: The callback functionality is untested, so do not be confused if it does not work.
        sample_buffer_len: int, optional
            Length of sample buffer (default is 200)

   .. py:method:: read():

   Read sensor values

   :returns: Collected sensor values as list

   .. py:method:: close():

   Close the connection to the sensor

.. class:: bhi160.BHI160Gyroscope

    Gyroscope of the BHI160

    Parameters:
        sample_rate: int, optional
            Sample rate (default is 4)
        dynamic_range: int, optional
            Dynamic range (default is 2)
        callback: callable, optional
            Call this callback when enough data is collected (default is None)

            .. todo:: The callback functionality is untested, so do not be confused if it does not work.
        sample_buffer_len: int, optional
            Length of sample buffer (default is 200)

   .. py:method:: read():

   Read sensor values

   :returns: Collected sensor values as list

   .. py:method:: close():

   Close the connection to the sensor

103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
.. class:: bhi160.BHI160Magnetometer

    Magnetometer of the BHI160

    Parameters:
        sample_rate: int, optional
            Sample rate (default is 4)
        dynamic_range: int, optional
            Dynamic range (default is 1)
        callback: callable, optional
            Call this callback when enough data is collected (default is None)

            .. todo:: The callback functionality is untested, so do not be confused if it does not work.
        sample_buffer_len: int, optional
            Length of sample buffer (default is 200)

Rahix's avatar
Rahix committed
119
120
   .. versionadded:: 1.11

121
122
123
124
125
126
127
128
129
130
   .. py:method:: read():

   Read sensor values

   :returns: Collected sensor values as list

   .. py:method:: close():

   Close the connection to the sensor