Skip to content

Commit 57fa27e

Browse files
ajaybhargavajaybhargav
committed
docs:add SDK examples and documentation cleanup
Signed-off-by: Ajay Bhargav <[email protected]>
1 parent 544e18a commit 57fa27e

File tree

5 files changed

+116
-16
lines changed

5 files changed

+116
-16
lines changed

‎docs/book/api/peri/adc.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ MT2503/MT6261/MT2625 based modules
7979
+--------------+------------------+-----------+-----------------+-----------+------------+------------+
8080
| ADC CH 1 | Pin 47 | Pin 12 | Pin 47 | Pin 16 | Pin 54 | -- |
8181
+--------------+------------------+-----------+-----------------+-----------+------------+------------+
82-
| ADC CH 2 | Pin 66 | Pin 3 | Pin 28 | Pin 28 | -- | -- |
82+
| ADC CH 2 | Pin 66 | Pin 3 | Pin 30 | Pin 28 | -- | -- |
8383
+--------------+------------------+-----------+-----------------+-----------+------------+------------+
8484
| ADC CH 3 | Pin 30 | Pin 2 | Pin 29 | Pin 29 | -- | -- |
8585
+--------------+------------------+-----------+-----------------+-----------+------------+------------+

‎docs/book/api/peri/spi.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ RDA8910 provide 2 ports.
1212
Chip Select Control
1313
-------------------
1414

15-
MT2503/MT6261/RDA8955
16-
^^^^^^^^^^^^^^^^^^^^^
15+
MT2503, MT6261, RDA8955
16+
^^^^^^^^^^^^^^^^^^^^^^^
1717

18-
Chip select (CS) line on GSM module doubles as GPIO. SPI driver provide option to
19-
let SPI controller Control CS line per transaction basis or CS line can be controlled
20-
by application using GPIO APIs.
18+
Chip select (CS) line on GSM module doubles as GPIO. SPI driver provide option
19+
to let SPI controller Control CS line per transaction basis or CS line can be
20+
controlled by application using GPIO APIs.
2121

2222
RDA8910
2323
^^^^^^^
2424

25-
SPI controller on LTE module has dedicated CS line which cannot be used as GPIO, However
26-
driver provide API to manually control the CS pin when its not configured to be controlled
27-
by SPI controller.
25+
SPI controller on LTE module has dedicated CS line which cannot be used as
26+
GPIO, However driver provide API to manually control the CS pin when its not
27+
configuredto be controlled by SPI controller.
2828

2929
Example Usage
3030
-------------

‎docs/book/api/peri/usb.rst‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
USB
22
===
33

4-
2G GSM modules (MT2503/MT6261/RDA8955) provide USB 1.1 interface with CDC(ACM) profile.
5-
USB port can be used to interface device with a USB host for communication.
4+
2G GSM modules (MT2503, MT6261, RDA8955) provide USB 1.1 interface with
5+
CDC(ACM) profile. USB port can be used to interface device with a USB host
6+
for communication.
67

78
Only Following GSM module provide USB Access:
89

‎docs/book/example.rst‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
SDK Examples
2+
============
3+
4+
List of examples to get started.
5+
6+
1. Hello World: https://github.com/waybyte/hello-world-logicrom
7+
2. OS Example: https://github.com/waybyte/example-os
8+
3. Console example: https://github.com/waybyte/example-console
9+
4. Timer example: https://github.com/waybyte/example-timer
10+
5. GPIO example: https://github.com/waybyte/example-gpio
11+
6. UART example: https://github.com/waybyte/example-uart
12+
7. ADC example: https://github.com/waybyte/example-adc
13+
8. PWM example: https://github.com/waybyte/example-pwm
14+
9. SPI example: https://github.com/waybyte/example-spi
15+
10. I2C example: https://github.com/waybyte/example-i2c
16+
11. Display example: https://github.com/waybyte/example-display
17+
12. GPS/GNSS example: https://github.com/waybyte/example-gps
18+
13. Socket example: https://github.com/waybyte/example-socket
19+
14. SSL Socket example: https://github.com/waybyte/example-ssl-socket
20+
15. SSL Socket with Client Authentication: https://github.com/waybyte/example-ssl-socket-clientauth
21+
16. HTTP Client example: https://github.com/waybyte/example-httpclient
22+
23+
Steps to build example via PlatformIO command line:
24+
25+
.. code-block:: bash
26+
27+
# clone or download project
28+
git clone https://github.com/waybyte/hello-world-logicrom
29+
# enter project dirctory
30+
cd hello-world-logicrom
31+
# build project using PlatformIO
32+
pio run
33+
# upload project to device
34+
pio run --target upload
35+

‎docs/index.rst‎

