@@ -6,186 +6,16 @@ This document is intended to help users setup software development environment
6
6
for application development on 4G LTE, GSM and NB-IoT modules using Logicrom
7
7
software development kit.
8
8
9
- Setting up Development Environment
10
- ==================================
9
+ Logicrom is supported by both PlatformIO IDE and Arduino IDE. Users can select
10
+ IDE of their choice though our recommendation is to go with PlatformIO.
11
11
12
- Logicrom is supported by both PlatformIO IDE and Arduino IDE with Arduino wiring
13
- support. Users can select IDE of their choice though our recommendation is to
14
- go with PlatformIO.
12
+ .. toctree ::
13
+ :maxdepth: 2
15
14
16
- PlatformIO IDE
17
- ==============
18
-
19
- PlatformIO IDE is the next-generation integrated development environment for IoT.
20
- More information about PlatformIO.
21
-
22
- - `What is PlatformIO? <https://docs.platformio.org/en/latest/what-is-platformio.html >`_
23
- - `About PlatformIO IDE <https://docs.platformio.org/en/latest/integration/ide/pioide.html >`_
24
- - `Installing PlatformIO IDE for VSCode <https://docs.platformio.org/en/latest/integration/ide/vscode.html#installation >`_
25
-
26
- Quick Installation steps for PlatformIO IDE
27
- -------------------------------------------
28
-
29
- 1. `Download <https://code.visualstudio.com/ >`_ and install official Microsoft Visual Studio Code. PlatformIO IDE is built on top of it.
30
- 2. **Open ** VSCode Package Manager.
31
- 3. **Search ** for the official PlatformIO ide `extension <https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide >`_
32
- 4. *Install* * PlatformIO IDE.
33
-
34
- .. image :: ../_static/platformio-ide-vscode-pkg-installer.png
35
-
36
- Installing Logicrom Platform
37
- ----------------------------
38
-
39
- 1. Click on "PlatformIO Home" button on the bottom `PlatformIO Toolbar <https://docs.platformio.org/en/latest/integration/ide/vscode.html#ide-vscode-toolbar >`_
40
-
41
- .. image :: ../_static/platformio-ide-vscode-welcome.png
42
-
43
- 2. Click on "Platforms" Button on the left sidebar of PlatformIO Home.
44
-
45
- .. image :: ../_static/platformio-ide-platforms-page.png
46
-
47
- 3. On Platforms Page, Click on "Embedded" button on the top toolbar.
48
-
49
- .. image :: ../_static/platformio-ide-embedded-menu.png
50
-
51
- 4. Type "Logicrom" in the search box as shown, and click on "Logicrom Development Platform".
52
-
53
- .. image :: ../_static/platformio-ide-logicrom-search.png
54
-
55
- 5. On Logicrom Platform page, Click install button as shown.
56
-
57
- You have successfully installed Logicrom Platform
58
-
59
- .. image :: ../_static/platformio-ide-logicrom-finish.png
60
-
61
- Setting Up the Project
62
- ----------------------
63
-
64
- 1. Go to "Projects" from PlatformIO Home and click "Create New Project" button.
65
-
66
- .. image :: ../_static/platformio-ide-new-project.png
67
-
68
- 2. Configure Project settings:
69
- * Name: Name of project
70
- * Board: Select board from dropdown
71
- * Framework: Select from "Arduino" or "LogicromSDK" frameworks
72
- * Location: To use custom location, un-check "Use default location" and select project folder.
73
- * Click finish to create project.
74
-
75
- .. image :: ../_static/platformio-ide-project-config.png
76
-
77
- 3. Open ``main.cpp `` file form ``src `` folder and replace its contents with
78
-
79
- .. code-block :: cpp
80
-
81
- /**
82
- * Blink
83
- *
84
- * Turns on an LED on for one second,
85
- * then off for one second, repeatedly.
86
- */
87
- #include "Arduino.h"
88
-
89
- void setup()
90
- {
91
- // initialize LED digital pin as an output.
92
- pinMode(LED_BUILTIN, OUTPUT);
93
- }
94
-
95
- void loop()
96
- {
97
- // turn the LED on (HIGH is the voltage level)
98
- digitalWrite(LED_BUILTIN, HIGH);
99
-
100
- // wait for a second
101
- delay(1000);
102
-
103
- // turn the LED off by making the voltage LOW
104
- digitalWrite(LED_BUILTIN, LOW);
105
-
106
- // wait for a second
107
- delay(1000);
108
- }
109
-
110
- .. image :: ../_static/platformio-ide-code-sample.png
111
-
112
- 4. Build your project with ctrl+alt+b hotkey (see all Key Bindings in “User Guide” section below)
113
- or using “Build” button on the PlatformIO Toolbar.
114
-
115
- .. image :: ../_static/platformio-ide-code-build.png
116
-
117
- Serial Port Configuration
118
- -------------------------
119
-
120
- To setup serial port for upload and monitor, You can edit project configuration file ``platform.ini ``
121
- in project source tree.
122
-
123
- .. code-block :: ini
124
-
125
- [env:s20gsm]
126
- platform = logicrom
127
- board = s20gsm
128
- framework = arduino
129
-
130
- ; Upload Port
131
- upload_port = COM1
132
- upload_speed = 921600 ; Default is 460800
133
-
134
- ; Monitor Port
135
- monitor_port = COM2
136
- monitor_speed = 115200
137
-
138
- Setting Debug Build Environment
139
- -------------------------------
140
-
141
- User can add extra configuration in ``platform.ini `` to build project against
142
- logicromsdk debug library.
143
-
144
- .. code-block :: ini
145
-
146
- ; Debug env
147
- [env:s20gsm_debug] ; Env Name
148
- platform = logicrom
149
- board = s20gsm
150
- framework = arduino
151
-
152
- build_type = debug ; Build Type
153
- debug_build_flags = -Os -g2 ; Extra flags for build
154
-
155
- Each environment in ``platform.ini `` file has its own task list which can be executed from "Project Task"
156
- list as shown below.
157
-
158
- .. image :: ../_static/platformio-ide-project-tasks.png
159
-
160
- User can add as many configuration as needed, with different boards etc. using same source.
161
-
162
- For advanced configuration settings of ``platform.ini `` Please refer official documentation of PlatformIO:
163
- https://docs.platformio.org/en/latest/projectconf/index.html#projectconf
164
-
165
- Arduino IDE
166
- ===========
167
-
168
- The open-source Arduino Software (IDE) makes it easy to write code and upload it to the board.
169
- More to read about Arduino IDE:
170
-
171
- `Arduino IDE <https://www.arduino.cc/en/main/software >`_
172
-
173
- Installing Logicrom Platform
174
- ----------------------------
175
-
176
- 1. Download and Install Arduino IDE from `Arduino website <https://www.arduino.cc/ >`_
177
- 2. Open Arduino IDE, Go to **File ** > **Preferences **
178
- 3. Add Logicrom Boards URL to *Additional Board Manager URLs * and click OK.
179
- ``https://waybyte.github.io/package_logicrom_index.json ``
180
-
181
- .. image :: ../_static/arduino-ide-prefs.png
182
-
183
- 4. Go to **Tools ** > **Board ** > **Board Manager **
184
- 5. In search box, type "Logicrom"
185
- 6. Click Install button for *Logicrom Arduino Boards *.
186
- 7. Select your GSM board from board manager under "Logicrom Arduino"
187
-
188
- .. image :: ../_static/arduino-ide-board-manager.png
15
+ Installing Logicrom on Arduino IDE <quick_start/setup_arduino >
16
+ Installing Logicrom on PlatformIO <quick_start/setup_platformio >
17
+ Creating Project in PlatformIO using Logicrom SDK <quick_start/logicrom >
18
+ Creating Project in PlatformIO using Arduino Framework <quick_start/arduino >
189
19
190
20
Support
191
21
=======
0 commit comments