Skip to content

Commit 722c259

Browse files
ajaybhargavajaybhargav
committed
Update readme file
Signed-off-by: Ajay Bhargav <[email protected]>
1 parent 6f92bb5 commit 722c259

File tree

1 file changed

+62
-50
lines changed

1 file changed

+62
-50
lines changed

‎README.md‎

Lines changed: 62 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Github Releases](https://img.shields.io/github/release/waybyte/platform-logicrom.svg)](https://github.com/waybyte/platform-logicrom/releases)
99
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/waybyte/platform-logicrom/blob/master/LICENSE)
1010

11-
## Installation
11+
## Quick Installation
1212

1313
1. Install [Visual Studio Code](https://code.visualstudio.com/)
1414
2. Install [PlatformIO Extension for VSCode](https://platformio.org/platformio-ide)
@@ -18,15 +18,26 @@
1818
* Enter in search box "Logicrom"
1919
* Open "Logicrom Development Platform" and hit install
2020

21+
For complete installation guide visit: [Installing Logicrom on PlatformIO](https://docs.logicrom.com/en/latest/book/quick_start/setup_platformio.html)
22+
2123
## Examples
2224

23-
* [gpio-blink](https://github.com/waybyte/platform-logicrom/tree/master/examples/gpio-blink) - GPIO Toggle Example
24-
* [adc-example](https://github.com/waybyte/platform-logicrom/tree/master/examples/adc-example) - ADC Read Example
25-
* [socket-example](https://github.com/waybyte/platform-logicrom/tree/master/examples/socket-example) - TCP Socket example using RAW Socket APIs
26-
* [ssl-socket-example](https://github.com/waybyte/platform-logicrom/tree/master/examples/ssl-socket-example) - SSL Socket example
27-
* [ssl-socket-clientauth](https://github.com/waybyte/platform-logicrom/tree/master/examples/ssl-socket-clientauth) - SSL Socket example with client certificate authentication
28-
* [example-os](https://github.com/waybyte/example-os) - OS API use Example
29-
* [example-console](https://github.com/waybyte/example-console) - Console and Comamnd processor example
25+
1. [Hello World](https://github.com/waybyte/hello-world-logicrom)
26+
2. [OS Example](https://github.com/waybyte/example-os)
27+
3. [Console example](https://github.com/waybyte/example-console)
28+
4. [Timer example](https://github.com/waybyte/example-timer)
29+
5. [GPIO example](https://github.com/waybyte/example-gpio)
30+
6. [UART example](https://github.com/waybyte/example-uart)
31+
7. [ADC example](https://github.com/waybyte/example-adc)
32+
8. [PWM example](https://github.com/waybyte/example-pwm)
33+
9. [SPI example](https://github.com/waybyte/example-spi)
34+
10. [I2C example](https://github.com/waybyte/example-i2c)
35+
11. [Display example](https://github.com/waybyte/example-display)
36+
12. [GPS/GNSS example](https://github.com/waybyte/example-gps)
37+
13. [Socket example](https://github.com/waybyte/example-socket)
38+
14. [SSL Socket example](https://github.com/waybyte/example-ssl-socket)
39+
15. [SSL Socket with Client Authentication](https://github.com/waybyte/example-ssl-socket-clientauth)
40+
16. [HTTP Client example](https://github.com/waybyte/example-httpclient)
3041

3142

3243
## Resources
@@ -54,51 +65,52 @@ Logicrom is available in dual-license:
5465

5566
## Get Free Personal License
5667

57-
1) Register account on [waybyte.in](https://waybyte.in/register)
58-
2) Click on [Register Free Device](https://waybyte.in/devices/register) from left menu
59-
3) Flash Logicrom core firmware
60-
4) Put a valid SIM card in device
61-
5) Turn on the device, It should accquire the license\
62-
If device fail to do so, run "getlic" command from device console to try again.
63-
64-
# Supported Modules
65-
## 4G LTE Cat.1 Modules
66-
67-
| Module Name | Networking | BLE[^1] | GPS | GPIO | ADC | I2C | SPI | USB | LCD | Camera |
68-
|--------------|------------|---------|-----|------|-----|-----|-----|-----|-----|--------|
69-
| Neoway N58 | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &cross; |
70-
| Neoway N716 | &check; | &check; | &#8212; | &check; | &check; | &check; | &check; | &check; | &check; | &cross; |
71-
| Quectel EC200U | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &cross; |
72-
| Quectel EC600U | &check; | &check; | &#8212; | &check; | &check; | &check; | &check; | &check; | &check; | &cross; |
73-
| Quectel EG915U | &check; | &check; | &#8212; | &check; | &check; | &check; | &check; | &check; | &check; | &cross; |
74-
| Fibocom L610 | &check; | &check; | &#8212; | &check; | &check; | &check; | &check; | &check; | &check; | &cross; |
75-
76-
> DFOTA is also supported for LTE modules
68+
Following are simple steps to activate your device.
7769

78-
## NB-IoT Modules[^2]
70+
1. Register account on [waybyte.in](https://waybyte.in/register)
71+
2. Click on [Register Free Device](https://waybyte.in/devices/register) from left menu
72+
3. Enter device details
73+
4. Flash Logicrom core firmware
74+
5. Put a valid SIM card in device
75+
6. Turn on the device, It should accquire the license\
76+
If device fail to do so, run "getlic" command from device console Port (USB Port 0 or Main UART) to try again.
7977

80-
| Module Name | Networking | GPS | GPIO | ADC | I2C | SPI | USB |
81-
|--------------|------------|-----|------|-----|-----|-----|-----|
82-
| Quectel BC66 | &check; | &#8212; | &check; | &check; | &check; | &check; | &check; |
83-
| Quectel BC20 | &check; | &check; | &check; | &check; | &check; | &check; | &check; |
78+
If you face any issue, Please feel free to contact us @ [email protected] or post your issue on github.
8479

85-
## GSM Modules
86-
87-
| Module Name | Networking | BT | GPS | GPIO | ADC | I2C | SPI | USB | LCD[^3] |
88-
|--------------|------------|----|-----|------|-----|-----|-----|-----|---------|
89-
| Quectel M66 | &check; | &check; | &#8212; | &check; | &check; | &check; | &check; | &#8212; | &cross; |
90-
| Quectel M66DS| &check; | &check; | &#8212; | &check; | &check; | &check; | &check; | &#8212; | &cross; |
91-
| Quectel MC60 | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &#8212; | &cross; |
92-
| Quectel MC20 | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &#8212; | &cross; |
93-
| Quectel M56| &check; | &check; | &#8212; | &check; | &check; | &check; | &check; | &check; | &cross; |
94-
| Quectel MC20U| &check; | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &cross; |
95-
| SIMCOM SIM868[^4]| &check; | &check; | &check; | &check; | &check; | &check; | &check; | &check; | &cross; |
96-
97-
98-
[^1]: Currely only GATT Server supported and used for console purpose only.
80+
# Supported Modules
9981

100-
[^2]: Updates to come
82+
| Name | Vendor | SoC/Chipset | Supported Peripherals | APP RAM / ROM |
83+
|-------------------|----------|-------------|----------------------------------------------------|-----------------|
84+
| EC200U-XX-YY [^1] | Quectel | RDA8910 | UART, USB, SPI, I2C, ADC, LCD, BT [^2], GNSS [^3] | 500 KB / 1 MB |
85+
| EC600U-XX-YY [^1] | Quectel | RDA8910 | | 500 KB / 1 MB |
86+
| EC600U-XX-YY [^1] | Quectel | RDA8910 | | 500 KB / 1 MB |
87+
| EG915U-XX-YY [^1] | Quectel | RDA8910 | | 500 KB / 1 MB |
88+
| N58-CA | Neoway | RDA8910 | | 500 KB / 1 MB |
89+
| N716-CA | Neoway | RDA8910 | | 500 KB / 1 MB |
90+
| EC100N-XX-XX | Quectel | ASR1603 | UART, USB, SPI, I2C, ADC | 512 KB / 1 MB |
91+
| EC200N-CN-AA | Quectel | ASR1603 | | 512 KB / 512 KB |
92+
| EC600N-CN-AA | Quectel | ASR1603 | | 512 KB / 1 MB |
93+
| EG912Y-EU-YY | Quectel | ASR1603 | | 512 KB / 1 MB |
94+
| EG915N-EU-YY | Quectel | ASR1603 | | 512 KB / 512 KB |
95+
| EC100Y-CN-YY | Quectel | ASR1601 | UART, USB, SPI, I2C, ADC | 512 KB / 512 KB |
96+
| EC100S-CN-YY | Quectel | ASR1601 | | 512 KB / 1 MB |
97+
| EC600S-CN-YY | Quectel | ASR1601 | | 512 KB / 1 MB |
98+
| AC7670C | SIMCOM | ASR1601 | | 512 KB / 1 MB |
99+
| MC20, MC60, MC20U | Quectel | MT2503 | UART, USB, SPI, I2C, ADC, GNSS | 94 KB / 256 KB |
100+
| SIM868[^4] | SIMCOM | MT2503 | | 94 KB / 256 KB |
101+
| M66, M26, M56 | Quectel | MT6261 | UART, USB, SPI, I2C, ADC | 94 KB / 256 KB |
102+
| SIM800[^4] | SIMCOM | MT6261 | | 94 KB / 256 KB |
103+
| MC65 | Quectel | RDA8955 | UART, USB, SPI, I2C, ADC, GNSS [^3], LCD | 1 MB / 576 KB |
104+
| M590 | Neoway | RDA8955 | | 1 MB / 576 KB |
105+
| A9, A9G | AiThinker| RDA8955 | | 1 MB / 576 KB |
106+
107+
[^1]: XX can be CN/AU/EU, YY can be AA/AB/AC
108+
109+
[^2]: Currely only GATT Server supported and used for console purpose only
110+
111+
[^3]: Supported on module with GNSS
112+
113+
[^4]: IMEI need to be configured when core is flashed for first time, use AT+EGMR=1,7,"imei"
101114

102-
[^3]: LCD is work in progress.
103115

104-
[^4]: Please backup calibration during first flash via Maui Meta tool (google is your friend).
116+
> DFOTA is also supported for LTE modules

0 commit comments

Comments
 (0)