Oct 02, 2010 Why WPF and compare WPF with Winforms? (WPF Interview question with answers) - Duration: 26:02.NET Interview Preparation videos 196,101 views. Contribute to JohnnyPP/WPF-Serial-Communication-Advanced development by creating an account on GitHub.
-->The Windows.Devices.SerialCommunication namespace defines Windows Runtime classes that a UWP app can use to communicate with a device that exposes a serial port or some abstraction of a serial port. The classes provide functionality to discover such serial device, read and write data, and control serial-specific properties for flow control, such as setting baud rate, signal states.
The namespace also supports devices that belong to the USB CDC device class. This includes ports exposed by Serial-to-USB adapters and internal USB to serial bridge chips like those used in Arduino Uno R3s. See note below on compatible IDs.
System-internal or on-chassis serial ports may be enumerated by DeviceInformation.FindAllAsync(), but cannot be opened by SerialDevice.FromIdAsync() because they currently are not supported. However, serial ports connected over USB, such as on USB-to-Serial cables are supported.
It is possible that the DeviceInformation collection returned by DeviceInformation.FindAllAsync() may have a serial device whose DeviceInformation.Name property is set to the machine name. This is by design and may occur when enumerating an on-board serial port. Apps should handle this case by either:
- Filtering such serial ports from the user's view, so that the user will not be able to interact with such an unsupported serial port at all.
- If the app decides to let the user interact with such a serial port, then note that when the app calls the DeviceAccessInformation.CreateFromId() function, an exception with the message: 'The system cannot find the file specified. (Exception from HRESULT: 0x80070002)' will be thrown. The app should handle such an exception and let the user know that the port is unsupported.
Serial devices that use the following compatible IDs can be supported by the in-box Windows 10 usbser.sys driver; these are automatically supported by Windows.Devices.SerialCommunication. In addition, USB serial devices that use other compatible IDs are supported through a vendor-supplied driver.
- USBClass_02&SubClass_02&Prot_01
- USBClass_02&SubClass_02
Serial device capability usage
Your UWP app must include certain device capabilities in its App package manifest. The capabilities identify the device and its purpose. Here are the required elements in hierarchical order:
- <DeviceCapability>: The Name attribute must be 'serialcommunication'.
- <Device>: The Id attribute must specify the device identifier. If you are using a Serial-to-USB adapter, Id must specify vendor/product identifiers or can be 'any' to allow access to any device that matches the function type.
- <Function>: The Type attribute specifies the device function. For serial devices this must be 'serialPort'.
Serial device capability example
Here is an example for defining serial device capabilities. It allows the app to access the serial port through a Serial-to-USB adapter.
![Port Port](http://www.xanthium.in/sites/default/files/site-images/serial-prog-csharp-gui/serial-port-communication-gui-program-design.jpg)
Classes
ErrorReceivedEventArgsErrorReceivedEventArgsErrorReceivedEventArgsErrorReceivedEventArgsErrorReceivedEventArgs | Represents the object that is passed as a parameter to the event handler that is invoked when error occurs on the serial port. |
PinChangedEventArgsPinChangedEventArgsPinChangedEventArgsPinChangedEventArgsPinChangedEventArgs | Represents the object that is passed as a parameter to the event handler that is invoked when the state of a signal line changes on the serial port. |
SerialDeviceSerialDeviceSerialDeviceSerialDeviceSerialDevice | Represents a serial port. The object provides methods and properties that an app can use to find the port (in the system). |
Enums
SerialErrorSerialErrorSerialErrorSerialErrorSerialError | Defines values for error conditions that can occur on the serial port. |
SerialHandshakeSerialHandshakeSerialHandshakeSerialHandshakeSerialHandshake | Defines values for hardware and software flow control protocols used in serial communication. The values are used by Handshake property on the SerialDevice object. |
SerialParitySerialParitySerialParitySerialParitySerialParity | Defines values for the parity bit for the serial data transmission. The values are used by the Parity property on the SerialDevice object. |
SerialPinChangeSerialPinChangeSerialPinChangeSerialPinChangeSerialPinChange | Defines values for types of signal state changes on the serial port. |
SerialStopBitCountSerialStopBitCountSerialStopBitCountSerialStopBitCountSerialStopBitCount | Defines values that indicate the number of stop bits used in a transmission. The values are used by the StopBits property on the SerialDevice object. |
See also
-->Definition
SerialPort
Examples
The following code example demonstrates the use of the SerialPort class to allow two users to chat from two separate computers connected by a null modem cable. In this example, the users are prompted for the port settings and a username before chatting. Both computers must be executing the program to achieve full functionality of this example.
Remarks
Use this class to control a serial port file resource. This class provides synchronous and event-driven I/O, access to pin and break states, and access to serial driver properties. Additionally, the functionality of this class can be wrapped in an internal Stream object, accessible through the BaseStream property, and passed to classes that wrap or use streams.
The SerialPort class supports the following encodings: ASCIIEncoding, UTF8Encoding, UnicodeEncoding, UTF32Encoding, and any encoding defined in mscorlib.dll where the code page is less than 50000 or the code page is 54936. You can use alternate encodings, but you must use the ReadByte or Write method and perform the encoding yourself.
You use the GetPortNames method to retrieve the valid ports for the current computer.
If a SerialPort object becomes blocked during a read operation, do not abort the thread. Instead, either close the base stream or dispose of the SerialPort object.
Constructors
SerialPort() | Initializes a new instance of the SerialPort class. |
SerialPort(IContainer) | Initializes a new instance of the SerialPort class using the specified IContainer object. |
SerialPort(String) | Initializes a new instance of the SerialPort class using the specified port name. |
SerialPort(String, Int32) | Initializes a new instance of the SerialPort class using the specified port name and baud rate. |
SerialPort(String, Int32, Parity) | Initializes a new instance of the SerialPort class using the specified port name, baud rate, and parity bit. |
SerialPort(String, Int32, Parity, Int32) | Initializes a new instance of the SerialPort class using the specified port name, baud rate, parity bit, and data bits. |
SerialPort(String, Int32, Parity, Int32, StopBits) | Initializes a new instance of the SerialPort class using the specified port name, baud rate, parity bit, data bits, and stop bit. |
Fields
InfiniteTimeout | Indicates that no time-out should occur. |
Properties
BaseStream | Gets the underlying Stream object for a SerialPort object. |
BaudRate | Gets or sets the serial baud rate. |
BreakState | Gets or sets the break signal state. |
BytesToRead | Gets the number of bytes of data in the receive buffer. |
BytesToWrite | Gets the number of bytes of data in the send buffer. |
CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component) |
CDHolding | Gets the state of the Carrier Detect line for the port. |
Container | Gets the IContainer that contains the Component. (Inherited from Component) |
CtsHolding | Gets the state of the Clear-to-Send line. |
DataBits | Gets or sets the standard length of data bits per byte. |
DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
DiscardNull | Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer. |
DsrHolding | Gets the state of the Data Set Ready (DSR) signal. |
DtrEnable | Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication. |
Encoding | Gets or sets the byte encoding for pre- and post-transmission conversion of text. |
Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
Handshake | Gets or sets the handshaking protocol for serial port transmission of data using a value from Handshake. |
IsOpen | Gets a value indicating the open or closed status of the SerialPort object. |
NewLine | Gets or sets the value used to interpret the end of a call to the ReadLine() and WriteLine(String) methods. |
Parity | Gets or sets the parity-checking protocol. |
ParityReplace | Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs. |
PortName | Gets or sets the port for communications, including but not limited to all available COM ports. |
ReadBufferSize | Gets or sets the size of the SerialPort input buffer. |
ReadTimeout | Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish. |
ReceivedBytesThreshold | Gets or sets the number of bytes in the internal input buffer before a DataReceived event occurs. |
RtsEnable | Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication. |
Site | Gets or sets the ISite of the Component. (Inherited from Component) |
StopBits | Gets or sets the standard number of stopbits per byte. |
WriteBufferSize | Gets or sets the size of the serial port output buffer. |
WriteTimeout | Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish. |
Methods
Close() | Closes the port connection, sets the IsOpen property to false , and disposes of the internal Stream object. |
CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
DiscardInBuffer() | Discards data from the serial driver's receive buffer. |
DiscardOutBuffer() | Discards data from the serial driver's transmit buffer. |
Dispose() | Releases all resources used by the Component. (Inherited from Component) |
Dispose(Boolean) | Releases the unmanaged resources used by the SerialPort and optionally releases the managed resources. |
Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object) |
GetHashCode() | Serves as the default hash function. (Inherited from Object) |
GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
GetPortNames() | Gets an array of serial port names for the current computer. |
GetService(Type) | Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
GetType() | Gets the Type of the current instance. (Inherited from Object) |
InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
MemberwiseClone() | Creates a shallow copy of the current Object. (Inherited from Object) |
MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
Open() | Opens a new serial port connection. |
Read(Byte[], Int32, Int32) | Reads a number of bytes from the SerialPort input buffer and writes those bytes into a byte array at the specified offset. |
Read(Char[], Int32, Int32) | Reads a number of characters from the SerialPort input buffer and writes them into an array of characters at a given offset. |
ReadByte() | Synchronously reads one byte from the SerialPort input buffer. |
ReadChar() | Synchronously reads one character from the SerialPort input buffer. |
ReadExisting() | Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the SerialPort object. |
ReadLine() | Reads up to the NewLine value in the input buffer. |
ReadTo(String) | Reads a string up to the specified value in the input buffer. |
ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
Write(Byte[], Int32, Int32) | Writes a specified number of bytes to the serial port using data from a buffer. |
Write(Char[], Int32, Int32) | Writes a specified number of characters to the serial port using data from a buffer. |
Write(String) | Writes the specified string to the serial port. |
WriteLine(String) | Writes the specified string and the NewLine value to the output buffer. |
Events
DataReceived | Indicates that data has been received through a port represented by the SerialPort object. |
Disposed | Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component) |
ErrorReceived | Indicates that an error has occurred with a port represented by a SerialPort object. |
PinChanged | Indicates that a non-data signal event has occurred on the port represented by the SerialPort object. |
Security
SecurityPermission
for the ability to call unmanaged code. Associated enumeration: UnmanagedCode
for the ability to call unmanaged code. Associated enumeration: UnmanagedCode