yaq-yeps/306

uses-serial

Abstract ¶

This YEP defines the uses-serial trait for hardware which communicates over a serial bus. See built documentation at at yaq.fyi.

Table of Contents ¶

Motivation ¶

Serial communication is one of the most common communication formats for hardware. This provides a common interface for hardware which communicates in similar fashions.

Definition ¶

message: direct_serial_write ¶

• Parameter: message (bytes)

This provides a debugging tool to directly write bytes onto the serial bus. This message does not return anything, and should information be returned as a result it should be logged at an INFO level. This method is not intended for normal use outside of debugging.

Copyright ¶

This document is placed in the public domain or under the CC0-1.0-Universal license, whichever is more permissive.

built 2023-10-10 23:52:42                                      CC0: no copyright