UART (Base class)

(2016.2.20 Created) 

　マイコンごとの実装は各ページの詳細を見てください(STM32, Arduino)。ここでは共通の利用方法を示します。

For specific microcomputer, please refer each pages (STM32, Arduino). Here is shown common usage. 

使用法 / Usage

初期化 / Initialize

　インスタンス作成後フォーマットを指定してください。送信だけであればこの直後から送信可能です。受信も行う場合はstartToReadコマンドを発行してください。

Please set format after creating the instance. If only use transmit, it was done. If need to receive, call startToReading.

送信 / Transmit

 "wirte"コマンドを使用してください。　/ call "write"

受信 / Receive

Nバイト読む場合バッファにNバイトたまるのを待ってから読みだしてください。

To read N bytes, wait until N bytes stored in the buffer.

Command Reference

列挙型 / Enumaration type

Parity Parity_Even, Parity_Odd, Parity_None
StopBits StopBits_None, StopBits_One, StopBits_OnePointFive, StopBits_Two

通信フォーマットを指定する / Set format

Declaration

void setFormat(const uint32_t &BaudRate,

                       const Parity &parity,

                       const StopBits &stopBits)

Return

None

Parameter

BaudRate

 

通信速度 / Baud rate

parity

Parity

stopBits

Size of StopBits

備考

Arduinoの場合Parity, stopBitsは無視されます。

In case of Arduino, parity and stopBits are ignored.

タイムアウトを設定 / Set Timeout

Declaration

void setTimeout(const uint16_t &ReadTimeOut,

                        const uint16_t &WriteTimeOut)

Return なし / None
Parameter ReadTimeOut

Timeout to read

WriteTimeOut

Timeout to write

Remarks

Arduinoの場合機能しません

In case of Arduino, this command do nothing.

受信開始・終了 / Start, end reading

Declaration

void startToRead();

 

void stopReading();

Return なし / None
Parameter なし / None
Remarks

Arduinoの場合機能しません

In case of Arduino, this command do nothing.

受信バッファサイズを得る / Get receive buffer size

Declaration

uint16_t GetRecvBufferSize() const

Return バッファサイズ / Buffer size
Parameter なし / None
Remarks  

1バイト読み込み / Read a byte

Declaration

uint8_t read() const

Return Read value
Parameter なし / None
Remarks  

読み込み / Read

Declaration

void read(uint8_t buff[], const uint32_t &length) const

Return なし / None
Parameter buff

データ / data to read

呼び込む前に領域確保が必要

Must allocate before calling.

length 読み込む長さ / length to read

 

Remarks  

送信 / Write

Declaration

void write(const uint8_t &c) const;

void write(const uint8_t buff[],

               const uint32_t &length) const;

void write(const char *str) const;

Return なし / None
Parameter *

データ / data to write

Remarks  

送信完了待ち / wait transfer complete

Declaration

void WaitUntilTransferCplt() const

Return なし / None
Parameter なし / None
Remarks