Arduino Serial Read String Until with ReadStringUntil Function Example

Arduino Serial Read String Until Function – Serial.readStringUntil

• Arduino Serial readStringUntil Function reads the serial port into the string variable, until it receive the terminating character.
• By default the readStringUntil function wait for terminating character or timeout to complete.
• The Serial.readStringUntil() function wait for timeout, which is one second by default.
• If the terminating character is not received within timeout time, the readStringUntil function terminate because of timeout event also.
• You can consider the terminating character as command end symbol, like in c language compiler look for “;” for end of statement.

Serial.readStringUntil() function is useful in copy all the received data in the String variable, for further analysis or testing the command received.

Arduino Serial readStringUntil Code Syntax

Ones the data is available in the string variable we can use functions for further analysis, like indexOf() function to search the particular word is exist or not.

The readString function return the String data type. The function terminate after timeout, or by receiving Newline.

We will use serial monitor tool available in the Arduino IDE to send the string to the Arduino board.

Arduino Serial Read String Until Example – ReadStringUntil

In the project program we will send some characters from serial monitor terminal and all are return back with Serial.println() function.

/*
    Serial.readStringUntil() function test code.
	Author: Nilesh Chaurasia
    https://elextutorial.com
*/
void setup() 
{
	Serial.begin(9600); // Set the baud rate to 9600
	
}
void loop() 
{
	String s1 = Serial.readStringUntil('\n');// s1 is String type variable.
	Serial.print("Received Data => ");
	Serial.println(s1);//display same received Data back in serial monitor.
	delay(500);
}   
				 

Application of ReadStringUntil in Project

In this example project we will control the LED connected on pin 13, with “on” and “off” command from serial monitor.

/*
    Serial.readString() program to control the LED from command "on" / "off".
	Author: Nilesh Chaurasia
    https://elextutorial.com
*/
void setup() 
{
	Serial.begin(9600); // Set the baud rate to 9600
	pinMode(13,OUTPUT);
}
void loop() 
{
	String s1 = Serial.readStringUntil('\n');// s1 is String type variable.
	Serial.print("Received Data => ");
	Serial.println(s1);//display same received Data back in serial monitor.
	if(s1.indexOf("on")>=0)
	{
		digitalWrite(13,HIGH);
	}
	if(s1.indexOf("off")>=0){
		digitalWrite(13,LOW);
	}
	delay(100);
}