シリアル通信 More...

#include <Serial.hpp>

Public Types
enum	ByteSize : uint8 { ByteSize::FiveBits = 5, ByteSize::SixBits = 6, ByteSize::SevenBits = 7, ByteSize::EightBits = 8 }
	バイトサイズ More...

enum	Parity : uint8 { Parity::None_ = 0, Parity::Odd = 1, Parity::Even = 2, Parity::Mark = 3, Parity::Space = 4 }
	パリティ More...

enum	StopBits : uint8 { One = 1, Two = 2, OnePointFive }
	ストップビット More...

enum	FlowControl : uint8 { FlowControl::None_, FlowControl::Software, FlowControl::Hardware }
	Flow Control. More...

Public Member Functions
SIV3D_NODISCARD_CXX20	Serial ()
	デフォルトコンストラクタ More...

SIV3D_NODISCARD_CXX20	Serial (StringView port, int32 baudrate=9600, ByteSize byteSize=ByteSize::EightBits, Parity parity=Parity::None_, StopBits stopBits=StopBits::One, FlowControl flowControl=FlowControl::None_)
	シリアルポートに接続します。 More...

	~Serial ()
	デストラクタ More...

bool	open (StringView port, int32 baudrate=9600, ByteSize byteSize=ByteSize::EightBits, Parity parity=Parity::None_, StopBits stopBits=StopBits::One, FlowControl flowControl=FlowControl::None_)
	シリアルポートに接続します。 More...

void	close ()
	シリアルポートとの接続を切断します。 More...

bool	isOpen () const
	シリアルポートに接続されているかを返します。 More...

	operator bool () const
	シリアルポートに接続されているかを返します。 More...

int32	baudrate () const noexcept
	ボーレートを返します。 More...

const String &	port () const noexcept
	シリアルポートの名前を返します。 More...

size_t	available ()
	受信済みで読み込み可能なデータのサイズ（バイト）を返します。 More...

void	clearInput ()
	読み込みバッファを消去します。 More...

void	clearOutput ()
	書き込みバッファを消去します。 More...

void	clear ()
	読み込みバッファと書き込みバッファを消去します。 More...

size_t	read (void *dst, size_t size)
	受信したデータを読み込みます。 More...

Array< uint8 >	readBytes ()
	受信したデータを読み込みます。 More...

bool	readBytes (Array< uint8 > &dst)
	受信したデータを読み込みます。 More...

SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool	read (TriviallyCopyable &to)
	受信したデータを読み込みます。 More...

size_t	write (const void *src, size_t size)
	バイナリデータを書き込みます。 More...

bool	writeByte (uint8 byte)
	1 バイトのデータを書き込みます。 More...

bool	writeByte (Byte byte)
	1 バイトのデータを書き込みます。 More...

SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool	write (const TriviallyCopyable &from)
	バイナリデータを書き込みます。 More...

void	setRTS (bool level)
	RTS ハンドシェイクの状態を変更します。 More...

void	setDTR (bool level)
	DTR ハンドシェイクの状態を変更します。 More...

bool	waitForChange ()
	CTS, DSR, RI, CD の変更、もしくは何らかの割り込みまで待機します。 More...

bool	getCTS ()
	CTS の状態を返します。 More...

bool	getDSR ()
	DSR の状態を返します。 More...

bool	getRI ()
	RI の状態を返します。 More...

bool	getCD ()
	CD の状態を返します。 More...

Detailed Description

シリアル通信

Member Enumeration Documentation

◆ ByteSize

enum s3d::Serial::ByteSize : uint8

strong

バイトサイズ

Enumerator
FiveBits
SixBits
SevenBits
EightBits

◆ FlowControl

enum s3d::Serial::FlowControl : uint8

strong

Flow Control.

Enumerator
None_
Software
Hardware

◆ Parity

enum s3d::Serial::Parity : uint8

strong

パリティ

Enumerator
None_
Odd
Even
Mark
Space

◆ StopBits

enum s3d::Serial::StopBits : uint8

ストップビット

Enumerator
One
Two
OnePointFive

Constructor & Destructor Documentation

◆ Serial() [1/2]

SIV3D_NODISCARD_CXX20 s3d::Serial::Serial ( )

デフォルトコンストラクタ

◆ Serial() [2/2]

SIV3D_NODISCARD_CXX20 s3d::Serial::Serial	(	StringView	port,
		int32	baudrate = `9600`,
		ByteSize	byteSize = `ByteSize::EightBits`,
		Parity	parity = `Parity::None_`,
		StopBits	stopBits = `StopBits::One`,
		FlowControl	flowControl = `FlowControl::None_`
	)

explicit

シリアルポートに接続します。

Parameters

port	シリアルポートの名前
baudrate	ボーレート
byteSize	バイトサイズ
parity	パリティ
stopBits	ストップビット
flowControl	Flow Control

Remarks: シリアルポートの名前は System::EnumerateSerialPorts() で列挙できます。

◆ ~Serial()

s3d::Serial::~Serial ( )

デストラクタ

Remarks: シリアルポートに接続している場合は切断します。

Member Function Documentation

◆ available()

size_t s3d::Serial::available ( )

受信済みで読み込み可能なデータのサイズ（バイト）を返します。

Returns: 読み込み可能なデータのサイズ（バイト）

◆ baudrate()

int32 s3d::Serial::baudrate ( ) const

noexcept

ボーレートを返します。

Returns: ボーレート

◆ clear()

void s3d::Serial::clear ( )

読み込みバッファと書き込みバッファを消去します。

◆ clearInput()

void s3d::Serial::clearInput ( )

