From 6d9c9d883aaf378da4724e62065a79b94563bb88 Mon Sep 17 00:00:00 2001 From: Yannis Chatzikonstantinou Date: Wed, 17 Jan 2024 13:17:42 +0200 Subject: [PATCH] update docs --- docs/studio/usage.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/studio/usage.rst b/docs/studio/usage.rst index 9ace4d88..805ed6ec 100644 --- a/docs/studio/usage.rst +++ b/docs/studio/usage.rst @@ -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 `_, you can even use Tinymovr Studio to control your own custom devices! + Issuing Commands in CLI #######################