Generate Thing Definitions

If you do not find the thing definitions that you need in the Device Cloud Management Portal, generate them yourself.

You need to know the organization into which you want to create the definitions. Your current organization appears in the upper-right corner of the Management Portal. If you are not sure what organizations you belong to, select Tools in the upper-right corner. If the Switch organization entry appears in the menu, select it to see your other organizations. If the entry does not appear, you are only a member in your current organization.

Device Cloud Tools Menu Switch Organization

You need organization administrator privileges to create the definitions. If the Administration entry appears in the Tools menu, you have organization administrator privileges for the organization. If you do not have organization administrator privileges, contact your administrator for help.

  • Check if the thing definitions that you need already exist. If they do, you do not need to perform this procedure. See Look Up Application Tokens.

  • You have Python installed.

  • You have administrator privileges for the organization to which you want to add the definitions.

  • You have access to the code that was downloaded from https://github.com/deviceWISE/device-cloud-lib/tree/vxworks_layer and extracted it to a temporary directory as part of the VxWorks configuration process. The setup-cloud-deps.py script is provided with this download.

  1. If you are not already logged on to Device Cloud, do so.

    Use the URL, user name, and password that you were given when you received your Device Cloud account.

  2. Click Developer.
  3. From the Endpoints section, get the domain name used for the device connection.

    Copy the domain name to a temporary file. Do not copy the entire URL (with the protocol identifier or any sub-directory or port number). For example, use api.devicecloud.windriver.com. Do not use http://api.devicecloud.windriver.com/api.

  4. Open a shell window, and change directory to myTmpDir/device-cloud-lib-vxworks_layer/share/admin-tools.

    Where myTmpDir is the one into which you extracted the download from https://github.com/deviceWISE/device-cloud-lib/tree/vxworks_layer.

  5. Start the setup-cloud-deps.py script.
  6. When prompted, enter the required information.

    • the Device Cloud endpoint that you copied from the Developer page

    • your user name

    • your password

    • an organization name

    For example:

    $ ./setup-cloud-deps.py

Cloud Address: api.devicecloud.windriver.com
Username: xeno@nadanichtsrienzip.com
Password:
Org Key(Optional): orgkey1

    The application and thing definition for the device manager and the sample applications are defined in Device Cloud.