Merge pull request #24 from CharaChorder/charachorder-engine

Initial draft for CCE

docs/CharaChorder Engine.rst

@@ -1,2 +1,42 @@
-CharaChorder Engine - UNDER CONSTRUCTION
-==============================================
+CharaChorder Engine
+===================
+
+Welcome to the Official CharaChorder Engine guide. You can select the links
+below to navigate to the topics that you find most relevant.
+
+.. _CCE:
+.. image:: /assets/images/CharaChorderEngine.jpg
+  :width: 1200
+  :alt: CharaChorder Engine
+
+CharaChorder Engine is a multichip module that enables you to build your own 
+CCOS powered text entry device. If you are interested in learning how to utilize
+CharaChorder Engine, please visit the `CharaChorder Engine Discord channel <https://discord.gg/VngNWSyZJb>`_ 
+and ping Riley Keen or Matt Swarts.
+
+.. contents::
+   :local:
+
+Pinout Diagram
+**************
+
+.. _CCEPinout:
+.. image:: /assets/cce/pinout.png
+  :width: 1200
+  :alt: CharaChorder Engine pinout table
+
+Design
+******
+
+The Engine is designed primarily to work with a MCU to receive inputs (through 
+UART and later I2C or SPI), process the chording logic, query the onboard chordmap
+library, and output the results back to the MCU (again over UART and later I2C or
+SPI). However, the layout of the Engine exposes USB pins, which could have a future
+capability for direct USB HID output. This could be limiting for some developers,
+as they may want to control their HID reports themselves through their MCU.
+
+Communicating with Engine Devices
+*********************************
+
+Like other CCOS powered devices, any device with CharaChorder Engine can use the 
+full power of the :doc:`Serial API<SerialAPI>`. 

docs/SerialAPI.rst

@@ -315,7 +315,7 @@ CMD_VAR_COMMIT
    :header: "I/O","Index","Name","Type","Example","Notes"
 
    "INPUT","0","Command","Chars","VAR",""
-   "INPUT","1","SubCommand","Hexadecimal VAR Code","B0","Commit p arameters to memory"
+   "INPUT","1","SubCommand","Hexadecimal VAR Code","B0","Commit parameters to memory"
    "OUTPUT","0","Command","Chars","VAR",""
    "OUTPUT","1","SubCommand","Hexadecimal VAR Code","B0",""
    "OUTPUT","2","Success","Boolean Number","0","This will be 0 on success, or greater than zero for an error if there was a problem commiting"
@@ -335,7 +335,7 @@ CMD_VAR_GET_PARAMETER
 
    "INPUT","0","Command","Chars","VAR",""
    "INPUT","1","SubCommand","Hexadecimal VAR Code","B1","Get parameter value"
-   "INPUT","2","Parameter Code","Decimal Parameter Code","2E",""
+   "INPUT","2","Parameter Code","Hexadecimal Parameter Code","2E",""
    "OUTPUT","0","Command","Chars","VAR",""
    "OUTPUT","1","SubCommand","Hexadecimal VAR Code","B1",""
    "OUTPUT","2","Parameter Code","Hexadecimal Parameter Code","2E",""
@@ -357,7 +357,7 @@ CMD_VAR_SET_PARAMETER
 
    "INPUT","0","Command","Chars","VAR",""
    "INPUT","1","SubCommand","Hexadecimal VAR Code","B2","Set parameter value"
-   "INPUT","2","Parameter Code","Decimal Parameter Code","2E",""
+   "INPUT","2","Parameter Code","Hexadecimal Parameter Code","2E",""
    "INPUT","3","Data In","Decimal Number","46",""
    "OUTPUT","0","Command","Chars","VAR",""
    "OUTPUT","1","SubCommand","Hexadecimal VAR Code","B2",""