LMT IoT Shortcut SDK for VS Code

The LMT IoT Shortcut SDK extension is the essential bridge between your development environment and the LMT IoT Shortcut hardware ecosystem. It streamlines the setup process for developers using the IoT Shortcut - a comprehensive, end-to-end platform designed to accelerate the development and deployment of cellular IoT products.

Whether you are prototyping with the IoT Shortcut Evaluation Kit or preparing for a mass production deployment with IoT Shortcut hardware modules, this extension automates the integration of LMT's Zephyr-based firmware SDK with the Nordic Semiconductor nRF Connect SDK.

Features

This extension simplifies the development workflow by managing the connection between the VS Code environment and the IoT Shortcut hardware (based on the Nordic nRF9151 SiP).

• Automated SDK Installation: Easily download and install specific versions of the LMT IoT Shortcut SDK.
• Board Registration: Automatically registers custom IoT Shortcut boards into the nRF Connect board list.
• Path Management: Handles configuration paths automatically.
• Multi-Version Support: Install and manage multiple SDK versions side-by-side for different projects.

Prerequisites

Before using this extension, you must ensure your development environment is correctly prepared.

1. Hardware

• LMT IoT Shortcut Evaluation Kit or custom PCB with LMT IoT Shortcut hardware module.

2. Software

• Please strictly follow the setup guidelines provided in the Evaluation Kit Tutorial.
• These guidelines identify all necessary dependencies, specifically which version of the Nordic Semiconductor nRF Connect SDK is required to run the LMT IoT Shortcut SDK.

Installation Guide

1. Install the Extension: Download and install "LMT IoT Shortcut SDK" from the Visual Studio Code Marketplace.
2. Open Command Palette: Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS).
3. Run Installer: Type and select IoT Shortcut SDK: Install SDK.
4. Select Version: Choose the desired SDK version from the dropdown list (latest recommended).
5. Select Target Directory: Choose the installation location.
   • Recommendation: Use your user folder (e.g., C:/Users/<username>).
   • A new folder named iot-shortcut-sdk-<version> will be created in this location.

Note: You can install multiple versions of the SDK. Each installation will create a distinct folder (e.g., /iot-shortcut-sdk-1.0.0, /iot-shortcut-sdk-1.1.0) in your chosen path.

Uninstalling the SDK

To remove a specific version of the SDK from your machine:

⚠️ WARNING: Before uninstalling, ensure you have backed up any firmware projects or source code stored within the SDK folder. The uninstallation process deletes the entire version folder, including user-created files inside it.

1. Open the Command Palette (Ctrl+Shift+P).
2. Select IoT Shortcut SDK: Uninstall SDK.
3. Choose the specific version you wish to remove from the provided list.
4. Confirm the action to delete the selected SDK version folder.

Troubleshooting

nRF Connect does not see custom boards

If the IoT Shortcut boards do not appear in the nRF Connect extension:

1. Verify Dependencies: Ensure the primary nRF Connect for VS Code extension is installed and enabled.
2. Reload Window: Run the command Developer: Reload Window (Ctrl+Shift+P) to refresh the VS Code instance.
3. Check Installation: Verify that the LMT SDK was installed correctly and that the boards folder exists in your installation path.
4. Manual Configuration: If automatic registration fails, you may need to add the board directory manually in the nRF Connect extension settings.

License

• Extension: This VS Code extension is licensed under the Apache 2.0 License.
• SDK: The IoT Shortcut SDK binaries and source code downloaded via this extension are also licensed under the Apache 2.0 License.