nanoFramework.System.IO.Ports 1.1.86

欢迎使用.NET nanoFramework System.IO.Ports库存储库

构建状态

组件	构建状态	NuGet包
System.IO.Ports

使用方法

您可以在测试中找到详细的示例。

创建SerialPort

您可以通过以下方式创建SerialPort

var port = new SerialPort("COM2");

请注意，端口号必须为COMx，其中x是一个数字。

GetPortNames方法将为您提供可用端口的列表

var ports = SerialPort.GetPortNames();

您还可以在构造函数中直接指定波特率和其他元素

var port = new SerialPort("COM2", 115200);

每个属性都可以调整，包括端口打开时。请注意，这可能会产生危险的行为。建议在端口关闭时更改属性。

重要：您应该为读写操作设置超时。如果没有设置，读或写周期可能导致线程无限期锁定。

port.WriteTimeout = 1000;
port.ReadTimeout = 1000;

注意：即使您可以在构造函数中设置它们，某些MCU也不支持握手或特定位奇偶校验。

打开和关闭端口

《SerialPort》只允许在开启时运行，关闭时结束所有操作。在释放时，不管是否有正在进行的接收或发送操作，《SerialPort》都会执行关闭操作。

var port = new SerialPort("COM2");
port.Open();
// Do a lot of things here, write, read
port.Close();

读写操作

您有多种读写函数，一些与字节相关，一些与字符串相关。请注意，字符串函数将使用UTF8 编码 字符集。

发送和接收字节

发送和读取字节数组的示例

byte[] toSend = new byte[] { 0x42, 0xAA, 0x11, 0x00 };
byte[] toReceive = new byte[50];
// this will send the 4 bytes:
port.Write(toSend, 0, toSend.Length);
// This will only send the bytes AA and 11:
port.Write(toSend, 1, 2);
// This will check then number of available bytes to read
var numBytesToRead = port.BytesToRead;
// This will read 50 characters:
port.Read(toReceive, 0, toReceive.Length);
// this will read 10 characters and place them at the offset position 3:
port.Read(toReceive, 3, 10);
// Note: in case of time out while reading or writing, you will receive a TimeoutException
// And you can as well read a single byte:
byte oneByte = port.ReadByte();

发送和接收字符串

示例

string toSend = "I ❤ nanoFramework";
port.WriteLine(toSend);
// this will send the string encoded finishing by a new line, by default `\n`
// You can change the new line to be anything:
port.NewLine = "❤❤";
// Now it will send 2 hearts as the line ending `WriteLine` and will use 2 hearts as the terminator for `ReadLine`.
// You can change it back to the `\n` default at anytime:
port.NewLine = SerialPort.DefaultNewLine; // default is "\n"
// This will read the existing buffer:
string existingString = port.ReadExisting();
// Note that if it can't properly convert the bytes to a string, you'll get an exception
// This will read a full line, it has to be terminated by the NewLine string.
// If nothing is found ending by the NewLine in the ReadTimeout time frame, a TimeoutException will be raised.
string aFullLine = port.ReadLine();

事件

字符

当接收到字符时，《SerialPort》支持事件。

    // Subscribe to the event
    port.DataReceived += DataReceivedNormalEvent;

    // When you're done, you can as well unsubscribe
    port.DataReceived -= DataReceivedNormalEvent;

private void DataReceivedNormalEvent(object sender, SerialDataReceivedEventArgs e)
{
    var ser = (SerialPort)sender;
    // Now you can check how many characters are available, read a line for example
    var numBytesToRead = port.BytesToRead;
    string aFullLine = ser.ReadLine();
}

WatchChar

.NET nanoFramework有一个监视传输期间是否存在特定字符的自定义API事件。

    port.WatchChar = '\r';
    // Subscribe to the event
    port.DataReceived += DataReceivedNormalEvent;

private void DataReceivedNormalEvent(object sender, SerialDataReceivedEventArgs e)
{
    if (e.EventType == SerialData.WatchChar)
    {
        // The specified character was detected when reading from the serialport.
    }
}

反馈和文档

有关文档、提供反馈、问题以及了解如何贡献，请参阅首页仓库。

加入我们的Discord社区这里。

致谢

该项目贡献者的列表可在CONTRIBUTORS中找到。

许可协议

nanoFramework 类库采用MIT 许可协议。

行为准则

本项目采用了贡献者公约中定义的行为准则，以阐明我们社区中预期的行为。更多信息请参阅.NET Foundation 行为准则。

.NET Foundation

本项目得到了.NET Foundation的支持。