Device
This context lets you access and manage a single Device.
Unique Actions
[ ? ]
 | This context may provide some unique actions other than described below, depending on the Device Driver managing it. For example, if it is managed by an Iotellect Agent driver, it will contain Device-specific actions. |
Edit Device Properties
This action allows connection details for how Iotellect Server communicates with the device to be configured, as well as giving access to a few property group specific to devices in Iotellect:
Connection properties specific to a particular device type (e.g host name and port number for networked devices)
Groups of settings, operations and events that should be synchronized and made available within Iotellect
 | Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier. |
Action Type: | |
Action Name: | setup |
Action Icon: |  |
Permissions: | Accessible at Manager permission level |
Manage Device
( Default Action )
Opens all dashboards that are valid for the device and have Launch via Manage Action flag set. If no relevant dashboards are found, simply starts the Configure Device action.
Action Name: | manage |
Action Icon: |  |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Observer permission level |
Configure Device
This action is used to view and edit the settings of a hardware Device. The server will attempt to write any changed setting values immediately to the device. If the immediate write fails, the new values are stored in the server cache and are written to the actual Device on next synchronization. See description of the Device Driver that manages the specific device for more information.
Action Type: |
Synchronize
This action immediately starts synchronization between the Iotellect Server and the Device.
Action Type: | |
Action Name: | synchronize |
Action Icon: |  |
Permissions: | Accessible at Operator permission level |
Reset Device Driver
This action clears Device settings cache, deletes all other information about Device remembered by Iotellect Server. Then starts synchronization as if Iotellect Server were just connected to Iotellect Server for the first time.
Action Type: | |
Action Name: | reset |
Action Icon: |  |
Permissions | Accessible at Manager permission level |
Common Actions
[ ? ]
Delete, Replicate, Edit Context Permissions, Monitor Related Events, View Status
Variable-Related Actions
[ ? ]
Edit Synchronization Options
This action allows to edit synchronization options of a certain device-provided setting. It is available only for variables "coming" from the device side.
Action Name: | editVariableSyncOptions |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |
Context States and Icons
Information about Device statuses is available here.
Icon | Code | State |
 | 20 | Offline, synchronized |
 | 21 | Online, synchronized |
 | 22 | Suspended, synchronized |
 | 23 | Connection status unknown, synchronized |
 | 30 | Offline, waiting for synchronization |
 | 31 | Online, waiting for synchronization |
 | 32 | Suspended, waiting for synchronization |
 | 33 | Connection status unknown, waiting for synchronization |
 | 40 | Offline, synchronization error |
 | 41 | Online, synchronization error |
 | 42 | Suspended, synchronization error |
 | 43 | Connection status unknown, synchronization error |
 | 50 | Offline, not synchronized or synchronization in progress |
 | 51 | Online, not synchronized or synchronization in progress |
 | 52 | Suspended, not synchronized or synchronization in progress |
 | 53 | Connection status unknown, not synchronized or synchronization in progress |
 | 70 | Offline, connecting (extended status only) |
 | 71 | Online, connecting (extended status only, reconnection has been requested by Iotellect Server) |
 | 72 | Suspended, connecting (extended status only, means that Device has been suspended during connection attempt) |
 | 73 | Connection status unknown, connecting (extended status only) |
 | 80 | Offline, reading metadata (extended status only, means that connection has been lost during metadata reading and synchronization is being interrupted) |
 | 81 | Online, reading metadata (extended status only) |
 | 82 | Suspended, reading metadata (extended status only, means that Device has been suspended during metadata reading) |
 | 83 | Connection status unknown, reading metadata (never occurs in practice) |
 | 90 | Offline, synchronizing settings (extended status only, means that connection has been lost during settings synchronization and it is being interrupted) |
 | 91 | Online, synchronizing settings (extended status only) |
 | 92 | Suspended, synchronizing settings (extended status only, means that Device has been suspended during settings synchronization) |
 | 93 | Connection status unknown, synchronizing settings (never occurs in practice) |
