Generic Network Driver

The generic network driver allows interfacing with devices connected to the computer network via TCP/IP where no driver yet exists. Incoming data is expected to be delimited by a string of characters to distinguish packets.

Manufacturer: N/A

Primary Communications Port: Network

Table of Contents [Hide/Show] Configuration Settings Events    Ready State Changed    Received Data Instance Properties    DeviceDisplayName    DeviceStartTime    DeviceLifecycleStage    DeviceIsRunningAndReady Instance Methods    Send ( String )    SendLine ( String )    SendBinary ( String )    SetPropertyForDuration ( String, TimeSpan, Object, Object )    SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Configuration Settings

• Host Name : The host name or ip address to connect to.
• Port : The port to connect to.
• Delimiter : (optional) Defaults to carriage-return linefeed ( \r\n ). This is the string that delimits incoming data packets.
• New Line String : (optional) Defaults to carriage-return linefeed ( \r\n ). This string is appended to the string passed to the SendLine() method.
  

Delimiter and NewLine special characters:

• \r : Carriage-return (ASCII character 13)
• \n : Linefeed (ASCII character 10)
• \t : Tab (ASCII character 9)
  

Events

Ready State Changed

The device's running and ready state changed.

Whenever Filter:


EventArgs:

• Number NewValue : The new property value.
• Number PreviousValue : The previous property value.
  

Received Data

Occurs when the driver receives incoming data from the network connection.

Whenever Filter:


EventArgs:

• String Data : The received data.
  

Example Script:

// Do something here. Normally you would parse the data string
// using the String datatype methods to determine what was received.
// Data formats:
// "STOPPED:%%" where %% is a number of how open the drapes are
// "OPENING"
// "CLOSING"
command = EventArgs.Data.Substring(0, 7);
if ( command == "STOPPED" )
    Log( "Drapes are open " + EventArgs.Data.Substring(8, 2) + "%" );
else if ( command == "OPENING" )
    Log( "Drapes are opening." );
else if ( command == "CLOSING" )
    Log( "Drapes are closing." );

Instance Properties

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

Send ( String )

Sends data over the network connection.

Syntax


Parameters

SendLine ( String )

Sends data over the network connection followed by the new line string.

Syntax


Parameters

SendBinary ( String )

Sends binary data to the serial port.

Syntax


Parameters

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax


Parameters

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax


Parameters