Skip to content

Commit 544e18a

Browse files
ajaybhargavajaybhargav
committed
improve quick start guide with flash instructions
Signed-off-by: Ajay Bhargav <[email protected]>
1 parent 9000f2b commit 544e18a

File tree

4 files changed

+158
-59
lines changed

4 files changed

+158
-59
lines changed

‎docs/book/flash/application.rst‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Flashing Application firmware
2+
=============================
3+
4+
Upload Application via PlatformIO
5+
---------------------------------
6+
7+
Click on the upload icon in bottom toolbar as shown in picture
8+
9+
.. image:: ../../_static/platformio-ide-code-build.png
10+
11+
Upload Application via Arduino
12+
------------------------------
13+
14+
Directly click on upload button in toolbar as shown
15+
16+
.. image:: ../../_static/arduino-ide-flash-upload.png
17+
18+
Alternatively from Menu bar, go to Sketch -> Upload
19+
20+
.. image:: ../../_static/arduino-ide-flash-menu.png
21+
22+
23+
Flashing RDA8955 firmware
24+
^^^^^^^^^^^^^^^^^^^^^^^^^
25+
26+
IDE flashing is not available for RDA8955 chipset, Please use tools
27+
mentioned in :doc:`core flashing <core>` section for flashing application
28+
firmware.

‎docs/book/flash/core.rst‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
Core Firmware Flashing
2+
======================
3+
4+
Logicrom core firmware can be downloaded from github page for supported
5+
modules. Following are the list of tools that can be used for core firmware:
6+
7+
+-----------------+----------------------+---------------+
8+
| SoC / Chipset | Flashtool | Download Link |
9+
+-----------------+----------------------+---------------+
10+
| RDA8910 | QFlash | |
11+
| +----------------------+---------------+
12+
| | Logicrom Flasher | |
13+
+-----------------+----------------------+---------------+
14+
| ASR1601/ASR1603 | Aboot | |
15+
| +----------------------+---------------+
16+
| | Adownload | |
17+
+-----------------+----------------------+---------------+
18+
| RDA8955 | QFlash | |
19+
| +----------------------+---------------+
20+
| | Coolwatcher | |
21+
+-----------------+----------------------+---------------+
22+
| MT2593/MT6261 | QFlash | |
23+
| +----------------------+---------------+
24+
| | Logicrom GSM Flasher | |
25+
+-----------------+----------------------+---------------+
26+
27+
Core Firmware Download
28+
----------------------
29+
30+
Logicrom core firmware for supported modules can be downloaded from github
31+
page: https://github.com/waybyte/logicrom_core
32+
33+
34+
Core Firmware Re-flash
35+
----------------------
36+
37+
Currently core re-flashing of MT2503 & MT6261 based devices is possible and
38+
it's only supported on windows platform due to vendor limitation.
39+
40+
Re-Flashing Core via PlatformIO
41+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42+
43+
1. Open project tasks by clicking PlatformIO icon from left sidebar
44+
2. Under custom tasks, click "Reflash Core Firmware"
45+
46+
.. image:: ../../_static/platformio-ide-flash-core.png
47+
48+
3. Core flashing will start, check progress in terminal windows
49+
50+
.. image:: ../../_static/platformio-ide-flash-core-progress.png
51+
52+
Re-Flashing Core via Arduino
53+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
54+
55+
1. Select Programmer from Tools -> Programmer -> Logicrom Core Flasher
56+
(MT2503/MT6261)
57+
58+
.. image:: ../../_static/arduino-ide-select-logicrom-flasher.png
59+
60+
1. Select device COM port under Tools -> Port
61+
62+
.. image:: ../../_static/arduino-ide-select-logicrom-flasher-port.png
63+
64+
3. Click Tools -> Burn Bootloader to start flashing. Check flash progress in
65+
the output console
66+
67+
.. image:: ../../_static/arduino-ide-logicrom-flasher-progress.png
68+

‎docs/book/flashing.rst‎

Lines changed: 6 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,17 @@
11
Firmware Flashing Guide
22
=======================
33

4-
Core and application firmware flashing is supported on both PlatformIO and Arduino IDE.
4+
.. toctree::
5+
:maxdepth: 2
56

