Vuo  1.1.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Typedefs | Functions
VuoSerial.h File Reference

Description

VuoSerial interface.

Typedefs

typedef void * VuoSerial
 Manages sending and receiving serial data.
 

Functions

VuoList_VuoSerialDevice VuoSerial_getDeviceList (void)
 Returns a list of the currently-avaialble serial devices.
 
void VuoSerial_use (void)
 Indicates that the caller needs to get notifications about serial devices.
 
void VuoSerial_disuse (void)
 Indicates that the caller no longer needs notifications about serial devices.
 
void VuoSerial_addDevicesChangedTriggers (VuoOutputTrigger(devices, VuoList_VuoSerialDevice))
 Adds a trigger callback, to be invoked whenever the list of known serial devices changes.
 
void VuoSerial_removeDevicesChangedTriggers (VuoOutputTrigger(devices, VuoList_VuoSerialDevice))
 Removes a trigger callback previously added by VuoSerial_addDevicesChangedTriggers.
 
VuoSerial VuoSerial_getShared (const VuoText devicePath)
 Returns the reference-counted object for the specified serial device.
 
void VuoSerial_checkPendingDevices (void)
 Attempts to open each device that has been requested but hasn't yet been successfully opened.
 
void VuoSerial_configureDevice (VuoSerial device, VuoInteger baudRate, VuoInteger dataBits, VuoParity parity, VuoInteger stopBits)
 Changes system-wide settings for the specified serial device.
 
void VuoSerial_addReceiveTrigger (VuoSerial device, VuoOutputTrigger(receivedData, VuoData))
 Adds a trigger callback, to be invoked whenever the specified serial device receives data.
 
void VuoSerial_removeReceiveTrigger (VuoSerial device, VuoOutputTrigger(receivedData, VuoData))
 Removes a trigger callback previously added by VuoSerial_addReceiveTrigger.
 
void VuoSerial_sendData (VuoSerial device, const VuoData data)
 Enqueues data for output on device.
 

Typedef Documentation

typedef void* VuoSerial

Manages sending and receiving serial data.

Function Documentation

void VuoSerial_addDevicesChangedTriggers ( VuoOutputTrigger(devices, VuoList_VuoSerialDevice )

Adds a trigger callback, to be invoked whenever the list of known serial devices changes.

Call VuoSerial_use() before calling this.

This function may be called from any thread.

void VuoSerial_addReceiveTrigger ( VuoSerial  device,
VuoOutputTrigger(receivedData, VuoData  
)

Adds a trigger callback, to be invoked whenever the specified serial device receives data.

This function may be called from any thread.

void VuoSerial_checkPendingDevices ( void  )

Attempts to open each device that has been requested but hasn't yet been successfully opened.

This function may be called from any thread.

void VuoSerial_configureDevice ( VuoSerial  device,
VuoInteger  baudRate,
VuoInteger  dataBits,
VuoParity  parity,
VuoInteger  stopBits 
)

Changes system-wide settings for the specified serial device.

void VuoSerial_disuse ( void  )

Indicates that the caller no longer needs notifications about serial devices.

This function may be called from any thread.

VuoList_VuoSerialDevice VuoSerial_getDeviceList ( void  )

Returns a list of the currently-avaialble serial devices.

VuoSerial VuoSerial_getShared ( const VuoText  devicePath)

Returns the reference-counted object for the specified serial device.

void VuoSerial_removeDevicesChangedTriggers ( VuoOutputTrigger(devices, VuoList_VuoSerialDevice )

Removes a trigger callback previously added by VuoSerial_addDevicesChangedTriggers.

This function may be called from any thread.

void VuoSerial_removeReceiveTrigger ( VuoSerial  device,
VuoOutputTrigger(receivedData, VuoData  
)

Removes a trigger callback previously added by VuoSerial_addReceiveTrigger.

This function may be called from any thread.

void VuoSerial_sendData ( VuoSerial  device,
const VuoData  data 
)

Enqueues data for output on device.

void VuoSerial_use ( void  )

Indicates that the caller needs to get notifications about serial devices.

This function may be called from any thread.