Menu

SerialDriver status codes

Thierry CHOMAUD vmacari

Return status represents the return value of most serial driver API.
Some of them are considered as normal (info), other as error.
For Java API, error are managed as Java exception.

Status Description Type
OK_SERIALDRIVER_SUCCESS Operation completed with no errors Info
KO_SENDING_FAILURE Failed to send frame for any reason Info
KO_SERIALFRAME_REQUIRED Serial frame has not been specified Info
KO_SERIALDRIVER_NOT_OPEN The serial port has not been open Info
KO_SERIALDRIVER_ALREADY_IN_USE The serial port is already in use the driver Error
KO_SERIALDRIVER_ALREADY_OPEN The port is already opened Error
KO_SERIALDRIVER_LISTENER_ALREADY_REGISTERED A listener has been already registered Error
KO_SERIALDRIVER_LISTENER_NOT_REGISTERED Listener has not beend registered Error
KO_SERIALDRIVER_MAX_SPY_LISTENER_EXCEED Max number of spy listners exceeded Error
KO_SERIALPORT_DISCONNECTED The serial port is disconnected Error
KO_SERIALPORT_UNEXPECTED_ERROR An unexpected error occured Error
KO_SERIALPORT_NOT_AVAILABLE Invalid port name has been specified Error
KO_PARAM_SERIALPORTID_NOT_EXIST Port ID parameter not exists (invalid) Error
KO_PARAM_BAUDRATE_NOT_VALID Specified baudrate is invalid Error
KO_PARAM_DATABIT_NOT_VALID Specified databit is invalid Error
KO_PARAM_STOPBIT_NOT_VALID Specified stop bit is invalid Error
KO_PARAM_PARITY_NOT_VALID Specified parity is invalid Error
KO_PARAM_FLOWCONTROLIN_NOT_VALID Specified IN flowcontrol is invalid Error
KO_PARAM_FLOWCONTROLOUT_NOT_VALID Specified OUT flowcontrol is invalid Error
KO_PARAM_LISTENINGPERIOD_NOT_VALID Specified listenint period is invalid Error
KO_PARAM_NOT_VALID Parameter not valid Error

Related

Wiki: APIs
Wiki: Serial Driver Initialization functions
Wiki: Serial Driver Listener reg-unreg functions
Wiki: Serial Driver Open-Close functions
Wiki: Serial Driver Sending functions

MongoDB Logo MongoDB