Skip to content

Updating the encoder

New encoder versions arrive over the internet. There’s no need to write the microSD card again: an update also brings the drivers and system parts that used to come only with a new image.

  1. The encoder looks for new versions by itself, every few hours, whenever it has internet.
  2. When there’s one, it downloads it by itself (never while you’re live) and lets you know: in Settings, the System entry and the Updates tab get a dot. On the web page, the Updates card says so.
  3. It doesn’t install by itself. It installs when you press the button.

If it reaches the internet through a modem or a phone, it doesn’t download on its own: it waits for Wi-Fi or a cable so it doesn’t eat your data. If you want it now, press Check now and it downloads over whatever connection there is. Each version is about 50 MB.

  1. Stop streaming. While you’re live, the button doesn’t install and the screen says Stop streaming to update.
  2. Open Settings › System › Updates. It says Version X is available and, below, What’s new: what it brings, in your language.
  3. Press Update to X and tap again to confirm (Tap again to install). On the web page it’s also Update to X.
  4. Wait. The screen and the preview cut out for a few seconds while the encoder restarts its services; the web page reconnects by itself within a minute or two.
  5. When it’s done, it says Updated to X.

Some versions bring changes that only kick in when the device restarts. Then the page says Restart the encoder to finish the update and a Restart now button shows up. It doesn’t work while you’re live either: you pick the moment.

Before installing, the encoder keeps the version you had. If the new one doesn’t start properly, it goes back to the previous one by itself and the page says so: The new version did not start well: the encoder went back to this one. You don’t lose your settings, destinations or cameras.

What to do:

  1. Keep using it as usual: the version you have works.
  2. Try again later, or wait for the next version.
  3. If it happens again, open a report in the GitHub issues with both versions, the one you had and the one you were installing.

If a power cut catches the update halfway, the encoder undoes the half-installed part when it boots again and carries on with the previous version.

It’s in Settings › System › About, under Version. There you also see the Network name, the IP addresses and the address of the Encoder’s web page. The published versions and what each one brings are on the GitHub releases page.

You only write a new image to start from scratch or for a new device: Writing the image and booting explains it. A card written with an older image catches up like any other: as soon as it has internet, it offers you the latest version.