← GitHub home

ROONPILOT COMPANION · STEP-BY-STEP VIDEO GUIDE · 7:54 MINUTES

Companion firmware – purpose and installation

The optional power-saving firmware for the second ESP32 inside RoonPilot. With the same design and narrator as our main firmware guide: animated clicks, actual installer views, and close-ups of turning over the USB-C connector. Pause whenever you need to and follow each step at your own pace.

Open the Companion project page

An optional power-saving addition – not a new version of the main RoonPilot firmware.

Chapter 1 · Introduction

Choose the full-screen icon for a larger view. On a phone, landscape orientation is easier to read. Optional captions can be enabled in the video controls.

Jump straight to a step

If several ESP32 devices are connected to the computer, temporarily disconnect the others so the USB selection is unambiguous. Install only on the round RoonPilot device, not on a separate Bridge.

Companion Sleep does not install the main RoonPilot firmware. The Companion project page above explains the separate installation paths.

Backing up the original firmware is optional, for an exact return to the Waveshare firmware. If you want that option, create the backup before installing Companion Sleep; the project page explains the Windows and macOS paths.

This guide shows the published Companion Sleep 1.0.1 installer, using its actual pages and dialogs. Its version number is independent of the RoonPilot version. Progress is shortened for the video; USB device selection, the connector close-up and the processor overview are illustrated examples. Normal installation requires no terminal commands or programming knowledge.

Read all the steps
  1. Companion firmware: purpose and installation

    This guide explains the optional Companion firmware: what it is for, what it does not do, and how to install it safely in your browser.

  2. One device – two independent processors

    The round Waveshare device contains two independent processors. The E S P thirty-two S three runs RoonPilot, including the display, touch controls, rotary control and network connection. The second, classic E S P thirty-two is the companion processor. It is inside the same device, not a separate Bridge.

  3. Put the unused companion processor to sleep

    RoonPilot does not need the second processor. The small Sleep firmware mutes its unused audio output, leaves the shared signal lines inactive, and puts the companion processor into indefinite deep sleep. This avoids unnecessary activity and is intended to save power.

  4. No new Roon, audio or Bridge features

    It does not turn RoonPilot into a music player or a Roon audio endpoint. It does not extend an I R or R M E Bridge, and it does not replace undervoltage protection. The audio D A C mentioned here is the small chip on the Waveshare board, not your external R M E D A C.

  5. RoonPilot also works without Companion Sleep

    This installation is optional. RoonPilot works fully without it. Afterwards, the display, touch controls, rotary control, Wi-Fi and Roon connection still work. Deep sleep affects only the companion processor, not RoonPilot. No particular increase in battery life is promised; other parts of the board still consume power.

  6. Computer, browser and USB data cable

    You need a computer, a U S B data cable, and a current Chrome or Edge browser. On a Mac, you can use Chrome. Safari and Firefox cannot run this U S B installer. Close other programs using a serial U S B connection, and connect RoonPilot directly to the computer.

  7. Only the Companion firmware is replaced

    Only the companion processor's firmware is erased and replaced. The RoonPilot version, Wi-Fi settings, profiles and Bridge pairings on the main processor remain unchanged. If you may want the exact original Waveshare companion firmware back later, save it first using the linked guide. That backup is not required for normal installation.

  8. Open the separate Companion installer

    Open the address shown here in your browser. Companion at the end of the address is important. You can also choose Open the Companion Web Installer on the main installer page. The heading should say Companion Firmware Installer.

  9. The version is independent of RoonPilot

    Scroll to Install Companion Sleep. This shows the separate Companion version, one point zero point one in this example. It is not an older RoonPilot version. Each processor has its own firmware and version number.

  10. Read and tick both confirmations

    Read the notice about selecting the right processor and replacing its firmware. Read the licence as well. Tick both boxes. Only then does Install Companion firmware become available. Click it to open the device selection window.

  11. Here, “USB serial” is the correct entry

    For this installation, U S B serial is correct. On Windows it has a C O M number. On a Mac, the port name may contain c u dot usbserial, or wchusbserial. These endings are only examples. The device name is what matters. If it already appears, select it and connect.

  12. If “USB JTAG/serial debug unit” appears

    If you see U S B J tag serial debug unit instead, you are connected to the main processor. This is the wrong side for the Companion firmware. Do not select it. Leave the device selection window open and turn the connector as shown next.

  13. 1. Unplug only at the RoonPilot end

    Unplug the U S B C connector at RoonPilot. Leave the other end connected to your computer. The existing entry disappears from the list. You do not need another socket or another cable.

  14. 2. Rotate the connector around its own length

    Rotate the connector around its own length by one hundred and eighty degrees. The side that was facing up now faces down. On this board, the connector orientation determines which processor is accessible over U S B.

  15. 3. Select “USB serial” and connect

    Plug the cable back into the same socket. The list updates, and U S B serial should now appear. Select that entry, then click Connect. You only need to turn the connector if the wrong name was shown before.

  16. Choose “Install RoonPilot Companion Sleep”

    In the small window, choose Install RoonPilot Companion Sleep. The installer dialogs are in English. You do not need Logs and Console for a normal installation.

  17. Tick “Erase device”, then click “Next”

    The Erase device window now appears. Tick the box to erase the companion processor's memory completely before installation. Then click Next. This warning refers only to the selected companion processor, not to your RoonPilot settings.

  18. Confirm the firmware and erase

    Check that the confirmation window names RoonPilot Companion Sleep. The erase warning still refers only to this processor. If everything is correct, click Install. The firmware is now written to the device.

  19. Preparing, erasing, writing and finishing

    The installer prepares the installation, erases the memory, and writes the firmware. The percentage shows progress. It then finishes the process. Keep this window visible, and do not disconnect U S B. The video shortens this sequence; your installation may take longer.

  20. Wait for “Installation complete!”

    Wait for Installation complete. Only then is the installation finished. Click Next and close the small window. Do not unplug just because the progress reaches one hundred percent while Wrapping up is still displayed.

  21. No Wi-Fi setup for Companion Sleep

    There is no setup Wi-Fi, no separate website and no Roon authorisation for the Companion firmware. Its job is to go to sleep after starting. Whenever the device is powered on again, the companion processor returns to this power-saving state.

  22. 1. Unplug after the installation finishes

    Now return the cable to the orientation for the main processor. After the successful installation, unplug it at the RoonPilot end. The Companion firmware remains stored permanently.

  23. 2. Turn the connector over again

    Turn the connector over by another one hundred and eighty degrees. The opposite side faces up again. This returns you to the normal U S B connection with the main processor.

  24. 3. Plug back in – do not reinstall anything

    Plug the cable back in and wait for RoonPilot. The normal U S B side is now U S B J tag serial debug unit again. You do not need to install anything there. Companion Sleep and the main firmware are now present independently.

  25. Continue with your existing settings

    If RoonPilot was already configured, it continues using its existing settings. You do not need to set up Wi-Fi, Roon or Bridges again because of Companion Sleep. If the main firmware was not installed yet, also follow our regular RoonPilot video guide. This Companion installation does not replace it.

  26. No USB device or wrong processor family?

    If the list is empty, check the data cable and close other serial programs. If the E S P thirty-two S three is reported as unsupported, close the dialog, turn the connector, and reconnect to the Companion side. After an interrupted installation, run the same Companion installer again. Do not substitute the main firmware.

  27. All done – optional, separate and simple

    All done. The companion processor sleeps, while RoonPilot remains your remote control. All steps and links to the written guide are below this video. Take your time, and repeat any chapter you need.