From f5d9ddc3cb57c1ec8d7aa0fa927089fa9585a767 Mon Sep 17 00:00:00 2001 From: John de St Germain Date: Mon, 8 Jan 2024 07:20:41 -0600 Subject: [PATCH] Delete unused file --- docs/GenerativeTextMenu.rst | 837 ------------------------------------ 1 file changed, 837 deletions(-) delete mode 100644 docs/GenerativeTextMenu.rst diff --git a/docs/GenerativeTextMenu.rst b/docs/GenerativeTextMenu.rst deleted file mode 100644 index efe214e..0000000 --- a/docs/GenerativeTextMenu.rst +++ /dev/null @@ -1,837 +0,0 @@ -.. _Generative Text Menu (GTM): - -Generative Text Menu (GTM) -============================= - -<<<<<<< Updated upstream -The Generative Text Menu (GTM) is a text based menu which can be accessed -anywhere you type. It allows you to access various device settings and features -without the need for software. It's a core feature of CCOS that you will want to -learn how to use to make the device your own. - -.. contents:: - :local: - -How to access -************* - -First, move your cursor into any area where you can type. You may want to choose -somewhere that is innocuous because some programs may respond to the keys of the -GTM menu. -======= -``CharaChorder GTM [ >KMCDR` settings including :ref:`chording tolerances`, :ref:`mouse speeds`, and :ref:`realtime feedback`, among other settings and features, without the need to use a software. It's a core feature of :doc:`CCOS` that you will want to -learn how to use to make the device your own. - -You will notice that some settings have different press and release values. This is because the switches are read by the :doc:`CCOS` at two different moments in time: when they are pressed, and when they are released. We have designed :doc:`CCOS` to have configurable settings for each of those "events" separately, for maximum adjustability. Intuitively, each **press** setting, such as :ref:`debounce press`, will affect the way that the :doc:`CCOS` reads the switch at the time that the switch is pressed into any one direction. Conversely, **release** settings, such as :ref:`release debounce`, will change the way that the :doc:`CCOS` reads the switch at the exact moment that the switch is released, or un-pressed, from any one direction. - -.. note:: - Although you can configure your CCOS settings anywhere that you can type through the GTM, you can also edit them on the :doc:`CharaChorder Device Manager`. - -.. warning:: - Please note that updating your CCOS device might reset your GTM settings to default. Please make sure that you have a :doc:`backup of your GTM settings` before updating your CCOS device. For instructions on how to restore backed up files, visit the :doc:`Backups` section. - - -Table of Contents of this Page -============================== - -.. contents:: - :local: - -How to access the GTM -************************** - -First, move your cursor into any area where you can type. For best results, you may want to choose a text area that doesn't automatically format text since some of the keys that the GTM uses may trigger unwanted formatting. We recommend using a vanilla (basic) text editor such as Notepad. Please note, however, that Windows Notepad has been known to have issues with how the GTM is displayed on Windows 11 PCs. - -Use the table below to find out how to trigger the GTM for your CCOS device. Please note that triggering the GTM will require a ":doc:`chorded`" action. ->>>>>>> Stashed changes - -.. csv-table:: - :header: "Device", "How to access" - -<<<<<<< Updated upstream - "CharaChorder One", "Chord both pinky keys north (Alt keys)" - "CharaChorder Lite", "Chord G and Dup key" - "CharaChorder X", "Chord G and Esc key" - "CharaChorder Engine", "Chord G and Esc key" - -How to navigate -*************** - -Once you see the menu (example shown below), you will be able to navigate the menu -by pressing letters on your device. - -``CharaChorder GTM [ >KMCDR` and `<` that surrounds the `K`. - -How to change values -******************** - -In general, if you find a setting that has a numeric value that you can change -you will be able to modify this by using the arrow keys on your device. The ``Up arrow`` -key will increase the value whereas the ``Down arrow`` key will decrease it. Once you are happy -with a value, you can use the ``Enter`` key to confirm your choice. - -If at any time you want to get out of the menu or discard changes you can press the -``Esc`` key. - -If you are on a submenu and would like to go back to the previous menu you can -use the ``Left arrow`` key on your keyboard. - -======= - "CharaChorder One", "Chord both pinky keys north (``Alt`` keys)" - "CharaChorder Lite", "Chord ``G`` and Middle ``Alt`` key (``Dup`` key)" - "CharaChorder X", "Chord ``G`` and ``Esc`` key" - "CharaChorder Engine", "Chord ``G`` and ``Esc`` key" - -.. _How to navigate through the GTM: -How to navigate through the GTM -********************************* - -The GTM has different submenus that we can call "pages". Each "page" of the GTM will have different options which can either adjust a specific setting or take you to another submenu. - -Once you perform the chord to call up the menu, :doc:`CCOS` will type out the menu and its options. It will look something like this: - -``CharaChorder GTM [ >KMCDRK<``) in your target submenu on your :doc:`CCOS` device. In the example above, you would press ``K`` for Keyboard, ``M`` for Mouse, ``C`` for Chording, ``D`` for Display, and ``R`` for Resources. In order to go back to a previous menu, press the left arrow. In order to leave the GTM at any point, press ``ESC``. Leaving the GTM by using ``ESC`` will save your changes. You can also confirm your changes by pressing ``ENTER``. - -In some submenus, you will see numeric values. In order to increase or decrease these, you can use the up and down arrow keys on your :doc:`CCOS` device. - - ``CharaChorder > Chording > Press Tolerance [ Use up/down arrow keys to adjust: 25ms ]`` - - -.. _Available Menus: ->>>>>>> Stashed changes -Available Menus -****************** - -.. csv-table:: - :header: "Menu", "Description" - - ":ref:`Keyboard`", "Settings related to using your device in character entry" - ":ref:`Mouse`", "Settings related to using your device as a mouse" - ":ref:`Chording`", "Settings related to chording on your device" - ":ref:`Display`","Settings related to your device version and other CCOS texts" - ":ref:`Resources`", "A menu of resources, mostly links" - -<<<<<<< Updated upstream -Keyboard --------- - -Scan Rate -~~~~~~~~~ - -The scan rate refers to the frequency at which the device checks the state of the input keys. -5 ms corresponds to 200 Hz or checking the position of the keys 200 times a second. - -Debounce Press / Release -~~~~~~~~~~~~~~~~~~~~~~~~ - -The debounce press/release settings refer to the time frame (measured in milliseconds) in which to filter out duplicate key activations on a press/release event. In -other words, any duplicate activations within the given time frame will only be counted once. -The default value on a CharaChorder One is 7 ms while the default on CharaChorder Lite/X is 20 ms. - -.. note:: - You might use this setting (by increasing its value) if you are seeing duplicate - characters while typing. - - -Keystroke Delay -~~~~~~~~~~~~~~~ - -This setting adds a small delay to keystroke inputs. It is measured in microseconds -and is very small by default. If you have a very fast device, you can decrease this -value to make chording and GTM menu feel snappier and more responsive. - -.. note:: - You might use this setting (by increasing its value) if you are having issues - with the GTM menus not working properly on your device. - -Capslock -~~~~~~~~ - -This setting should be familiar. It toggles the state of the caps lock. When on, all -characters output by the device will be capitalized. - -Operating system -~~~~~~~~~~~~~~~~ - -This setting can have the value of Windows, Mac, Linux, iOS, or Android. -The intent of this is to provide more accurate key mapping so it is best to set -this to whatever device you are using. - - -GUI-CTRL Soft Swap (Lite only) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This setting will swap the behavior of the bottom two keys on the CharaChorder Lite, -making it so that Ctrl is the bottom left most key and Windows/GUI key is the second one. -Users who are used to normal keyboard layouts will want to take advantage of this -setting so they don't have to relearn the position of the keys. - -Mouse ------ - -Poll rate -~~~~~~~~~ - -The poll rate of the mouse. This is used in conjunction with the slow/fast mouse speed. - -Slow speed/fast speed -~~~~~~~~~~~~~~~~~~~~~ - -The number of pixels to move at the mouse poll rate. In other words, the mouse -can move 2 pixels every poll rate and if your default poll rate of 20ms (50 Hz) -then you will move 100 pixels every 1 second. -Slow speed is activated when you use only one of the mouse keys. The fast speed -is activated when you use both of the mouse keys in the same direction. - -Scroll speed -~~~~~~~~~~~~ - -The scroll is the number of times to scroll at the mouse poll rate. In other words, if the poll rate is 20 ms (50 Hz) then you will scroll 50 times in a second. -If you adjust this value higher you will be able to scroll faster - -Active mode -======= -.. _Keyboard: -Keyboard --------- - -Under this menu, you will be able to modify settings pertaining to how your CCOS device interacts with your computer. - -.. _Scan Rate: -Scan Rate -~~~~~~~~~ - -The scan rate, sometimes known as the "Key scan duration," refers to the frequency at which the device checks the state of the input keys. -For reference, 5 ms corresponds to 200 Hz, which means that :doc:`CCOS` checks the position of the keys once every 5 milliseconds, which equals 200 times in a second. Having a lower number is usually better as it makes CCOS more responsive, though the difference at low numbers is usually negligible. In the GTM, this setting is adjustable in millisecond (ms) units. - -You can find the default scan rates of the different CharaChorder devices in the table below. - -+------------------+----------------+------------+------------+---------------+ -| Device | Default Value | Min. Value | Max. Value | Increments | -+==================+================+============+============+===============+ -| CharaChorder One | 2 ms | 0 ms | 20 ms | 1 ms | -+------------------+----------------+------------+------------+---------------+ -| CharaChorder Lite| 2 ms | 0 ms | 20 ms | 1 ms | -+------------------+----------------+------------+------------+---------------+ -| CharaChorder X | 2 ms | 0 ms | 20 ms | 1 ms | -+------------------+----------------+------------+------------+---------------+ - - -.. _Debounce Press: -Debounce Press -~~~~~~~~~~~~~~~~~~~~~~~~ - -The debounce press setting refers to the time frame (measured in milliseconds) in which :doc:`CCOS` will filter out duplicate key activations on a press event. In other words, any duplicate activations within the given time frame will only be counted as one. - -We should adjust this setting if we are having unintentional duplicate characters while typing. Increasing this value will lower the probability that unwanted duplicate characters will appear because it tells :doc:`CCOS` to wait longer before typing an additional character that's assigned to the same switch-direction. However, having this setting set too high might also cause issues with :doc:`CCOS` not reading intentional double-presses, so it's recommended to try different numbers in small increments. This setting should be used in connection with the :ref:`debounce release` setting. - -You can find the default debounce press value of the different CharaChorder devices in the table below: - -+------------------+----------------+------------+------------+---------------+ -| Device | Default Value | Min. Value | Max. Value | Increments | -+==================+================+============+============+===============+ -| CharaChorder One | 7 ms | 0 ms | 100 ms | 1 ms | -+------------------+----------------+------------+------------+---------------+ -| CharaChorder Lite| 12 ms | 0 ms | 100 ms | 1 ms | -+------------------+----------------+------------+------------+---------------+ -| CharaChorder X | 1 ms | 0 ms | 100 ms | 1 ms | -+------------------+----------------+------------+------------+---------------+ - - - -.. _Debounce Release: -Debounce Release -~~~~~~~~~~~~~~~~~~~ - -The debounce release setting refers to the time frame (measured in milliseconds) in which :doc:`CCOS` will filter out duplicate key activations on a release event. In other words, any duplicate activations within the given time frame will only be counted as one. - -We should adjust this setting if we are having unintentional duplicate characters while typing. Increasing this value will lower the probability that unwanted duplicate characters will appear because it tells :doc:`CCOS` to wait longer before typing an additional character that's assigned to the same switch-direction. However, having this setting set too high might also cause issues with :doc:`CCOS` not reading intentional double-presses, so it's recommended to try different numbers in small increments. This setting should be used in connection with the :ref:`debounce press ` setting. - -You can find the default debounce release value of the different CharaChorder devices in the table below: - -+------------------+----------------+------------+------------+---------------+ -| Device | Default Value | Min. Value | Max. Value | Increments | -+==================+================+============+============+===============+ -| CharaChorder One | 7 ms | 0 ms | 100 ms | 1 ms | -+------------------+----------------+------------+------------+---------------+ -| CharaChorder Lite| 12 ms | 0 ms | 100 ms | 1 ms | -+------------------+----------------+------------+------------+---------------+ -| CharaChorder X | 1 ms | 0 ms | 100 ms | 1 ms | -+------------------+----------------+------------+------------+---------------+ - - - -.. _Keystroke Delay: -Keystroke Delay -~~~~~~~~~~~~~~~ - -This setting adds a small delay to keystroke inputs. It is measured in microseconds (μs) and is very small by default. - -You should increase this value if your computer is not accepting all of the characters output by your device, such as when using the GTM. If you are having this issue, your GTM would look weird, with missing chunks or characters. - -If you have a faster computer, then you can lower this setting to make chording and the GTM feel snappier and more responsive. - -This value is adjusted in 40us increments. You can find the default debounce press of the different CharaChorder devices in the table below: - -+------------------+----------------+------------+-------------+--------------+ -| Device | Default Value | Min. Value | Max. Value | Increments | -+==================+================+============+=============+==============+ -| CharaChorder One | 480 μs | 0 μs | 10200 μs | 40 μs | -+------------------+----------------+------------+-------------+--------------+ -| CharaChorder Lite| 480 μs | 0 μs | 10200 μs | 40 μs | -+------------------+----------------+------------+-------------+--------------+ -| CharaChorder X | 480 μs | 0 μs | 10200 μs | 40 μs | -+------------------+----------------+------------+-------------+--------------+ - - -.. _Capslock: -Capslock -~~~~~~~~ - -This setting is similar to a computer's Capslock: it toggles the state of the capslock. When on, all -letters output by the CCOS device will be capitalized. When off, all letters output by the CCOS device will be lowercase. - -.. _Operating System: -Operating System -~~~~~~~~~~~~~~~~~~~ - -This setting refers to your host computer's operating system. Because the keys on the different computer operating systems may vary, you can set your CCOS device up so that it matches your computer. - -Currently, on CCOS, you can select between Windows, Mac, Linux, iOS, or Android. - -The intent of this setting is to provide more accurate key mapping. As such, it is recommendable to set this setting to match whatever computer operating system you're using your CCOS device on. - -.. csv-table:: - :header: "Device", "Default" - - "CharaChorder One", "Windows" - "CharaChorder Lite", "Windows" - "CharaChorder X", "Windows" - -.. Warning:: - As of December of 2023, this setting doesn't do anything on CCOS devices. - - -.. _GUI-CTRL Soft Swap (CharaChorder Lite only): -GUI-CTRL Soft Swap (CharaChorder Lite only) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This setting will swap the behavior of the two keys on the bottom-left of the CharaChorder Lite. - -Traditional QWERTY keyboards keep the ``CTRL`` key at the bottom left corner of the keyboard with the ``GUI`` key (Command key on Mac, Windows key on Windows, Super key on Linux, etc.) to the right of the ``CTRL`` key. The CharaChorder Lite has these two keys swapped by default, which some users find odd and difficult to adjust to. A brand new CharaChorder Lite will have the ``GUI`` key at the bottom-left corner with the ``CTRL`` key to the right of the ``GUI`` key. - -With this setting, you can effectively swap the two keys' location at the level of the CCOS so that ``CTRL`` is at the bottom-left corner. - -This setting has two options: GUI-CTRL and CTRL-GUI. This setting is set to GUI-CTRL by default. - -**Default Key Mapping:** - -.. _GUI-CTRL: -.. image:: /assets/images/GUI-CTRL.jpg - :width: 1200 - :alt: Default CharaChorder Lite CTRL mapping - -**Key Mapping after swapping:** - -.. _CTRL-GUI: -.. image:: /assets/images/CTRL-GUI.jpg - :width: 1200 - :alt: Alternative CharaChorder Lite CTRL mapping - -Users who are used to traditional keyboard layouts will want to take advantage of this setting so they don't have to relearn the new position of the keys. - -.. _Mouse: -Mouse ------ - -CCOS allows you to use your device as a mouse including functions like scrolling and cursor movement. This section will cover settings that relate to the mouse function on CCOS devices. - -.. _Poll Rate: -Poll Rate -~~~~~~~~~ - -The polling rate (poll rate) is the frequency at which data from the CharaChorder's mouse functionality is sent to the device it's connected to. In other words, how often it updates the cursor's position to the computer. This is typically expressed in Hz (Hertz), with the average gaming mouse reporting data at 1000 Hz, which means 1000 times every second. - -However, :doc:`CCOS` uses ms (milliseconds) which is directly inverse to Hz. 1 ms is equal to 1000 Hz, 2 ms is equal to 500 Hz, and 1000 ms is equal to 1 Hz. - - .. dropdown:: An Explanation of Hz to ms conversion - - In the context of frequency and period (time duration), the relationship is inverse. Frequency is the number of cycles per second, measured in Hz. The period is the time it takes for one cycle to complete, measured in seconds (s). The formula is: - - ``Frequency (Hz) = 1/Period (s), where s = 1000 ms`` - - If you convert the period to milliseconds (ms), the relationship remains inverse. For instance, if you have a frequency of 1000 Hz, the period is 1 ms (because 1 second = 1000 milliseconds). As the frequency increases, the period (measured in ms) decreases. - - - -You can find the default settings for each device in the table below: - -.. csv-table:: - :header: "Device", "Default", "Min. Value", "Max. Value", "Increments" - - "CharaChorder One", "20 ms", "0 ms", "100 ms", "1 ms (Hz)" - "CharaChorder Lite", "20 ms", "0 ms", "100 ms", "1 ms (Hz)" - "CharaChorder X", "20 ms", "0 ms", "100 ms", "1 ms (Hz)" - -This setting is used in conjunction with the :ref:`slow speed ` and :ref:`fast speed ` settings. Both, the :ref:`slow speed ` and the :ref:`fast speed ` rely on the poll rate. - -.. _Slow Speed: -Slow Speed -~~~~~~~~~~ - -Slow speed is activated when you use only one of the mouse keys in a single direction (as opposed to using 2 keys in the same direction). Increasing this setting will make your CCOS pointer move faster. - -This setting is used in conjunction with :ref:`poll rate `. See the explanation below. - -.. dropdown:: Explanation of CCOS mouse speeds - - The mouse speed refers to the speed of the cursor on the CharaChorder's mouse functionality. The cursor will move at the number of pixels (px) indicated by this setting multiplied by the number of Hz indicated by the :ref:`polling rate`. - - In other words, if your speed is set to 2 px, and your :ref:`poll rate` is set to 20 ms (~50 Hz), your CharaChorder's cursor will move at 100 pixels per second (px/s). The equation comes out to: - ``Speed (px) x poll rate (Hz) = Number of pixels that the cursor will move per second`` - - -You can find the default settings for each device in the table below: - -.. csv-table:: - :header: "Device", "Default", "Min. Value", "Max. Value", "Increments" - - "CharaChorder One", "5 px", "0 px", "250 px", "1 px" - "CharaChorder Lite", "16 px", "0 px", "250 px", "1 px" - "CharaChorder X", "16 px", "0 px", "250 px", "1 px" - - -.. _Fast Speed: -Fast Speed -~~~~~~~~~~~~~~~~~~~~~ - -Fast speed is activated when you use two mouse keys in a single direction (as opposed to using only one key in the same direction). Increasing this setting will make your CCOS pointer move faster. - -This setting is used in conjunction with :ref:`poll rate `. See the explanation below. - -.. dropdown:: Explanation of CCOS mouse speeds - - The mouse speed refers to the speed of the cursor on the CharaChorder's mouse functionality. The cursor will move at the number of pixels (px) indicated by this setting multiplied by the number of Hz indicated by the :ref:`polling rate`. - - In other words, if your speed is set to 2 px, and your :ref:`poll rate` is set to 20 ms (~50 Hz), your CharaChorder's cursor will move at 100 pixels per second (px/s). The equation comes out to: - ``Speed (px) x poll rate (Hz) = Number of pixels that the cursor will move per second`` - - -You can find the default settings for each device in the table below: - -.. csv-table:: - :header: "Device", "Default", "Min. Value", "Max. Value", "Increments" - - "CharaChorder One", "25 px", "0 px", "250 px", "1 px" - "CharaChorder Lite", "32 px", "0 px", "250 px", "1 px" - "CharaChorder X", "32 px", "0 px", "250 px", "1 px" - -.. _Scroll Speed: -Scroll Speed -~~~~~~~~~~~~ - -Scroll speed refers to the speed at which your CCOS scroll will scroll. - -Increasing this setting will make your CCOS scrolling scroll faster. This setting is used in conjunction with :ref:`poll rate `. See the explanation below. - -.. dropdown:: Explanation of CCOS mouse speeds - - The scroll speed refers to the speed at which the CharaChorder scrolls at. The CCOS will scroll at the number of pixels (px) indicated by this setting multiplied by the number of Hz indicated by the :ref:`polling rate`. - - In other words, if your speed is set to 2 px, and your :ref:`poll rate` is set to 20 ms (~50 Hz), your CharaChorder's scroll will move at 100 pixels per second (px/s). The equation comes out to: - ``Speed (px) x poll rate (Hz) = Number of pixels that the cursor will move per second`` - - -You can find the default settings for each device in the table below: - -.. csv-table:: - :header: "Device", "Default", "Min. Value", "Max. Value", "Increments" - - "CharaChorder One", "2 px", "0 px", "25 px", "1 px" - "CharaChorder Lite", "2 px", "0 px", "25 px", "1 px" - "CharaChorder X", "2 px", "0 px", "25 px", "1 px" - - -.. _Active Mode: -Active Mode ->>>>>>> Stashed changes -~~~~~~~~~~~ - -Active mode nudges your mouse cursor one pixel every minute or so (not a specific timing). -This setting can be used to keep your computer from going to sleep. You might turn this setting off if you notice desktop apps are preventing you from getting mobile notifications (for example on Discord or Microsoft Teams). - -<<<<<<< Updated upstream -Chording --------- - -Character only mode -~~~~~~~~~~~~~~~~~~~ - -This setting is a toggle that when turned on will disable chording mode completely. - -.. note:: - You might use this setting if you don't expect to want to use chording (perhaps like during gaming) and you want to ensure that you don't accidentally activate any chords. - -Press tolerance / Release tolerance -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. note:: - If you only pay attention to one setting in this guide, you should read this one. It is probably the most customized setting on a CharaChorder device. - -This is a very important setting to pay attention to and perhaps configure as you use your device and get more experienced. The press and release tolerance refers to a threshold between the first and last press or release of the letters of a chord in order for it to activate. - -What this practically means is that if you want to make the window of time larger that you can activate chords in (ie easier) then you will increase these values. This is often helpful for beginners who are just starting to learn how to chord. - -The downside to having these values larger is that you will perhaps accidentally trigger chords during normal character entry, so if you are noticing that, you might want to decrease the values. - -One thing to point out is that chords with more keys by default get a longer window of time. This means chords with many keys can be a bit easier to trigger because the timing doesn't have to be as exact. - -Timeout -~~~~~~~ - -The time from the last character entry to stop counting characters to replace -You might want to change this if you often find yourself typing a word with chentry (character entry) and then chording after and the word is getting replaced. - -Spurring -~~~~~~~~ -A 'chording only' mode which tells your device to output chords on a press rather than a press & release. It also enables you to jump from one chord to another without releasing everything. It can provide significant speed gains with chording, but also takes away the flexibility of character entry. Spurring also helps new users learn how to chord by eliminating the need to focus on timing. - -Spurring On/Off -^^^^^^^^^^^^^^^ - -This will turn on or off spurring mode. - -======= -.. _Chording: -Chording --------- - -CCOS devices feature the ability to :doc:`chord`. The following settings affect the device's chording abilities. - -.. _Character Only Mode: -Character Only Mode -~~~~~~~~~~~~~~~~~~~ - -This setting is a toggle that disables chording capabilities on CCOS devices. It is off by default and can be enabled in case we don't want any chording at all. This setting can be useful in cases where we don't want to accidentally trigger chords unintentionally, such as when gaming. - -If your CCOS device suddenly loses its chording ability, it's a good idea to check if this setting is toggled off. - -.. _Press Tolerance: -Press Tolerance -~~~~~~~~~~~~~~~~ - -The press tolerance refers to a window of time in which a chord can be performed, measured in milliseconds (ms). This timer is initiated upon the first "press" action of the first key in a chord and ends once a key is released, or until the press tolerance runs out, whichever comes first. - -.. _Tolerances: -.. image:: /assets/images/Press-and-Release-Tolerances.WEBP - :width: 1200 - :alt: Diagram Explaining Tolerances - -Put simply, increasing the press tolerance (usually, done in conjunction with increasing the :ref:`release tolerance `) makes it easier to perform chords. - -.. note:: - The press tolerance scales (increases) according to the number of keys in a chord. The window of time will be bigger with a 6-key chord than with a 3-key chord. This means that, though you might set the tolerance to a specific timing, it will actually be longer than that depending on how many keys are in your chord. - -You can increase this setting in order to make that window of time longer and make chording easier. - -The downside to having higher values is that you may accidentally trigger chords during normal character entry. Therefore, if you are noticing chords fire unintentionally, it is a good idea to lower this setting along with the :ref:`release tolerance `. - -You can find the default settings for each device in the table below: - -.. csv-table:: - :header: "Device", "Default", "Min. Value", "Max. Value", "Increments" - - "CharaChorder One", "25 ms", "0 ms", "150 ms", "1 ms" - "CharaChorder Lite", "25 ms", "0 ms", "150 ms", "1 ms" - "CharaChorder X", "25 ms", "0 ms", "150 ms", "1 ms" - -.. _Release Tolerance: -Release Tolerance -~~~~~~~~~~~~~~~~~~ - -The release tolerance refers to a window of time in which a chord can be performed, measured in milliseconds (ms). This timer is initiated upon the first "release" action of any key in a chord and ends once the chord is fully performed, or until the release tolerance runs out, whichever comes first. - -.. _Tolerances: -.. image:: /assets/images/Press-and-Release-Tolerances.WEBP - :width: 1200 - :alt: Diagram Explaining Tolerances - -Put simply, increasing the release tolerance (usually, done in conjunction with increasing the :ref:`press tolerance `) makes it easier to perform chords. - -.. note:: - The press tolerance scales (increases) according to the number of keys in a chord. The window of time will be bigger with a 6-key chord than with a 3-key chord. This means that, though you might set the tolerance to a specific timing, it will actually be longer than that depending on how many keys are in your chord. - -You can increase this setting in order to make that window of time longer and make chording easier. - -The downside to having higher values is that you may accidentally trigger chords during normal character entry. Therefore, if you are noticing chords fire unintentionally, it is a good idea to lower this setting along with the :ref:`press tolerance `. - -You can find the default settings for each device in the table below: - -.. csv-table:: - :header: "Device", "Default", "Min. Value", "Max. Value", "Increments" - - "CharaChorder One", "18 ms", "0 ms", "150 ms", "1 ms" - "CharaChorder Lite", "18 ms", "0 ms", "150 ms", "1 ms" - "CharaChorder X", "18 ms", "0 ms", "150 ms", "1 ms" - - -.. _Timeout: -Timeout -~~~~~~~ - -This setting will change how long CCOS counts time in order to replace characters that precede a chord. - -CCOS devices have a running timer that starts after every single character that is entered in traditional chentry (character entry, i.e. one letter at a time). This timer controls whether or not the next chord that you perform deletes the preceding characters. - -This feature allows users to misfire chords, yet be able to correct them by quickly performing the chord correctly, without having to backspace manually to erase the misfired chord. The result is that the timeout will automatically backspace all of the preceding characters (up to the last :doc:`breaking character `) and replace them with the intended chord. - -You can set this setting to be as low as 0.0 seconds (s) or as high as 25.0 seconds (s), being able to adapt it to your individual :doc:`chording` style. - -.. warning:: - Setting this setting to 0.0 s will result in :doc:`chords` not working at all. They will fire, but they will not automatically erase the :ref:`chord inputs`. - -You can find the default settings for each device in the table below: - -.. csv-table:: - :header: "Device", "Default", "Min. Value", "Max. Value", "Increments" - - "CharaChorder One", "4 s", "0 s", "25 s", "0.1 s" - "CharaChorder Lite", "4 s", "0 s", "25 s", "0.1 s" - "CharaChorder X", "4 s", "0 s", "25 s", "0.1 s" - -.. _Spurring: -Spurring -~~~~~~~~ - -A 'chording only' mode which tells your device to output chords on a press event rather than a press & release and release event. When in spurring mode, you can press the keys of a chord one at a time with a much longer waiting period, which makes it a useful mode for those who want to practice chording without worrying about proper :ref:`timing`. - -Spurring mode also enables you to jump from one chord to another without releasing everything. It can provide significant speed gains when chording, but also takes away the flexibility of character entry. Spurring mode can truly maximize speed when chording if a user has chords for all of the words they want to use. - -.. _Spurring On/Off: -Spurring On/Off -^^^^^^^^^^^^^^^ - -This setting will toggle spurring mode ON or OFF. - -.. _Spurring Timeout: ->>>>>>> Stashed changes -Spurring Timeout -^^^^^^^^^^^^^^^^ - -The time of inactivity to default back to fluid chorded/character entry mode (aka spurring off). - -<<<<<<< Updated upstream -Arpeggiate -~~~~~~~~~~ - -Arpeggiate inputs are a special set of inputs that can follow chords, such as "I" or "a" and if pressed rapidly after a normal chord they will output the word and a space automatically. - -Arpeggiate On/Off -^^^^^^^^^^^^^^^^^ - -This will turn on or off arpeggiate inputs? or also modifiers - -Arpeggiate Timeout -^^^^^^^^^^^^^^^^^^ - -The time from the last chord, measured in ms, that the device will check for arpeggiates. This includes pressing a modifier after the word to change it. - -Display -------- - -Version -~~~~~~~ - -This will show you the current version of the GTM. You can use this to quickly check what version you are running anyhere you can type. - -Realtime feedback -~~~~~~~~~~~~~~~~~ - -Turning this on will show the helpful text like SPURRING_ON, SPURRING_OFF etc. -Most users prefer to leave this on but you can turn it off if you would like. - -On startup -~~~~~~~~~~ - -Turning this on will show the text "CCOS is ready." after you have plugged in your device. -In some cases, you may want to not have it automatically type stuff when plugged in because it can interfere with your system so you can toggle this off. - -Color (Lite only) -~~~~~~~~~~~~~~~~~ - -Use this to change the color of the LEDs on your CharaChorder Lite - -Brightness (Lite only) -~~~~~~~~~~~~~~~~~~~~~~ - -Adjusts the brightness of the LEDs - -.. note:: - If you are using a low power usb bank you may draw too much current if you have a high setting and the device might not properly function - - -======= -You can find the default settings for each device in the table below: - -.. csv-table:: - :header: "Device", "Default", "Min. Value", "Max. Value", "Increments" - - "CharaChorder One", "240 s", "0 s", "250 s", "1 s" - "CharaChorder Lite", "240 s", "0 s", "250 s", "1 s" - "CharaChorder X", "240 s", "0 s", "250 s", "1 s" - -.. _Arpeggiate: -Arpeggiate -~~~~~~~~~~~ - -Arpeggiate actions are timed actions that can modify a chord after the chord is performed. A quick example of this is the use of :doc:`chord modifiers` after you perform the chord. You can read that section for information on how the :doc:`chord modifiers` work. - -With arpeggiates enabled, you can chord the word ``run`` and then, within the :ref:`arpeggiate timeout window`, press the :doc:`past tense modifier` for the word to be "modified" into its past tense variant; in english, ``ran``. - - -.. _Arpeggiate On/Off: -Arpeggiate On/Off -^^^^^^^^^^^^^^^^^ - -This setting will let you toggle the arpeggiate capability ON or OFF. - -Some users dislike arpeggiates as, in really fast typing, it may cause unwanted modifications. - -.. _Arpeggiate Timeout: -Arpeggiate Timeout -^^^^^^^^^^^^^^^^^^ - -The arpeggiate timeout is a window of time after a chord is performed during which CCOS will expect arpeggiates to be performed. After this timer runs out, CCOS will NO LONGER modify the preceding chord. - -A common issue that users may run into while having arpeggiates enabled is the shift key modifying the preceding chord instead of the next key. For this reason, some users lower the arpeggiate timeout to a really low amount of time in order to reduce the possibility of this happening unintentionally. - -.. _Display: -Display -------- - -Under this section, you'll find settings that deal with how your CharaChorder displays certain things. - -.. _Version: -Version -~~~~~~~ - -Though this is not a setting that can be modified, it's a useful piece of text that will show you the CCOS version that your CharaChorder is currently on. You can use this to quickly check what version you are running on the fly, anywhere that you can read GTM - -.. _Realtime Feedback: -Realtime Feedback -~~~~~~~~~~~~~~~~~ - -This setting toggles realtime feedback ON or OFF. - -Realtime feedback refers to the helpful text like ``SPURRING_ON``, ``SPURRING_OFF`` etc, that lets the user know if a certain mode has been activated or deactivated on the CharaChorder device. Since there is no other visual way to know if the chord used to enable or disable certain settings, it is helpful to have these texts pop up as confirmation. - -.. Note:: - The realtime feedback setting controls the :ref:`startup` setting. If realtime feedback is OFF, then startup will be OFF, regardless of that setting's individual toggle. - -.. _Startup: -Startup -~~~~~~~~~~ - -Having this setting set to "ON" will result in your device displaying the text "CCOS is ready." after you have plugged your device into a computer. The startup text will be displayed wherever your cursor was last typing, if that window is active. This setting is useful so that you know when your CharaChorder device is ready to be used, since startup may take a couple of seconds. - -However, if you have editable text highlighted when you connect your CharaChorder, this setting will replace that highlighted text with the startup message. Additionally, if there is not a selected window where text may be typed, the key codes that the CharaChorder sends to your computer in order to display the startup message may be interpreted by your computer as actions and may result in unwanted behavior. - -If you would rather not have this message display every time that you connect your device, then you can toggle this setting OFF. - -.. Warning:: - The Startup setting is dependent on the :ref:`realtime feedback setting`. If that setting is set to OFF, then Startup won't display, even if Startup is set to ON. - -.. _LEDs (CharaChorder Lite only): -LEDs (CharaChorder Lite only) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The :doc:`CharaChorder Lite` comes with RGB LEDs that light up the keys of the keyboard from below with a static light. This section contains settings pertaining to those LED lights. - -.. note:: - LED settings only exist in the GTM for :doc:`CharaChorder Lite` devices, not on any other CharaChorder devices. - -.. _LED On/Off: -On/Off -^^^^^^^^ - -Quickly toggle the LEDs on or off with this setting. - -.. _LED Color: -Color -^^^^^^ - -Use this setting to change the color of the LED backlights on your CharaChorder Lite. In the GTM, there are 11 colors to choose from which you can see in the table below: - -.. csv-table:: - :header: "Letter", "Color" - - "W", "White" - "R", "Red" - "O", "Orange" - "Y", "Yellow" - "L", "Lime" - "G", "Green" - "C", "Cyan" - "B", "Blue" - "V", "Violet" - "P", "Pink" - "M", "Multicolor" - -Please note that, as of December of 2023, the LEDs are NOT individually addressable. The color setting changes the color of ALL LEDs at the same time. - -.. _LED Brightness: -Brightness -^^^^^^^^^^^ - -This setting lets you adjust the brightness of the LED backlights on your CharaChorder Lite. You can choose any number between 0 and 50, where 0 means that your LEDs are completely off and 50 means that your LEDs are at max brightness. - -Please note that LEDs are NOT individually addressable as of December of 2023. The brightness setting adjusts the brightness for ALL LEDs equally. - -.. note:: - If you are using a low power usb bank or port, having a high LED brightness may lead to issues with your CharaChorder Lite's power. If you have issues on your device that seem to keep your CharaChorder Lite from properly powering on or staying on, it may be a good idea to lower this setting. - -You can find the default settings for the CharaChorder Lite in the table below: - -.. csv-table:: - :header: "Device", "Default", "Min. Value", "Max. Value", "Increments" - - "CharaChorder Lite", "5", "0", "50", "1" - - -.. _Resources: ->>>>>>> Stashed changes -Resources ---------- - -This section contains links which may be helpful to you. These links include: - -.. csv-table:: -<<<<<<< Updated upstream - :header: "Item", "Description" - - "About", "Opens https://www.charachorder.com/pages/about" - "Get started", "Opens https://www.charachorder.com/pages/get-started" - "Discord", "Opens CharaChorder Discord Server" - "Training", "Opens https://iq-eq.io" - "Message Riley", "Copies Riley Keen (CharaChorder CEO)'s email address to your clipboard" - "Learn chords", "Opens The Starter Chord List" - "System updates", "Opens the CCOS firmware updates page" -======= - :header: "Letter", "Item", "Description" - - "A", "About", "Opens https://www.charachorder.com/pages/about." - "G", "Get started", "Opens https://www.charachorder.com/pages/get-started." - "D", "Discord", "Invites you to the CharaChorder Discord" - "T", "Training", "Opens https://iq-eq.io, our free tool to help people learn to type at the speed of thought" - "M", "Message Riley", "Copies Riley Keen (CharaChorder CEO)'s email address to your clipboard" - "L", "Learn chords", "Opens The Starter Chord List" - "S", "Check system updates", "Opens the CCOS version updates page" ->>>>>>> Stashed changes