|
| 1 | +# LoRaStudio |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +LoRaStudio is a demonstration and evaluation tool for the Semtech LoRa Plus series radio chips. This software suite enables developers and engineers to explore the capabilities of the LR2021 through an intuitive host-based interface that communicates with development kits to execute various radio demonstrations and tests. |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- **Host-based Control**: Python application with pyOCD integration for seamless communication with development kits |
| 10 | +- **Multiple Demo Applications**: |
| 11 | + - Ping Pong: Bi-directional communication demonstration |
| 12 | + - PER (Packet Error Rate): Link quality and performance testing |
| 13 | + - Continous Wave: Put the chip in transmission to allow user make measures |
| 14 | + - Power consumption measures application: Set the chip in all possible state to finely measure its consumption |
| 15 | + - More to come... |
| 16 | +- **Cross-platform Support**: Available for Windows and Linux |
| 17 | +- **Multi-platform Dev Kit Support**: Includes firmware for STM32 Nucleo-L476RG, Nordic nRF54-DK, and Seeed XIAO nRF54 platforms |
| 18 | + |
| 19 | +## System Requirements |
| 20 | + |
| 21 | +### Host Computer |
| 22 | + |
| 23 | +**Windows:** |
| 24 | + |
| 25 | +- Windows 10 or later (64-bit) |
| 26 | +- USB port for dev kit connection |
| 27 | + |
| 28 | +**Linux:** |
| 29 | + |
| 30 | +- Ubuntu 22.04 or later (or equivalent distribution) |
| 31 | +- USB port for dev kit connection |
| 32 | + |
| 33 | +### Development Kit |
| 34 | + |
| 35 | +- Compatible Semtech LR2021 development kit (one of the following): |
| 36 | + - Seeed Studio XIAO nRF54 module on expension board with LR2021 module (official most common dev-kit) |
| 37 | + - STMicroelectronics Nucleo-L476RG with LR2021 expension board and Arduino pinout adaptation board |
| 38 | + - Nordic Semiconductor nRF54-DK with LR2021 expension board and Arduino pinout adaptation board |
| 39 | +- USB cable for host connection |
| 40 | +- Power supply as battery pack for standalone running mode (measures on the field) |
| 41 | + |
| 42 | +## Installation |
| 43 | + |
| 44 | +### Option 1: Self-Extracting Installer (Windows) |
| 45 | + |
| 46 | +1. Download `LoRaStudio-Setup-<PACKAGE_NAME>.exe` |
| 47 | +2. Double-click the installer and follow the on-screen instructions |
| 48 | +3. The installer will place all necessary files and create desktop shortcuts |
| 49 | +4. Launch LoRaStudio from the Start Menu or desktop shortcut |
| 50 | +Note: Prefer _user_ installation as _system_ installation, installing LoRaStudio on a computer that already has one will overwrite the previous one |
| 51 | + |
| 52 | +### Option 2: Standalone Windows Version |
| 53 | + |
| 54 | +1. Download `LoRaStudio-Windows-Standalone-<PACKAGE_NAME>.zip` |
| 55 | +2. Extract the archive to your preferred location |
| 56 | +3. Navigate to the extracted folder |
| 57 | +4. Run `LoRaStudio.exe` to launch the application |
| 58 | +Note: Choose this if you would rather have multiple versions at your disposal. |
| 59 | + |
| 60 | +### Option 3: Standalone Linux Version |
| 61 | + |
| 62 | +1. Download `LoRaStudio-Linux-Standalone-<PACKAGE_NAME>.tar.gz` |
| 63 | +2. Extract the archive: |
| 64 | + |
| 65 | + ```bash |
| 66 | + tar -xzf LoRaStudio-Linux-Standalone-<PACKAGE_NAME>.tar.gz |
| 67 | + ``` |
| 68 | + |
| 69 | +3. Navigate to the extracted folder: |
| 70 | + |
| 71 | + ```bash |
| 72 | + cd LoRaStudio-Linux |
| 73 | + ``` |
| 74 | + |
| 75 | +4. Make the binary executable (if needed): |
| 76 | + |
| 77 | + ```bash |
| 78 | + chmod +x lorastudio |
| 79 | + ``` |
| 80 | + |
| 81 | +5. Run the application: |
| 82 | + |
| 83 | + ```bash |
| 84 | + ./lorastudio |
| 85 | + ``` |
| 86 | + |
| 87 | +## Development Kit Setup |
| 88 | + |
| 89 | +The kits are supposed to be already flashed with LoRaStudio software. However, you might want to update them to the latest version. |
| 90 | + |
| 91 | +### Firmware Update |
| 92 | + |
| 93 | +The distribution includes three embedded firmware binaries for different development kit platforms: |
| 94 | + |
| 95 | +- `LoRaStudio_xiao_nrf54_<PACKAGE_NAME>.bin` - For Seeed Studio XIAO nRF54 modules |
| 96 | +- `LoRaStudio_nrf54_dk_<PACKAGE_NAME>.bin` - For Nordic nRF54-DK boards |
| 97 | +- `LoRaStudio_nucleo_l476rg_<PACKAGE_NAME>.bin` - For STM32 Nucleo-L476RG boards |
| 98 | + |
| 99 | +They can be found in the `binaries` folder in the LoRaStudio installation folder. |
| 100 | + |
| 101 | +### Flashing the Development Kit |
| 102 | + |
| 103 | +1. Identify your development kit platform: |
| 104 | + - **XIAO nRF54**: Seeed Studio XIAO nRF54 module |
| 105 | + - **STM32 Nucleo-L476RG**: STMicroelectronics Nucleo board with STM32L476RG MCU |
| 106 | + - **nRF54-DK**: Nordic Semiconductor nRF54 Development Kit |
| 107 | + Some pictures are shown on the documentation page of the applicationfor better identification. |
| 108 | +2. Connect your development kit to your computer via USB |
| 109 | +3. Launch LoRaStudio, go to the connexion page |
| 110 | +4. The application should automatically detect the connected device(s) |
| 111 | +5. If not detected, click **Search for devices** button |
| 112 | +6. Select your device and click on the **Connect** button |
| 113 | +7. Once connected, your kit can be upgraded by clicking on the **Update firmware** button (last of the small squared button on the top left corner of the window), choose the appropriate binary to flash. |
| 114 | + |
| 115 | +**Note for STM32 Nucleo users:** The Nucleo-L476RG board also supports drag-and-drop programming. You can simply copy the firmware binary file to the Nucleo drive that appears when you connect the board to your computer. |
| 116 | + |
| 117 | +If you encounter any issue with your kit, please got to the documentation page in the application. |
| 118 | +It is located on the last tab and you can access it by clicking on the book looking button on the left of the main window, on the very bottom. |
| 119 | + |
| 120 | +## Getting Started |
| 121 | + |
| 122 | +To get a full overview of LoRa Studio capabilities and user guide please open the documentation page directly in the application. |
| 123 | + |
| 124 | +## Troubleshooting |
| 125 | + |
| 126 | +### Device Not Detected |
| 127 | + |
| 128 | +- Ensure the development kit is properly connected via USB |
| 129 | +- Check that USB drivers are installed (Windows may require manual driver installation) |
| 130 | +- Try a different USB cable or port |
| 131 | +- Verify the firmware is properly flashed on the dev kit |
| 132 | + |
| 133 | +### Communication Errors |
| 134 | + |
| 135 | +- Reset the development kit by pressing the reset button |
| 136 | +- Restart LoRaStudio |
| 137 | +- Check USB connection stability |
| 138 | +- Ensure no other application is using the same COM port or USB device |
| 139 | + |
| 140 | +## Technical Details |
| 141 | + |
| 142 | +### Architecture |
| 143 | + |
| 144 | +LoRaStudio consists of two main components: |
| 145 | + |
| 146 | +1. **Host Application**: Python-based GUI application that runs on the host computer, utilizing pyOCD for device communication and control. |
| 147 | + |
| 148 | +2. **Embedded Firmware**: Dedicated software running on the development kit that processes commands from the host and executes radio operations. |
| 149 | + |
| 150 | +## Support and Documentation |
| 151 | + |
| 152 | +For additional documentation, technical support, or to report issues: |
| 153 | + |
| 154 | +- Refer to the documentation page in the application itself |
| 155 | +- Refer to the LR2021 datasheet and application notes |
| 156 | +- Contact your Semtech representative |
| 157 | + |
| 158 | +## License |
| 159 | + |
| 160 | +Please refer to the LICENSE file included in this distribution for software license terms and conditions. |
| 161 | + |
| 162 | +## Version Information |
| 163 | + |
| 164 | +**Current Version**: <PACKAGE_NAME> |
| 165 | +**Release Date**: October 2025 |
| 166 | +**Compatible Firmware Versions**: <PACKAGE_NAME> |
| 167 | + |
| 168 | +--- |
| 169 | + |
| 170 | +© 2025 Semtech Corporation. All rights reserved. |
0 commit comments