Skip to content

Commit

Permalink
add docs on custom device definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
yconst committed Sep 27, 2023
1 parent 1fd00b4 commit 3daa2a9
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/develop/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -238,3 +238,22 @@ This will install the Tinymovr Studio in develop mode. Now, `tinymovr`, `tinymov

Happy coding!


Custom Device Definitions
#########################

Tinymovr uses YAML files for device specification (the spec). Device spec files reside in `{tinymovr_package_dir}/studio/Python/tinymovr/specs/`. This is where files covering Tinymovr firmware 1.3.x to 1.6.x are situated by default.

You can add custom device spec files in this directory to tell Tinymovr Studio GUI, CLI and library how to communicate with custom devices. For instance, assuming that you have installed Tinymovr Studio using `pip3`, you will need to find the directory of the tinymovr package first using the command below:

Windows
.. code-block:: console
python -c "import os, tinymovr; print(os.path.dirname(tinymovr.__file__))"
Macos and Linux
.. code-block:: console
python3 -c "import os, tinymovr; print(os.path.dirname(tinymovr.__file__))"
Then, paste your custom spec file to `{tinymovr_package_dir}/studio/Python/tinymovr/specs/`. Tinymovr should correctly discover your custom device.

0 comments on commit 3daa2a9

Please sign in to comment.