A simple wrapper for controlling sushi over gRPC via a python script.
To use this wrapper, python3.6 or greater needs to be installed, together with the grpcio-tools Python package. Both are installed by default in the development releases of Elk for the various supported architectures.
If you are running your python program on a device running Elk Audio OS, the latest elkpy should already be installed.
But, if you use elkpy on another system, e.g. macOS, you can either copy the module folder to the directory where it will be used, or install it locally with pip3 install -e elkpy or similar.
First import the sushicontroller package, e.g.:
from elkpy import sushicontroller as scThen create an instance of the SushiController object:
controller = sc.SushiController()The default gRPC address is localhost:51051.
To connect to another address, pass it as an argument to the constructor of the controller with the format ip-address:port.
The second argument to the constructor of SushiController is a path to the sushi_rpc.proto file, which contains Sushi's Protobuf protocol definition.
If the argument is empty, the class will look for it at usr/share/sushi/sushi_rpc.proto, the default installation path for Sushi.
To use the controller simply use the methods of the controller objects different sections. For example:
# To make sure all the sub-controllers of SushiController close properly, you can wrap them in a try except block:
try:
# Get a list of the tracks available in sushi
list_of_tracks = controller.audio_graph.get_tracks()
# Get the parameters of the track with the id passed to the method
track_id = 0
list_of_processors = controller.parameters.get_track_parameters(track_id)
# Send a note on message to a track in sushi
track_id = 0
channel = 0
note = 65
velocity = 0.8
controller.keyboard.send_note_on(track_id, channel, note, velocity)
# To ensure proper closing of SushiController, close() should be called on your instance when you're done using it
except KeyboardInterrupt:
controller.close()For full documentation on all available methods, use:
$ pydoc3 elkpy.sushicontroller.SushiControllerOn the terminal where the elkpy folder is located.
The examples subdirectory contains examples of how elkpy can be used.
This demonstrates instantiating 3 processors onto Sushi started with an “empty” config, subscribing to notifications to wait for their instantiation, and then setting their parameters once they're available.
To run:
- Ensure you have a Python environment set up where the packages described in requirements.txt are available, globally or in a
venv. - Start Sushi with the provided "sushi_control_example_config.json", and the '--base-plugin-path' set to point to where
mda-vst.vst3plugins are available:
$ ./sushi --portaudio \
--config-file /path/to/elkpy/examples/sushi_control_example_config.json \
--base-plugin-path=/path/to/sushi/build/debug/VST3/Debug/
If you've built Sushi from source, the plugins are built and accessible in the above path relative to the sushi binary.
- Start
sushi_control_example.py:
$ python3 ./sushi_control_example.py --protofile "/path/to/sushi/rpc_interface/protos/sushi_rpc.proto"
The --protofile argument points elkpy to the protocol buffer file used by Sushi.
You should hear Sushi play a familiar theme tune.
An example passive monitor app using elkpy. It connects to a sushi instance, subscribes to notifications and displays all the parameter, transport and audio graph changes that Sushi broadcasts.
Ensure there is a Sushi instance running on the same computer.
Then run:
$ export SUSHI_GRPC_ELKPY_PROTO=./sushi_rpc.proto
$ python3 examples/sushi_monitor.py
Before running unit tests with the unittest command-line interface, you need to export the environment variable SUSHI_GRPC_ELKPY_PROTO, pointing to the Sushi's .proto definition file.
Example:
$ export SUSHI_GRPC_ELKPY_PROTO=./sushi_rpc.proto
$ python3 -m unittest discover -s tests -p '*_test.py'
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent