From adca3ee7a7b6ba95af519ceb68f779b7341a53f7 Mon Sep 17 00:00:00 2001 From: duianto Date: Mon, 15 Sep 2025 13:48:19 +0200 Subject: [PATCH] Move two images into assets/images dir --- docs/CharaChorder Engine.rst | 3 +-- docs/SerialAPI.rst | 2 +- .../{cce/pinout.png => images/cce-pinout.png} | Bin docs/assets/{serial => images}/serialterminal.png | Bin 4 files changed, 2 insertions(+), 3 deletions(-) rename docs/assets/{cce/pinout.png => images/cce-pinout.png} (100%) rename docs/assets/{serial => images}/serialterminal.png (100%) diff --git a/docs/CharaChorder Engine.rst b/docs/CharaChorder Engine.rst index f41c65c..bd088d4 100644 --- a/docs/CharaChorder Engine.rst +++ b/docs/CharaChorder Engine.rst @@ -21,8 +21,7 @@ Pinout Diagram ************** .. _CCEPinout: -.. image:: /assets/cce/pinout.png - :width: 1200 +.. image:: /assets/images/cce-pinout.png :alt: CharaChorder Engine pinout table Design diff --git a/docs/SerialAPI.rst b/docs/SerialAPI.rst index f1f71d9..f10eff4 100644 --- a/docs/SerialAPI.rst +++ b/docs/SerialAPI.rst @@ -3,7 +3,7 @@ Serial API The Serial API allows users and developers to interact with their CCOS powered device over a serial connection. This can be used to add and remove chords, change advanced parameters, and perform common commands such as resetting keymaps or resetting the device to factory settings. You can utilize this serial API by using any serial terminal such as `serialterminal.com `_ on a `serial enabled web browser `_. The serial connection operates at a baud rate of 115200 bps. In general, a success returns a 0 at the end, while a failure returns a number greater than zero, which represents an error code. When sending Serial API commands to a CharaChorder device, allow for at least 100 microseconds (us) between commands to allow time for the commands to be processed on the device. If there is no time allowed to process commands on the device, then the serial input buffer on the device can fill up and overflow, causing a system crash. Ideally, sequential Serial API commands should be called in a restful manner by waiting for a response from the previous command. -.. figure:: /assets/serial/serialterminal.png +.. figure:: /assets/images/serialterminal.png :alt: Running some simple commands on serialterminal.com Running some simple commands on serialterminal.com diff --git a/docs/assets/cce/pinout.png b/docs/assets/images/cce-pinout.png similarity index 100% rename from docs/assets/cce/pinout.png rename to docs/assets/images/cce-pinout.png diff --git a/docs/assets/serial/serialterminal.png b/docs/assets/images/serialterminal.png similarity index 100% rename from docs/assets/serial/serialterminal.png rename to docs/assets/images/serialterminal.png