Pylades OSC Message API - rjsmith/rsbatech-modules GitHub Wiki
This page describes the Open Sound Control message - based API, used between the Pylades VCVRack module and the Pylades TouchOSC preset.
Version: 2.1.0
From Pylades VCVRack to OSC Controller
/fader
Sends mapped parameter control value as a 14-bit integer range 0..16535
| Name | Type | Value | Notes |
|---|---|---|---|
| Id | Integer | 1 |
Id of mapped OSC controller |
| Value | Integer | '5461' |
Value of controlled parameter as 14bit integer |
ADDRESS(/fader) INT32(0) INT32(5461)
/fader/info
Sends extended parameter information for display on the OSC Controller.
| Name | Type | Value | Notes |
|---|---|---|---|
| Id | Integer | 1 |
Id of mapped OSC controller |
| DisplayValue | String | '4.6225' |
Display value of controlled parameter |
| ParameterName | String | '-01-: pan' |
Parameter name. |
ADDRESS(/fader/info) INT32(2) STRING(0 ) STRING(Pulse width)
/module/changing
Marks the start of a series of /fader and fader/info messages sending all the parameter values of a newly selected module.
| Name | Type | Value | Notes |
|---|---|---|---|
| ModuleName | String | 'Clocked'. |
module slug. |
| ModuleDisplayName | String | 'Impromptu Clocked' |
Module display name |
| ModuleY | Float | 38380 |
Module rack Y - axis (vertical) position |
| ModuleX | Float | 29715 |
Module rack X - axis (horizontal) position |
| MaxControllerId | Integer | '27' |
Highest controller id in the module's mapped parameters |
STRING(Clocked) STRING(Impromptu Clocked) FLOAT(38380) FLOAT(29715) INT32(27)
/module/endmml
Marks the completion of the list of mapped modules in the current VCVRack patch
ADDRESS(/module/endmml)
/module/mappedmodule
Information for a single mapped module in the current VCVRack patch.
| Name | Type | Value | Notes |
|---|---|---|---|
| ModuleKey | String | 'Valley Plateau' |
Plugin + module slugs |
| ModuleDisplayName | String | 'Plateau' |
Module display name |
| ModuleY | Float | 38380 |
Module rack Y - axis (vertical) position |
| ModuleX | Float | 31560 |
Module rack X - axis (horizontal) position |
ADDRESS(/module/mappedmodule) STRING(Valley Plateau) STRING(Plateau) FLOAT(38380) FLOAT(31560)
/module/startmml
Marks to commencement of sending a list of mapped modules in the current VCVRack patch
ADDRESS(/module/startmml)
/pylades/version
Reports the RSBATechModules VCVRack plugin version
| Name | Type | Value | Notes |
|---|---|---|---|
| Version | String | '2.1.0' |
RSBATechModules plugin version |
ADDRESS(/pylades/version) STRING(2.1.0)
To Pylades VCVRack from OSC Controller
/fader
Requests the connected Pylades module changes a controlled parameter value.
| Name | Type | Value | Notes |
|---|---|---|---|
| Id | Integer | 1 |
Id of mapped OSC controller |
| Value | Integer | '5461' |
Value of controlled parameter as 14bit integer |
ADDRESS(/fader) INT32(2) INT32(8191)
/pylades/apply/rackmapping
Requests the connected Pylades to switch to the saved VCVRack patch rack-level mapping, if there is one, else does nothing.
ADDRESS(/pylades/apply/rackmapping)
/pylades/apply/modulemapping
Requests the connected Pylades to remotely switch on the "apply" mode, so next mouse click will apply mapped settings for selected module.
ADDRESS(/pylades/apply/modulemapping)
/pylades/listmodules
Requests the connected Pylades modules sends a list of all mapped modules in the current VCVRack patch. Pylades will respond with a series of messages:
/module/startmml1..n./module/mappedmodulen+1./module/endmml
ADDRESS(/pylades/listmodules)
/pylades/next
Requests that the connected Pylades module skips to the next mapped module on the same row as the current mapped module, moving to the right. It will wrap round to the left-most module of the next row down, and then back to the left-most module on the first row.
ADDRESS(/pylades/next)
/pylades/prev
Requests that the connected Pylades module skips to the next mapped module on the same row as the current mapped module, moving to the left. It will wrap round to the right-most module of the next row up, and then back to the right-most module on the last row.
ADDRESS(/pylades/prev)
/pylades/resend
Requests that the connected Pylades module sends the current mapped parameter list (sent by Pylades as individual /fader and /fader/info messages).
ADDRESS(/pylades/resend)
/pylades/resetparam
Requests that the connected Pylades module triggers the indicated parameter ID to reset its value (to whatever the module's developer has set as the default value)
| Name | Type | Value | Notes |
|---|---|---|---|
| Id | Integer | 4 |
Id of mapped OSC controller |
ADDRESS(/pylades/resetparam) INT32(4)
/pylades/select
Requests the connected Pylades module changes the current mapped module to the module located at the given Y , X position in the VCVRack patch
| Name | Type | Value | Notes |
|---|---|---|---|
| ModuleY | Float | 38380 |
Module rack Y - axis (vertical) position |
| ModuleX | Float | 29715 |
Module rack X - axis (vertical) position |
ADDRESS(/pylades/select) FLOAT(38380) FLOAT(29715)
/pylades/version
Requests the RSBATechModules plugin version from the connected Pylades VCVRack module
ADDRESS(/pylades/version)
Acknowledgments
This API was adapted and modified from the excellent OSC'elot VCVRack plugin by TheModularMind.