Vuo  1.1.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Enumerations | Functions
VuoSerialDevice

Description

Information about a serial I/O device.

Classes

struct  VuoSerialDevice
 Information about a serial I/O device. More...
 

Enumerations

enum  VuoSerialDevice_MatchType { VuoSerialDevice_MatchName, VuoSerialDevice_MatchPath }
 Which field to match on. More...
 

Functions

VuoSerialDevice VuoSerialDevice_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoSerialDevice_getJson (const VuoSerialDevice value)
 Encodes value as a JSON object.
 
char * VuoSerialDevice_getSummary (const VuoSerialDevice value)
 Returns a compact string representation of value.
 
bool VuoSerialDevice_areEqual (const VuoSerialDevice valueA, const VuoSerialDevice valueB)
 Returns true if the two values are equal.
 
bool VuoSerialDevice_isLessThan (const VuoSerialDevice valueA, const VuoSerialDevice valueB)
 Returns true if valueA is less than valueB.
 
bool VuoSerialDevice_realize (VuoSerialDevice device, VuoSerialDevice *realizedDevice)
 If device specifies name-matching:
 
VuoSerialDevice VuoSerialDevice_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoSerialDevice_getString (const VuoSerialDevice value)
 Automatically generated function.
 
void VuoSerialDevice_retain (VuoSerialDevice value)
 Automatically generated function.
 
void VuoSerialDevice_release (VuoSerialDevice value)
 Automatically generated function.
 

Class Documentation

struct VuoSerialDevice
Class Members
VuoSerialDevice_MatchType matchType Which field to use for matching a VuoSerialDevice structure to an actual device.
VuoText name The device's display name.
VuoText path The POSIX filesystem path to the device file.

Enumeration Type Documentation

Which field to match on.

Function Documentation

bool VuoSerialDevice_areEqual ( const VuoSerialDevice  valueA,
const VuoSerialDevice  valueB 
)

Returns true if the two values are equal.

struct json_object* VuoSerialDevice_getJson ( const VuoSerialDevice  value)
read

Encodes value as a JSON object.

char* VuoSerialDevice_getString ( const VuoSerialDevice  value)

Automatically generated function.

char* VuoSerialDevice_getSummary ( const VuoSerialDevice  value)

Returns a compact string representation of value.

bool VuoSerialDevice_isLessThan ( const VuoSerialDevice  valueA,
const VuoSerialDevice  valueB 
)

Returns true if valueA is less than valueB.

VuoSerialDevice VuoSerialDevice_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"matchType": "path",
"name": "FTDI FT232R USB UART (A60049zx)",
"path": "/dev/cu.usbserial-A60049zx"
}
VuoSerialDevice VuoSerialDevice_makeFromString ( const char *  str)

Automatically generated function.

bool VuoSerialDevice_realize ( VuoSerialDevice  device,
VuoSerialDevice realizedDevice 
)

If device specifies name-matching:

  • If at least one serial device is connected, sets realizedDevice to a specific, existing device matched by its POSIX path, and returns true.
  • If no serial devices are connected, returns false, leaving realizedDevice unset.

If device specifies path-matching, sets realizedDevice to a copy of device, and returns true. (Doesn't bother checking whether the path actually exists.)

void VuoSerialDevice_release ( VuoSerialDevice  value)

Automatically generated function.

void VuoSerialDevice_retain ( VuoSerialDevice  value)

Automatically generated function.