Skip to content

Simplified API for controls Zoom effects unit

Notifications You must be signed in to change notification settings

PedalPi/PluginsManager-Zoom

Repository files navigation

Pedal Pi - PluginsManager - Zoom

Controls zoom equipments using the Pedal Pi API.

Code:
https://github.com/PedalPi/PluginsManager-Zoom

Installation

Probably PedalPi requirements

sudo apt-get install portaudio19-dev

Supported Equipment

This library extends PluginsManager to control third effects unit. Note that for this to be possible, the effects unit must be communicable by some protocol (usually MIDI) and someone in the community must implement support in this library. These are currently supported devices. A detailed list of support for each device is below.

Zoom G3 v2

# Instantiate
zoom = ZoomG3v2()
# Connect the object 'zoom' with the real equipment
zoom.connect()

# Load all patches from the equipment
zoom.load_data()

# Disconnect the equipment
zoom.disconnect()

Columns:

  • Command: Feature
  • Pedalboard: Information sended by the Zoom G3 equipment in the "pedalboard" message data. These are usually messages about the state of a pedalboard, but it is possible (but not yet verified) that general information about the equipment is also passed, such as battery information, global level, etc ...
  • Read Change: Zoom equipment informs a change applied directly in it
  • Send Change: API informs changes to the Zoom equipment
  Command
Command Pedalboard Read Change Send Change
Pedalboard/Patch data
Patch Name x x  
Patch Level x x x
Patch Display pos ? no support ?
Effect x x x
Effect status x x x
Param value x x x
CTRL SW/PDL      
PDL DST      
Swap effects     ?
Set current patch x x x
Tunner
Tunner on/off   no support only API
Tunner+mute on/off   no support only API
Replace/swap
Replace patch     ?
Swap patches     ?
Global data
Global tempo     only API
Global level   no support ?
Global output   no support ?
Signal patch     ?
Battery   no support ?
LCD   no support ?
Autosave (on off)     ?
USB audio volume   no support ?
Other messages
Get current patch x x
Change autosaved   no support
Manual save msg    

Legend:

  • Blank cells: Not implemented. It may be supported.
  • x: Integrated with PluginsManager API
  • only API: Not yet integrated with PluginsManager API
  • ?: Unknown. Probably not possible
  • no support: Equipment doesn't informs/receive information about

Other info:

  • Changes applied by the API are not automatically saved to the device.
  • If the autosave option is active on the machine, it eventually saves the latest changes. However, changes made may be lost if the connection to the equipment is terminated before the autosave saves it.

Zoom MS50g v3.x

# Instantiate
zoom = ZoomMS50gv3()
# Connect the object 'zoom' with the real equipment
zoom.connect()

# Load all patches from the equipment
zoom.load_data()

# Disconnect the equipment
zoom.disconnect()

Columns:

  • Command: Feature
  • Pedalboard: Information sended by the Zoom G3 equipment in the "pedalboard" message data. These are usually messages about the state of a pedalboard, but it is possible (but not yet verified) that general information about the equipment is also passed, such as battery information, global level, etc ...
  • Read Change: Zoom equipment informs a change applied directly in it
  • Send Change: API informs changes to the Zoom equipment
  Command
Command Pedalboard Read Change Send Change
Pedalboard/Patch data
Patch Name x no support  
Patch Level no support
Patch Display pos   no support  
Effect x    
Effect status x   x:0-2
Param value x   x:0-2
CTRL SW/PDL no support
PDL DST no support
Swap effects    
Set current patch no support   only API
Tunner
Tunner on/off ? no support only API
Tunner+mute on/off ? no support only API
Replace/swap
Replace patch no support  
Swap patches no support  
Global data
Global tempo   conflictTAP  
Global level no support
Global output no support
Signal patch no support
Battery   no support  
LCD   no support  
Autosave (on off)   no support  
USB audio volume no support
Other messages
Get current patch no support  
Change autosaved no support  
Manual save msg    

Legend:

  • conflictTAP: Same message to the 4º effect 7º param value
  • Blank cells: Not implemented. It may be supported.
  • x: Integrated with PluginsManager API
  • only API: Not yet integrated with PluginsManager API
  • only API:0-2: only API, but only works with 0-2 effects
  • ?: Unknown. Probably not possible
  • no support: Equipment doesn't informs/receive information about

About

Simplified API for controls Zoom effects unit

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages