Skip to content

CC1, fix links #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

CC1, fix links #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 32 additions & 35 deletions docs/CharaChorder One.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ chords, layouts, and settings. It also contains a female USB-C port on
the left side of the half and a 3.5 mm “audio jack” port on the right
side of the half (See :ref:`Connections<CharaChorder One:Connections>`). The right half is nearly a mirror
image of the left half. It has a 3.5 mm “audio jack” port on the left
side of the half and a no other ports (See :ref:`Connections<CharaChorder One:Connections>`).
side of the half and no other ports (See :ref:`Connections<CharaChorder One:Connections>`).

The Center Bar
~~~~~~~~~~~~~~
Expand All @@ -79,7 +79,7 @@ Each CharaChorder half has nine 5-way switches. Starting from the
outside on each half and working inwards, the switches correspond to the
following fingers; pinky, ring, middle, and index. The three switches on
the inner-most side of each half correspond to the thumb. You can see
what characters are on each switch in :doc:`Layout<Layout>`. Additionally,
what characters are on each switch in the :ref:`CC English layout<CC1 CCEnglish Layout>`. Additionally,
there are two black switches off the “home-row” which can be accessed by
the ring and middle fingers.

Expand Down Expand Up @@ -135,15 +135,15 @@ computer, or into a mobile device, usually with the help of an adapter.
Communication
~~~~~~~~~~~~~

.. _power cable:
.. _CC1 Power Cable:

The Power Cable also doubles as a way for the CharaChorder One to
communicate with your computer. For this reason, it’s important that the
USB-A end of the power cable is inserted into a port on your computer
that’s capable of sending and receiving data, and not just an energy
port.

.. _TRS cable:
.. _CC1 TRS Cable:

In between the two CharaChorder halves, there’s a single 3.5 mm TRS cable, commonly known as an AUX cable. This cable facilitates
instant communication between the right half and the left half of the
Expand All @@ -156,18 +156,18 @@ Plugging In

The CharaChorder One is plug-and-play, so it doesn’t require any
additional software to work. Before plugging your CharaChorder in for
the first time, it’s important to make sure that the :ref:`TRS cable<TRS cable>` is fully plugged into both halves. With constant movement, it’s
the first time, it’s important to make sure that the :ref:`TRS cable<CC1 TRS Cable>` is fully plugged into both halves. With constant movement, it’s
possible that this cable becomes slightly dislodged which could lead to
issues with the device, so it’s a good idea to check these connections
when moving the CharaChorder to a new computer.

If not done already, make sure that the USB-C side of the
:ref:`power cable<power cable>` is plugged into the left half of the
:ref:`power cable<CC1 Power Cable>` is plugged into the left half of the
CharaChorder. It’s important to be certain that the cable is plugged all
the way in, otherwise, the CharaChorder might not function as intended.

After making sure that all the cables on the CharaChorder are properly
plugged in, connect the USB-A side of the :ref:`power cable<power cable>` into
plugged in, connect the USB-A side of the :ref:`power cable<CC1 Power Cable>` into
a USB-A port on your computer. Upon connecting, you
will be able to see a small, lime colored light inside the space that
holds the USB-C port on the left half of the CharaChorder One.
Expand All @@ -177,7 +177,7 @@ Getting Started

There are a few steps that you’ll likely want to take if this is your
first time using your CharaChorder device. In the following section, we
will update your device, explain navigation in the :doc:`GTM<GenerativeTextMenu>`, and demonstrate the default layout on your new
will update your device, explain navigation in the :doc:`GTM<GenerativeTextMenu>`, and demonstrate the :ref:`default layout<CC1 CCEnglish Layout>` on your new
device.

Updating your Device
Expand All @@ -189,7 +189,7 @@ Updating your Device
instructions on how to upgrade your device to our new CCOS :ref:`here<CCOS:Upgrade to CCOS>`. If your device is not running :doc:`CCOS<CCOS>`, you will be unable to follow the
steps below to update your device.

Checking your Device’s Firmware
Checking the Firmware
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can check your device’s current firmware by following the steps
Expand All @@ -199,7 +199,6 @@ below:
#. Click “Connect” at the bottom middle of the page
#. When the popup box comes up that reads “charachorder.io wants to connect to a serial port”, choose your CharaChorder device, then click the “connect” button

