DSAM port interface.
More...
|
|
constant int | SUCCESS = 0 |
| | Success code.
|
| |
|
constant int | SETTINGS_INVALID = 1 |
| | Error codes.
|
| |
|
constant int | SSH_DPA_PORT_INVALID = 2 |
| |
|
constant int | SSH_DPA_PORT_IN_USE = 3 |
| |
◆ DeviceInterfaceType
Derial device interface type.
| Enumerator |
|---|
| DEV_IFTYPE_AUTO | auto detect
|
| DEV_IFTYPE_DTE | DTE (Data Terminal Equipment) device detected.
|
| DEV_IFTYPE_DCE | DCE (Data Communications Equipment) device detected.
|
◆ FlowControl
Flow control type.
| Enumerator |
|---|
| FLOW_CTRL_NONE | No flow control.
|
| FLOW_CTRL_HARDWARE | Hardware flow control.
|
| FLOW_CTRL_SOFTWARE | Software flow control.
|
◆ Parity
Parity mode.
| Enumerator |
|---|
| PARITY_NONE | No parity (implies 8 data bits)
|
| PARITY_ODD | Odd parity (implies 7 data bits)
|
| PARITY_EVEN | Even parity (implies 7 data bits)
|
◆ State
Port state.
| Enumerator |
|---|
| STATE_AVAILABLE | no clients connected to port
|
| STATE_OCCUPIED | at least one client connected, more clients allowed
|
| STATE_BUSY | no more clients allowed
|
◆ getInfo()
| Info dsam::DsamPort::getInfo |
( |
| ) |
|
Get current port info.
- Returns
- Port info
◆ getSettings()
| Settings dsam::DsamPort::getSettings |
( |
| ) |
|
Get current port settings.
- Returns
- Port settings.
◆ getTtyUsbNumber()
| int dsam::DsamPort::getTtyUsbNumber |
( |
| ) |
|
Get the number of the ttyUSB device.
NOTE: This function is only used internally and is not available via JSON-RPC.
- Returns
- ttyUSB device number
◆ setSettings()
| int dsam::DsamPort::setSettings |
( |
in Settings |
settings | ) |
|
Set port settings.
- Parameters
-
- Returns
- SUCCESS if no error occured or one of the defined error codes
◆ setState()
| void dsam::DsamPort::setState |
( |
in State |
state | ) |
|
Set the state of the port.
NOTE: This function is only used internally and is not available via JSON-RPC.
- Parameters
-
The documentation for this interface was generated from the following file: