DeviceProps

Properties for defining a Device.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-iot-device

Initializer

import { DeviceProps } from '@alicloud/ros-cdk-iot'
const deviceProps: DeviceProps = { ... }

Properties

productKey^Required

public readonly productKey: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property productKey: The identifier of the product to which the device to be registered belongs.

devEui^Optional

public readonly devEui: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property devEui: The DevEUI of the LoRaWAN device.

This parameter is required when you create a LoRaWAN device.

deviceName^Optional

public readonly deviceName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property deviceName: The DeviceName of the device.

The name must be 4 to 32 characters in length, and can contain letters, digits, hyphens (-), underscores (_), at signs (@), periods (.), and colons (:). You can use a combination of the DeviceName and ProductKey parameters to identify a device.

If you do not specify this parameter, IoT Platform randomly generates a DeviceName.

iotInstanceId^Optional

public readonly iotInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property iotInstanceId: The ID of the instance.

You can view the instance ID on the Overview page in the IoT Platform console.

• If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
• If your instance has no Overview page or ID, you do not need to set this parameter.

nickname^Optional

public readonly nickname: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property nickname: The alias of the device.

The alias must be 4 to 64 characters in length, and can contain letters, digits, and underscores (_).

If you do not specify this parameter, IoT Platform does not generate an alias for the device.

pinCode^Optional

public readonly pinCode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property pinCode: The PIN code of the LoRaWAN device.

This parameter is used to verify the DevEUI. When you create a LoRaWAN device, set LoraNodeType to CUSTOMDEFINED. This parameter is required.