Skip to content

Commit c115948

Browse files
Tinyu-Zhaolbuque
authored andcommitted
lib/base: Add Atomic GPS Base v2.0 base support.
Signed-off-by: tinyu <[email protected]>
1 parent 589abd5 commit c115948

File tree

10 files changed

+956
-136
lines changed

10 files changed

+956
-136
lines changed

docs/en/base/gpsv2.rst

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
Atomic GPS Base v2.0
2+
======================
3+
4+
.. sku: A134-V2
5+
6+
.. include:: ../refs/base.gpsv2.ref
7+
8+
This is the driver library for the Atomic GPS Base v2.0, which is used to get the GPS data.
9+
10+
Support the following products:
11+
12+
|Atom GPS Base v2.0|
13+
14+
UiFlow2 Example
15+
---------------
16+
17+
get GPS data
18+
^^^^^^^^^^^^^^^^^
19+
20+
Open the |base_gpsv2_atom_example.m5f2| project in UiFlow2.
21+
22+
This example demonstrates how to get the GPS data using Atomic GPS Base v2.0.
23+
24+
UiFlow2 Code Block:
25+
26+
|example.png|
27+
28+
Example output:
29+
30+
None
31+
32+
33+
MicroPython Example
34+
-------------------
35+
36+
get GPS data
37+
^^^^^^^^^^^^^^^^^^
38+
39+
This example demonstrates how to get the GPS data using Atomic GPS Base v2.0.
40+
41+
MicroPython Code Block:
42+
43+
.. literalinclude:: ../../../examples/base/gpsv2/base_gpsv2_atom_example.py
44+
:language: python
45+
:linenos:
46+
47+
Example output:
48+
49+
None
50+
51+
52+
**API**
53+
-------
54+
55+
AtomicGPSV2Base
56+
^^^^^^^^^^^^^^^
57+
58+
.. autoclass:: base.gpsv2.AtomicGPSV2Base
59+
:members:
60+
:member-order: bysource
61+
62+
.. autoclass:: driver.atgm336h.ATGM336H
63+
:members:
64+
:member-order: bysource

docs/en/base/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Base
1212
atom_gps.rst
1313
display.rst
1414
echo.rst
15+
gpsv2.rst
1516
hdriver.rst
1617
motion.rst
1718
pwm.rst

docs/en/refs/base.gpsv2.ref

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
.. |Atom GPS Base v2.0| image:: https://static-cdn.m5stack.com/resource/docs/products/atom/atom_can/atom_can_01.webp
2+
:target: https://docs.m5stack.com/en/atom/atom_can
3+
:height: 200px
4+
:width: 200px
5+
6+
.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/init.png
7+
.. |set_work_mode.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/set_work_mode.png
8+
.. |get_work_mode.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_work_mode.png
9+
.. |get_antenna_state.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_antenna_state.png
10+
.. |get_gps_time.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_gps_time.png
11+
.. |get_gps_date.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_gps_date.png
12+
.. |get_gps_date_time.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_gps_date_time.png
13+
.. |get_timestamp.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_timestamp.png
14+
.. |get_latitude.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_latitude.png
15+
.. |get_longitude.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_longitude.png
16+
.. |get_altitude.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_altitude.png
17+
.. |get_satellite_num.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_satellite_num.png
18+
.. |get_pos_quality.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_pos_quality.png
19+
.. |get_course_over_ground.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_course_over_ground.png
20+
.. |get_speed_over_ground.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_speed_over_ground.png
21+
.. |set_time_zone.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/set_time_zone.png
22+
.. |get_time_zone.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/get_time_zone.png
23+
.. |deinit.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/deinit.png
24+
25+
.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/gps_v2/example.png
26+
27+
.. |base_gpsv2_atom_example.m5f2| raw:: html
28+
29+
<a
30+
href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/base/gpsv2/base_gpsv2_atom_example.m5f2"
31+
target="_blank"
32+
>
33+
base_gpsv2_atom_example.m5f2
34+
</a>
35+

0 commit comments

Comments
 (0)