HardwareSerial::available()

Abstract

The Serial.available()/HardwareSerial::available() returns how many bytes can be written to receive buffer of serial communication.

Source Code

The HardwareSerial::available is defined in hardware/arduino/avr/cores/arduino/HardwareSerial.cpp as below.

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;
}

No input, returns int.

1
2


int HardwareSerial::available(void)
{

Calculate the number of available bytes in the buffer.

3
4


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

In case of rx_buffer_tail < rx_buffer_head, rx_buffer_head - rx_buffer_tail is the available bytes in the buffer. Adding SERIAL_RX_BUFFER_SIZE to the result, it will SERIAL_RX_BUFFER_SIZE more than the result. To get the answer, calculate the division reminder by SERIAL_RX_BUFFER_SIZE, then get rx_buffer_head-rx_buffer_tail.

In case of rx_buffer_tail > rx_buffer_head, rx_buffer_head + SERIAL_BUFFER_SIZE - rx_buffer_tail is the available bytes in the buffer. As the valid available bytes dose not exceed SERIAL_RX_BUFFER_SIZE, the result of reminder is not changed.

If it is difficult to understand, assuming SERIAL_BUFFER_SIZE something like 100, may ease the problem.

Version

Arduino AVR Boards 1.8.6

License

 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) 2019 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
*/

Last Update

August 25, 2019