Device Management

Register and manage WEDA Nodes, SubNodes, and Custom Devices. Start by registering a device to an organization. Then list and rename devices, change their status, download WEDA Node connection credentials, read capabilities, configure telemetry, and store custom info.

📄️Register a device to an organization

Link one existed weda node device to one organization. Or create a weda node device which is associated with the organization.

📄️List devices in an organization

This api will response paginated list of devices belonging to a specific organization ID.

📄️Get a device in an organization

Get a single Weda Node or Custom Device belonging to a specific organization ID. A SubNode, or a WEDA Node that is still Registered, returns 404.

📄️Rename a device in an organization

Update the deviceName of a Weda Node or Custom Device belonging to a specific organization ID. deviceId, hwModel, and orgId are immutable and must not be included in the request body. A SubNode returns 404.

📄️List devices

Get kinds of devices. Including WEDA Node, subnodes, and Custom devices.

📄️Rename a device

Update device by given deviceId. Applies to WEDA Node and Custom Device. A SubNode returns 404.

📄️Delete a device

Permanently delete device by given deviceId.

📄️Deactivate or reactivate a device

Deactivate or reactivate a device.

📄️Get WEDA Node connection credentials

Get auth info of a device with downloadable encrypted file. Give the encrypted file to WEDA Node as is and import it there; you do not need to decrypt it. Applies to WEDA Node and Custom Device. A SubNode returns 400 (Device.InvalidType).

📄️Get device hardware capabilities

Retrieve the full hardware capability report of the specified device, including CPU, memory, disk, network interfaces, sensors, containers, and subnodes.

📄️List supported sensors

List the sensors the target device supports, with each sensor's name and the dtmi of its type. To read a sensor's settings definition, call GET capabilities/schema with type=configs and match the dtmi against an entry's @id. Only the device's own sensors are listed. A device without sensors of its own returns an empty list.

📄️Get sensor and command definitions

Get the DTDL Interfaces for one category of configuration types. Applies to WEDA Node and SubNode whose agent provides a capability model (agent SDK version 1.2 or later); otherwise 422. A Custom Device returns 404.

📄️Get device telemetry settings

Get telemetry configurations for a specific device. Applies to WEDA Node and SubNode. A Custom Device returns 404.

📄️Update device telemetry settings

Partially update telemetry configurations for a specific device. Applies to WEDA Node and SubNode. A Custom Device returns 404. Requires the admin role, and a WEDA Node must have finished onboarding; otherwise 403.

📄️Clear requested telemetry settings

Clear the device's requested telemetry settings. A 202 response confirms that the clear request was sent. The device firmware determines whether factory defaults are restored. After the reset, GET telemetry-configs returns the device-reported settings.