https://github.com/smfsw/serialterminal

Arduino Hardware Serial Terminal (for processing of serial communication)
https://github.com/smfsw/serialterminal

arduino arduino-library communication ihm serial

Last synced: about 2 months ago
JSON representation

Arduino Hardware Serial Terminal (for processing of serial communication)

• Host: GitHub
• URL: https://github.com/smfsw/serialterminal
• Owner: SMFSW
• License: bsd-3-clause
• Created: 2017-03-25T15:19:32.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-04-30T21:33:21.000Z (about 1 year ago)
• Last Synced: 2025-04-30T22:33:18.009Z (about 1 year ago)
• Topics: arduino, arduino-library, communication, ihm, serial
• Language: C++
• Size: 255 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# SerialTerminal

[![author](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/SMFSW/a9a2b2a02fda1b33461d53ddfe69d649/raw/auth_SMFSW.json)](https://github.com/SMFSW)

![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/SMFSW/a9a2b2a02fda1b33461d53ddfe69d649/raw/SerialTerminal_status_badge.json)

[![license](https://img.shields.io/badge/License-BSD3-darkred.svg)](LICENSE)

[![CodeFactor](https://www.codefactor.io/repository/github/smfsw/seqtimer/badge)](https://www.codefactor.io/repository/github/smfsw/serialterminal)

![platform](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/SMFSW/a9a2b2a02fda1b33461d53ddfe69d649/raw/platform_INO.json)

[![doxy](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/SMFSW/a9a2b2a02fda1b33461d53ddfe69d649/raw/tool_DOXY.json)](https://smfsw.github.io/SerialTerminal)

[![re_note](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/SMFSW/a9a2b2a02fda1b33461d53ddfe69d649/raw/tool_RN.json)](ReleaseNotes.md)

Arduino Hardware Serial Terminal

Arduino Hardware Serial Terminal (low level), sending complete sequence to function for processing it (mainly for user input)

## Usage

- Declare a function of type `void (*func)(String)` for message processing

- Initialize terminal with `term.init(uint32_t speed, void (*processing)(String)=NULL, String * title=NULL, String * ver=NULL, int msg_size=64)`

  - `speed`: terminal baud rate

  - `processing`: pointer to message processing function

  - `title`: pointer to terminal title String

  - `ver`: pointer to version String

  - `msg_size`: maximum serial input size

- messages will be passed to `func` for processing when breakout char (default being ';') occurs or max size is reached

- Other methods:

  - `term.setBreakoutChar()`: change breakout character

  - `term.getBreakoutChar()`: get actual breakout character

## Examples included

- [ParrotTerminal.ino](examples/ParrotTerminal/ParrotTerminal.ino): Writes back terminal entries to terminal

- [SetLEDTerm.ino](examples/SetLEDTerm/SetLEDTerm.ino): Set onboard LED state through serial terminal