Quick Start

Get from account creation to your first remote wake in a single session using the Android app, ESP32 firmware, and the hosted relay.

Note
Time to complete: About 15–20 minutes. You will install the Android app, create an account, flash the ESP32 firmware, provision the agent onto your network, and send your first wake command.

1 Download the Android App

The WakeLink Android app is the primary first-party client for sending wake commands. It requires Android 7.0 (API 24) or higher.
  1. Visit the Downloads page
  2. Tap Download APK on your Android agent
  3. Open the downloaded wakelink.apk
  4. Allow installation from unknown sources if Android prompts you
  5. Tap Install
Go to Downloads

2 Create a WakeLink Account

  1. Open the WakeLink app or visit the registration page in your browser
  2. Create an account with your email address and password
  3. Sign in and keep the dashboard open for the next steps
Create Account

3 Register an Agent and Collect Provisioning Values

The ESP32 agent needs your relay connection details before it can come online.
  1. Open the WakeLink dashboard
  2. Navigate to Agents → Register New Agent
  3. Create an agent entry such as "ESP32 Living Room"
  4. Click Export Config and keep the downloaded values nearby
  5. Keep the per-agent relay token (wla_…, api_agent_token) returned during agent creation available for provisioning
relay_url:   wss://wakelink-project.org/wss
agent_id:    esp32-living-room
agent_token: your-ewsp-secret
Note
Security: Treat the exported token values like passwords. Do not commit them to source control or share them publicly.

4 Flash the ESP32 Firmware

Download wakelink-esp32.bin from the Downloads page, connect the board over USB, then flash it with esptool: 
pip install esptool

# Linux / macOS
esptool.py --chip esp32 --port /dev/ttyUSB0 --baud 460800 \
  write_flash 0x0 wakelink-esp32.bin

# Windows (adjust COM port number)
esptool.py --chip esp32 --port COM3 --baud 460800 \
  write_flash 0x0 wakelink-esp32.bin
Note
Port not found? On Linux, check ls /dev/ttyUSB*. On Windows, open agent Manager under Ports (COM & LPT). Many boards use the CP2102 driver or CH340 driver.

5 Configure Wi-Fi and Relay Credentials

After flashing, the agent starts its provisioning hotspot.
  1. Connect to the Wi-Fi network named WakeLink-Setup
  2. Use the AP password shown on the serial console on first boot
  3. Open http://192.168.4.1 in a browser, or use the Android setup wizard
  4. Fill in the provisioning form with your Wi-Fi settings and relay credentials
  5. Click Save & Connect
WiFi SSID:      YourNetworkName
WiFi Password:  YourNetworkPassword
Server Host:    wakelink-project.org
Server Port:    443
Use TLS:        enabled
Agent ID:       esp32-living-room
Agent Token:    your-ewsp-secret
API Token:      wla_your_device_relay_token
The LED blinks slowly while the AP is active, then turns solid once the agent is connected to Wi-Fi and the relay.

6 Add the Computer You Want to Wake

Now register the target computer in the dashboard.
  1. Find its MAC address
  2. Open the WakeLink dashboard
  3. Click Add agent
  4. Enter a friendly name and the MAC address
  5. Select the ESP32 agent you just provisioned
  6. Save the agent entry
# Windows
ipconfig /all

# Linux
ip link show

# macOS
ifconfig en0 | grep ether

7 Send Your First Wake Command

  1. Power off the target computer completely
  2. Open the WakeLink Android app
  3. Sign in with your account
  4. Tap Wake next to the agent you added
  5. Wait a few seconds for the computer to power on
Wake requests are created by the client and sealed with EWSP before they cross the relay.
Note
Wake-on-LAN must be enabled in BIOS/UEFI and in the operating system's network adapter settings. Look for labels such as Wake on LAN, Power On By PCI-E, or Resume By PCI-E.

Next Steps

Continue reading