Toggle Input

WebSerial Pro lets you enable or disable the command input bar of the terminal from your firmware. Use it to prevent user interaction during critical operations, such as a firmware update, or to make the terminal permanently read-only.

User input is enabled by default.

Disable user inputCopy Anchor Link

WebSerial.disableInput();

While input is disabled, messages received from the terminal are ignored and the onMessage() callback is not invoked.

Enable user inputCopy Anchor Link

WebSerial.enableInput();

Set the input stateCopy Anchor Link

setInput() enables or disables the input bar from a boolean value:

WebSerial.setInput(false);

NotesCopy Anchor Link

• The input state is sent to the browser when the terminal connects. Reload the terminal page to see a change made while the page is open.