VuoSerial.h File Reference

Description

VuoSerial interface.

Copyright

Copyright © 2012–2020 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see https://vuo.org/license.

Definition in file VuoSerial.h.

Go to the source code of this file.

Typedefs
typedef void *	VuoSerial
	Manages sending and receiving serial data. More...

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

Typedef Documentation

VuoSerial

typedef void* VuoSerial

Manages sending and receiving serial data.

Definition at line 34 of file VuoSerial.h.

Function Documentation

VuoSerial_addDevicesChangedTriggers()

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.

Definition at line 262 of file VuoSerialDevices.cc.

VuoSerial_addReceiveTrigger()

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.

Definition at line 250 of file VuoSerialIO.cc.

VuoSerial_checkPendingDevices()

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.

Definition at line 155 of file VuoSerialIO.cc.

VuoSerial_configureDevice()

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

Changes system-wide settings for the specified serial device.

Definition at line 297 of file VuoSerialIO.cc.

VuoSerial_disuse()

void VuoSerial_disuse

(

void

)

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

This function may be called from any thread.

Definition at line 243 of file VuoSerialDevices.cc.

VuoSerial_getDeviceList()

VuoList_VuoSerialDevice VuoSerial_getDeviceList

(

void

)

Returns a list of the currently-avaialble serial devices.

Definition at line 80 of file VuoSerialDevices.cc.

VuoSerial_getShared()

VuoSerial VuoSerial_getShared

(

const VuoText

devicePath

)

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

Definition at line 239 of file VuoSerialIO.cc.

VuoSerial_removeDevicesChangedTriggers()

void VuoSerial_removeDevicesChangedTriggers

(

VuoOutputTrigger(devices, VuoList_VuoSerialDevice)

)

Removes a trigger callback previously added by VuoSerial_addDevicesChangedTriggers.

This function may be called from any thread.

Definition at line 273 of file VuoSerialDevices.cc.

VuoSerial_removeReceiveTrigger()

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.

Definition at line 266 of file VuoSerialIO.cc.

VuoSerial_sendData()

void VuoSerial_sendData	(	VuoSerial	device,
		const VuoData	data
	)

Enqueues data for output on device.

Definition at line 279 of file VuoSerialIO.cc.

VuoSerial_use()

void VuoSerial_use

(

void

)

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

This function may be called from any thread.

Definition at line 183 of file VuoSerialDevices.cc.