DeviceProps
Properties for defining a Device.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-iot-device
Initializer
import ros_cdk_iot
ros_cdk_iot.DeviceProps(
product_key: typing.Union[str, IResolvable],
dev_eui: typing.Union[str, IResolvable] = None,
device_name: typing.Union[str, IResolvable] = None,
iot_instance_id: typing.Union[str, IResolvable] = None,
nickname: typing.Union[str, IResolvable] = None,
pin_code: typing.Union[str, IResolvable] = None
)
Properties
| Name | Type | Description |
|---|---|---|
product_key | typing.Union[str, ros_cdk_core.IResolvable] | Property productKey: The identifier of the product to which the device to be registered belongs. |
dev_eui | typing.Union[str, ros_cdk_core.IResolvable] | Property devEui: The DevEUI of the LoRaWAN device. |
device_name | typing.Union[str, ros_cdk_core.IResolvable] | Property deviceName: The DeviceName of the device. |
iot_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Property iotInstanceId: The ID of the instance. |
nickname | typing.Union[str, ros_cdk_core.IResolvable] | Property nickname: The alias of the device. |
pin_code | typing.Union[str, ros_cdk_core.IResolvable] | Property pinCode: The PIN code of the LoRaWAN device. |
product_keyRequired
product_key: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property productKey: The identifier of the product to which the device to be registered belongs.
dev_euiOptional
dev_eui: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property devEui: The DevEUI of the LoRaWAN device.
This parameter is required when you create a LoRaWAN device.
device_nameOptional
device_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.
iot_instance_idOptional
iot_instance_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.
nicknameOptional
nickname: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.
pin_codeOptional
pin_code: typing.Union[str, IResolvable]
- Type: typing.Union[str, 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.