Device Manager
The CharaChorder Device Manager is the one-stop-shop for users with a CCOS-powered device. It boasts high quality graphics, animations and a simple user interface. On the device manager, you can change your device’s layout, manage your chord library, adjust your settings, and even send serial commands to your device.
In this section, we’ll talk about the device manager and how you can navigate around it to configure your device to your liking. First, we’ll discuss the website and where to find useful buttons on it, then we’ll cover the three main pages on the device manager and how to use them, and, lastly, we’ll touch upon some other features and useful tools on the manager.
Feel free to use the links below to skip to whatever section you would like to read or scroll to start with the first section.
Connecting to the Device Manager
You can follow the steps below to connect to the device manager for the first time.
Note
If you have previously selected Auto-reconnect within that browser for the same device, you may not need to repeat these steps every time that you go to the device manager page.
Tip
If the device button at the top right hand corner of the screen is not pink, then the device manager is currently connected to a device. Open the device menu to make sure that it’s the right device.
On a chromium based browser, such as Chrome or Edge, go to the CharaChorder Device Manager
Click “Connect”
Additional Step if you don’t see the “Device” box.
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
If these steps were performed correctly, the device button will have gone from pink to transparent. You can verify that you’re connected to the device manager by clicking the device button and reading your device’s name and OS version.
Linux Serial Port Access
Warning
For Linux based users: serial port access is often restricted to specific user groups for security. To enable serial port access in a browser like Chromium, you’ll need to add your user to the appropriate group based on your Linux distribution. Follow the steps below to grant access.
For Ubuntu, Debian, Linux Mint, openSUSE, CentOS, Elementary OS, Zorin OS:
sudo usermod -aG dialout $USER
For Fedora, Arch Linux, Manjaro:
sudo usermod -aG uucp $USER
Replace $USER
with your username or use $USER
to automatically reference the current user.
Log out and log back in for the changes to take effect.
If the above commands don’t work, check the group ownership of the serial device (e.g., /dev/ttyUSB0
) using:
ls -l /dev/ttyUSB0
This command will display the device’s group. Replace /dev/ttyUSB0
with the appropriate device file for your system.
After identifying the group (e.g., dialout
, uucp
, or another), add your user to that group using:
sudo usermod -aG <group_name> $USER
Replace <group_name>
with the name of the group displayed in the previous step.
Log out and log back in to apply the changes. Your user will now have the necessary permissions to access the serial port.
Device Manager Website
Undo and Redo
Near the top left corner, the device manager has handy undo and redo buttons which do exactly what their names describe. If you’re making changes to your layout, your chords, or your layout, you can step back, one change at a time, all the way back to the very first change that you made during that session. Once you’re stepped back, you can step forward to redo the change(s) that was/were undone.
Pertinent Links
On the bottom left hand of the device manager you can find four buttons that will redirect you to helpful websites related to the manager.
Version
The leftmost button is the version button will always display the version of the device manager that you’re currently using. You can click on it to go to the github page where the device manager is hosted from. If you’d like, you can submit “issues” on github for things you would like to see added to the device manager, such as features or bug fixes.
Issues
This button will redirect you to the “issues” page on the device manager github where you can view issues that have been submitted by other users. You can also submit new issues for things that you would like to see added to the device manager, such as features or bug fixes.
Docs
The Docs button will redirect you to the Official CharaChorder documentation – this manual that you’re reading right now.
Train
The button labeled “train” will redirect you to CharaChorder’s very own Dot IO. This website will help you to learn to use your device as well as take advantage of CCOS’s chording feature.
Color Scheme
On the bottom right of the device manager, you’ll see a circle with a solid color. Hovering over this circle will reveal the label “color scheme.” You can click this circle to change the color scheme of the device manager. In the color scheme menu, you can choose your preferred color using a color pallette, an RGB color system, or by clicking the dropper icon to choose a color on your screen.
Light and Dark Mode
Also in the bottom right-hand corner, you’ll find a sun or moon icon where you can toggle between light and dark mode. This toggle can help those who would rather a brighter screen to see better or a darker screen to reduce eye strain.
Language
Finally, the last icon in the bottom right corner will allow you to change the device manager’s language. Currently, the device manager supports English and German.Changing the manager’s language will NOT change your device’s layout or the chords in your chord library. It will only change the language in which the device manager’s text appears in.
Chord Manager
At the top center of the device manager you’ll find a menu with three selections: Chords, Layout, and Settings.
The Chord Manager is a powerful tool that lets you add, delete and edit chords stored in your chord library. It’s easy to use and quick to load. We’ll go over how to use it below.
When you connect your device to the device manager, the webpage will start reading the chords on your device. It may take a couple of seconds — or even over a minute for very large libraries — to load the first time. If you have auto-reconnect enabled, the loading times are much shorter.
Chords displayed here are shown in alphabetical order, using the list of chord outputs. The number of chords shown on the chord manager depends on your screen size and browser zoom settings. Above the chords list, you’ll see the search bar which will display the number of chords on your CCOS device until something is typed there.
You can search through your chords by searching chord outputs (the word that displays once you’ve performed a chord). This textbox is not case sensitive, so you can type in capital or lowercase letters regardless of whether or not the chord has a capital letter in it. This search bar is also intuitive enough that you are also able to search partial words/phrases.
To the right of the search bar, you’ll find two numbers separated by a forward slash (/
). These numbers indicate the page number that you’re on out of the total number of pages that compose your chord library. Using the angle brackets to the right of those numbers will allow you to flip through the different pages of your chord library which is sorted in alphabetical order.
Under the page-turning brackets, you’ll see a tall box with the text “Try typing here”. You can use this text box to test your new chords as you edit them in the manager.
Finally, at the bottom of the chord manager, you’ll notice a “Reload” button. You can click on this button to have the device manager read your device’s chord library again. This process can take a few seconds.
Creating a Chord
You can follow the steps below to create a new chord on the device manager.
Note
In order to follow these steps, you must already have your device connected to the device manager.
Find the “New chord” text under the search bar and click it.
When the text displays “Hold chord,” press and hold all of the keys that you want to use as your chord input. Once you have pressed all of the keys, release the keys.
You will now see the chord input in the left column as letters inside individual boxes. These boxed-letters will be highlighted in a color (as opposed to black or white). The color depends on your selected color scheme. You will also notice a single, floating dot highlighted in the same color off to the right of the boxed-letters.
Note
You can add any number of chords at a time without defining the desired chord output.
Warning
If you click save, before defining a chord output as described in step three, any chords that you’ve created will save to your device with a blank output and will lead to strange behavior.
Click into the text box to the right of the chord input that you created in the previous step and type your desired chord output.
Using Action Codes
As you type your chord output, you’ll notice that your cursor will have a bubble with a
+
above it. You can click this to open the action codes menu where you can search for specific action codes or browse through the action codes available to assign into a chord output. Read the action codes section for information on the different kinds of action codes.As you type, you’ll notice that your text has changed color to match your color scheme and that the end of your text has a floating dot immediately to the right.
Once you are satisfied with your output, you can proceed to modify another chord or click save.
Deleting a Chord
You can follow the steps below to delete a chord in the device manager.
Note
In order to follow these steps, you must already have your device connected to the device manager.
Locate the chord that you would like to delete.
When you hover over the chord that you would like to delete, you will notice a small trash icon appear in line with that chord map. Click the trash icon in order to mark it for deletion.
When you click the trash icon, the boxed-letters in the left column will have a line through them and they will turn red. You can unmark chords for deletion by clicking the “undo” arrow next to the trash icon. The chord will return to its original color and the line will disappear.
Tip
You can mark multiple chords for deletion at a time. Flipping through the pages in your chord library will not unmark the chords that you have marked for deletion.
Once you have marked the undesired chords for deletion and are ready to delete them, click the save button.
Once you click save, the marked chord maps will disappear from the list.
Editing a Chord
You can follow the steps below to edit an existing chord in the device manager.
Note
In order to follow these steps, you must already have your device connected to the device manager.
Locate the chord that you would like to edit.
Click the textbox in the right column where the chord output is displayed.
Edit the chord output to be whatever you would like. As you type, you will notice that the text changes color to match your color scheme and that the end of your text has a floating dot immediately to the right.
Using Action Codes
As you type your chord output, you’ll notice that your cursor will have a bubble with a
+
above it. You can click this to open the action codes menu where you can search for specific action codes or browse through the action codes available to assign into a chord output. Read the action codes section for information on the different kinds of action codes.Tip
You can edit multiple chords before saving your changes. Flipping through the pages in your chord library will not undo the changes that you have made to your existing chords.
Once you are ready to save your changes, click save.
Once you click save, the chord(s) that you’ve modified will change color to match the rest of the list and the floating dot will disappear.
Layout Editor
The Device Manager has a very intuitive layer editor. It’s the second option in the main navigation bar at the top and center of the page. When you go to this tab, you’ll see a diagram of your device, with each key filled in with the corresponding action code.
Layer Selector
Explanation of Layers on CCOS Devices
As of February of 2024, 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.
Note
In this section, we’ll refer only to the default layouts on CCOS devices. 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, also known as the alpha layer, is the main layer that is active by default. Your device will always be in the A1 layer upon boot.
A2 Layer
The A2 layer, sometimes referred to as the numeric layer, is accessible with the A2 access key. In the Device Manager, this key has the name “Numeric Layer (Left)” and “Numeric Layer (Right)”, one for each hand.
The A2 Layer is accessible by pressing and holding one layer access button. Any key that is mapped to the A2 Layer can only be accessed by pressing and holding the A2 Layer access key along with the target key. You do not need to chord the keys together; it’s only required that the A2 Layer access key is pressed while the target key is pressed.
A3 Layer
The A3 layer, sometimes referred to as the “function layer”, is accessible with the A3 access key. In the Device Manager, this key is assignable by the names “Function Layer (Left)” and “Function Layer (Right)”.
Once you’ve mapped the A3 layer access buttons, the A3 Layer is accessible by pressing and holding either one of them. You do not have to hold them both in order to access the A3 layer. Any key that is on the A3 Layer can only be accessed by pressing and holding the A3 access key, along with the target key. You do not need to chord the keys together; it’s only required that the A3 layer access key is pressed while the target key is pressed.
Note
The following section assumes that you have already connected your device to the device manager.
Above the diagram of your device, you’ll see a circle with the letters “ABC” in the middle. The circle, together with the “wings” on either side (one on the left with the numbers “123” inscribed and one on the right with “fx” stylized within), make up the layer selector. You can select any one of these to view the keys that are mapped to each location, on each layer.
Remapping
On the layer editor, you can remap your layout by using action codes. Follow the instructions below to remap your device one key at a time.
How to Remap Your Keys
Note
In order to follow these steps, you must already have your device connected to the device manager.
Choose the layer where you want to change the key.
Click on the key that you would like to change. This will bring up the action codes menu.
Use the search feature in the action codes menu or scroll through available action codes. Once you’ve found the desired action code, click on it.
Once you select the action code, you will notice that the layout diagram now reflects the selected action code highlighted according to your color scheme and it will be accompanied by a floating dot.
Once you have changed the desired key(s), click the save button.
Using Action Codes
You can use action codes in chord outputs as well as while remapping keys.
What are Action Codes
Action codes are data that 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.
Available Action Codes
You can see the action codes below, or view them externally here.
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 CCOS device.
Creating a Backup
Note
In order to follow these steps, you must already have your device connected to the device manager.
Open the history menu.
Choose an “individual backup” to download to your computer, or select “download everything” to download a single file with all three parts. The file(s) will be downloaded in .json format.
Note
You can make individual backups of just your chords, just your layout, or just your settings. The “download everything” option will download all three of these in a single file instead of three separate files.
If prompted, select a location to save to on your computer and rename the file to your liking.
Congratulations! Now you have created a backup.
Restoring from a Backup
Additionally, you can restore your chords, your layout, and your settings on the Device Manager. Follow the steps below to do so.
Note
In order to follow these steps, you must already have your device connected to the device manager.
Open the history menu.
Click on “Restore”.
Select a file to use to restore from. This file should be in .json format.
Note
Files that you can restore from will have been created ahead of time by following the steps to create a backup.
If there are changes, the save button will appear on the top left. Note the changes in the appropriate tab. If you restored chords, check the chords tab, if you restored a layout, check the layout tab, and if you restored settings, check the settings tab.
Note
The restore feature does NOT erase data from your device. If there is a conflict (such as a changed setting, a different key in the layout, or a chord that has a different output), that will be overwritten by the restore file. Settings and layout backups ALWAYS overwrite everything.
Once you see the changes that the restore file made, you can click save to apply the changes.
Bootloader
In the 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 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
Note
In order to follow these steps, you must already have your device connected to the device manager.
Warning
Before performing the below steps, please make sure that you have a backup of your layout as well as a backup of your chord library and a backup of your GTM settings. The update might reset those, so it’s important that you keep backup files handy. For instructions on how to restore backed-up files, visit the Backups section.
Click “Boot Menu” (the power icon) followed by “Bootloader”. Your CharaChorder will now appear as an external storage device on your computer’s File Explorer or Finder app. It might be named one of the following: “Arduino”, “Seeduino”, or “CharaChorder One”.
Download your update file from this site: https://www.charachorder.com/pages/update-your-firmware
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.
Copy the CURRENT.UF2 file that you just downloaded and paste it into the CharaChorder drive that we found in step 1.
When your computer asks you how you would like to resolve the issue of two files with the same name, select “Replace file”.
At this point, your device will automatically reboot, and the CharaChorder drive will have disappeared. Congratulations! You have successfully updated your device. You can check your device’s CCOS in the device menu.
Terminal
Also in the device menu, you’ll find the option to go into the terminal. This is a sandbox space where you can feed commands directly to your CCOS device.
You can read about the available commands in the serial api section.