Advanced Information
Context Information
Context Type: device.DEVICE_TYPE
Context Name: provided by Device Driver
Context Description: provided by Device Driver
Context Path: users.USER_NAME.devices.NAME_OF_THIS_CONTEXT
Context Mask: users.*.devices.*
Context Permissions
[ ? ]
Level | Description |
None | No access allowed. |
Observer | Device settings browsing. Basic event monitoring. Status browsing. |
Operator | Device account properties browsing. Device settings editing. Executing device operations. Device event monitoring. Explicit device synchronization requesting. |
Manager | Device account properties configuration. Device removal. Device driver resetting. Viewing statistical data. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
[ ? ]
Some public variables of this context depend on the type of Device represented by it. Iotellect Server creates one public variable in this context per every Device setting. Variables corresponding to the Device settings are readable at the Observer permission level and writable at Operator permission level.
Common Variables: groupMembership (Group Membership), activeAlerts (Active Alerts)
Generic Device Properties
Contains Generic Properties of the Device.
Variable Name: | genericProperties |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String |
|
description | String |
|
type | String |
|
syncPeriod | Long | Measured in milliseconds |
startSyncOnSettingChange | Boolean |
|
interruptOnError | Boolean |
|
suspend | Boolean |
|
disableSynchronousSettingValueRW | Boolean |
|
extendedStatus | Boolean |
|
syncQueueLength | Integer |
|
timeZone | String |
|
metadata | Integer |
|
activeEntities | Integer |
|
cache | Integer |
|
settingsDefaultQuality | Integer |
|
eventStoragePeriod | Long |
|
dependency | String |
|
status | String |
|
color | String |
|
latitude | String |
|
longitude | String |
|
locationStoragePeriod | Long |
|
offlineAlert | Boolean |
|
virtualNetwork | String |
|
Statistics Channels
This variable allows to manage statistics channels of this Device.
Variable Name: | statisticsProperties |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Name of the channel. |
variable | String | Name of variable the channel is based on. |
properties | Data Table | Properties of the channel. |
Device Settings Synchronization Options
Contains Setting Synchronization Options of the Device.
Variable Name: | settingSyncOptions |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String |
|
description | String |
|
mode | Integer |
|
updateHistoryStorageTime | Long | Measured in milliseconds |
syncPeriod | Long | Measured in milliseconds |
filter | String | Nullable |
master | String |
|
addPreviousValueToVariableUpdateEvent | Boolean |
|
Assets
This variable allows to manage assets provided by Device.
Variable Name: | assets |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
id | String | Asset unique ID. |
description | String | Human-readable description of the asset. |
enabled | Boolean | Flag indicating whether asset is enabled and its members (settings, operations and events) are available within Iotellect. |
children | Data Table | List of nested assets. It has the same format as this variable. |
Variables
This table allows to select which device settings that will exposed within Device context. It's only enabled if Active Entities option is set to Selected Entities.
Variable Name: | managedVariables |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Variable name. |
description | String | Variable description. |
group | String | Variable group. |
active | Boolean | Flag defining whether the variable will be exposed by the device context. |
Functions
This table allows to select which device operations that will exposed within Device context. It's only enabled if Active Entities option is set to Selected Entities.
Variable Name: | managedFunctions |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Function name. |
description | String | Function description. |
group | String | Function group. |
active | Boolean | Flag defining whether the function will be exposed by the device context. |
Events
This table allows to select which device events that will exposed within Device context. It's only enabled if Active Entities option is set to Selected Entities.
Variable Name: | managedEvents |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Event name. |
description | String | Event description. |
group | String | Event group. |
active | Boolean | Flag defining whether the event will be exposed by the device context. |
Status
Returns status of the Device.
Variable Name: | status |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
status | String | Custom textual device status. Calculated by the Status Expression, which is a setting of device account. |
color | Color | Custom device status color. Calculated by the Color Expression, which is a setting of device account. |
driver | String | Device Driver |
syncTime | Date | Date/time of last synchronization between Iotellect Server and Device. |
connectionStatus | Integer | Device connection status. |
syncStatus | Integer | Device synchronization status. |
syncDetails | String | Current synchronization progress. |
Settings Synchronization Status
Returns synchronization status information for Device settings.
Variable Name: | settingsStatus |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Name of setting variable. This field is hidden. |
setting | String | Setting description, i.e. description of setting variable. |
serverTime | Date | Date/time of last synchronization. |
duration | Long | Duration of last synchronization, i.e. time elapsed by device driver for reading/writing settings value from the hardware. |
updated | Boolean | Updated on Server flag that is true if setting value was updated in the server cache and new value is not yet written to the hardware. |
syncStatus | String | Textual description of current setting synchronization status. |
Statistics
This variable is a view of device statistics, i.e. aggregated data collected by device's statistical channels.
Variable Name: | statistics |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Name of the channel. |
variable | String | Name of variable the channel is based on. |
statistics | Data Table | Brief statistical data. |
Location
Returns current location of the device. See Tracking Device Location for details.
Variable Name: | location |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
latitude | Float | Current device latitude in floating point number format. |
longitude | Float | Current device longitude in floating point number format. |
Variable Statuses
Returns additional status information about Device settings.
Variable Name: | variableStatuses |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Name of variable |
status | String | Unique string ID of the status |
comment | String | Human-readable description of status |
Public Functions
[ ? ]
Some public functions of this context depend on the type of Device represented by it. Iotellect Server creates one public function in this context per every operation provided by Device. Functions corresponding to the Device operations are accessible at Operator permission level.
Synchronize
Starts synchronization between Device and Iotellect Server. You can also synchronize only a variable instead of whole Device. Pass your variable name into synchronize function parameters. See Synchronize action for details.
Function Name: | synchronize | ||
Permissions: | Accessible at Operator permission level | ||
Input Records: | 1 | ||
Input Format: | |||
| Name | Type | Description | |
|---|---|---|---|
| variable | String | Synchronizes with Iotellect Server | |
Output Records: | 0 | ||
Output Format: | none | ||
Reset Device Driver
Causes Iotellect Server to purge all information about Device and start synchronization. See Reset Device Driver action for details.
Function Name: | reset |
Permissions: | Accessible at Manager permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format: | none |
Public Events
[ ? ]
Public events of this context depend on the type of Device represented by it. Iotellect Server creates one public event in this context per every type of event that may be generated by Device.
Common Events: info (Information), contextStatusChanged (Status Changed)
Synchronized
This event is generated at the end of every synchronization cycle. It doesn't belong to any event group and, therefore, doesn't appear in event log during Monitor Related Events action.
Event Name | synchronized |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent |
Records: | 0 |
Function Called
This event is generated when a device operation is executed. Events are generated only when Enable Extended Status generic device property is on.
Event Name | functionCalled |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
function | String | Name of called function. |
input | Data Table | Function input table. |
output | Data Table | Function output table. |
user | String | Name of user who called the function of null if the call was performed by a system component. |
Backdated Change event
This event is fired during a connection phase of every synchronization cycle providing the variable history. It contains a variable (defined in this context) and its dated value (a change occurred at the particular date/time in the past).
Event Name | backdatedChange |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent (see Change event for variable update persistence) |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
variable | String | Name of changed variable. |
value | Data Table | Historical value of the variable. |
Was this page helpful?