elkpy.CvGateController

class elkpy.cvgatecontroller.CvGateController(address='localhost:51051', sushi_proto_def='/usr/share/sushi/sushi_rpc.proto')

Bases: object

Class to manage CV/Gate connections in Sushi via gRPC. It creates, deletes and gets info about Cv/Gate connections on sushi tracks.

Attributes:

_stub (CvGateControllerStub): Connection stub to the gRPC CvGate interface.

__init__(address='localhost:51051', sushi_proto_def='/usr/share/sushi/sushi_rpc.proto')

The constructor for the CvGateController class setting up the gRPC connection with sushi.

Args:

address: IP address to Sushi in the uri form : ‘ip-addr:port’ sushi_proto_def: path to the .proto file with SUSHI gRPC services definitions

connect_cv_input_to_parameter(processor_id: int, parameter_id: int, cv_port_id: int) → None

Connects a CV input to a parameter

Parameters:

processor_id (int): The id of the processor to parameter belongs to parameter_id (int): The id of parameter to connect to cv_port_id (int): The id of the CV port to connect to

connect_cv_output_from_parameter(processor_id: int, parameter_id: int, cv_port_id: int) → None

Connects a CV output to a parameter

Parameters:

processor_id (int): The id of the processor to parameter belongs to parameter_id (int): The id of parameter to connect to cv_port_id (int): The id of the CV port to connect to

connect_gate_input_to_processor(processor: int, gate_port_id: int, channel: int, note_no: int) → None

Connects a Gate input to a processor

Parameters:

processor (int): The id of the processor to connect to gate_port_id (int): The id of the gate port being connected channel (int): The midi channel number note_no (int): The note number to trigger

connect_gate_output_from_processor(processor: int, gate_port_id: int, channel: int, note_no: int) → None

Connects a Gate output from a processor

Parameters:

processor (int): The id of the processor to connect to gate_port_id (int): The id of the gate port being connected channel (int): The midi channel number note_no (int): The note number to trigger

disconnect_all_cv_inputs_from_processor(processor: int) → None

Disconnects all CV inputs from a processor.

Parameters:

processor (int): the processor ID from which to disconnect CV inputs

disconnect_all_cv_outputs_from_processor(processor: int) → None

Disconnects all CV outputs from a processor.

Parameters:

processor (int): the processor ID from which to disconnect CV outputs

disconnect_all_gate_inputs_from_processor(processor: int) → None

Disconnects all Gate inputs from a processor.

Parameters:

processor (int): the processor ID from which to disconnect Gate inputs

disconnect_all_gate_outputs_from_processor(processor: int) → None

Disconnects all Gate outputs from a processor.

Parameters:

processor (int): the processor ID from which to disconnect Gate outputs

disconnect_cv_input(processor_id: int, parameter_id: int, cv_port_id: int) → None

Disconnects a CV input from a parameter

Parameters:

procsessor_id (int): The id of the processor the parameter belongs to parameter_id (int): The id of the parameter to disconnect cv_port_id (int): The id of the CV port to disconnect

disconnect_cv_output(processor_id: int, parameter_id: int, cv_port_id: int) → None

Disconnects a CV output from a parameter

Parameters:

procsessor_id (int): The id of the processor the parameter belongs to parameter_id (int): The id of the parameter to disconnect cv_port_id (int): The id of the CV port to disconnect

disconnect_gate_input(processor: int, gate_port_id: int, channel: int, note_no: int) → None

Disconnects a Gate input from a processor

Parameters:

processor (int): The id of the processor to connect to gate_port_id (int): The id of the gate port being connected channel (int): The midi channel number note_no (int): The note number to trigger

disconnect_gate_output(processor: int, gate_port_id: int, channel: int, note_no: int) → None

Disconnects a Gate output from a processor

Parameters:

processor (int): The id of the processor to connect to gate_port_id (int): The id of the gate port being connected channel (int): The midi channel number note_no (int): The note number to trigger

get_all_cv_input_connections() → List[elkpy.sushi_info_types.CvConnection]

Gets all CV input connections

Returns:

List[info_types.CvConnection]: List of CvConnection objects

get_all_cv_output_connections() → List[elkpy.sushi_info_types.CvConnection]

Gets all CV output connections

Returns:

List[info_types.CvConnection]: List of CvConnection objects

get_all_gate_input_connections() → List[elkpy.sushi_info_types.GateConnection]

Gets all Gate input connections

Returns:

List[info_types.GateConnection]: List of GateConnection objects

get_all_gate_output_connections() → List[elkpy.sushi_info_types.GateConnection]

Gets all Gate output connections

Returns:

List[info_types.GateConnection]: List of GateConnection objects

get_cv_input_channel_count() → int

Gets a count of all CV input channels

Returns:

int: count

get_cv_input_connections_for_processor(processor_id: int) → List[elkpy.sushi_info_types.CvConnection]

Gets a list of all CV input connections for specified processor.

Returns:

List[info_types.CvConnection]: List of CvConnection objects

get_cv_output_channel_count() → int

Gets a count of all CV output channels

Returns:

int: count

get_cv_output_connections_for_processor(processor_id: int) → List[elkpy.sushi_info_types.CvConnection]

Gets a list of all CV output connections for specified processor.

Returns:

List[info_types.CvConnection]: List of CvConnection objects

get_gate_input_connections_for_processor(processor_id: int) → List[elkpy.sushi_info_types.GateConnection]

Gets a list of all Gate input connections for specified processor.

Returns:

List[info_types.GateConnection]: List of GateConnection objects

get_gate_output_connections_for_processor(processor_id: int) → List[elkpy.sushi_info_types.GateConnection]

Gets a list of all Gate output connections for specified processor.

Returns:

List[info_types.GateConnection]: List of GateConnection objects