RNBO Objects & Operators rnbo.remote
Open Help

rnbo.remote

Communicate with a remote rnbo device

Description

Remotely set and receive information on a Remote RNBO Device. This Information includes information and changes with parameters , messages, MIDI, external clock , and RNBO presets on the remote device.

Arguments

None.

Attributes

addr [symbol] (default: )

Setting the address of the device host running the RNBO code will point the rnbo.remote device to communicate with that device. The address is the IPV4 address of the RNBO remote device.

fdbkdel [float]

The number of milliseconds to ignore incoming parameter updates after a local update for feedback suppression.

inst [int]

The numbered instance of the patcher to load and communicate with. This is associated alpabetically with the patchername that has been exported to your Pi (f.e. if you have two patches on your pi, @inst 0 will reference @patchername delay and @inst 1 will reference @patchername reverb ).

name [symbol] (default: )

The name of the RNBO device host to communicate with. This is the name set for your RNBO device determined in the configuration settings at the time of export.

patchername [symbol] (default: )

The name of the patcher to load and communicate with. This is the name set for your patcher determined under Patch Name in the target sidebar at the the time of export. Possible values:

'<none>'
'untitled'

port [int]

Communicate on a specific port of the RNBO device shared IPv4 network. This can be specifically useful for instances where you would like to utilize port forwarding for the rnbo.remote 's communication. Provided that both the RNBO device and the remote are connected to the same network, setting the port will allow messaging to be forwarded specifically to that port. The default port is 5678 .

presets/initial [symbol] (default: )

The name of the preset to load on reboot of the RNBO Remote device. By default, the first preset will load on reboot.

presets/midi_channel [symbol] (default: none)

The midi channel (or omni or none) to use to change presets with program change messages Possible values:

'omni'
'1'
'2'
'3'
'4'
'5'
'6'
'7'
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'15'
'16'
'none'

setname [symbol] (default: )

The name of the current set Possible values:

'<none>'

transport/bpm [float]

Remote control the transport tempo (beats per minute) of the RNBO code running locally on the RNBO remote device.

transport/rolling [int]

The RNBO code running on the remote device has it's own transport tempo. Enabling transport/rolling allows us the ability to remotely control and visualize the transport tempo running on the RNBO runner from the rnbo.remote object.

transport/sync [int]

Transport Sync

Common Box Attributes

Messages

int

Arguments

byte [int]
MIDI formatted messages sent to the left inlet of the rnbo.remote are sent to midiin objects on the remote device.

launchwebinterface

Launch the Web Interface in the default browser window.

message

Arguments

message [list]
To change the value of a named inport object , the word message is prepended to the inport @name, followed by a value.
message 'inport @name' $

patcherdestroy

Remove a named patcher that has been exported to the pi from the runner's cache.

If an instance of the patcher is loaded when a "patcherdestroy" is set for it, the instance will remain loaded until a different patcher is loaded.

patcherrename

Rename a named graph set to a different name. The message should be formatted as setrename 'Graph set to be renamed' "new graph set name."

preset

Arguments

preset [list]
Load, save, and delete presets on the RNBO device remotely.

To load a preset from the RNBO devices preset index, append the preset message with the load argument, followed by the name of the preset so that it looks like this : preset load $1 .

To save a preset from the RNBO devices preset index, append the preset message with the save argument, followed by the name of the preset so that it looks like this : preset save $1 .

To delete a preset from the RNBO devices preset index, append the preset message with the delete argument, followed by the name of the preset so that it looks like this : preset delete $1 .

To set a preset to load first when the device intially boots, append the preset message with the initial argument,followed by the name of the preset so that it looks like this : preset initial $1 . If this is not set, then by default, the first preset saved to the rnbo.device will load on reboot.

setdestroy

Delete a Graph Set from the list of saved Sets on the Runner. Deleting the set will also remove it from the Web interface.

setload

Load a Graph Set from the list of saved Graph Sets on the Runner. Loading the set will also load it in the Web interface.

setrename

Rename a named graph set to a different name. The message should be formatted as setrename 'Graph set to be renamed' "new graph set name."

setsave

Save the loaded Graph Set on the Runner. Saving the set will also save it to the Web interface.

status

From the rightmost outlet, the status of the RNBO code on the remote device is reported.

The "host names" message retrieves a list of discovered remote rnbo devices. This is essentially all of the RNBO Device names that appear on the shared networks address.

The "connectivity" message reveals the connectivity status between the Remote and the RNBO device. An output value of '1' means that the devices are connected for remote control and retrieval of information from the device, AND '0'means there are no connected devices.

The "instance_info" message retrieves and lists the values of the named parameters, inports, outports, and data_refs

unloadall

Unload the loaded device running on the runner. This will remove the device, but it doesn't delete the patcher. It will still remain a patcher to load as a device on the runner.

Inlets

Inlet

The Message and Midi inlet on the rnbo.remote receive midi formatted messages and messages to set attributes of the exported rnbo code on the RNBO remote device. MIDI messages sent to the left inlet of the rnbo.remote are sent to midiin objects on the remote device. Messages can be set to named inport objects in the left inlet to target named param objects and attributes of the rnbo.remote object.

Outlets

Midi Bytes

The middle outlet outputs the status of midiformatted messages that are sent to midiout objects in the exported RNBO code on the remote device.

Outport Messages

The left outlet reports the state of outport objects exported rnbo code on the RNBO remote device. To report the state of the outport objects, reference the object by namespace using an object such as route.

Status Info

The right outlet reports the status of the RNBO code on the remote device.

The "host names" message retrieves a list of discovered remote rnbo devices. This is essentially all of the RNBO Device names that appear on the shared networks address.

The "connectivity" message reveals the connectivity status between the Remote and the RNBO device. An output value of '1' means that the devices are connected for remote control and retrieval of information from the device, and '0'means there are no connected devices.

The "instance_info" message retrieves and lists the values of the named parameters, inports, outports, and data_refs

See Also

Name Description
rnbo~ The rnbo~ object is a Max wrapper for RNBO technology