Register and Activate Devices in Oracle Internet of Things Cloud Service

To associate device sensors with your assets, make sure that the devices are registered and activated in Oracle Internet of Things Intelligent Applications Cloud.

The Oracle IoT Asset Monitoring Cloud Service application relies on your platform side Oracle Internet of Things Intelligent Applications Cloud for its devices. If you do not already have your sensor devices set up in Oracle Internet of Things Intelligent Applications Cloud, you need to register and activate these devices.

Register a Single Device

To communicate with Oracle Internet of Things Cloud Service, every device that is connected to Oracle Internet of Things Cloud Service must be registered and then activated. All devices are registered as a Directly Connected Device (DCD). During activation, the device indicates support for indirect enrollment. A device indicating indirect enrollment capability is automatically changed from DCD to gateway.

  1. Click the Menu (Menu icon) icon adjacent to the Oracle Internet of Things Cloud Service title on the Management Console.
  2. Click Devices.
  3. Click Registration.
  4. Click Register Single Device.
  5. Complete the optional and mandatory fields.

    Note:

    If you leave the Activation Secret field blank, a value is auto-generated and displayed when the device registration is confirmed. You can enter your own Activation Secret value. Any additional information, such as Name, Description, and Metadata are optional, but can be useful as search criteria when managing your registered devices.
  6. Click Register.
  7. Enter a password in the File Protection Password field to encrypt the provisioning file that contains the configuration and credentials to activate your device.
  8. Enter the password again in the Confirm Password field.
  9. Download the provisioning file:
    1. Click Download Provisioning File.
    2. Click Save File.
    3. Click OK.
    4. Browse to a location to save the provisioning file.
    5. Click Save.
  10. Click Finish.

Register a Batch of Devices

Registering a batch of devices reduces the time required to register multiple devices. You create a comma-separated values (CSV) file to define the settings for each device. You upload the CSV file to Oracle Internet of Things Intelligent Applications Cloud.

To view the information that you should include in the CSV file, see About CSV Batch Registration File Properties.
  1. Click the Menu (Menu icon) icon adjacent to the Oracle Internet of Things Intelligent Applications Cloud title on the Management Console.
  2. Click Devices.
  3. Click Registration.
  4. Select one of these options:
    • Click Download CSV template to download a CSV template that you can complete.

      Note:

      The CSV file contains the mandatory and optional property values for each device. If a value is not provided for the optional properties, insert a comma to indicate that a value is not provided. In the last line of the sample CSV file, a comma indicates that property values are not provided for ActivationId and Activation Secret
    • Click Batch Registration to upload an existing CSV file.
  5. Click Browse and browse to the CSV file that contains the registration information for the devices you are registering.
  6. Click Next when the CSV registration file is successfully uploaded.
    If the Review page contains a warning (A yellow triangle with an exclamation point. This icon is used if there is at least one device in the CSV file that is already registered) icon, select one of these options:
    • Update - Choose this option if you want to update the information for an existing registered device. The registered device has the same manufacturer, model and serial number as one of the devices listed in the CSV registration file.
    • Ignore - Choose this option if you do not want to include the device in the current registration process.
  7. Click one of these options:
    • Next: Click to proceed to register the items in the CSV registration file that have been identified as being viable candidates for registration.

    • Cancel: Click to discontinue the batch registration process.

  8. Enter a password in the File Protection Password field to encrypt the provisioning file that contains the configuration and credentials to activate your device.
  9. Enter the password again in the Confirm Password field.
  10. Download the provisioning file:
    1. Click Download Provisioning File.
    2. Click Save File.
    3. Click OK.
    4. Browse to a location to save the provisioning file.
    5. Click Save.
  11. Click Finish.
  12. Activate the registered devices to begin a secure communication between the devices and Oracle Internet of Things Intelligent Applications Cloud. See Activate a Batch of Registered Devices.

About CSV Batch Registration File Properties

The following table provides descriptions of the properties that appear in the Comma Separated Values (CSV) file used to register a batch of devices with Oracle Internet of Things Intelligent Applications Cloud. Mandatory and optional values are described in the table and are listed in the order they are expected to appear in the CSV file.

To register a batch of devices with Oracle Internet of Things Intelligent Applications Cloud, see Registering a Batch of Devices.

Property Required / Optional Description

Name

Optional

The String data type assigned to the registered device. This value can be modified after device registration.

Manufacturer

Required

The manufacturer of the device.

Model Number

Required

The model number of the device

Serial Number

Required

The serial number of the device.

Activation ID

Optional

A Device Unique Identifier (UID) that is required for device activation. If a value is not specified, an auto-generated value is assigned to the device after a successful registration. The value cannot be changed after the device is successfully registered.

Activation Secret

Optional

The Activation Secret (also known as Shared Secret) value required to activate your device. If a value is not specified, an auto-generated string value is assigned to the device after a successful registration. This value is available after a successful registration. This value can be modified before you modify your device.

Latitude

Optional

The decimal notation of the latitude of the device’s position. For example: -43.5723 [World Geodetic System 1984]. If you specify the latitude, then you must also specify the longitude.

Longitude

Optional

The decimal notation of the longitude of the device’s position. For example: , e.g. -43.5723 [World Geodetic System 1984]. If you specify the longitude, then you must also specify the latitude.

Altitude

Optional

The decimal notation of the altitude of the device’s position, in meters above sea level.

Accuracy

Optional

The accuracy of the device’s position in meters. This must be a positive number or zero. An accuracy value can only be specified if the latitude and longitude are provided.

Metadata

Optional

Key/value pairs that are listed in successive columns. There must be an even number of columns containing keys and values. If there is an odd number of columns, an error message is returned.

Activate a Device

A device can be activated after it is registered and an application has been created and run on the device. During activation, the device indicates support for indirect enrollment. A device indicating indirect enrollment capability is automatically changed from DCD to Gateway.

  1. Register your directly connected device. See Registering a Single Device.
  2. Create an application for the device using the Oracle Internet of Things Intelligent Applications Cloud Client Software Library APIs. See Developing Device Software Using the Client Software Libraries.

    When using the Java Client Library, for example, use the following steps to initialize and activate the device:

    1. Add this statement to the device application code to initialize the device:

      DirectlyConnectdDevice dcd = new DirectlyConnectedDevice(configFilePath, configFilePassword);
    2. Add this statement to the device application code to activate the device:

      if (!dcd.isActivated())
      { dcd.activate(deviceModelUrn); }
  3. Verify the device has been activated:
    1. Open the Oracle Internet of Things Intelligent Applications Cloud Management Console.
    2. Click the Menu (Menu icon) icon adjacent to the Oracle Internet of Things Cloud Service title on the Management Console.
    3. Click Devices.
    4. Click Management.
    5. Locate the device in the device table or use the Property and Value fields at the top of the table to search for a specific device.
    6. Verify Activated and not Registered is displayed in the State column.

Activate a Batch of Registered Devices

After you’ve registered a batch of devices, you need to activate the devices before they can securely communicate with Oracle Internet of Things Intelligent Applications Cloud.

  1. Register the devices and download the provisioning file. See Registering a Batch of Devices.
  2. Activate each of the registered devices. See Activate a Device.
  3. Verify that each of the registered devices has been activated.
    1. Open the Oracle Internet of Things Intelligent Applications Cloud Management Console.
    2. Click the Menu (Menu icon) icon adjacent to the Oracle Internet of Things Cloud Service title on the Management Console.
    3. Click Devices.
    4. Click Management.
    5. Locate the device in the device table or use the Property and Value fields at the top of the table to search for a specific device.
    6. Verify Activated and not Registered is displayed in the State column.