diff options
| author | Judah Fuller <[email protected]> | 2023-04-26 17:34:37 +0100 |
|---|---|---|
| committer | Judah Fuller <[email protected]> | 2023-04-26 17:34:37 +0100 |
| commit | 006ed3ec28e3211a02fdb9baee1aba77581592d7 (patch) | |
| tree | 8dc141750db451332aaf92e6c41332a2cf450384 /docs | |
| parent | e7af5313bfe4cf96fd5c71056bf8ccdb4866c2b8 (diff) | |
| download | OpenCortex-006ed3ec28e3211a02fdb9baee1aba77581592d7.tar.gz OpenCortex-006ed3ec28e3211a02fdb9baee1aba77581592d7.zip | |
Auto stash before merge of "Docs" and "upstream/main"
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/consumer/Model_Renamer.md | 22 | ||||
| -rw-r--r-- | docs/consumer/VNC.md | 23 | ||||
| -rw-r--r-- | docs/dev/Control.md | 0 | ||||
| -rw-r--r-- | docs/dev/Crypto.md | 0 | ||||
| -rw-r--r-- | docs/dev/README.md (renamed from docs/README.md) | 0 | ||||
| -rw-r--r-- | docs/dev/Updates.md | 0 | ||||
| -rw-r--r-- | docs/dev/dsp.md | 0 |
7 files changed, 45 insertions, 0 deletions
diff --git a/docs/consumer/Model_Renamer.md b/docs/consumer/Model_Renamer.md new file mode 100644 index 0000000..43ab007 --- /dev/null +++ b/docs/consumer/Model_Renamer.md @@ -0,0 +1,22 @@ +# Editing the default model names + +Companies like NDSP aren't allowed to ship their models under the real name it is based on. Luckly they keep track of it in the actual model list. + +The models and their respective categories, names and parameters, are stored inside `/opt/neuraldsp/ModelRepo.xml`. In order to rename these files to the real deal, you need to edit the file. + +If you don't want to rename the files manually you can: + +- Use the `model_renamer.py` script in this repo to generate the XML file + + - Usage: + + ```console + python model_renamer.py <original-modelrepo> <output-file-path> + ``` + +- Use the pre-generated XML file inside `Model Repositories` (make sure to match it to your CorOS verion) + +Now replace the `ModelRepo.xml` file inside `/opt/neuraldsp` with the new file. Make sure this is called `ModelRepo.xml`. +Finally reboot your QC, now you should have all models (except captures) renamed to their real names. + + diff --git a/docs/consumer/VNC.md b/docs/consumer/VNC.md new file mode 100644 index 0000000..05b9b3a --- /dev/null +++ b/docs/consumer/VNC.md @@ -0,0 +1,23 @@ +# External editor (VNC) + + + +Since we've figured out how to cross-compile our own binaries, we were able to compile a VNC solution for the Quad Cortex. The VNC server we compiled is based on [this project](https://github.com/ponty/framebuffer-vncserver). We had to modify the source code a bit to make it work with the touchscreen, But besides that, it is identical. + +**Note:** when connected to the QC over VNC, you might notice a dip in framerate on the device itself. This is normal. It is the device trying to encode the video feed and struggling. +**Note:** _Installer and auto-run on boot will be added later, For now you can use it the manual way_ + +## Installation + +In the `External VNC` folder you will find the files `qc_vnc` and `libvncserver.so.1`. Move these to the following locations on the QC: + +- **qc_vnc:** `/bin` +- **libvncserver.so.1**: `/lib` + +That's it. You can now start the server! + +## Usage + +```console +qc_vnc -f /dev/fb0 -t /dev/input/event0 +``` diff --git a/docs/dev/Control.md b/docs/dev/Control.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/dev/Control.md diff --git a/docs/dev/Crypto.md b/docs/dev/Crypto.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/dev/Crypto.md diff --git a/docs/README.md b/docs/dev/README.md index 83ab4e4..83ab4e4 100644 --- a/docs/README.md +++ b/docs/dev/README.md diff --git a/docs/dev/Updates.md b/docs/dev/Updates.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/dev/Updates.md diff --git a/docs/dev/dsp.md b/docs/dev/dsp.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/dev/dsp.md |