Skip to content

An alternative firmware for the Riden WiFi module that provides Modbus TCP and SCPI support as well as a web interface.

Notifications You must be signed in to change notification settings

m-kozlowski/riden-dongle

 
 

Repository files navigation

Riden Dongle - A Multi-Protocol Firmware for the Riden WiFi Module

This is an alternative firmware for the Riden WiFi module that provides Modbus TCP and SCPI support as well as a web interface.

The firmware has been tested with various tools and libraries:

Features

  • Modbus RTU client communicating with Riden power supply firmware.
  • Modbus TCP bridge.
  • SCPI control.
  • Web interface to configure the dongle and update firmware.
  • Automatically set power supply clock based on NTP.
  • mDNS advertising.
  • Handles approximately 65 queries/second using Modbus TCP or SCPI (tested using Unisoft v1.41.1k, UART baudrate set at 921600).

Warning

  • When flashing the Riden WiFi module you will erase the existing firmware.
  • The firmware provided in this repository comes with no warranty.

Query Performance

The regular Riden power supply firmware is considerably slower than UniSoft, handling less than 10 queries/second.

Hardware Preparations

This one had me stuck for some time. To quote from https://community.home-assistant.io/t/riden-rd6006-dc-power-supply-ha-support-wifi/163849:

I had to do small modification to the wifi board - I snipped one pin from the pinheader (EN-Enable) so it does not make contact with the power supply and soldered 1k resistor between EN and 3.3V. It is done because the PS enables wifi module only in “wifi mode” but I need it to run in “TTL mode” as well.

In order to flash an existing Riden WiFi module, solder on three additional wires: GPIO0, EN, and 3.3V. In order to ease development you may want to terminate the wires in a Dupont header connector allowing you to more easily use an ESP01 USB Serial Adapter or similar.

Download the Firmware from GitHub

Firmware files will be released on GitHub as part of the repository.

Compiling the Firmware

You will need PlatformIO in order to compile the firmware.

No configuration is necessary; simply execute pio run and wait. The firmware is located at .pio/build/esp12e/firmware.bin.

Flashing the Firmware

Provided you have prepared the hardware as described, connect it to your computer as you would when flashing any other ESP12F module.

Execute

pio run -t upload --upload-port <ESP12F serial port>

and wait for the firmware to be flashed.

Before re-inserting the module into your power supply, it may be a good idea to make the necessary configuration changes. You need to select TTL as the communications mode, and 9600 as the speed.

Re-insert the module and power up the power supply.

The module will begin to flash, first slowly and then faster. If it starts flashing really fast (5 flashes per second), you propably misconfigured the power supply. Double-check, and if you are still having issues, add an issue to the Github repository.

If all is well, the module has created a new access point, named RDxxxx-ssssssss (xxxx is the model and ssssssss is the serial number), e.g. RD6006-00001234.

Connect to this access point, and you will be greeted by a web page allowing you to configure the WiFi network that the module should connect to.

Follow the instructions, and save the configuration.

If all goes well, the blue LED will start to flash slowly after a short while, and eventually stop. You should now be able to connect to the dongle at http://RDxxxx-ssssssss.local.

Using lxi-tools to Verify Installation

Execute the command

lxi discover -m

to get a list of discovered SCPI devices on the network. This firmware sneakily advertised lxi support in order for lxi-tools to recognise it.

Execute the command

lxi scpi -a RDxxxx-ssssssss.local -r "*IDN?"

to retrieve the SCPI identification string containing power supply model, and firmware version.

Execute the command

lxi scpi -a RDxxxx-ssssssss.local -r "VOLT?"

to retrieve the currently set voltage.

Invoke

lxi scpi -a RDxxxx-ssssssss.local -r "VOLT 3.3"

to set the voltage to 3.3V

A description of the implemented commands is available in SCPI_COMMANDS.md.

OTA firmware update

In order to update the firmware, you may prefer to use OTA update instead of having to remove the module from the power supply and connecting it to a computer.

From the Configure page you can upload a new firmware binary.

Limitations

The Riden power supply firmware has some quirks as described below. The firmware provided here err towards caution, and does not implement functionality that is known to be unreliable.

Currently Active OVP and OCP Values

There is no way to reliably retrieve these values. If they are set by selecting a preset, M0 does not reflect the new values. If they are set via the front panel, M0 does reflect the new values.

Therefore I have decided NOT to support *SAV. *RCL is implemented.

Preset Register

The Preset register (19) only reflects the active preset if changed via the modbus interface. It is not updated if a preset is selected using the front panel. Therefore it is currently not possible to retrieve the selected preset.

Language Selection

Only 0 and 1 are recognised when setting the Language register. Reading the register matches the language set from the front panel.

Keypad

It is not possible to control keypad lock.

Credits

About

An alternative firmware for the Riden WiFi module that provides Modbus TCP and SCPI support as well as a web interface.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 92.8%
  • C 5.6%
  • Python 1.6%