Skip to content

Commit 43f32c5

Browse files
committed
docs: Add NB-IoT Module document.
Signed-off-by: lbuque <[email protected]>
1 parent d9f3664 commit 43f32c5

File tree

4 files changed

+39
-0
lines changed

4 files changed

+39
-0
lines changed

docs/en/module/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Module
1212
hmi.rst
1313
lora.rst
1414
lorawan868.rst
15+
nbiot.rst
1516
plus.rst
1617
pps.rst
1718
rca.rst

docs/en/module/nbiot.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
NB-IoT Module
2+
=============
3+
4+
.. include:: ../refs/module.nbiot.ref
5+
6+
The following products are supported:
7+
8+
|NB-IoT Module|
9+
10+
11+
class NBIOTModule
12+
-----------------
13+
14+
Constructors
15+
------------
16+
17+
.. class:: NBIOTModule(id: Literal[0, 1, 2], tx: int, rx: int)
18+
19+
Create a NBIOTModule object
20+
21+
:param id: UART ID.
22+
:param int tx: the UART TX pin.
23+
:param int rx: the UART RX pin.
24+
25+
UIFLOW2:
26+
27+
|init.png|
28+
29+
30+
See :ref:`unit.NBIOTUnit.Methods <unit.NBIOTUnit.Methods>` for more details.

docs/en/refs/module.nbiot.ref

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. |NB-IoT Module| image:: https://static-cdn.m5stack.com/resource/docs/products/module/comx_nb-iot/comx_nb-iot_01.webp
2+
:target: https://docs.m5stack.com/en/module/comx_nb-iot
3+
:height: 200px
4+
:width: 200px
5+
6+
7+
.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/module/nbiot/init.png

docs/en/units/nbiot.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Constructors
5656

5757
|init.png|
5858

59+
.. _unit.NBIOTUnit.Methods:
5960

6061
Methods
6162
-------

0 commit comments

Comments
 (0)