a
aREST
Devices

Device Registration

Add new devices to your aREST account.

Adding a New Device

To register a new device from the dashboard:

  1. Go to Devices in the sidebar
  2. Click the Add Device button
  3. Fill in the device details (see below)
  4. Click Register
  5. Copy your credentials

Device Details

Device Name

A friendly name for your device. Use something descriptive like "Living Room Thermostat" or "Garden Sensors".

Device ID

A unique identifier for your device. Use lowercase letters, numbers, and underscores. Example: "living_room_01".

Hardware Type

Select your board: ESP32, ESP8266, Arduino (with WiFi/Ethernet shield), or Raspberry Pi.

Description (Optional)

Add notes about the device's purpose, location, or connected sensors.

Your Credentials

After registration, you'll receive credentials to configure your device:

Device ID

The unique ID you entered. Used to identify your device in the cloud.

API Key

A secret key that authenticates your device. Keep this secure!

MQTT Broker

The server address your device connects to: mqtt.arest.io on port 1883.

Important: The API Key is only shown once! Copy it immediately and store it securely. If you lose it, you'll need to regenerate a new one.

Configuring Your Device

After getting your credentials, update your device's firmware:

  1. Open the aREST cloud example sketch in Arduino IDE
  2. Enter your WiFi network name and password
  3. Enter your Device ID from the dashboard
  4. Enter your API Key from the dashboard
  5. Upload the sketch to your device
  6. Check Serial Monitor for "Connected to MQTT" message

Once connected, your device will appear as "Online" in the dashboard within a few seconds.

Managing API Keys

If you need to regenerate an API key:

  1. Go to the device's settings page
  2. Click Regenerate API Key
  3. Confirm the action
  4. Copy the new key and update your device firmware

Warning: Regenerating the API key will immediately disconnect your device. You'll need to re-flash it with the new key.

Troubleshooting

Device won't connect

  • Double-check WiFi credentials
  • Verify Device ID matches exactly (case-sensitive)
  • Make sure the API Key has no extra spaces
  • Check that port 1883 isn't blocked by your network

Device shows offline after working

  • Check if the device lost power
  • Verify WiFi network is still available
  • Try resetting the device