Onboard Your Device

Prerequisites

please check the Prerequisites section before starting the onboarding process.

Parameters

• deviceId: Must be a MAC address (lowercase letters and numbers only, no symbols).
• hwModel: hardware model of the device, e.g. "MIC-710", "EPC-R7300", etc.
• orgId: The organization ID where the device will be registered.
• stackConfigId: The stack configuration ID.
• stackRevisionId: The stack revision ID.

---

STEP 1. Register a Device

1.1 Follow the Sequence of API Collections: 0-WiseSso to get Access Token

The first collection is 0-WiseSso, which contains the workflow to get access token. Please make sure to run the APIs in the correct order, which means running 5 requests in sequence, and you will get the access token at the end of the workflow.

1. Externl Login 302
2. Account Login: Login with your WEDA account.
3. External Login 200
4. Signin Oidc: Get the OIDC token using the cookie from previous request.
5. WEDA Token: Get the WEDA access token using the OIDC token from previous request.

1.2 Create a New Org

Create a new organization using the following APIs.

Postman Collection: 1-Org & ClientCrend

1. Org List: Get the list of organizations. Make sure the new org name is not duplicated with existing ones.
2. Org Create: Create a new organization with a unique name.

Example Request: Curl

curl --location --request POST 'https://{domain}/{tenantPath}/weda/api/v1/orgs' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}' \
--data '{
  "name": "new_org"
}'

Example Response

{
  "name": "new_org",
  "id": "3a1d1d06-4759-cefd-af34-0705d0ca8902",
  "parentId": null
}

Other APIs in the 1-Org & ClientCrend collection:

• Org Delete: Delete an organization by its ID.
• Client-Cred Create: Create a new client credential.
• Client-Cred List: Get the list of client credentials.
• Client-Cred Delete: Delete a client credential by its ID.

Note: Client credential is required for third-party integrations. For example, Grafana data source.

1.3 Create a Device

Create a device using the following APIs, the variable Org ID will automatically be populated if you have finished the previous step 1.2.

Postman Collection: 2-Provisioning&Activation

1. Node Register: Create a new device under the organization.
2. Node Activation: Activate the device after provisioning.
3. Node List: Get the list of devices under the organization. You should see the newly created device in the list.
4. Node List Under Org: Get the list of devices under the organization.

Example Request: Curl

curl --location --request POST 'https://{domain}/{tenantPath}/weda/api/v1/orgs/devices' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}' \
--data '{
  "deviceId": "48b02d8861de",
  "hwModel": "MIC-710",
  "orgId": "3a1d40ed-4f97-aed8-c727-57704d3d5d2e"
}'

Example Response

{
  "deviceId": "48b02d8861de",
  "hwModel": "MIC-710",
  "orgId": "3a1d40ed-4f97-aed8-c727-57704d3d5d2e",
  "status": "Registered"
}

Other APIs in the 2-Provisioning&Activation collection:

• Token Refresh: Get a new access token using the refresh token.
• Node Deactivate: Deactivate a device by its ID. status: deactivate
• Node Remove: Delete a device by its ID.

---

STEP 2. Install WEDA Node

Enabling WEDA Node (First-Time Setup)

Select "Setup WEDA Node" from the main menu to run the setup wizard.

Step 1 — License Agreement

1. Scroll to read the full license (↑/↓ or Space to page down)
2. At the bottom, press Space to check acceptance: [☑]
3. Press Enter to continue

---

Step 2 — Credential Source

---

Option A — Register & Connect device to WEDA Site (default)

Best for standard Advantech devices connecting to the public WEDA Cloud.

1. Select "Register & Connect device to WEDA Site" and press Enter
2. The built-in master key bundled with the installer is used automatically
3. No login or external file required

Expected results: Device is automatically provisioned on the public WEDA platform on first service start.

---

Option C — Use Local Credential File

Best for offline deployments or pre-provisioned devices.

1. Select "Use Local Credential File" and press Enter

2. Step 6 — Select authentication method:

   Method	File	Use When
   Auto Provision	Master Key (.bin)	Mass deployment — one key provisions many devices
   Device Credentials Setup	Device Credential (.bin)	Single device with a pre-downloaded credential file

3. Press Enter to open the file picker and navigate to your .bin file:

Expected result: Credential file is copied to /opt/Advantech/dmagent/res/.

---

Step 3 — Installing

---

• Fast Network: 2-3 minutes
• Slow Network: 5-10 minutes
• Do NOT close the terminal or press Ctrl+C

Expected result: Docker images downloaded, containers started, service running.

Step 4 — Complete

Service Dashboard

Status icons:

• ● green — running / connected / registered
• ○ grey — stopped / unknown
• ✗ red — failed / disconnected

Connection box color:

• Green border — device connected to WEDA server
• Red border — REG_FAILED or container not found
• Grey border — intermediate states

The dashboard auto-refreshes every 5 seconds.

Management Actions

Action	Description
Update Authentication Credentials	Replace the master key or credential file without reinstalling
Restart Service	Stop and restart all WEDA Node Docker containers
Remove WEDA Node	Uninstall containers, volumes, and configuration (type REMOVE to confirm)

---

STEP 3. Get Device Telemetry Data

3.1 Get Latest Device Telemetry Data

Use the following APIs to get the latest telemetry snapshot from the device.

Postman Collection: 3-Telemetry

1. Data Points Historical Get: Get the historical data points of a sensor.
2. Data Points Latest Get by User Token: Get the latest data point of a sensor using user token.
3. Data Points Latest Get by Client Token: Get the latest data point of a sensor using client credential.

Note:

Subject: Data Points Historical Get: Open the tab Scripts to modify the time range. the unit is milliseconds. Here are some examples for time transformation:

• 1 second = 1 * 1000 ms
• 1 minute = 1 _ 60 _ 1000 ms
• 1 hour = 1 _ 60 _ 60 * 1000 ms

Example Request: Curl

curl --location --request GET 'https://{domain}/{tenantPath}/weda/api/v1/devices/{deviceId}/inputs/data-objects/latest' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}'

Example Response

{
  "deviceId": "ded3809a07c1",
  "time": "2026-04-08T10:31:47.7456284Z",
  "tenantId": "7892720857535df9a5ccee7954060c2a",
  "measurements": {
    "gpioIsSupported": false,
    "hwinfoMotherboard": "",
    "cpuUsage": 1.3,
    "diskRootTotal": 955208638464,
    "diskRootAvailable": 477604319232,
    "diskRootUsed": 477604319232,
    "diskRootUsagePercent": 50,
    "cpuLoad1m": 0.23,
    "cpuLoad5m": 0.08,
    "cpuLoad15m": 0.03,
    "memoryTotal": 8383709184,
    "memoryAvailable": 7459311616,
    "memoryUsed": 924397568,
    "memoryCached": 252735488
  },
  "dataTypes": [
    "boolean",
    "string",
    "double",
    "double",
    "double",
    "double",
    "double",
    "double",
    "double",
    "double",
    "double",
    "double",
    "double",
    "double"
  ]
}

Other APIs in the 3.Telemetry collection:

1. Sensor Settings Get: Get the list of sensors and their settings.
2. Sensor Settings Change: Change the settings of a sensor.

---

Congratulations! You have successfully onboarded your edge device to the WEDA platform and retrieved telemetry data. Next, you can explore how to deploy AI Containers.

---

Last updated on Apr-8, 2026 | Version 1.0.0