Device Server
This context is used to access and manage a single Device Server.
Unique Actions
[?]
Edit Device Server Properties
This action is used to edit properties of Device Server Account.
Action Type: | |
Action Name: | editProperties |
Action Icon: |  |
Configure Device Server
This action is used to edit settings of hardware Device Server. Its differences from a standard Configure action is that Device Server is rebooted when new settings are saved.
Action Name: | configure |
Action Icon: | No icon |
Configure Device Driver
This action is used to edit Device Server-level properties of a Device Driver associated with Device Server Account. Driver type is defined in the basic properties of the Device Server Account. See the driver description for information about available properties.
Action Type: | |
Action Name: | configureDevicePlugin |
Action Icon: |  |
View Device Servers Summary
Shows Device Servers summary.
Action Type: | |
Action Name: | list |
View Device ServerS Status
This action shows status of Device Server Account.
Action Type: | Configure (read-only mode) |
Action Name: | status |
Action Icon: |  |
Buzz
This action buzzes a hardware Device Server.
Action Type: | |
Action Name: | buzz |
Reboot
This Call Function action reboots a hardware Device Server.
Action Type: | |
Action Name: | reboot |
Non-Interactive Mode: | Supported |
View Data Flow
This action is used to monitor data routed between hardware Device Server and Iotellect Server. See details here.
Action Name: | dataFlow |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Observer permission level |
Common Actions
[?]
Delete, Replicate, Edit Context Permissions, Monitor Related Events
Context States and Icons
 | Device Server if offline |
 | Device Server is online (connected to the Iotellect Server) |
 | Device Server Account is blocked, login attempts will be denied |
 | Some Device Drivers may affect the state and icon of this context. For example, the Transparent Data Routing (Link Service) driver sets context icon to In other words, you see this icon when the Iotellect Server is used as a transparent "pipe" between a Device Server and some other software. |
and status to Client connected when some third-party software is connected to the Iotellect Server using a dedicated port specified in the driver settings for this Device Server Account and exchanges data with current Device Server. Advanced Information |
Context Information
Context Type: deviceServer
Context Name: provided by user
Context Description: provided by user
Context Path: users.USER_NAME.deviceservers.DEVICE_SERVER_ACCOUNT_NAME
Context Mask: users.*.deviceservers.*
Context Permissions: Observer
Public Variables (Properties)
[?]
Device Server Information
Returns properties of a Device Server Account.
Variable Name: | deviceServerInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Name | Type | Description |
owner | String |
|
name | String |
|
password | String |
|
description | String |
|
registerindns | Boolean |
|
blocked | Boolean |
|
inbandpassthrough | Boolean |
|
timezone | String |
|
deviceplugin | String |
|
Device Server Status
Returns status of a Device Server Account.
Variable Name: | status |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
name | String |
|
online | Boolean |
|
pluginStatus | String |
|
dsToServer | Long |
|
serverToDs | Long |
|
creationtime | Date |
|
updatetime | Date |
|
realip | String | Nullable |
realport | Integer | Nullable |
logintime | Date | Nullable |
internalip | String | Nullable |
Public Functions
[?]
Send Commands
This function sends several commands to a hardware Device Server and returns its replies.
Function Name: | commands | ||
Permissions: | Accessible at Observer permission level | ||
Input Records: | 1...unlimited | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
command | String | Command text. | |
Output Records: | 1...unlimited | ||
Output Format: | Name | Type | Description |
successful | Boolean | True is command was successfully sent and replied by Device Server. | |
errortext | String | Text of error message if some I/O error occurred while sending command. | |
reply | String | Text of reply received from a Device Server if command was successfully replied. | |
Send Non-replied Commands
This function sends several commands to a hardware Device Server but doesn't expect to get any replies from it.
Function Name: | nonRepliedCommands | ||
Permissions: | Accessible at Observer permission level | ||
Input Records: | 1...unlimited | ||
Input Format: | Name | Type | Description |
|---|---|---|---|
command | String | Command text. | |
Output Records: | 1...unlimited | ||
Output Format: | Name | Type | Description |
successful | Boolean | True is command was successfully sent to Device Server.
| |
errortext | String | Text of error message if some I/O error occurred while sending command. | |
Successfully sending a non-replied command via UDP does not mean that is was received and processed by the Device Server.Buzz
Buzzes Device Server.
Function Name: | buzz |
Permissions: | Accessible at Observer permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format: | none |
Reboot
Reboots Device Server.
Function Name: | reboot |
Permissions: | Accessible at Observer permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format: | none |
Disconnect
Causes server to close TCP connection with a hardware Device Server. It will attempt to reconnect to the Device Server in several seconds.
Function Name: | disconnect |
Permissions: | Accessible at Observer permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format: | none |
Remove
Permanently destroys Device Server Account.
Function Name: | remove |
Permissions: | Accessible at Observer permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format: | none |
Public Events
[?]
Common Events: info (Information), contextStatusChanged (Status Changed)
Connection
This event is fired upon device server connection and successful login.
Event Name | connection |
Permissions: | Accessible at Observer permission level |
Records: | 0 |
Disconnection
This event is fired upon device server disconnection.
Event Name | disconnection |
Permissions: | Accessible at Observer permission level |
Records: | 0 |
Inband
This event is generated when an inband notification (i.e. command that is not a reply to any other command) is received from a Device Server. Such inbands are handled by Iotellect Server only if Inband commands allowed for client option if disabled in Device Server account settings.
Event Name | inband |
Permissions: | Accessible at Observer permission level |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
text | String | Text of received inband. |
Was this page helpful?