CytonSerial | SuperCollider 3.13.0 Help

Description

this class is for communication via bluetooth serial (dongle). use CytonWifi for the wifi shield.

NOTE: does not survive CmdPeriod.

Class Methods

.new

open port

Arguments:

port	a String with the name of the serial port. by default this is `"/dev/tty.usbserial-DM00DRM0"`
baudrate	it is not recommended to change this. leave it at the default `115200` (see Cyton: -setRadioHostBaudRate)
dataAction	set the OpenBCI: -dataAction
replyAction	set the OpenBCI: -replyAction. note that if none give a default function that just posts will be used.
initAction	set the OpenBCI: -initAction
bufferSize	how many datapoints to store in the internal buffer.

Instance Methods

.close

stops main loop and closes the serial port.

Examples

SerialPort.listDevices;

//just posting data
c= CytonSerial("/dev/tty.usbserial-DM00DRM0", dataAction:{|num, data, accel| [num, data, accel].postln})
c.getVersion  //get firmware version
c.start
c.stop

c.start
c.off(1)  //turn off the first channel
c.off([2, 3, 4])
c.off((1..8))  //all off
c.on(3)
c.on((1..8))  //all on

c.testGnd  //test signal
c.test1AmpSlow
c.test1AmpFast
c.testDC
c.test2AmpSlow
c.test2AmpFast
c.stop

c.softReset
c.data  //last sample data reading
c.accel  //last accelerometer reading
c.accelAction= {|accel| accel.postln}
c.dataAction= {}
c.start  //should only post accelerometer now (notice the lower sample rate)
c.accelAction= {|accel| accel.postln}  //-4 to 4 g
c.stop

c.dataAction= {|num, data, accel| [num, data, accel].postln}  //sample data in uV
c.start
c.stop
c.close  //finish and close the serial port

//--
c= CytonSerial("/dev/tty.usbserial-DM00DRM0")
c.settings(1, 1)  //channel 1, power down
c.settings(1, 0)  //channel 1, power up
c.settings(1, 0, 0)  //channel 1, power up, set gain to 1
c.settings(1, 0, 6)  //channel 1, power up, set gain to 24 (the default)
c.getDefaultChannelSettings
c.setDefaultChannelSettings

c.timeStampingON
c.timeStampingOFF

c.attachWifi
c.getWifiStatus
c.softResetWifi
c.removeWifi
c.getWifiStatus

c.getRadioChannel
c.setRadioChannel(7)
c.getRadioPollTime
c.setRadioPollTime(80)  //the default is 80ms
c.setRadioHostBaudRate(0)
c.getRadioSystemStatus
c.getBoardMode
c.setBoardMode(2)
c.getSampleRate
c.setSampleRate(4)
c.startLogging
c.stopLogging
c.getVersion  //get firmware version
c.query  //query register settings
c.softReset
c.start
c.stop
c.close

helpfile source: /tmp/tmp5ewoie94baryon_OpenBCI-SuperCollider/OpenBCI-SuperCollider/Classes/CytonSerial.schelp
link::OpenBCI-SuperCollider/Classes/CytonSerial::

CytonSerial
Extension

Description

Class Methods

.new

Arguments:

Instance Methods

.port

.close

Examples

CytonSerialExtension

Description

Class Methods

.new

Arguments:

Instance Methods

.port

.close

Examples

CytonSerial
Extension