Manages devices on an PRO4 RS-485 bus which require protocol wrapping
Typically this is done using the Protocol Adapter Mux on the wet end.
And a vitual serial port on the top end to communicate with the driving software
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class Protocol_PRO4_InterfaceAdapter : Protocol_PRO4_IDevice
<SerializableAttribute> _ Public Class Protocol_PRO4_InterfaceAdapter _ Implements Protocol_PRO4_IDevice
[SerializableAttribute] public ref class Protocol_PRO4_InterfaceAdapter : Protocol_PRO4_IDevice
Members| All Members | Constructors | Methods | Properties | Fields | |
| Icon | Member | Description |
|---|---|---|
 | Protocol_PRO4_InterfaceAdapter()()() | Initializes a new instance of the Protocol_PRO4_InterfaceAdapter class |
 | BaudRate |
BaudRate to use to communicate with external application
Usually does not matter if using a virtual serial port
|
| Close()()() |
Close the communication port
|
| CommsTimeout |
Duration in mS to wait for response from device
|
| ConsecutiveMissedResponseCount |
Number of missed replys.
This value is set by the CommsManager
|
| CountPacketsToSend |
Gets the number of packets to be sent.
|
| DeviceName |
A device name so the user can identify the device in the UI
|
| DeviceType |
Get the Device Type
|
| Equals(Object) | (Inherited from Object.) |
| ExpectedResponseLength |
Gets or sets the expected length of the response.
This is used to know when a transmission is complete FROM a device on the tether bus which does NOT
implement the PRO4 protocol. It is currently used for the KCF smart tether
|
| GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| HandleResponse_CSR(UInt32, array<Byte>[]()[]) |
Handler for standard CSR read responses
|
| HandleResponse_DeviceSpecific(Int32, array<Byte>[]()[]) |
Handler for device specific responses
|
| HostInitiatedComms |
Flag to indicate if all comms to the device are host initiated
Examples would be standard VR devices, KCF nodes, etc.
If this flag is false than the
|
| ImmediateOutput |
Flag to indicated that output from device should be sent immediately to the
communication port. If false data is que'd in an output que which can be accessed via
the Read functions.
Default is true;
|
| MaxLength_input |
Gets or sets the max size for the input que.
|
| MaxLength_output |
Gets or sets the max length_output.
|
| MaxRxCount |
Set limit on the maximum size to send to the device
|
| MaxTxCount |
Set limit on the maximum size to send to the device
|
| NetworkID |
Get Network Node ID
|
| NextPacketToSend |
Gets the next packet to send.
|
| Open(String, Int32) |
Opens the specified port to be used as the relay port.
Data to/from this port is muxed onto the tether bus
|
| Open()()() |
Opens the specified port to be used as the relay port.
Data to/from this port is muxed onto the tether bus
|
| Port_ReceivedData(Object, CommPort..::.DataReceivedArgs) |
Standard handler for data reception from the tether bus.
The base behavior is to add the data to the output que for transmission on attached port
|
| PortName |
Comm port to use to communicate with external application
Typically this will be a virtual serial port, but could be a real one
|
| Read |
Return any bytes available from the device
|
  | REPLY_SEND_MAX_AVAILABLE_FLAG |
Flag to indicate that the devices should send the maximum available data
|
| Rx(array<Byte>[]()[]) |
Called by the handler of the PRO4 protocol communications port when
data has been recieved.
This data is either que'd or immeditatly sent to the port depending upon the
ImmediateOutput flag
|
| RxCount |
Get the number of bytes in the recieve buffer
This is used for polled operation
|
| ToString()()() | (Inherited from Object.) |
| Tx()()() |
Get an encapulated packet with bytes to be sent to the device
|
| UsesRawComms |
Flag to indicate device uses RAW data stream and not true PRO4 protocol
Most devices should set this to FALSE
|
| Write(array<Byte>[]()[]) |
Que data to be sent out the muliplexed PRO4 protocol channel
|
| Write(Byte) |
Que's a single byte to be sent out the muliplexed PRO4 protocol channel
|
Inheritance Hierarchy| Object | ||
 | Protocol_PRO4_InterfaceAdapter | |
| InterfaceAdapter_KCF_SmartTether | |