Programming / firmware updates

The firmware for the CurrentRanger is freely available as an Arduino IDE sketch and you can tweak it, customize its default behavior and even make it better.

Drag-drop firmware updates

The latest firmware is posted on Github. The older R1-R2 firmware is also posted on Github for legacy purposes. Since the release of R3mk4 (and some late R3mk3) the CurrentRanger shipped with a new UF2 bootloader which allows easy backup and swapping of firmware. Hence there is a UF2 firmware file available as well. To access the UF2 bootloader, double tap on the RST button, the CurrentRanger will enumerate as a flash drive exposing the Current.uf2 firmware – this should be backed up whenever you plan to replace it or upload new firmware. Also ensure you save the calibration values (from the OLED or USB serial), these values should be loaded after flashing the new firmware (via USB serial menu – press ‘?’+Enter in serial monitor to access all options).

CurrentRanger revisions shipped before March 2019 do not have the UF2 bootloader. For this reason they might not include the RST button, in this case you need Arduino IDE to reflash firmware, and Arduino will perform the reset into bootloader. To force the unit in bootloader mode you can short RST to GND twice quickly to simulate a double tap (see RST pin location in image below). The bottom of this page also explains how to access the SWD interface to reflash the bootloader.
If the CurrentRanger does not enumerate correctly and show as Unknown Device in Device Manager (Windows10), uninstall/remove the Unknown Device, power cycle the CurrentRanger and replug the USB, and it should enumerate correctly.

Compiling from source

To compile from source code and upload the firmware you will have to install the following packages in Arduino IDE. First ensure you have the official Arduino SAMD Boards (32-bits ARM Cortex-M0+) boards package, via the Tools>Boards>Boards Manager :

Then you will need the LowPowerLab SAMD boards package, which includes the CurrentRanger SAMD21 board definition. Add the following URL to your Preferences:

https://lowpowerlab.github.io/MoteinoCore/package_LowPowerLab_index.json

Then open Tools>Boards>Boards Manager and install or update to the latest LowPowerLab SAMD package:

Then once plugged in (it has to be powered ON as well), the CurrentRanger will show as a serial USB device that you can pick as a target in the Arduino IDE, just make sure you pick the correct serial port associated with CurrentRanger from the Tools>Port menu or you may use Felix’s custom Arduino IDE with serial/port shortcut bars add-on:

The CurrentRanger’s USB port can power it for programming purposes even without a battery attached. You should only use a standard Lithium-Polymer rechargeable battery while connected to USB since there is a LiPo charger on board that expects this type of battery.

You will need to install several 3rd party libraries to be able to compile the firmware. Please see the sketch header for the links to each library, they should all be available to install through the IDE’s Tools>Manager Libraries dialog.

Older Windows Drivers

If you’re on MAC or Linux you should not need any drivers. Also Windows 10 will probably detect the board as a virtual serial port and assign it a COM port by default without the need of installing a driver. Older Windows versions are likely going to fail to install a driver when CurrentRanger is first plugged in. Click below to get the USB driver and unzip it to your Desktop or another folder. The ZIP file contains a screenshot walkthrough of how to install the driver (shown for MoteinoM0, same for CurrentRanger).

ADC gain and LDO calibration

Your CurrentRanger is calibrated to the measured LDO output during testing, it is a value around 3.3V. Also the ADC gain is adjusted to improve the ADC readings (output on the OLED and to serial logging). These values can slightly change based on load and how long the unit has been turned ON and perhaps other conditions (temperature, etc) – especially true for the LDO voltage. The latest firmware allows to change these values easily via USB serial. The LDO value can be measured on any of the exposed headers (between any GND and “3V” pins). To adjust the LDO and gain, along with other options, access the available commands menu by sending ‘?’+Enter (newline) to USB serial. It is required that you use USB isolation if you do this while measuring a load.

Reset button, manually running the bootloader

There is a RESET button on the bottom side. Although it should not be necessary, you may double-tap the RESET button to enter the bootloader to accept a new firmware upload if you try something that causes the SAMD21 to becomes unresponsive. You know you are in the bootloader if the LPF LED displays a breathing pattern.

OLED I2C Clock Speed

It’s desirable to speed up the clock of the I2C bus when using an I2C SSD1306 based OLED display. Without this optimization there will be more noise on the output when the OLED is connected (visible on a scope only). The “factory” firmware loaded into the CurrentRanger contains this optimization as well as the latest sketch update:

u8g2.setBusClock(1600000); //1.6Mhz i2C clock

SWD programming

To reflash the MCU you will need to access the SWD interface. These pins are located on the PCB as highlighted below. The BOOTPROT fuse is set, this needs to be disabled and re-enabled after flashing the MCU. Any reflashing is done at your own risk and there is no support offered for this procedure. The UF2 bootloader as well as the older samba bootloader are both available in the LowPowerLab SAMD boards package, see the Compiling From Source section above on how to install that.