Getting Started

Quickstart

Get your first device online and controllable from the dashboard in under 10 minutes.

Step 1: Create Your Account

Head to dashboard.arest.io and sign up for a free account. You'll get access to:

  • Up to 3 devices on the free plan
  • Real-time device monitoring
  • Custom dashboards with widgets
  • 7 days of event history

Step 2: Register Your Device

Once logged in, add your first device:

  1. Click Devices in the sidebar
  2. Click the Add Device button
  3. Enter a name for your device (e.g., "Living Room Sensor")
  4. Select your hardware type (ESP32, ESP8266, Arduino, or Raspberry Pi)
  5. Click Register

Important: Copy your Device ID and API Key - you'll need these for the next step. The API key is only shown once!

Step 3: Set Up Your Hardware

Flash your device with the aREST firmware:

Install the Library

In Arduino IDE: Sketch → Include Library → Manage Libraries → Search "aREST" → Install

Open the Example Sketch

Go to File → Examples → aREST → ESP32_cloud (or ESP8266_cloud for ESP8266)

Enter Your Credentials

Update the sketch with your WiFi credentials, Device ID, and API Key from step 2

Upload

Connect your device via USB and click Upload. Open Serial Monitor to see the connection status.

Step 4: Control from the Dashboard

Once your device connects, it will appear as "Online" in the dashboard. Click on it to:

Toggle Pins

Use the pin controls to turn LEDs on/off or trigger relays.

Read Sensors

View real-time values from analog sensors and variables.

Call Functions

Execute custom functions you've defined in your sketch.

View History

See past commands and sensor readings in the event log.

Troubleshooting

Device stays offline?

  • Check your WiFi credentials in the sketch
  • Verify the Device ID and API Key are correct
  • Open Serial Monitor to see error messages
  • Make sure your network allows MQTT (port 1883)

Can't find the library?

Make sure you also install the PubSubClient library for MQTT support.

What's Next?