diff --git a/docs/develop/guide.rst b/docs/develop/guide.rst index 8d5b49ed..2d686802 100644 --- a/docs/develop/guide.rst +++ b/docs/develop/guide.rst @@ -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. \ No newline at end of file