This context lets you access and manage a single Device.
Unique Actions [?]
Some actions of this context depend on the type of Device represented by it. AggreGate Server creates one Call Function action in this context per every operation provided by Device. Actions corresponding to the Device operations are accessible at Operator permission level.
This action helps to set parameters of communications between AggreGate Server and Device.
This action provides access to several groups of properties:
| • | 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 AggreGate |
|
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. If no relevant dashboards are found, simply starts Configure Device action.
Action Name: |
manage |
Action Icon: |
|
Non-Interactive Mode: |
Not Supported |
Permissions: |
Accessible at Observer permission level |
This action is used to edit the settings of a hardware Device. New setting values are stored in the server cache during editing and written to the actual Device on next synchronization. See description of the Device Driver that manages Device for more information.
|
This context may provide some other unique actions, depending on the Device Driver managing it. For example, if it is managed by an AggreGate Agent driver, it will contain Device-specific actions. |
Action Type: |
Configure Device Dynamically
This action has just one difference from the above: when Device settings are open for editing, and their values are modified in the server cache (e.g by an ordinary synchronization or other system operators), these changes are immediately reflected in the editor. This may greatly help to monitor state of device with frequently changed read-only settings (e.g. sensor readings). However, this editing mode is not convenient for changing Device settings, as modifications made in the editor may be overwritten by third-party modifications made to the server cache.
Action Type: |
|
Action Name: |
configureDynamically |
This action immediately starts synchronization between AggreGate Server and Device.
Action Type: |
|
Action Name: |
synchronize |
Action Icon: |
|
Permissions: |
Accessible at Operator permission level |
This action clears Device settings cache, deletes all other information about Device remembered by AggreGate Server. Then starts synchronization as if AggreGate Server were just connected to AggreGate 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 device side.
Action Name: |
editVariableSyncOptions |
Non-Interactive Mode: |
Not Supported |
Permissions: |
Accessible at Manager permission level |
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 AggreGate 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: Observer
Public Variables (Properties) [?]
Some public variables of this context depend on the type of Device represented by it. AggreGate 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)
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 |
interruptOnError |
Boolean |
|
suspend |
Boolean |
|
extendedStatus |
Boolean |
|
dependency |
String |
|
offlineAlert |
Boolean |
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 channel. |
variable |
String |
Name of variable the channel is based on. |
properties |
Data Table |
Properties of channel. |
Device Settings Synchronization Options
Contains Per-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 |
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 AggreGate. |
children |
Data Table |
List of nested assets. It has the same format as this variable. |
Returns status of the Device.
Variable Name: |
status |
Records: |
1 |
Permissions: |
Readable at Observer permission level |
Record Format:
Field Name |
Field Type |
Notes |
driver |
String |
Device Driver |
syncTime |
Date |
Date/time of last synchronization between AggreGate 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 channel. |
variable |
String |
Name of variable the channel is based on. |
statistics |
Data Table |
Brief statistical data. |
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. AggreGate 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 AggreGate Server. See Synchronize action for details.
Function Name: |
synchronize |
Permissions: |
Accessible at Operator permission level |
Input Records: |
0 |
Input Format: |
None |
Output Records: |
0 |
Output Format: |
none |
Reset Device Driver
Causes AggreGate 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. AggreGate 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)