Control By Web

The Control By Web integrated system provides remote input, output and sensor monitoring, with the ability to control electronic devices.

Setup

See the Data Servers page for information on configuring driver communication.

Definitions

CBW — Control By Web

Compatibility

Module Compatible Unsupported Tags Notes
Web Relay Wireless Yes
  • registerX
  • sXAlrm
  • units
 Support only available for the sensors and outputs.
Web Relay Quad Yes Only outputs are available for this module. They are fully supported.
Web Relay 10 Yes Only outputs are available for this module. They are fully supported.
Web Relay 10 Plus Yes
  • extvarX
  • hgihtime
  • count
  • units
WebSwitch Yes
  • rbtattemptsX
  • totalrebootsX
  • failuresX
  • rebootXState
WebSwitch Plus Yes
  • rbtAttemptsX
  • extvarX
  • units
  • failures
  • rebootXstate
  • totalrebootsX
X-300 Yes
  • extvarX
  • units
X-332 Partially
  • an1State
  • an3Alrm
 Output and input statuses which use bit sequences. Sensors are supported.
X-400 Yes
X-404 Partially
  • registerX
  • downloadSettings
X-405 Yes
  • registerX
X-406 Yes
  • registerX
X-408 Yes
X-410 Yes
X-420 Partially
  • analogInputX
 Digital inputs and outputs can be used, however they must be configured as inputs.
XW-110 Yes
  • battery
  • batteryVoltage
  • powersource
  • units
  • sXAlrm
 Only sensors are supported.
XW-110 Plus Yes
  • battery
  • batteryVoltage
  • powersource
  • units
XW-111 Yes
  • battery
  • batteryVoltage
  • powersource
 Only inputs are supported.
XW-112 Yes
  • battery
  • batteryVoltage
  • powersource
 Only inputs are supported.
Note: Expansion modules add inputs and outputs to an X-4XX or X-600 device. The number of inputs and outputs depends on the expansion module. When the expansion is added, the additional inputs and outputs will have incrementing IDs based on the previously connected devices.

Prerequisites

Software Minimum Version
IPFusion — Control By Web 1.11
.NET Framework 4.7.2

When completing your setup, be sure to have the Control By Web documentation available for reference.

Ports

These ports must be open in your network firewall for the integration to work.

Purpose Default Value Configurable
Communication Settings 80 Yes
Dataserver 9580 Yes
Debug Tools 9581 No

Communication Configuration

In the integrated system configuration panel, you will find the Communication Settings. The below information is required:

Name The Name of the device you are connecting to.
Address The IP Address of the device.
Port The Port number for the connection.
Username The Username of the user to log in as. This is normally a user created specifically for the Runtime connection.
Password The Password associated with the Username.
Timeout (ms) The time in milliseconds Runtime will try connecting before timing out. The minimum value is 100.
Refresh Rate (ms) The time in milliseconds Runtime will refresh data from CBW. The minimum value is 100.
Note: Red X indicates an invalid or out of range value given for field.

End Device Authorization Configuration

The Control By Web device contains three different user accounts:
  • Admin — has full access to all setup and control pages. This use always has an associated password.
  • Manager — has access to tasks and control pages. This may be configured with a password.
  • User — has access only to control pages. This may be configured with a password.

All connections to the device are given user-level permissions. If the user account is not password protected, anyone will be able to access the control pages. This includes if they provide invalid login information.

Assets

Input

This asset represents an input device in the CBW system (e.g. a button).

Required Property Grid Fields

Device The CBW Device that the input is present on.
Index The Index or ID of the input being represented.

View all properties

Supported States

Normal The asset is online and in its default state.
Fault An issue has been detected in a connected asset.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
On The asset is currently on.
Off The asset is currently off.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Analog Input

This asset represents an analog input device in the CBW system (e.g. a thermometer).

Required Property Grid Fields

Device The CBW Device that the analog input is present on.
Index The Index or ID of the analog input being represented.

View all properties

Supported States

Normal The asset is online and in its default state.
Fault An issue has been detected in a connected asset.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Analog Value The values which the analog input must be between to be in this custom state.
  • Lower Threshold — The lowest the analog value can be to resolve to this state. This is a float value which can be configured up to 5 decimal places.
  • Upper Threshold — The highest the analog value can be to resolve to this state. This is a float value which can be configured up to 5 decimal places.
Note: If the analog value sent from the input does not match any of the configured analog value states in the status table, the asset resolves to fault.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

See the Command Tables page for more information on configuring command tables.

Output

This asset represents an output device in the CBW system (e.g. a light).

Required Property Grid Fields

Device The CBW Device that the output is present on.
Index The Index or ID of the output being represented.

View all properties

Supported States

Normal The asset is online and in its default state.
Fault An issue has been detected in a connected asset.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
On The asset is currently on.
Off The asset is currently off.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.
On Turn the asset on.
Off Turn the asset off.

See the Command Tables page for more information on configuring command tables.

Sensor

This asset represents a sensor within the CBW system (e.g. a thermometer).

Required Property Grid Fields

Device The CBW Device that the sensor is present on.
Index The Index or ID of the sensor being represented.

View all properties

Supported States

Normal The asset is online and in its default state.
Fault An issue has been detected in a connected asset.
Masked The asset has been masked over its true state.
Acknowledged An asset alarm has been acknowledged.
No Communication Communication has been lost with the driver or asset. This status can also occur if the communication configuration for the system or asset is invalid.
Note: This status is required in all status tables.
Sensor Value A status tied to the read value for a sensor in the CBW system.
  • Minimum Threshold — When a read value exceeds this Threshold, this state is triggered.
Note: If the Sensor Value provided by the system does not fall within the threshold for any Sensor Value statuses, it will go into a fault state.

See the Configure a Status Table page for more information on configuring status tables.

Supported Commands

Mask Mask the asset's true state.
Acknowledge Acknowledge an asset alarm.
Reset Resets the asset to its true hardware state.
Cancel Deselects all selected assets.

Workflow Integration

System Commands

System commands are commands executed through Workflows at the system level. For more information about Workflows, see the Workflows section.

Set Output State On

Turns an output asset On.

Table 1. Parameters
Asset ID The unique identifier for an output asset.

Set Output State Off

Turns an output asset Off.

Table 2. Parameters
Asset ID The unique identifier for an output asset.

Troubleshooting

Logs from the driver and Runtime can be viewed in the Debug Tools client. These messages contain information which can provide further context for issues during initialization, or while actively running. This can help diagnose problems.