最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

serialport

シリアル ポートへの接続

説明

serialport オブジェクトは、シリアル ポートと通信するためのシリアル クライアントを表します。オブジェクトの作成後、ドット表記を使用してプロパティを設定します。

作成

構文

s = serialport(port,baudrate)

s = serialport(port,baudrate,Name,Value)

s = serialport

説明

s = serialport(port,baudrate) は、port で指定されたシリアル ポートにボー レート baudrate で接続します。

s = serialport(port,baudrate,Name,Value) はシリアル ポートに接続し、オプションの名前と値のペアを使用して追加のプロパティを設定します。

引数のない s = serialport は、最後にクリアした serialport オブジェクト インスタンスのプロパティ設定を使用してシリアル ポートに接続します。保持されるプロパティは、Port、BaudRate、ByteOrder、FlowControl、StopBits、DataBits、Parity、Timeout および Terminator です。プロパティを参照してください。

入力引数

port — シリアル ポート名

string | char

シリアル ポート名。string または文字ベクトルとして指定します。接続されているポートのリストを取得するには、serialportlist を使用します。

例: "COM2"

baudrate — ボー レート

double

シリアル通信のボー レート。double として指定します。

例: 9600

名前と値のペアの引数

オプションの Name,Value の引数ペアをコンマ区切りで指定します。Name は引数名で、Value は対応する値です。Name は引用符で囲まなければなりません。Name1,Value1,...,NameN,ValueN のように、複数の名前と値のペアの引数を任意の順序で指定できます。

名前と値のペアを使用して、DataBits、Parity、StopBits、FlowControl、ByteOrder および Timeout オブジェクトのプロパティを設定できます。これらのデータ型と指定可能な値については、プロパティを参照してください。

例: "Timeout",30

プロパティ

Port — 接続用シリアル ポート

string

このプロパティは読み取り専用です。

接続用シリアル ポート。string または文字ベクトルとして返されます。

例: "COM1"

データ型: string

BaudRate — 通信速度

double

通信速度 (bit/s)。double の正の整数として返されます。

例: 14400

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Parity — パリティ

"none" (既定値) | "even" | "odd"

データが失われたか書き込まれたかをチェックするためのパリティ。"none"、"even" または "odd" として返されます。

例: "odd"

データ型: char | string

DataBits — データの 1 文字を表すビット数

8 (既定値) | 7 | 6 | 5

データの 1 文字を表すビット数。8、7、6 または 5 として返されます。

例: 8

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

StopBits — 1 文字の終わりを示すビットのパターン

1 (既定値) | 1.5 | 2

1 文字の終わりまたは伝送全体の終わりを示すビットのパターン。1、1.5 または 2 として返されます。

例: 1

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

FlowControl — データ伝送速度の管理モード

"none" (既定値) | "hardware" | "software"

データ伝送速度の管理モード。"none"、"hardware" または "software" として返されます。

例: "software"

データ型: char | string

ByteOrder — バイト順

"little-endian" (既定値) | "big-endian"

大きい数値に複数のバイトを配置する順序。"little-endian" または "big-endian" として返されます。

例: "little-endian"

データ型: char | string

Timeout — 操作完了までの許容時間

10 (既定値) | 数値

読み取り操作と書き込み操作の完了までの許容時間 (秒単位)。数値として返されます。

例: 60

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

NumBytesAvailable — 読み込みに使用できるバイト数

数値

このプロパティは読み取り専用です。

読み取り可能なバイト数。数値として返されます。

例: 1024

データ型: double

NumBytesWritten — シリアル ポートに書き込まれるバイト数

0 (既定値) | 数値

このプロパティは読み取り専用です。

シリアル ポートに書き込まれるバイト数。数値として返されます。

例: 512

データ型: double

Terminator — 行の終端文字

"LF" (既定値) | "CR" | "CR/LF"

読み取り行および書き込み行の終端文字。"LF"、"CR" または "CR/LF" として返されます。このプロパティは、関数 configureTerminator (Instrument Control Toolbox) を使用して設定します。

例: "CR"

データ型: char | string

BytesAvailableFcn — コールバック関数で使用できるバイト数

関数ハンドル

使用可能なバイト数のコールバック関数。関数ハンドルとして返されます。コールバックは、特定のバイト数または終端子を受信することによりトリガーされます。このプロパティは、関数 configureCallback (Instrument Control Toolbox) を使用して設定します。

例: @myFun

データ型: function_handle

BytesAvailableFcnCount — コールバックをトリガーするデータのバイト数

64 (既定値) | 数値

コールバックをトリガーするデータのバイト数。double として返されます。この値は、BytesAvailableFcnMode プロパティが "byte" である場合にのみ使用されます。これらのプロパティは、関数 configureCallback (Instrument Control Toolbox) を使用して設定します。

例: 128

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

BytesAvailableFcnMode — コールバックのトリガー モードで使用できるバイト数

"off" (既定値) | "byte" | "terminator"

使用可能なバイト数のコールバック トリガー モード。"off"、"byte" または "terminator" として返されます。この設定は、コールバックがオフか、バイト数によってトリガーされるか、または終端子によってトリガーされるかを決定します。このプロパティは、関数 configureCallback (Instrument Control Toolbox) を使用して設定します。

例: "off"

データ型: char | string

ErrorOccurredFcn — エラーによりトリガーされるコールバック関数

関数ハンドル

エラーによりトリガーされるコールバック関数。関数ハンドルとして返されます。

例: @myErrFun

データ型: function_handle

UserData — ユーザー データの汎用プロパティ

任意のタイプ

ユーザー データの汎用プロパティ。任意の型として返されます。

例: datetime()

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical | char | string | struct | table | cell | function_handle | categorical | datetime | duration | calendarDuration | fi
複素数のサポート: あり

オブジェクト関数

read	シリアル ポートからのデータの読み取り
readline	シリアル ポートからの ASCII 文字列データ行の読み取り
write	シリアル ポートへのデータの書き込み
writeline	シリアル ポートへの ASCII データ行の書き込み
flush	シリアル ポート バッファーのフラッシュ
configureTerminator	シリアル ポートでの ASCII 文字列通信の終端子を設定
configureCallback	シリアル ポートのコールバック関数とトリガーの設定
getpinstatus	シリアル ピンのステータスの取得
setRTS	シリアル RTS ピンをセット
setDTR	シリアル DTR ピンをセット

例

シリアル ポートからのデータの読み取り

COM3 シリアル ポートから uint32 データ値を 16 個読み取ります。

s = serialport("COM3",9600,"Timeout",5);
data = read(s,16,"uint32");

参考

関数

• serialportlist

R2019b で導入