.. _Serial Port Popup Check Firmware:
.. image:: /assets/images/SerialPort-Message-CC1.webp
:width: 435
:alt: Popup to select serial device
Expand All @@ -208,7 +207,6 @@ After following the above steps, you can find your
firmware version in the bottom left of your screen. It will read
something like this: ``CCOS 2.1.0``

.. _Bottom Bar Check Firmware:
.. image:: /assets/images/DM-Bottom-Bar-CC1-M0.webp
:width: 1200
:alt: Checking the firmware on Device Manager
Expand All @@ -228,14 +226,12 @@ site <https://charachorder.io/ccos/>`__.
#. If not auto-connected, click “Connect”
#. When the popup box comes up that reads “charachorder.io wants to connect to a serial port”, choose your CharaChorder device, then click the “connect” button

.. _Serial Port Popup Update Firmware:
.. image:: /assets/images/SerialPort-Message-CC1.webp
:width: 435
:alt: Popup to select serial device

#. Click on the CCOS version on the bottom left of the page

.. _Bottom Bar Update Firmware:
.. image:: /assets/images/DM-Bottom-Bar-CC1-M0.webp
:width: 1200
:alt: Checking the firmware on Device Manager
Expand All @@ -245,20 +241,21 @@ site <https://charachorder.io/ccos/>`__.

At this point, your device will automatically reboot. Congratulations! You have
successfully updated your device. You can check your device’s firmware
version by following the steps :ref:`here<CharaChorder One:Checking your Device’s Firmware>`.
version by following the steps :ref:`here<CharaChorder One:Checking The Firmware>`.

Understanding the Settings
--------------------------

The CharaChorder One has settings that are user-configurable. Since the
device is plug-and-play, you don’t need any software to edit the
device’s settings; all you need is a place to type text. We call these
settings the Generative Text Menu, or GTM for short.
settings the :doc:`Generative Text Menu<GenerativeTextMenu>`, or GTM
for short.

You can access the :doc:`GTM<GenerativeTextMenu>` by
:doc:`chording<Chords>` both pinkies `north`_ on any space that
allows text entry such as a notepad app. For an explanation on chords
and how to perform them, visit the :doc:`Chords<Chords>` section.
You can access the GTM by :doc:`chording<Chords>` both pinkies `north`_
on any space that allows text entry such as a notepad app. For an
explanation on chords and how to perform them, visit the
:doc:`Chords<Chords>` section.

Once you perform the chord to call up the :doc:`GTM<GenerativeTextMenu>`, your CharaChorder will type out the menu and its options.
It will look something like this:
Expand All @@ -283,7 +280,7 @@ You can read an explanation on all of the settings on your CharaChorder device :
Learning the Layout
-------------------

The default CharaChorder layout, which we will refer to as the CC English layout, has been designed to favor bigrams and trigrams commonly used in the English language while making the letters accessible for a logical choice of :doc:`lexical chords<Chords>`. You can find the quick reference guide for the layout below, and :ref:`read about how the layout was designed, here <Layout:Design of the layout>`.
The default CharaChorder layout, which we will refer to as the :ref:`CC English layout<CC1 CCEnglish Layout>`, has been designed to favor bigrams and trigrams commonly used in the English language while making the letters accessible for a logical choice of :doc:`lexical chords<Chords>`. You can find the quick reference guide for the layout below, and :ref:`read about how the layout was designed, here <Layout:Design of the layout>`.

.. note::
General consensus amongst the community is that, while not perfect,
Expand All @@ -296,7 +293,7 @@ The default CharaChorder layout, which we will refer to as the CC English layout
and benefits of such modifications are debatable.


.. _CCEnglish Layout:
.. _CC1 CCEnglish Layout:
.. image:: /assets/images/CCEnglish.png
:width: 1200
:alt: CC English Layout
Expand All @@ -311,17 +308,17 @@ into account that each switch can access 5 different positions, and
considering that each layer has access to all of those 9 switches, we
have over 250 assignable slots between the two CharaChorder halves.

In this section, we’ll refer only to the default CC English layout. If
you have modified your layout to something different, then the next
In this section, we’ll refer only to the default :ref:`CC English layout<CC1 CCEnglish Layout>`.
If you have modified your layout to something different, then the next
portion might not be accurate for your device. If you have purchased
your device from CharaChorder, then the following is accurate to your
device.

A1 Layer
^^^^^^^^

