HardwareSerial::read()

概要

Serial.read()/HardwareSerial::read()は、シリアル通信の受信用バッファから文字を読み出します。リファレンスはこちら}。

ソースコード

HardwareSerial::read()は、hardware/arduino/avr/cores/arduino/HardwareSerial.cppに定義されています。以下に全ソースコードを示します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


int HardwareSerial::read(void)
{
  // if the head isn't ahead of the tail, we don't have any characters
  if (_rx_buffer_head == _rx_buffer_tail) {
    return -1;
  } else {
    unsigned char c = _rx_buffer[_rx_buffer_tail];
    _rx_buffer_tail = (rx_buffer_index_t)(_rx_buffer_tail + 1) % SERIAL_RX_BUFFER_SIZE;
    return c;
  }
}

入力はありません。戻り値はintです。

1
2


int HardwareSerial::read(void)
{

受信バッファのheadとtailが同じ場合は、何も受信していないので、-1を返します。

3
4
5
6


// if the head isn't ahead of the tail, we don't have any characters
if (_rx_buffer_head == _rx_buffer_tail) {
  return -1;
} else {

そうでない場合(headとtailが異なる場合)は、一番古いデータ(buffer[tail]に格納されています)を読み出し、tailを一つ進めます。そして、読み出したデータを返却します。

 6
 7
 8
 9
10
11


} else {
    unsigned char c = _rx_buffer[_rx_buffer_tail];
    _rx_buffer_tail = (rx_buffer_index_t)(_rx_buffer_tail + 1) % SERIAL_RX_BUFFER_SIZE;
    return c;
  }
}

受信バッファはリングバッファなので、バッファの最後に到達したときには先頭に戻します。このため、tailに1を足した後、バッファのサイズ(SERIAL_RX_BUFFER_SIZE)で割った余りを代入しています。

受信したデータをリングバッファに格納するのは、USART_RX_vectという割り込みルーチンで実装しています。

バージョン

Arduino AVR Boards 1.8.6

最終更新日

March 21, 2023