Every data stored on the UCW platform is saved as a project. This aids data management and interpretation. Each project consists of a device and data management. The device management handles the mechanism for uniquely identifying and monitoring end devices sending data to the platform. The data management allows the user to name and classify data stored on the server. We will demonstrate the steps to create a project on the UCW IoT platform. We will also explain the token creation and management system, as well.
Table of Contents
1.0 Create a project
To start, navigate to project management panel (Projects → Manage Projects)
To create a project, click on the Create project button located on the top right of the page.
Enter project details: The user is expected to provide the name, key, and description (optional) of the project and then click on the Create button. It should be noted that once the project key has been created, it can not be changed.
You should have a notification on your screen, indicating that the project has been successfully created. The newly created project will be listed along with existing projects, if any, as shown below:
Project actions - Browse, Edit, Remove. There are three options under the Actions header, that can be explored with the new project.
- Browse - allows the user to access the data stream, device, and token management of the project.
- Edit - button returns to the dialog box for the user to change project name and description only. The project key option is grayed out.
- Remove - button removes the project.
2.0 Managing a project
If the communication mode employed by the end-device is GSM, WiFi, or Ethernet, http is being employed to handle the connection to our server. Each connection is authenticated by our servers using tokens. The user can create a token, and assign desired attributes to it. This process is explained below
- On the project Overview page, click on Access Tokens
- Click on Create Token button on the top right corner of the page
- This pops up a dialogue box, where token Name, Scope, and intended validity/Expiration period (in milliseconds) is provided by the user
Once the token has been successfully created, your screen should display the token and any existing token like this:
tokenTokens are only valid in the project they are being created.
The Scope attribute or variable indicates the privileges for the assigned user. There
i. READ_ONLY: The user can have access to read data only. User can not create, or modify device and data stream
ii READ_WRITE: The user can modify and create device and data stream
III ADMIN: Access rights for a user designated as the system administrator
IV GROUP_MEMBER: This scope allows the user to access the privileges of multiple devices
- Under the Actions header, the user has two options for the user to take on this token:
i. Edit: This button allows the user to make changes to the field values of the token.
ii. Remove button deletes the token
This handles the creation and administration of devices. These devices are mapped to the physical end-devices sending data to the server. This mapping is achieved by the user assigning end devices with unique device IDs. To start, select devices under Device management in the menu option.
- Creating a device: click on the Add Device button located on the top right of the page
- A dialog box is presented for the user to provide device attribute values such as name, type, and click the Add button
- Upon successful addition of new device, you screen should look like this:
- Device variables: some of the variables of each device added to a project are as follows:
i. Device ID: This is uniquely identifies each device in a project. It is automatically generated by the server. It must be provided by the user in the firmware for each end device
ii. Name: The user provides a unique name to identify the device. It is similar in function to the Device ID, but is created by the user.
iii. Type: Specify the device type: generic, arduino, raspberry pi, particle
iv. State: The device has to be Enabled for it to be active. This is done by checking the Enable box in the Add device dialogue box
v. Status interval: This is the period, in seconds, after which the system confirms if the device is still connected to the server.
vi Last connection: This records the time the device lost connection to the server
- Edit, Remove, Sensors: The following actions are available to the user after a device has been added
i. Edit: this allows the user to change the device variables, described in section 4 above. Not all variables can be edited
ii. Remove: this button deletes the device
iii. Sensors stores data of certain categories or type. For instance, temperature and humidity data values stored as sensor type DHT. Makes retrieval of data easy.
This handles the classification of data being stored in a project. The user determines, the manner in which data is being represented, and displayed on our platform. We will demonstrates the steps in doing so below:
- Select Data Streams under DATA MANAGEMENT option
- Creating stream: click the Create Stream button on the top right of the page
- Provide the stream variable values in the dialogue box as shown below and click Create:
- Your screen should look like this:
- Edit Browse Remove: these actions are as described below:
i. Edit: change where applicable, the values of the data stream variables
ii. Browse displays the actual data sent from the end devices being stored on our server.
iii. Remove deletes the stream
- When data is sent to our platform, using the token, device ID created above, to this data stream, it will be displayed as: