From: Advaith Menon <noreply-git@bp4k.net>
Date: Thu, 22 Jan 2026 20:56:11 +0000 (-0500)
Subject: Update docs on baud rate
X-Git-Url: https://git.devinivas.org/?a=commitdiff_plain;h=ec31d747f88caebbda2af360eab3c48048c0cd60;p=4dulcd-nolibrary.git

Update docs on baud rate
* Add info on baud rate
---

diff --git a/GUIDE.adoc b/GUIDE.adoc
index 829555a..8cf918f 100644
--- a/GUIDE.adoc
+++ b/GUIDE.adoc
@@ -144,3 +144,37 @@ the baud rate to a function called `update_baud`.
 Note that `setBaudWait` doesn't take a baud rate as its argument! It instead
 takes a mapping to a number indicating a baud rate. The mapping table can be
 found at 4D's website.
+
+The function `ulcd_baud` performs the baud rate change. It takes two arguments,
+the first being the index from the table, and the second the actual baud rate.
+The below table lists a few of the possible values.
+
+[cols="1,1"]
+|===
+|Index |Baud Rate
+
+|312
+|9600 (default)
+
+|207
+|14400
+
+|155
+|19200
+
+|77
+|38400
+
+|25
+|115200
+
+|4
+|600000 (fastest)
+|===
+
+The baud rate change happens in 100ms. We wait while the hardware gets the
+acknowledge and stores it, and then we check for the acknowledge afterwards.
+
+To demonstrate the difference in using a faster baud rate, a demo program
+showing a moving circle has been made. Note that the circle moves faster and is
+more clear with a higher baud rate.