Portals Device Overview
Portals is a user interface that provides a mean to manage and visualize the devices (One Platform clients) sending data to the One Platform (server). If Exosite Portals is being used to view devices and device data, the device must be added into Portals before the physical device client can send data or receive data. Each device has a unique CIK (Client Interface Key) number that identifies it to the platform.
Portals provides one way to interact with devices. Developers can also use the Exosite API to not only read and write data but also to created and edit device clients.Managing Devices in Portals
The devices page shows a table of all devices registered for a specific portal. Besides allowing the user to click on a device to see the device configuration popup, there are a couple of columns to point out here.
|Name||Device name, this is meta information|
|Alias||The alias for the client in the platform|
|Type||Either 'generic' or a client model created by a vendor|
|Unique ID||Only used by client models. Not used by generic device type.|
|Location||Another field put into meta information for the client.|
Clicking on a device will open it’s pop-up box. This shows all of the specifics about the device setup, it’s list of data sources (alias). Deleting a device is also possible here. Clicking on a data source opens up another pop-up about Data Information where you can see the data log. To add a data source for a specific device, go to the Data page on navigation menu to get to the Data Sources page.
Adding a new device
Adding a new device is simple and starts by going to the ‘Devices’ page, or on some custom (sub-domain) Portals, there may be a link on the default home page.
1. Click the Add Device button. (Shown with red arrow below)
2. A Device Setup popup window will guide you through the setup process. Select the appropriate device type, device timezone, and provide a descriptive location value. Click the ’Continue’ button to continue.
A note about device types. The device type provides for different protocols and custom devices that Exosite’s One Platform supports.
3. Give the device a name, verify the information from the previous step, and click ‘Submit’ to complete the process. If you need to go back, click the ‘Device Setup’ text link.
4. You should see the new device added to the device table. You can now start using this device.
Client Interface Key. A secret unique identifier number for a device to the platform. The One Platform generates the CIK automatically when a device client is created. CIK's for a vendor client model type device can be re-generated. APIs that take action on behalf of a device including reading from and reading to it's dataports require the CIK.
Arbitrary name provided to identify the device to a user. This is a 'friendly' name that can be specified.
An alias for this client in the One Platform. Optional to use but APIs, widgets and other functionality may require one. An Alias is a simple identifier for the client's RID (resource identifier).
Exosite supports clients that are either 'generic' or that are of a specific Client Model, which must be created by a device OEM. More Information for Managing Client Models in Portals
Arbitrary location provided to help identify device to user. Examples: Office, Factory, North Field, etc. This location settings is put by Portals into the client's meta field.
The timezone for the given device. Important for recording time stamps and providing accurate time based values to the user. Should be specific to the location of the device, not the user. This timezone information is put by Portals into the client's meta field and Portals uses it to show data in that timezone even though data is stored as UTC.