Quick Start Guide

This document is intended to guide users in preparing their hardware and setting up the software development environment for application development on 4G LTE, GSM, and NB-IoT modules using the Logicrom software development kit.

Logicrom Spark

Logicrom Spark LTE-G Board

The Logicrom Spark boards come pre-installed with Logicrom core firmware, ready to kickstart your project development.

If you are using the Logicrom Spark LTE-G board, you can directly proceed to the section on Setting up the Development Environment.

Custom Hardware/Module Board

Check here to verify if your module is supported by the Logicrom OpenCPU SDK. To request the addition of a new module, refer to the section on Need Help?

This section is divided into three parts:

  1. Prepare Your Hardware for the SDK: Flash Logicrom Core Firmware

  2. Activate Logicrom Core: Activate Logicrom Core

  3. Setting up the IDE: Setting up the Development Environment

Flash Logicrom Core Firmware

Download the core firmware for the selected module from our GitHub page: https://github.com/waybyte/logicrom_core

Refer to the core flashing guide for instructions on flashing the core firmware onto the device.

Activate Logicrom Core

To run applications on the Logicrom OpenCPU SDK, the device needs to be activated. A personal license is free to use without any feature restrictions. Follow these steps to acquire a license for your device:

  1. Register an account on Waybyte (https://waybyte.in/register).

  2. Click on “Register Free Device” from the left menu

  3. Enter device details (IMEI and module type) and register

  4. Insert a valid SIM card into the device

  5. Power on the device; it should acquire the license. If not, run the “getlic” command from the device console port (USB Port 0 or main UART) to try again.

  6. If the APN needs to be configured, set the APN using the following command:

    apn=<access point name>

    For example: apn=mynetapn

    After setting the APN, reboot the device or run the “getlic” command as mentioned in step 5.

  7. If activation is successful, the device will respond with the serial number URC text:

    "+SER: 123456789012345"

  8. Reboot the device and verify using the “devinfo” command. The UID must be set to the new serial number.

Setting up the Development Environment

Setup IDE

Logicrom is supported by both the PlatformIO IDE and Arduino IDE. Users can choose the IDE of their preference, though our recommendation is to use PlatformIO.

Follow the installation guide to set up the IDE.

Building & Flashing Application

Refer to the application flashing guide for uploadingthe application onto the device.

Need Help?

Need assistance with installation or want to request the addition of a new module? Feel free to reach out to us via email at support[at]waybyte.in or post your queries on our GitHub page at https://github.com/waybyte/platform-logicrom/issues