Register WEDA Node

Connect a physical edge device running WEDA Node to the intended organization in WEDA Cloud. Registration creates or links the Cloud record; activation and connection then take place on the edge device.

Prepare Device Information

Before starting, confirm:

• Organization access: You can access the intended Org and have permission to register devices there.
• Device access: You have terminal access with root or sudo privileges.
• Network access: The device can reach the intended WEDA Cloud environment and the image sources required during setup.
• Activator: WEDA Node Activator is available on the device. If it is not installed, see WEDA Node Activator Installer.
• API access, if used: You have a user access token and the target orgId.

1. Launch WEDA Node Activator from its shortcut or run:

   sudo /opt/Advantech/dmagent/weda-node-activator/bin/weda-node-activator

2. Copy the Device ID (labelled Device) and Model from the footer. Keep the Activator available while you register the device.

3. Choose a device name that identifies its purpose or location.

The footer shows Device: cc827fdd1713 and Model: ARK-2252 in this example. Copy the values shown on your own device.

Note: Validate identity and name before registration

Field	v1.2.0 requirement	Example
Device ID (deviceId)	Exactly 12 lowercase English letters or digits. Copy the Activator value without adding separators.	aa1122334455
Model (hwModel)	1-64 characters: uppercase English letters, digits and hyphens. Copy the Activator value.	EPC-R7300
Device name (deviceName)	1-128 characters: English letters, digits, hyphens and underscores.	FactoryA_Edge01

Device names must be unique within the Org, ignoring letter case. WEDA Nodes and Custom Devices share that name scope. Spaces, non-English characters and periods are not accepted in the name. These identity-format rules apply to WEDA Node registration, not to SubNode or Custom Device IDs.

Check the result: You have the actual Device ID and Model from the Activator, a valid device name, and the intended Org. The values above are examples; replace them with your device's information.

Register Your Device

Choose either WEDA Console or the API to register the device. Complete this step before starting WEDA Node setup.

In WEDA Console:

1. Select the target organization in the top bar, then open Devices.
2. Check whether the device is already listed. If it is, inspect that record before attempting another registration.

Confirm the selected organization, then select Add in Devices.

3. Select Add.

Use the values from your own Activator, rather than the sample illustration built into this form.

4. Enter the device details:
   • Device ID: The value copied from the Activator.
   • Model: The model copied from the same Activator.
   • Device name: The Console generates a name from Model and Device ID, joined by a hyphen, for example ARK-2252-cc827fdd1713. Keep it or edit it, following the naming rules above.

The Console suggests ARK-2252-cc827fdd1713 from the model and Device ID. You can edit this name before submitting.

5. Select Submit, then Add in the confirmation dialog.

Select Add to confirm device registration.

6. Confirm that the device appears under the intended Org.

The device record is Registered. Activation and a live connection are separate checks.

Check the result: The device record is listed under the intended Org. A new WEDA Node that has not connected can remain Registered. Creating the record alone does not start the service on the physical device.

Note: Allow time for activation

If WEDA Node is already running and can reach WEDA Cloud, allow a few seconds after registration for the status to change from Registered to Activated, then refresh the Devices list. If WEDA Node has not been configured and started, complete the activation steps below first.

Using the API:

The examples use https://weda.example.com/central/weda as the WEDA base URL. Replace the origin and tenant path with your environment, and replace the example identity with the Activator values.

POST https://weda.example.com/central/weda/api/v1/orgs/{orgId}/devices
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "deviceId": "aa1122334455",
  "hwModel": "EPC-R7300",
  "deviceName": "FactoryA_Edge01"
}

For this WEDA Node path, supply deviceId and hwModel. The API allows deviceName to be omitted for a WEDA Node; this example supplies it explicitly. Omitting deviceId selects Custom Device creation, which is a different integration path.

Check the result: The API returns 201 Created. Query the Org device list with deviceIds={deviceId} and confirm its identity, name and Registered status. The single-device endpoint returns 404 until the WEDA Node is activated. If you use Postman, set the device identifier yourself from the Activator and check the selected Org and device before subsequent requests.

See Register a Device to an Organization for the complete request and response.

Activate WEDA Node

Return to the Activator on the physical device. Select Setup WEDA Node, review and accept the license, then choose the credential source appropriate for your deployment.

Credential source	When to use it
Register & Connect device to WEDA site	The standard path for a supported Advantech device connecting to the public WEDA Cloud.
Use Local Credential File	Your deployment uses a credential file prepared in advance for the device or environment.

For the optional local-file path, follow Appendix: Register by Local Credential File.

Standard Public Cloud Path

1. Select Register & Connect device to WEDA site.

2. In Review and Confirm, check the automatically detected model and setup configuration. The model is read-only in this summary.

3. Press Enter to begin setup. Wait for image downloads, service startup and connection verification to finish.

4. Check Service Status Overview, which opens after successful setup:

   • Provision State: Activated
   • Connection: Connected
   • Service Status: Running

Check the result: The Activator reports that WEDA Node is activated, connected and running. If setup fails or any status differs, use the troubleshooting checks below.

Note: Keep setup running

Keep the terminal open while setup is in progress. Do not interrupt it with Ctrl+C. If WEDA Node is already installed and running, use Manage WEDA Node to inspect its status before attempting setup again.

Appendix: Register by Local Credential File

Use this optional path when a credential file has been prepared for the registered device and WEDA environment you intend to connect to.

