Skip to content

DeviceProps

Properties for defining a Device.

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

Initializer

import com.aliyun.ros.cdk.iot.DeviceProps;
DeviceProps.builder()
    .productKey(java.lang.String)
    .productKey(IResolvable)
//  .devEui(java.lang.String)
//  .devEui(IResolvable)
//  .deviceName(java.lang.String)
//  .deviceName(IResolvable)
//  .iotInstanceId(java.lang.String)
//  .iotInstanceId(IResolvable)
//  .nickname(java.lang.String)
//  .nickname(IResolvable)
//  .pinCode(java.lang.String)
//  .pinCode(IResolvable)
    .build();

Properties

Name Type Description
productKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property productKey: The identifier of the product to which the device to be registered belongs.
devEui java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property devEui: The DevEUI of the LoRaWAN device.
deviceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property deviceName: The DeviceName of the device.
iotInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property iotInstanceId: The ID of the instance.
nickname java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property nickname: The alias of the device.
pinCode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property pinCode: The PIN code of the LoRaWAN device.

productKeyRequired

public java.lang.Object getProductKey();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


devEuiOptional

public java.lang.Object getDevEui();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property devEui: The DevEUI of the LoRaWAN device.

This parameter is required when you create a LoRaWAN device.


deviceNameOptional

public java.lang.Object getDeviceName();
  • Type: java.lang.String OR com.aliyun.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.


iotInstanceIdOptional

public java.lang.Object getIotInstanceId();
  • Type: java.lang.String OR com.aliyun.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

public java.lang.Object getNickname();
  • Type: java.lang.String OR com.aliyun.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.


pinCodeOptional

public java.lang.Object getPinCode();
  • Type: java.lang.String OR com.aliyun.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.