This context lets you access and manage a single Device.
Unique Actions [?]
This Configure action helps to set parameters of communications between LinkServer and Device. It is available only for directly connected devices.
This action provides access to two groups of settings:
| • | Settings specific to a particular Device type (e.g host name and port number for networked devices) |
This Configure 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 Data Transfer/Device Plugin that manages Device for more information.
|
This context may provide some other unique actions, depending on the Data Transfer/Device Plugin managing it. For example, if it is managed by an AggreGate Agent plugin, it will contain Device-specific actions. |
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.
This Configure action provides modification access to the Device Settings Synchronization Options.
Allows to view status of the Device (online status, synchronization status and time of last synchronization) and individual settings synchronization status.
Immediately starts synchronization between LinkServer and Device.
Clears Device settings cache and deletes all other information about Device remembered by LinkServer. Then starts synchronization as if LinkServer were just connected to LinkServer for the first time.
Common Actions [?]
Delete, Replicate, Edit Context Permissions, Monitor Related Events
Context Icon |
Context State |
|
Offline, synchronized |
|
Online, synchronized |
|
Suspended, synchronized |
|
Offline, waiting for synchronization |
|
Online, waiting for synchronization |
|
Suspended, waiting for synchronization |
|
Offline, synchronization error |
|
Online, synchronization error |
|
Suspended, synchronization error |
|
Offline, not synchronized or synchronization in progress |
|
Online, not synchronized or synchronization in progress |
|
Suspended, not synchronized or synchronization in progress |
Advanced Information |
Context Information
Context type: DeviceContext
Context name: provided by Data Transfer/Device Plugin
Context description: provided by Data Transfer/Device Plugin
Context path: users.USER_NAME.devices.NAME_OF_THIS_CONTEXT for directly connected devices, users.USER_NAME.deviceservers.DEVICE_SERVER_ACCOUNT_NAME.devices.NAME_OF_THIS_CONTEXT for devices connected via Device Servers
Context mask: users.*.devices.* for directly connected devices, users.*.deviceservers.*.devices.* for devices connected via Device Servers
Context permissions: User
Public Variables (Properties) [?]
Public variables of this context depend on the type of Device represented by it. LinkServer creates one public variable in this context per every Device setting.
Status
Returns status of the Device.
Variable Name: |
status |
Records: |
1 |
Permissions: |
Readable at User permission level |
Record Format:
Field Name |
Field Type |
Notes |
syncTime |
Date |
Date/time of last synchronization between LinkServer and Device. |
onlineStatus |
String |
Device online status. |
syncStatus |
String |
Device synchronization status. |
Public Functions [?]
Public functions of this context depend on the type of Device represented by it. LinkServer creates one public function in this context per every operation provided by Device.
Synchronize
Starts synchronization between Device and LinkServer. See Synchronize action for details.
Function Name: |
synchronize |
Permissions: |
Accessible at User permission level |
Input Records: |
0 |
Input format: |
None |
Output Records: |
0 |
Output format: |
none |
Purge Server Cache
Causes LinkServer to purge all information about Device and start synchronization. See Purge Server Cache action for details.
Function Name: |
purge |
Permissions: |
Accessible at User 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. LinkServer 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)