Lines changed: 69 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,84 @@
11
.. logicromsdk documentation master file, created by
22
sphinx-quickstart on Mon May 25 18:39:44 2020.
33
4-
Welcome to Logicrom SDK Documentation!
5-
======================================
4+
Logicrom IoT SDK
5+
================
6+
7+
.. |br| raw:: html
8+
9+
<br>
610

711
Logicrom Software Development Kit is a framework for Wireless IoT development
8-
on 4G LTE Cat.1 (RDA8910), GSM (MT2503/MT6261/RDA8955) and NBIoT (MT2625)
9-
chipsets/modules.
12+
on 4G LTE Cat.1 (RDA8910, ASR1601, ASR1603), GSM (MT2503, MT6261, RDA8955) and
13+
NBIoT (MT2625) chipsets/modules.
14+
15+
Supported Modules
16+
-----------------
17+
18+
+-------------------+----------+-------------+-----------------------+-----------------+
19+
| Name | Vendor | SoC/Chipset | Supported Peripherals | APP RAM / ROM |
20+
+-------------------+----------+-------------+-----------------------+-----------------+
21+
| EC200U-XX-YY [1]_ | Quectel | RDA8910 | UART, USB, SPI, I2C, | 500 KB / 1 MB |
22+
+-------------------+ | | ADC, LCD, | |
23+
| EC600U-XX-YY [1]_ | | | Camera [2]_, | |
24+
+-------------------+ | | GNSS [3]_ | |
25+
| EC600U-XX-YY [1]_ | | | | |
26+
+-------------------+ | | | |
27+
| EG915U-XX-YY [1]_ | | | | |
28+
+-------------------+----------+ | | |
29+
| N58-CA | Neoway | | | |
30+
+-------------------+ | | | |
31+
| N716-CA | | | | |
32+
+-------------------+----------+-------------+-----------------------+-----------------+
33+
| EC100N-XX-XX |br| | Quectel | ASR1603 | UART, USB, SPI, I2C, | 512 KB / 1 MB |
34+
+-------------------+ | | ADC, LCD [2]_ +-----------------+
35+
| EC200N-CN-AA |br| | | | | 512 KB / 512 KB |
36+
+-------------------+ | | +-----------------+
37+
| EC600N-CN-AA |br| | | | | 512 KB / 1 MB |
38+
+-------------------+ | | +-----------------+
39+
| EG912Y-EU-YY |br| | | | | 512 KB / 1 MB |
40+
+-------------------+ | | +-----------------+
41+
| EG915N-EU-YY |br| | | | | 512 KB / 512 KB |
42+
+-------------------+----------+-------------+-----------------------+-----------------+
43+
| EC100Y-CN-YY |br| | Quectel | ASR1601 | UART, USB, SPI, I2C, | 512 KB / 512 KB |
44+
+-------------------+ | | ADC, LCD [2]_ +-----------------+
45+
| EC100S-CN-YY |br| | | | | 512 KB / 1 MB |
46+
+-------------------+ | | +-----------------+
47+
| EC600S-CN-YY |br| | | | | 512 KB / 1 MB |
48+
+-------------------+----------+ | +-----------------+
49+
| AC7670C | SIMCOM | | | 512 KB / 1 MB |
50+
+-------------------+----------+-------------+-----------------------+-----------------+
51+
| MC20, MC60, MC20U | Quectel | MT2503 | UART, USB, SPI, I2C, | 94 KB / 256 KB |
52+
+-------------------+----------+ | ADC, GNSS | |
53+
| SIM868 | SIMCOM | | | |
54+
+-------------------+----------+-------------+-----------------------+ |
55+
| M66, M26, M56 | Quectel | MT6261 | UART, USB, SPI, I2C, | |
56+
+-------------------+----------+ | ADC | |
57+
| SIM800 | SIMCOM | | | |
58+
+-------------------+----------+-------------+-----------------------+-----------------+
59+
| MC65 | Quectel | RDA8955 | UART, USB, SPI, I2C, | 1 MB / 576 KB |
60+
+-------------------+----------+ | ADC, GNSS [3]_, LCD | |
61+
| M590 | Neoway | | | |
62+
+-------------------+----------+ | | |
63+
| A9, A9G | AiThinker| | | |
64+
+-------------------+----------+-------------+-----------------------+-----------------+
65+
66+
67+
.. [1] XX can be CN/AU/EU, YY can be AA/AB/AC
68+
.. [2] Not Supported on logicrom
69+
.. [3] Supported on module with GNSS
70+
71+
Documentation
72+
=============
1073

1174
.. toctree::
12-
:maxdepth: 3
75+
:maxdepth: 2
1376

1477
Quick Start Guide <book/quick_start>
1578
API Reference Guide <book/api/index>
1679
Hardware Reference Guide <book/hw/index>
1780
Firmware Flashing Guide <book/flashing>
81+
SDK Examples <book/example>
1882
Bug Report <book/bugs>
1983

2084
Indices and tables

0 commit comments

Comments
 (0)