Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yconst committed Jan 17, 2024
1 parent 6c4348b commit 6d9c9d8
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/studio/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,25 @@ Compatibility

Tinymovr Studio includes by default a checksum comparison to determine protocol compatibility between firmware and studio version. This is performed each time a node is discovered, and prior to initializing the tinymovr object. If you see a compatibility-related message, please upgrade to the latest studio and firmware versions.

Custom Device Specs
###################

You can specify a custom device spec (YAML file) as a command line argument:

|gui|

.. code-block:: console
tinymovr --spec=/path/to/myspec.yaml
|cli|

.. code-block:: console
tinymovr_cli --spec=/path/to/myspec.yaml
This is useful, for instance, if you have altered the default Tinymovr spec files. Using this parameter with a project developed using `Avlos <https://github.com/tinymovr/avlos>`_, you can even use Tinymovr Studio to control your own custom devices!


Issuing Commands in CLI
#######################
Expand Down

0 comments on commit 6d9c9d8

Please sign in to comment.