HardwareSerial::available()

概要

Serial.available()/HardwareSerial::available()は、シリアル通信の受信バッファ内の有効な文字数を返します。リファレンスはこちら}。

ソースコード

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

1
2
3
4

int HardwareSerial::available(void)
{
  return ((unsigned int)(SERIAL_RX_BUFFER_SIZE + _rx_buffer_head - _rx_buffer_tail)) % SERIAL_RX_BUFFER_SIZE;
}

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

1
2

int HardwareSerial::available(void)
{

バッファ内の有効な文字数を計算して返却します。

3
4

  return ((unsigned int)(SERIAL_RX_BUFFER_SIZE + _rx_buffer_head - _rx_buffer_tail)) % SERIAL_RX_BUFFER_SIZE;
}

rx_buffer_tail < rx_buffer_head の場合、rx_buffer_head - rx_buffer_tail がバッファ内の有効な文字数です。これにSERIAL_RX_BUFFER_SIZEを足すと、SERIAL_RX_BUFFER_SIZE分文字数が大きくなりますが、SEIRIAL_RX_BUFFER_SIZEで割った余りを求めることで、本来必要なrx_buffer_head-rx_buffer_tailに戻ります。

rx_buffer_tail > rx_buffer_head の場合、rx_buffer_head + SERIAL_BUFFER_SIZE - rx_buffer_tail がバッファ内の有効な文字数です。有効な文字数はSERIAL_RX_BUFFER_SIZEを超えることはないので、SERIAL_RX_BUFFER_SIZEで割った余りは変わりません。

わかりづらい場合は、SERIAL_BUFFER_SIZEを仮に100とかにして考えてみると比較的簡単だと思います。

バージョン

Arduino AVR Boards 1.8.6

ライセンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

/*
  Copyright (c) 2016 garretlab.
  Added source code explanation by garretlab.
*/

/*
  HardwareSerial.cpp - Hardware serial library for Wiring
  Copyright (c) 2006 Nicholas Zambetti.  All right reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

  Modified 23 November 2006 by David A. Mellis
  Modified 28 September 2010 by Mark Sproul
  Modified 14 August 2012 by Alarus
  Modified 3 December 2013 by Matthijs Kooijman
*/

最終更新日

July 31, 2025

inserted by FC2 system