FAQ

FAQ

What is ANSITerm for?

Building simple text user interfaces on a serial or network terminal from Arduino-class boards — menus, status panels, teaching demos, and small games.

Do I need a special display?

No. Your computer screen (via a terminal program) is the display. The board only sends text and control codes.

Is this the same as the Arduino Serial Monitor?

Related, but different. Serial Monitor is great for println debugging. ANSITerm expects a terminal that understands colors and cursor movement. See Choosing a Terminal Program.

Which example should I run first?

Basic, then Buttons.

Does mouse support always work?

No. Plan on keyboard controls. Mouse is a bonus when the terminal supports it.

Can I use this on ESP32?

Yes. Serial examples work, and there are dedicated network / Wi‑Fi control demos.

Is the “network terminal” example real SSH?

No. It is plain TCP (telnet-style) on port 23. The old name “SSH” was misleading and the example was renamed.

Can I sell products that use ANSITerm?

The library is licensed under LGPL-3.0. Read LICENSE.txt or ask a lawyer for your situation — this wiki is not legal advice.

How do I report a bug?

Use the Bug report form. Include library version, board, terminal, and steps.

Where is the technical API reference?

Start with comments in ANSITerm.h and the example sketches in the repository. This wiki stays focused on user-facing how-to.