Skip to main content

Device Registration Guide

ToFollow getthis 4-step process to register and activate new devices on your deviceAtra upRMS and running, follow these simple steps.platform.

Prerequisites Checklist

 Before starting registration:

 ✅ You have the device's Serial ID
 ✅ You have "Devices Register" permission in your role
 ✅ Target organization exists (create it first if needed)

1.Step 1: Locate Your Device's Serial ID 🆔

You'llThe needSerial ID is a unique 16-character identifier required for registration.

embedded-image-vPVAJOQK.png

embedded-image-A3kdFGfG.png

Finding the Serial ID to register your device. You can find it in one of two locations:ID:

Option

A: On the Box

  • On the Box:

    Look for a white sticker on the device'sdevice packaging

    box.

  • Format: xxxx-xxxx-xxxx-xxxx

  • Example: 1A2B-3C4D-5E6F-7G8H

Option

B:

obraz.pngOn the Device

  • On the Device:

    Check for a white sticker on the back or underside of thedevice

    device
    • itself.

  • Same format as above

🔍 Serial ID Format:

  • obraz.pngExactly 16 characters

  • Four groups of 4 characters

  • Separated by hyphens

  • Mix of numbers and letters

⚠️

Common Mistakes:

  • 📝Don't confuse Serial ID Format:with TheMAC IDAddress

    will
    • be
  • in

    Don't theinclude format:extra xxxx-xxxx-xxxx-xxxx.spaces

  • Ensure all characters are correctly transcribed (0 vs O, 1 vs I)

Step

2.2: StartNavigate theto Registration ProcessPage

  1. NavigateClick to"Devices" in the Devicesleft page.sidebar menu

  2. Click the "Register"REGISTER" button.button This(teal, willtop-left takecorner)

    you
    3. to
  3. the

    "Register Device" page.page loads

obraz.png


3.Step Fill3: Out theComplete Registration Form

Completeembedded-image-FEcAVRXL.png

the

Fill out all required fieldsfields:

on
Name theof Device Registration(Required)
form:

Input Rules:

  • Length: 3-40 characters

  • Allowed: Letters, numbers, spaces, periods (.), underscores (_), hyphens (-)

  • Not allowed at start/end: Period (.), underscore (_), hyphen (-)

  • No consecutive special characters: Avoid device..name or device--name

Examples:

  • ✅ Factory_Gateway_01

  • ✅ Warehouse-Floor-2

  • ✅ Office.Main.Router

  • ❌ _Gateway01 (starts with underscore)

  • ❌ Device..Name (consecutive periods)

💡 Best Practice: Use descriptive names that indicate location or function (e.g., "Mumbai_Plant_A_Gateway" rather than "Device123").

obraz.png

Serial ID (Required)

Input Rules:

  • Format: Exactly xxxx-xxxx-xxxx-xxxx

  • Case: Usually uppercase, but system accepts both

  • Validation: System checks if Serial ID is valid and not already registered

What Happens:

  • ✅ Valid + Unused: Registration proceeds

  • ❌ Invalid Format: Error message appears

  • ❌ Already Registered: "Device already registered" error

Select Organization (Required)

Dropdown Options:

  • Your current organization

  • All child organizations under your management

⚠️ Important Notes:

Creating Child Organizations:

  • If target child org doesn't exist yet, you must create it first

  • Go to: Organizations → Create button

  • Then return to device registration

Organization Hierarchy:

  • Device will belong to selected organization only

  • Parent orgs can view child org devices

  • Child orgs cannot view parent org devices

Description (Optional)

Input Rules:

  • Length: 0-1000 characters

  • Purpose: Additional notes about device

Example Use Cases:

  • Physical location details: "2nd Floor, Server Room B, Rack 5"

  • Network information: "Connected to Switch-A, Port 12"

  • Maintenance notes: "Installed June 2025, Warranty until June 2027"

  • Contact information: "Site supervisor: John Doe, +91-9876543210"

Form Actions

Button

Color

Action

FieldREGISTER

RequirementTeal

GuidanceSubmit form and register device

Name of DeviceRESET

MandatoryTeal outline

ChooseClear aall nameform you'll easily recognize (e.g., "Living Room Sensor" or "Main Gateway").fields

Serial IDCLOSE

MandatoryRed outline

EnterCancel theand IDreturn youto locatedDevice in Step 1.

Select Organization

Mandatory

Select your primary organization. For a child organization, you must first create it in the Organization section before continuing here.

Description

Optional

Add any helpful notes, like the device's location or purpose.List

Once finished, click the "Register" button.


4.Step 4: Power On & Go Online 🟢Activate

After registrationsuccessful isregistration, complete,the youdevice willmust beestablish automaticallyits redirectedfirst connection to thecome Device List.online.

Scenario A: First-Time Setup (Device Never Powered On)

  1. InImmediately theAfter Registration:

  • Device appears in Device List, your device will initially show as "Disconnected".List

  • Now,Status switchshows: on"Offline" the physical device.

  • AfterPower a short moment,On the statusPhysical willDevice:

    change

  • Connect power supply

  • Provide internet to gateway

  • Wait 90-120 seconds for boot sequence

  • Automatic Connection:

  • Device establishes connection to Atra RMS

  • Status changes to: "Online"

    (with
    • a
  • green

    Example: color"Online - 2 minutes ago"

Typical Boot Time: 90-120 seconds depending on model and anetwork greenspeed.

dot

showing

Scenario B: Device Was Already Running

If the lastdevice was powered on before registration:

⚠️ Critical Step: You must restart the device to complete registration.

Restart Methods:

Method 1: Power Cycle

  1. Unplug power cable

  2. Wait 10 seconds

  3. Reconnect power cable

  4. Wait 90-120 seconds for connection time, e.g., "x time ago").

Method

2: Reboot Command (if accessible)

  1. 💡 Already On? If yourAccess device admin interface

  2. Execute reboot command

  3. Wait for restart completion

Troubleshooting: Device Stays Offline

If device remains "Offline" after several minutes:

Quick Fix - Manual Refresh:

  1. Navigate to Device Detail Page (click device name)

  2. Click Refresh button (circular arrow, top-right of tab header)

  3. Status updates immediately

If Still Offline - Check Common Issues:

❌ Power Supply

  • Verify power cable is connected

  • Check power LED indicator on device

  • Try different power outlet

❌ Network Connection

  • Ethernet: Verify cable is connected, check link lights on port

  • Cellular: Verify SIM card is inserted correctly and active

❌ Serial ID Issues

  • Verify Serial ID was alreadyentered runningcorrectly beforeduring youregistration

  • Check for typos (0 vs O, 1 vs I, etc.)

  • Confirm device hasn't been registered it, you must restart it now to completedifferent the connection.organization


Still Having Issues?

  • See Comprehensive Troubleshooting Offlinesection

    Status
    If
    • you
  • are

    Contact onAtreyo thefor DeviceSupport

    Details
    • page
and

the
device

is still showing as Offline after powering it on, simply click the refresh button located on the right end of the tab header.

Back to top