Device

Updating Device Firmware

We strongly recommend you to upgrade your firmware to the latest version as we are constantly making improvements and adding new features to the devices.

Here are the download links to the update tool. Please download the appropriate one for your OS and follow the instructions on the screen.

Windows
macOS (10.11 or Higher)
Linux (requires dialog and python-serial package)

Previous versions of firmware are available for download here.

Updating Device Firmware

The basic firmware upgrade procedure can be found below, please follow these steps carefully:

After you’re done with upgrading, you can use the CtrlR Plugins to upload and run programs in your device.

Before connecting your module to a Pysense / Pytrack board, you should check for updates of the firmware on the Pysense/Pytrack board. Instructions on how to do this can be found here.
Disconnect your device from your computer
Insert the module into Expansion Board
- On Expansionboard 2.0, connect a jumper cable or wire between G23 and GND
Reconnect the board via USB to your computer
Run the Firmware Upgrade tool and click through the menus. There are several different firmware types available:
- Pybytes: this is the most commonly used latest firmware with built in Ctrl library. You can use this firmware to connect to Ctrl (or choose to not use it)
- Pygate: This firmware is needed to operate the Pygate expansionboard. It contains additional features like support for the LoRa gateway and PyEthernet. On the Lopy4, you cannot use the onboard LoRa radio. This version also includes the Ctrl library
- Pymesh: This firmware is only available through a package on Ctrl as you will need to agree to additional licensing. It allows you to set up a LoRa mesh of SG devices connected through Ctrl
We do not recommend using the following firmware types in a production environment:
- Development: The latest beta-releases will be published here, they will be of the Ctrl variant. This is new development, so it can contain known and unknown issues. Testing and feedback is very much appreciated, but don’t run it in production.
- Legacy: Older firmwares without support for Ctrl.
- Pybytes-legacy: Older firmwares with support for Ctrl.

Checking ‘Include Development Releases’ will check for the development releases of the Firmware Updater Tool

Checking ‘Show Advanced Settings’ will give you the option screen in the next figure.

In some cases, erasing the NVS and CONFIG partitions can solve issues relating to WiFi, Timers or other variables stored in the NVS / CONFIG. Erase during update will remove all Python code on the device.

The firmware version of your device is now upgraded to the latest version.
- On Expansionboard 2.0, remove the jumper cable.

After you’re done with upgrading, you can use the CtrlR Plugins to upload and run programs in your device.

Common issues:

If you are having any issues uploading firmware to your device, make sure the TX and RX jumpers are present on your Expansion Board, as the jumpers sometimes come loose in the box during transport. Without these jumpers, the updater will fail.
On MacOS, the firmware upgrade tool needs access to the /tmp folder
On MacOS, there is an issue with signing of the firmware tool. Go to system preferences –> Security & Privacy –> General, and click “Allow” for the SG Firmware Updater tool.