読み込みバッファを消去します。

◆ clearOutput()

void s3d::Serial::clearOutput ( )

書き込みバッファを消去します。

◆ close()

void s3d::Serial::close ( )

シリアルポートとの接続を切断します。

◆ getCD()

bool s3d::Serial::getCD ( )

CD の状態を返します。

Returns: CD の状態

◆ getCTS()

bool s3d::Serial::getCTS ( )

CTS の状態を返します。

Returns: CTS の状態

◆ getDSR()

bool s3d::Serial::getDSR ( )

DSR の状態を返します。

Returns: DSR の状態

◆ getRI()

bool s3d::Serial::getRI ( )

RI の状態を返します。

Returns: RI の状態

◆ isOpen()

bool s3d::Serial::isOpen ( ) const

シリアルポートに接続されているかを返します。

Returns: 接続されている場合 true, それ以外の場合は false

◆ open()

bool s3d::Serial::open	(	StringView	port,
		int32	baudrate = `9600`,
		ByteSize	byteSize = `ByteSize::EightBits`,
		Parity	parity = `Parity::None_`,
		StopBits	stopBits = `StopBits::One`,
		FlowControl	flowControl = `FlowControl::None_`
	)

シリアルポートに接続します。

Parameters

port	シリアルポートの名前
baudrate	ボーレート
byteSize	バイトサイズ
parity	パリティ
stopBits	ストップビット
flowControl	Flow Control

Remarks: シリアルポートの名前は System::EnumerateSerialPorts() で列挙できます。

Returns: 接続に成功した場合 true, それ以外の場合は false

◆ operator bool()

s3d::Serial::operator bool ( ) const

explicit

シリアルポートに接続されているかを返します。

Remarks: isOpen() と同じです。

Returns: 接続されている場合 true, それ以外の場合は false

◆ port()

const String& s3d::Serial::port ( ) const

noexcept

シリアルポートの名前を返します。

Returns: シリアルポートの名前

◆ read() [1/2]

SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool s3d::Serial::read ( TriviallyCopyable & to )

受信したデータを読み込みます。

Template Parameters

TriviallyCopyable 読み込む値の型

Parameters

to 読み込み先

Returns: 読み込みに成功した場合 true, それ以外の場合は false

◆ read() [2/2]

size_t s3d::Serial::read	(	void *	dst,
		size_t	size
	)

受信したデータを読み込みます。

Parameters

dst	読み込み先
size	読み込むサイズ（バイト）

Returns: 実際に読み込んだサイズ（バイト）

◆ readBytes() [1/2]

Array<uint8> s3d::Serial::readBytes ( )

受信したデータを読み込みます。

Returns: 読み込んだデータ

◆ readBytes() [2/2]

bool s3d::Serial::readBytes ( Array< uint8 > & dst )

受信したデータを読み込みます。

Parameters

dst 読み込み先

Returns: 読み込みに成功した場合 true, それ以外の場合は false

◆ setDTR()

void s3d::Serial::setDTR ( bool level )

DTR ハンドシェイクの状態を変更します。

Parameters

level on にする場合 true, off にする場合 false

Remarks: デフォルトでは on です。

◆ setRTS()

void s3d::Serial::setRTS ( bool level )

RTS ハンドシェイクの状態を変更します。

Parameters

level on にする場合 true, off にする場合 false

Remarks: デフォルトでは on です。

◆ waitForChange()

bool s3d::Serial::waitForChange ( )

CTS, DSR, RI, CD の変更、もしくは何らかの割り込みまで待機します。

Returns: 変更があった場合は true, それ以外の何かが起こった場合は false

◆ write() [1/2]

SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool s3d::Serial::write ( const TriviallyCopyable & from )

バイナリデータを書き込みます。

Template Parameters

TriviallyCopyable 書き込む値の型

Parameters

from 書き込むデータ

Returns: 書き込みに成功した場合 true, それ以外の場合は false

◆ write() [2/2]

size_t s3d::Serial::write	(	const void *	src,
		size_t	size
	)

バイナリデータを書き込みます。

Parameters

src	書き込むデータの先頭ポインタ
size	書き込むデータのサイズ（バイト）

Returns: 書き込みに成功したバイト数

◆ writeByte() [1/2]

bool s3d::Serial::writeByte ( Byte byte )

1 バイトのデータを書き込みます。

Parameters

byte 書き込むデータ

Returns: 書き込みに成功した場合 true, それ以外の場合は false

◆ writeByte() [2/2]

bool s3d::Serial::writeByte ( uint8 byte )

1 バイトのデータを書き込みます。

Parameters

byte 書き込むデータ

Returns: 書き込みに成功した場合 true, それ以外の場合は false

The documentation for this class was generated from the following file:

OpenSiv3D/Siv3D/include/Siv3D/Serial.hpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ByteSize

◆ FlowControl

◆ Parity

◆ StopBits

Constructor & Destructor Documentation

◆ Serial() [1/2]

◆ Serial() [2/2]

◆ ~Serial()

Member Function Documentation

◆ available()

◆ baudrate()

◆ clear()

◆ clearInput()

◆ clearOutput()

◆ close()

◆ getCD()

◆ getCTS()

◆ getDSR()

◆ getRI()

◆ isOpen()

◆ open()

◆ operator bool()

◆ port()

◆ read() [1/2]

◆ read() [2/2]

◆ readBytes() [1/2]

◆ readBytes() [2/2]

◆ setDTR()

◆ setRTS()

◆ waitForChange()

◆ write() [1/2]

◆ write() [2/2]

◆ writeByte() [1/2]

◆ writeByte() [2/2]