Hermes Gadget

From USB to your first conversation

Let's set up your gadget.

We'll walk through the board, your Hermes, and the connection.

  1. 1Board
  2. 2Hermes
  3. 3Install
  4. 4Connect
  5. 5Pair

  1. Which board do you have?

    Match the exact model printed on your board. Check its wiring guide before continuing.

    Board not listed? See what a port involves, or ask for it.

  2. Prepare your Hermes

    First time? Set up Hermes

    On the computer that runs Hermes, install the plugin, then add Hermes Gadget to the gateway:

    hermes plugins install https://github.com/Adolanium/hermes-gadget-sdk/tree/main/plugin --enable
    hermes gateway setup

    Choose Hermes Gadget and restart the gateway when it asks. It then prints a link to this page with your Hermes address filled in. Full guide

    Keep the gateway running. hermes gadget info shows the address your board needs in the connection step.

    Already installed the plugin? Check that the gateway is running, then continue. Voice also needs speech recognition and text-to-speech.

  3. Install the firmware

    Plug the board into this computer with a USB data cable. Then click Connect and install, and choose the board in the list your browser shows.

  4. Connect it to Wi-Fi and Hermes

    2.4 GHz networks only: the board can't join a 5 GHz network.

    Run hermes gadget info on your Hermes computer to see it. The link hermes gateway setup prints fills it in for you.

    Access token

    Only if your Hermes sets GADGET_ACCESS_TOKEN. Leave it empty to keep the board's current token.

    These settings go straight to the board over USB. This page has no server and sends them nowhere else.

  5. Pair it with Hermes

    • Joining the Wi-Fi network
    • Reaching Hermes
    • Waiting for your approval
Technical details 

    


    

      
Troubleshooting

      

        The board isn't in the browser's list
        
Try another cable: many USB cables only charge. On Windows, a DevKit's UART port needs the driver for its USB chip (CP210x or CH34x). On Linux, add yourself to the dialout group and log in again.

      

      

        It won't connect, or stops partway
        
Close anything else using the port, such as a serial monitor or idf.py monitor. Then hold the board's BOOT button, press and release RESET (or plug it in while holding BOOT), let go of BOOT, and try again.

      

      

        It doesn't join the Wi-Fi
        
Check the password, and that the network is 2.4 GHz. The board's console only takes plain ASCII, so a network name or password with other characters has to be built into the firmware instead (idf.py menuconfig, then Hermes Gadget).

      

      

        It's on Wi-Fi but doesn't reach Hermes
        
Check the address with hermes gadget info on the Hermes computer, that the gateway is running, and that its firewall lets the board in on port 8765. The board has to be able to reach that address from its network.

      

      

        Something else
        
With the board plugged in, save its diagnostics report, then open an issue with the file attached.

        

          
        

        
        
        
From a terminal, hermes-gadget diag --port <port> saves the same report.