Merge pull request #60 from CharaChorder/migrate-to-ccos

Initial commit

docs/CharaChorder Operating System (CCOS).rst → docs/CCOS.rst

@@ -56,4 +56,49 @@ the above which utilizes 100% custom hardware? No problem. This is all possible
 with CCOS.
 
 Thank you for your interest in CharaChorder OS.  We look forward to unleashing 
-a keyboard revolution and redefining the limits of human-computer interaction!
+a keyboard revolution and redefining the limits of human-computer interaction!
+
+Upgrade to CCOS
+***************
+
+.. danger::
+    These instructions are only for those that had a device shipped before 2023 
+    and that wish to update to CCOS. For all other CCOS updates, see 
+    :ref:`the device manager page<Device Manager:Updating Your Device>`.
+
+Part I - Back up chord library and update device
+------------------------------------------------
+
+#. Go to https://launchpad.charachorder.com/#/manager in a Google Chrome or other Chromium browser
+#. Click the ‘Connect’ button, then select your device
+#. You can confirm your device is properly connected if you see something like "Device: CHARACHORDER, firmware: 0.9.5"
+#. Click the ‘Download Chords’ button and wait for the table to populate. This could take a few minutes.
+#. Click ‘Export Library’ to export a .csv file to your machine (The file should be called: “CharaChorder_ChordLibrary.csv”)
+#. Once you are absolutely sure your library is exported properly, and ALL of your chords are present in the file, click the ‘Delete All Chords’’ button.
+#. Refresh the page, reconnect your device via steps 2-3, and click the ‘Bootloader’ button. A file explorer window should open on Windows. On Mac you may need to find your device as an external drive
+#. Download your update file from this site: `<https://www.charachorder.com/pages/update-your-firmware>`__
+
+    .. warning::
+        You'll notice that there are two different versions of the CharaChorder 
+        Lite. Please be sure to download the version that corresponds to your 
+        device, whether it's M0 or S2. If you have a CharaChorder Lite that was 
+        delivered before October 1st, 2022 you will need to use the file which 
+        corresponds to the MO chipset. Otherwise CharaChorder Lite users should 
+        use the S2 chipset.
+
+    .. danger::
+        Make sure that the file you download is named exactly
+        like this: ``CURRENT.UF2``. If there are any other characters in the
+        file name, the file will not work. ``CURRENT(1).UF2`` will NOT work.
+        Additionally, the file name is case-sensitive; all letters must be
+        capitalized.
+
+#. Drag the UF2 file into the file explorer window and confirm that you would like to replace the existing file.
+#. The file explorer window should automatically close
+
+
+
+Part II - Migrate your chord library
+------------------------------------
+
+#. Follow the steps to restore your library on the new device manager by following the steps on the Device Manager page for :ref:`restoring from backup<Device Manager:Restoring from a Backup>`. Note, that although it says the file type should be .json, the .csv file downloaded will work.

docs/CharaChorder One.rst

@@ -205,7 +205,7 @@ Updating your Device
 .. warning::
    IMPORTANT: If your device shipped from our warehouse before 2023,
    it’s possible that it is running an obsolete firmware. You can read
-   instructions on how to upgrade your device to our new CCOS :doc:`here<Upgrade to CCOS>`. If your device is not running    :doc:`CCOS<CharaChorder Operating System (CCOS)>`, you will be unable to follow the
+   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.
 
 .. _charachorder-one-checking-your-devices-firmware:

docs/CharaChorder_Lite.rst

@@ -5,7 +5,7 @@ Welcome to the Official CharaChorder Lite Guide. You can select the links
 below to navigate to the topics that you find most relevant.
 
 The CharaChorder Lite is CharaChorder's approach to introducing :doc:`chording<Chords>` 
-to a traditional, QWERTY keyboard. It's small, sleek, and portable, but what truly sets the "CCL" apart from other keyboards is that it's powered by :doc:`CCOS<CharaChorder Operating System (CCOS)>`. This makes the CCL a superpowered, :doc:`chording<Chords>` keyboard that may be easier to learn than the :doc:`CharaChorder One`.
+to a traditional, QWERTY keyboard. It's small, sleek, and portable, but what truly sets the "CCL" apart from other keyboards is that it's powered by :doc:`CCOS<CCOS>`. This makes the CCL a superpowered, :doc:`chording<Chords>` keyboard that may be easier to learn than the :doc:`CharaChorder One`.
 
 It boasts a beautiful set of keycaps, intentionally translucent to be able to appreciate the RGB backlights that breathe a modern look into the beautifully crafted keyboard. 
 
@@ -163,7 +163,7 @@ Updating your Device
 .. warning::
    IMPORTANT: If your device shipped from our warehouse before 2023,
    it’s possible that it is running an obsolete firmware. You can read
-   instructions on how to upgrade your device to our new CCOS :doc:`here<Upgrade to CCOS>`. If your device is not running    :doc:`CCOS<CharaChorder Operating System (CCOS)>`, you will be unable to follow the
+   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.
 
 .. _charachorder-lite-checking-your-devices-firmware:

docs/Device Manager.rst

@@ -275,7 +275,7 @@ Layer Selector
 
 .. dropdown:: Explanation of Layers on CCOS Devices
 
-	As of February of 2024, :doc:`CCOS<CharaChorder Operating System (CCOS)>` devices come with three (3) layers that you can make use of: the base layer, called the A1 (Alpha) layer, the secondary layer, referred to as A2 (Numeric), and the tertiary layer, named A3 (Function).
+	As of February of 2024, :doc:`CCOS<CCOS>` devices come with three (3) layers that you can make use of: the base layer, called the A1 (Alpha) layer, the secondary layer, referred to as A2 (Numeric), and the tertiary layer, named A3 (Function).
 
 	In order to access layers, you need to press and hold a "layer access" button. You MUST hold the button in order to use keys mapped to layers other than the alpha layer. The alpha layer is active by default.
 
