ofDocsdocumentation communication ofSerialDeviceInfo

ofSerialDeviceInfo

editEdit

This describes a Serial device, what ID it has, what name it has, and the path to the device.

getDeviceID( )

int getDeviceID()

Gets the ID of the device

Example: 0,1,2,3 etc.

Returns: the device ID.

getDeviceName( )

string getDeviceName()

Gets the name of the device

Example: usbdevice-a440 or COM4.

Returns: the device name.

getDevicePath( )

string getDevicePath()

Gets the path to the device

Example: /dev/tty.cu/usbdevice-a440.

Returns: the device path.

ofSerialDeviceInfo( )

ofSerialDeviceInfo()

Construct an undefined serial device.

ofSerialDeviceInfo( ... )

ofSerialDeviceInfo(string devicePathIn, string deviceNameIn, int deviceIDIn)

Construct an ofSerialDeviceInfo with parameters.

Parameters:

devicePathIn The path to the device.

deviceNameIn The name of the device.

deviceIDIn The ID of the device.

Variables

int deviceIDThe device ID (e.g. 0, 1, 2, 3, etc).
string deviceNameThe device name (e.g. usbdevice-a440 / COM4).
string devicePathThe device path (e.g /dev/tty.cu/usbdevice-a440).