The A1 layer is the main layer that is active by default. The CC English
layout has all 26 letters of the English alphabet on the A1 layer so
The A1 layer is the main layer that is active by default. The :ref:`CC English layout<CC1 CCEnglish Layout>`
has all 26 letters of the English alphabet on the A1 layer so
that you can access all of them without having to hold or press anything
else. Your device will always be in the A1 layer upon boot.

Expand All @@ -333,7 +330,7 @@ A2 Layer
^^^^^^^^

The A2 layer, sometimes referred to as the “number layer”, is accessible
with the :doc:`A2 access key<CharaChorder Keys>`. In the above :ref:`graphic<CCEnglish Layout>`, you’ll see this labeled
with the :doc:`A2 access key<CharaChorder Keys>`. In the above :ref:`graphic<CC1 CCEnglish Layout>`, you’ll see this labeled
as “num-shift.” In the `Device Manager <https://charachorder.io/config/layout/>`__,
this key has the name “Numeric Layer (Left)” and “Numeric Layer (Right)”, one for each side of the
CharaChorder.
Expand All @@ -347,7 +344,7 @@ need to :doc:`chord<Chords>` the keys together; it’s only required that the
A2 Layer access key is pressed while the target key is pressed.

.. note::
EXAMPLE: On the CC English layout, you can access the number
EXAMPLE: On the :ref:`CC English layout<CC1 CCEnglish Layout>`, you can access the number
``4`` by pressing and holding the right pinky to the east and the
left middle finger to the east.

Expand All @@ -356,7 +353,7 @@ A3 Layer

The A3 layer, sometimes referred to as the “function layer”, is
accessible with the :doc:`A3 access key<CharaChorder Keys>`. This key is not
in the above :ref:`graphic<CCEnglish Layout>`, and instead
in the above :ref:`graphic<CC1 CCEnglish Layout>`, and instead
is accessible by pressing and holding either pinky down, into the
device. In the `Device Manager <https://charachorder.io/config/layout/>`__,
this key has the name “Function Layer (Left)” and “Function Layer (Right)”, one for each side of the
Expand All @@ -371,7 +368,7 @@ together; it’s only required that the A3 layer access key is pressed
while the target key is pressed.

.. note::
EXAMPLE: On the CC English layout, you can access the F1 key by
EXAMPLE: On the :ref:`CC English layout<CC1 CCEnglish Layout>`, you can access the F1 key by
pressing and holding either pinky down, into the device, and adding the letter ``a`` or ``r`` (location of number 1 on the default layout) to it.

Shift Modifier
Expand All @@ -384,7 +381,7 @@ like other modifiers (such as Ctrl and Alt). The Shift modifier output
is currently controlled by the Operating System that your CharaChorder is
plugged to, and it is not possible to customize their outputs.

In the above graphic, you’ll see
In the above :ref:`graphic<CC1 CCEnglish Layout>`, you’ll see
the Shift key labeled as “Shift”. In the `Device Manager <https://charachorder.io/config/layout/>`__,
this key has the name “Shift Keyboard Modifier (Left)” and “Shift Keyboard Modifier (Right)”, one for each side
of the CharaChorder.
Expand All @@ -398,7 +395,7 @@ holding the Shift key along with the target key. You do not need to
key is pressed while the target key is pressed.

.. note::
EXAMPLE: On the CC English layout, you can access the capital
EXAMPLE: On the :ref:`CC English layout<CC1 CCEnglish Layout>`, you can access the capital
``A`` by pressing and holding the left pinky to the east and the
right index finger to the west.

Expand All @@ -409,10 +406,10 @@ Configurability
~~~~~~~~~~~~~~~

The CharaChorder One’s layout is configurable, which means that you can
:doc:`remap<Glossary>` almost all keys. Though the CC English
layout has been optimized for writing in English by
remap almost all keys. Though the :ref:`CC English
layout<CC1 CCEnglish Layout>` has been optimized for writing in English by
:doc:`chentry<Glossary>` and :doc:`chording<Chords>`, some users may
choose to :doc:`remap<Glossary>` their device’s layout to better
choose to remap their device’s layout to better
suit their personal needs. For a thorough explanation on how remapping
works and how to remap your device, visit the :ref:`remapping section<Device Manager:Remapping>`

Expand All @@ -425,7 +422,7 @@ on how to get started with learning your device. If you want to just
jump in without having to read a minute longer, head on over to our
training website; https://www.iq-eq.io/#/

.. _Dot I/O:
.. _CC1 Dot I/O:
.. image:: /assets/images/DOTIO.png
:width: 1200
:alt: Practicing on DOT I/O