@@ -341,7 +341,7 @@ You can use action codes in chord outputs as well as while :ref:`remapping<Devic
 
 What are Action Codes
 ^^^^^^^^^^^^^^^^^^^^^^^
-Action codes are data that :doc:`CCOS<CharaChorder Operating System (CCOS)>` interprets as characters. **Put simply, they are the characters that we see while typing.** These include letters, numbers, special characters, function keys, and others. 
+Action codes are data that :doc:`CCOS<CCOS>` interprets as characters. **Put simply, they are the characters that we see while typing.** These include letters, numbers, special characters, function keys, and others. 
 
 Action Code Menu
 ^^^^^^^^^^^^^^^^^^^^^^^
@@ -516,19 +516,19 @@ In this box, you can change a few settings that relate to using your device for
 
 .. dropdown:: Key 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<CharaChorder Operating System (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.
+	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<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.
 
 .. dropdown:: Key Debounce Press
 
-	The debounce press setting refers to the time frame (measured in milliseconds) in which :doc:`CCOS<CharaChorder Operating System (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.
+	The debounce press setting refers to the time frame (measured in milliseconds) in which :doc:`CCOS<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<CharaChorder Operating System (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<CharaChorder Operating System (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 debounce release setting.
+	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<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<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 debounce release setting.
 
 .. dropdown:: Key Debounce Release
 
-	The debounce release setting refers to the time frame (measured in milliseconds) in which :doc:`CCOS<CharaChorder Operating System (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.
+	The debounce release setting refers to the time frame (measured in milliseconds) in which :doc:`CCOS<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<CharaChorder Operating System (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<CharaChorder Operating System (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 debounce press setting.
+	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<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<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 debounce press setting.
 
 .. dropdown:: Output Character Delay
 
@@ -542,23 +542,23 @@ Mouse
 -------
 .. dropdown:: Mouse???
 
-	:doc:`CCOS<CharaChorder Operating System (CCOS)>` has mouse functionality. This means that your CharaChorder, or CCOS-powered keyboard, has the ability to control your computer's mouse. These settings affect the mouse usage on your CharaChorder.
+	:doc:`CCOS<CCOS>` has mouse functionality. This means that your CharaChorder, or CCOS-powered keyboard, has the ability to control your computer's mouse. These settings affect the mouse usage on your CharaChorder.
 
 .. image:: /assets/images/ManagerSettingsMouse.png
   :width: 1200
   :alt: The Mouse settings box
 
-In this box, you can adjust settings relating to :doc:`CCOS'<CharaChorder Operating System (CCOS)>` mouse abilities.
+In this box, you can adjust settings relating to :doc:`CCOS'<CCOS>` mouse abilities.
 
 .. dropdown:: Mouse Speed(s)
 
-	:doc:`CCOS<CharaChorder Operating System (CCOS)>` has two mouse speeds, a fast speed and a slow speed. The 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). The 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).
+	:doc:`CCOS<CCOS>` has two mouse speeds, a fast speed and a slow speed. The 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). The 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).
 
 	You can read a more in-depth explanation of mouse speeds in the :ref:`GTM section<GenerativeTextMenu:Slow Speed>`. 
 
 .. dropdown:: Scroll Speed
 
-	Scroll speed refers to the speed at which your :doc:`CCOS<CharaChorder Operating System (CCOS)>` scroll will scroll.
+	Scroll speed refers to the speed at which your :doc:`CCOS<CCOS>` scroll will scroll.
 
 	You can read a more in-depth explanation of the scroll speed in the :ref:`GTM section<GenerativeTextMenu:Scroll Speed>`.
 
@@ -586,7 +586,7 @@ Chording
   :width: 1200
   :alt: The Chording settings box
 
-In this box, you can adjust settings relating to :doc:`CCOS'<CharaChorder Operating System (CCOS)>` :doc:`chording<Chords>` abilities as well as turn off :doc:`chording<Chords>` alltogether, should you choose to.
+In this box, you can adjust settings relating to :doc:`CCOS'<CCOS>` :doc:`chording<Chords>` abilities as well as turn off :doc:`chording<Chords>` alltogether, should you choose to.
 
 .. dropdown:: Auto-delete Timeout
 
@@ -641,7 +641,7 @@ Other Tools
 
 Backups
 --------
-On the Device Manager, you can create backups of your chords, your layout, and even your settings. Follow the steps below to create a backup and to restore saved backups to your :doc:`CCOS<CharaChorder Operating System (CCOS)>` device.
+On the Device Manager, you can create backups of your chords, your layout, and even your settings. Follow the steps below to create a backup and to restore saved backups to your :doc:`CCOS<CCOS>` device.
 
 Creating a Backup
 ~~~~~~~~~~~~~~~~~~
@@ -686,7 +686,7 @@ Bootloader
 -----------
 In the :ref:`device menu<Device Manager:Device Menu>`, you'll find the boot menu button. When you click on that, it'll bring up the option to put your device into bootloader.
 
-In bootloader mode, your :doc:`CCOS<CharaChorder Operating System (CCOS)>` device will disconnect from the Device Manager and a new drive will appear in your File Explorer (Finder, in Mac OS). This drive contains your CharaChorder's CCOS information.
+In bootloader mode, your :doc:`CCOS<CCOS>` device will disconnect from the Device Manager and a new drive will appear in your File Explorer (Finder, in Mac OS). This drive contains your CharaChorder's CCOS information.
 
 Updating Your Device
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~