Serial.readStringUntil()

Описание

readStringUntil() читает символы из буфера последовательного порта в String. Функция завершается при превышении тайм-аута (см. setTimeout()).

Serial.readStringUntil() наследуется от служебного класса Stream.

Синтаксис

Используйте следующую функцию, чтобы читать входящие данные с последовательного порта до тех пор, пока не будет найден символ-завершитель:

Serial.readStringUntil(terminator)

Параметры

Функция принимает следующие объекты и параметры:

Serial: объект последовательного порта. Список доступных последовательных портов для каждой платы см. на главной странице Serial.
terminator: символ, который нужно искать. Допустимые типы данных: char.

Возвращаемое значение

Функция возвращает всю String, прочитанную из буфера последовательного порта, вплоть до символа-завершителя. Если символ-завершитель не найден или перед ним нет данных, функция вернёт NULL.

Пример кода

Следующий код читает входящие данные с последовательного порта до получения символа новой строки:

void setup() {
  Serial.begin(9600);
  while (!Serial);

  Serial.println("Enter a word and press Enter:");
}

void loop() {
  if (Serial.available()) {
    String input = Serial.readStringUntil('\n');  // читать до символа новой строки
    Serial.print("You entered: ");
    Serial.println(input);
  }
}

Примечания и предупреждения

Примечание

Символ-завершитель отбрасывается из буфера последовательного порта. Если символ-завершитель не найден, все прочитанные символы будут отброшены.