6-
Flashing Application firmware
7-
-----------------------------
8-
9-
Upload Application via PlatformIO
10-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
11-
12-
Click on the upload icon in bottom toolbar as shown in picture
13-
14-
.. image:: ../_static/platformio-ide-code-build.png
15-
16-
Upload Application via Arduino
17-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18-
19-
Directly click on upload button in toolbar as shown
20-
21-
.. image:: ../_static/arduino-ide-flash-upload.png
22-
23-
Alternatively from Menu bar, go to Sketch -> Upload
24-
25-
.. image:: ../_static/arduino-ide-flash-menu.png
26-
27-
28-
Core Firmware Re-flash
29-
----------------------
30-
31-
Currently core re-flashing of GSM devices is possible and it's only supported on windows platform due to vendor limitation.
32-
33-
Flashing Core via PlatformIO
34-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35-
36-
1. Open project tasks by clicking PlatformIO icon from left sidebar
37-
2. Under custom tasks, click "Reflash Core Firmware"
38-
39-
.. image:: ../_static/platformio-ide-flash-core.png
40-
41-
3. Core flashing will start, check progress in terminal windows
42-
43-
.. image:: ../_static/platformio-ide-flash-core-progress.png
44-
45-
Flashing Core via Arduino
46-
^^^^^^^^^^^^^^^^^^^^^^^^^
47-
48-
1. Select Programmer from Tools -> Programmer -> Logicrom Core Flasher (MT2503/MT6261)
49-
50-
.. image:: ../_static/arduino-ide-select-logicrom-flasher.png
51-
52-
2. Select device COM port under Tools -> Port
53-
54-
.. image:: ../_static/arduino-ide-select-logicrom-flasher-port.png
55-
56-
3. Click Tools -> Burn Bootloader to start flashing. Check flash progress in the output console
57-
58-
.. image:: ../_static/arduino-ide-logicrom-flasher-progress.png
7+
Core Firmware Flashing <flash/core>
8+
Application Firmware Flashing <flash/application>
599

6010
Flashing Issues
6111
---------------
6212

63-
If you face any problem during application or core flashing, Please open new issue here:
13+
If you face any problem during application or core flashing, Please open new
14+
issue here:
6415

6516
https://github.com/waybyte/platform-logicrom/issues
6617

‎docs/book/quick_start.rst‎

Lines changed: 56 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,71 @@ This document is intended to help users setup software development environment
66
for application development on 4G LTE, GSM and NB-IoT modules using Logicrom
77
software development kit.
88

9+
Getting Hardware Ready
10+
======================
11+
12+
Logicrom is supported on 4G LTE Cat.1 modules and 2G GSM modules. Select a
13+
module of your choice from the list provided on the main page.
14+
15+
Download the core firmware for selected module from our github page here:
16+
https://github.com/waybyte/example-os
17+
18+
If you do not find your module on the list, Do let us know we will try to
19+
add it to the list.
20+
21+
Follow the :doc:`flashing guide <flash/core>` and Flash the core firmware
22+
on the device.
23+
24+
Activate Logicrom Core
25+
----------------------
26+
27+
To run applications on logicrom SDK, device needs to Activate. A personal
28+
license is Free to use without any feature restrictions. Following are steps
29+
to accquire a license for your device.
30+
31+
1. Register account on `waybyte.in <https://waybyte.in/register>`_
32+
2. Click on `Register Free Device <https://waybyte.in/devices/register>`_ from left menu
33+
3. Enter device details (IMEI and Module type) and register
34+
4. Put a valid SIM card in device
35+
5. Turn on the device, It should accquire the license\
36+
If device fail to do so, run "getlic" command from device console Port
37+
(USB Port 0 or Main UART) to try again.
38+
39+
Getting Software Ready
40+
======================
41+
42+
Setup IDE
43+
---------
44+
945
Logicrom is supported by both PlatformIO IDE and Arduino IDE. Users can select
1046
IDE of their choice though our recommendation is to go with PlatformIO.
1147

48+
Follow the installation guide to setup the IDE.
49+
50+
1251
.. toctree::
13-
:maxdepth: 2
52+
:maxdepth: 1
1453

1554
Installing Logicrom on Arduino IDE <quick_start/setup_arduino>
1655
Installing Logicrom on PlatformIO <quick_start/setup_platformio>
56+
57+
Building & Flashing Application
58+
-------------------------------
59+
60+
.. toctree::
61+
:maxdepth: 1
62+
1763
Creating Project in PlatformIO using Logicrom SDK <quick_start/logicrom>
1864
Creating Project in PlatformIO using Arduino Framework <quick_start/arduino>
1965

20-
Support
21-
=======
66+
Follow the :doc:`application flashing guide <flash/application>` to upload
67+
application on the device.
68+
69+
70+
Need Help?
71+
==========
2272

2373
Need help in installation or setup?
24-
or Post issues on our GitHub page @ https://github.com/waybyte/platform-logicrom/issues
74+
Drop an email @ support[at]waybyte.in or Post issues on our GitHub
75+
page @ https://github.com/waybyte/platform-logicrom/issues
76+

0 commit comments

Comments
 (0)