1. After registering the device, obtain its encrypted credential file through Get WEDA Node Connection Credentials, using your authorized user access token.
   • deviceId: Use the registered device's ID.
   • type: Select the service type required by your deployment. The API documents MQTT and NATS; confirm the appropriate value with your WEDA support team.
   • enc: Set to true for encrypted output and save the downloaded credential file as a .bin file.
2. Transfer that file to the edge device.

Choose the authentication method that matches the prepared file:

Authentication method	File to use
Auto Provision (Recommended)	A provisioning key supplied for your WEDA deployment.
Device Credentials Setup (Advanced)	The device-specific credential file (.bin) downloaded above.

The screenshot below shows these choices under Manage WEDA Node > Update Authentication Credentials for an installed Node. During first-time setup, Use Local Credential File opens Authentication Configuration instead.

Update Authentication Credentials on an installed Node. Match the authentication method to the file prepared for your device or deployment.

3. For first-time setup, select Use Local Credential File in the Activator's Credential Source.

4. In Authentication Configuration, select Device Credentials Setup (Advanced) for the downloaded device credential. Use Auto Provision (Recommended) only when you have the provisioning key for that deployment; the two file types are not interchangeable.

5. Select the .bin file in the file picker and press Enter. Press n after selection to continue to Review and Confirm.

6. Review the setup, start it, and check the same Provision State, Connection and Service Status results as in the standard path.

Check the result: WEDA Node is activated and connected to the intended WEDA Cloud environment. Downloading the file alone does not activate the device. A local file supplies credentials; the device still needs network connectivity to its configured WEDA environment.

Caution: Protect the credential file

Treat the .bin file as a credential. Keep it out of source control, screenshots and shared documentation, and transfer it only to the intended device or authorized administrator.

Verify Activation and Connectivity

Check the edge device and its Cloud record separately.

On the device: Open Manage WEDA Node and confirm Provision State: Activated, Connection: Connected and Service Status: Running. These are the Activator's local status indicators.

For the same demo device, the Activator reports Activated, Connected and Running.

In WEDA Console:

1. Return to Devices under the intended Org.
2. Allow a few seconds for the status to update, then refresh the list. Find the same Device ID and confirm its lifecycle status is Activated.

After WEDA Node activates and connects, refresh the list to check the same device record.

3. Open the device's Telemetry tab and inspect the latest received values and timestamps, if telemetry is configured for the device.

Inspect the latest Value and Last updated timestamp for the expected sensor. This WEDA Node example includes CPU and memory telemetry.

Using the API:

Check	Request
The registered record and lifecycle status	Get Device in Organization: GET /api/v1/orgs/{orgId}/devices/{deviceId}. Returns 404 if the WEDA Node is still Registered; use the list query below.
Heartbeat connectivity for this device	List Devices in an Organization: GET /api/v1/orgs/{orgId}/devices?deviceIds={deviceId}

Prefix the paths with your WEDA base URL and send your user access token. In the Org-list result, inspect the matching deviceId, confirm type: WedaNode and status: Activated, then check connectivity.state and connectivity.updatedAt.

• Lifecycle: Activated confirms activation, not a current heartbeat.
• Heartbeat: Connected indicates the connectivity result at query time. The timestamp is the server receipt time of the latest accepted heartbeat after activation.
• Received data: Recent telemetry values and timestamps confirm that the configured data is arriving. An active connection alone does not prove that each expected sensor is reporting.

Note: Activator and Cloud connectivity are different checks

The Activator's Connection indicator is a local check on the device. In WEDA Console, the Connectivity label shows Connected when the device has reported DataStream values within the latest-value retention window (60 minutes by default). It is not the heartbeat result, so it can read Connected for a Deactivated device that reported data recently. Use the API's connectivity field for the heartbeat-based state, including Abnormal and Unknown. A newly activated device without a qualifying heartbeat can read Disconnected with updatedAt: null.

Check the result: The device is in the correct Org, its lifecycle is Activated, the Activator reports a live connection, and the API heartbeat or received-data checks provide the evidence needed for your next operation.

Troubleshooting

What you see	What to check next
Registration returns 400	Compare the submitted Device ID and Model with the Activator. Validate all supplied field formats, including spaces in the device name.
Registration returns 409	Either the Device ID is already registered, or the device name is already used in this Org. For a name conflict, check WEDA Nodes and Custom Devices in the same Org; names that differ only by letter case still conflict. For a Device ID conflict, inspect the existing record before retrying.
The device is missing or a request is denied	Check your selected Org, orgId, user token and membership. A device belongs to one Org at a time.
The Cloud record remains Registered, or the Activator reports Activation Failed	Confirm registration completed for the same Device ID and Model. Check the credential source and intended WEDA environment before retrying setup.
The local-file setup fails	Confirm the file belongs to the intended device or deployment and that its authentication method matches the file type. Ask your WEDA support team to confirm the required service type or replace the file if needed.
Service Status is Degraded or Stopped	Inspect the Activator's service status. When Degraded, press ? for its troubleshooting panel. Collect relevant service logs before contacting support.
The Activator reports Disconnected	Check that WEDA Node is running and can reach its configured WEDA Cloud environment. Registration alone does not establish a connection.
The API heartbeat is not Connected	Check the Node service and network, then query again. An Activated record alone does not establish connectivity; no accepted heartbeat after activation gives a null timestamp.
No telemetry arrives	Confirm the connection, then check the expected sensors and their reporting configuration. Compare the latest received timestamps.

When contacting support, include the WEDA environment, Org ID, Device ID, relevant status values, timestamps and error message. Exclude access tokens and credential-file contents.