Device programming

Overview

The programming tool has two main sections:

  • The first, called "Archive" allows you to load the archive of the image you want to program on the device and check the content of this archive.
  • The second, called "Devices programming" allows you to see devices available for programming and program them with the loaded archive.

Download an archive (*.wimg)

You can find the latest LORIX images in the Download area.

Load an archive

To load an archive, you can either drop the wimg image into the dotted blue zone or chose on with the "Choose archive" button.

The Programming Tool will then extract the images from the archive, read the included metadata and validate that the images are valid regarding the metadata description.

The archive will be extracted in the operating system temp folders. In Windows, the path is : %TMP%\wifx\lorix\programming-tool\archives .

Once loaded, you can check the archive content with the "Check" step. It will show you three section :

  • Archive information
  • List of supported products of this archive
  • Partitions details

If the archive has anything wrong, you will get informed with a warning message.

You may check that the loaded image supported the product you want to program by expanding the "Supported products" section:

If everything is fine, you can go on with connecting your device.

Hardware version verification

The Programming Tool will not check that the image supports the product you try to program. Please be sure you use a correct archive otherwise the device will not be functioning.

Connect your device

To program the device, you need to connect it to your computer with the USB cable and power the device with the PoE (Ethernet) cable.

Once the device connected, you need to put it into programming mode.

Entering programming mode

To enter programming mode, you need to remove any SD card inserted into the device and to be connected to a PC through the USB cable.

To enter programming mode, you have to press shortly 2 times on the reset button and then keep pressed a third time for at least 3 seconds (until the status LED flashes again):

Note that the time between each press must be very short (<0.5 seconds). The blue LED must flash at each press. If the sequence failed, wait for 5 seconds before you try again.

Your device will then be listed in the list of available devices to program:

If you cannot enter programming mode, please read the Operating modes and reset page for additional details.

Program the device

You can connect multiple devices if you want to program them simultaneously. In the device list, check only the devices you want to program.

Verification

By default, the programming tool is configured to verify the written partition. We recommend to always keep this option turned on. Verification takes about 40% of the total programming time.

Data loss

When programming the device with the Programming Tool, all existent data and configuration will be erased and overwritten with the new image. This means that all your current data and configuration will be definitely lost.


When ready, press the "Program" button. The device(s) programming will start:

The devices list will show you an approximate progression of the programming process for each device through the progression bar and the numeric percentage in the "Status" column".

When programming of a device is finished, the status column of the device is updated with a check mark:

If you want to keep the log, please export it manually before disconnecting or resetting the device.

You can safely disconnect the device by removing the USB cable and reboot it by pressing the reset button (or unplug and plug the ethernet cable). Congratulation, your device is now ready with the new firmware! 

You have to reboot the gateway (power cycle) to start the system, otherwise it will stay in programming mode.

Programming log

To see the details of the programming process, you can expand the "Programming logs" panel. You'll find a tab for each device of the list with his respective log:

 

This log is particularly useful to diagnose programming errors. You can find a typical successful programming log here : Log.txt.

Programming error

In case of failure, you will get an error message popping from the bottom of the application and the corresponding device status will show an error icon. To diagnose the error, please refer to the device programming log.

Auto programming

If you need to program a large number of devices, you may be interested in enabling the "Auto program" feature. When enabled, all new connected devices detected will be automatically programmed with the loaded archive without asking confirmation to the user.