https://sourceforge.net/p/coronissdk/wiki/SerialDriver%2520Configuration%2520functions/Recent changes to SerialDriver Configuration functionsenSat, 12 May 2012 19:33:46 -0000https://sourceforge.net/p/coronissdk/wiki/SerialDriver%2520Configuration%2520functions/<pre>--- v8 +++ v9 @@ -8,72 +8,71 @@ * set the serial port flow control mode (flowControl IN and OUT) * set the listening period for the scrutation of serial port +------------------------ **C source API extract** ------------------------- /** * Get the serial port ID, if previously setted * @param driver The SerialDriver instance * @param Setted literal value of serial port ID (dependent from OS) * Prealocated char buffer where to write port id * @param Size of the setted literal value, <code>0</code> if not setted * Size of prealocated buffer where ID is stored */ WAVENIS_API int driver_get_port_id( const void* driver, char* id, int idLen ); /** * Set the serial port ID to which SerialDriver must be connected * @param driver The SerialDriver instance * @param id The serial port identifier to set * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_SERIALPORTID_NOT_EXIST if id is not valid for the OS */ WAVENIS_API int driver_set_port_id( const void* driver, const char* id ); /** * Set the standard serial port parameters * Valid serial port parameters are listed in serial_port_constants.h * @param driver The SerialDriver instance * @param baudRate The baud rate * @param dataBits The number of data bits * @param stopBits The number of stop bits * @param parity The type of parity * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_xxx_NOT_VALID if param xxx is not valid */ WAVENIS_API int driver_set_port_params( const void* driver, int baudRate, int dataBit, int stopBit, int parity ); /** * Set the listening period parameter of the serial port listener * @param driver The SerialDriver instance * @param receiveTimeout Listening period to set (between 1 ms and 100 ms) * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_LISTENINGPERIOD_NOT_VALID if period is not valid for the OS */ WAVENIS_API int driver_set_listening_period_param( const void* driver, int receiveTimeout ); /** * Set the flowcontrol mode parameter of the serial port * Valid serial port parameters are listed in serial_port_constants.h * @param driver The SerialDriver instance * @param flowControlIn Type of flow control for receiving (SerialPort constants) * @param flowControlOut Type of flow control for sending (SerialPort constants) * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_xxx_NOT_VALID if param xxx is not valid */ WAVENIS_API int driver_set_flow_control_mode_params( const void* driver, int flowControlIn, int flowControlOut ); -<br> +--------------------------- **Java source API extract** ---------------------------- /** * Get the serial port ID, if previously setted </pre>Thierry CHOMAUDSat, 12 May 2012 19:33:46 -0000https://sourceforge.net73f64f78c5b960087688a2f63df55227d5c71c84https://sourceforge.net/p/coronissdk/wiki/SerialDriver%2520Configuration%2520functions/<pre>--- v7 +++ v8 @@ -9,69 +9,71 @@ * set the listening period for the scrutation of serial port **C source API extract** - - /** +------------------------ + + /** * Get the serial port ID, if previously setted * @param driver The SerialDriver instance * @param Setted literal value of serial port ID (dependent from OS) * Prealocated char buffer where to write port id * @param Size of the setted literal value, <code>0</code> if not setted * Size of prealocated buffer where ID is stored */ WAVENIS_API int driver_get_port_id( const void* driver, char* id, int idLen ); /** * Set the serial port ID to which SerialDriver must be connected * @param driver The SerialDriver instance * @param id The serial port identifier to set * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_SERIALPORTID_NOT_EXIST if id is not valid for the OS */ WAVENIS_API int driver_set_port_id( const void* driver, const char* id ); /** * Set the standard serial port parameters * Valid serial port parameters are listed in serial_port_constants.h * @param driver The SerialDriver instance * @param baudRate The baud rate * @param dataBits The number of data bits * @param stopBits The number of stop bits * @param parity The type of parity * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_xxx_NOT_VALID if param xxx is not valid */ WAVENIS_API int driver_set_port_params( const void* driver, int baudRate, int dataBit, int stopBit, int parity ); /** * Set the listening period parameter of the serial port listener * @param driver The SerialDriver instance * @param receiveTimeout Listening period to set (between 1 ms and 100 ms) * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_LISTENINGPERIOD_NOT_VALID if period is not valid for the OS */ WAVENIS_API int driver_set_listening_period_param( const void* driver, int receiveTimeout ); /** * Set the flowcontrol mode parameter of the serial port * Valid serial port parameters are listed in serial_port_constants.h * @param driver The SerialDriver instance * @param flowControlIn Type of flow control for receiving (SerialPort constants) * @param flowControlOut Type of flow control for sending (SerialPort constants) * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_xxx_NOT_VALID if param xxx is not valid */ WAVENIS_API int driver_set_flow_control_mode_params( const void* driver, int flowControlIn, int flowControlOut ); <br> **Java source API extract** +--------------------------- /** * Get the serial port ID, if previously setted </pre>Thierry CHOMAUDSat, 12 May 2012 19:32:00 -0000https://sourceforge.netf71918d122179e6c5245486030fa5aed318ca8f9https://sourceforge.net/p/coronissdk/wiki/SerialDriver%2520Configuration%2520functions/<pre>--- v6 +++ v7 @@ -1,6 +1,6 @@ ##Configuration functions## -After having instanciate a SerialDriver implementation, serial driver could be configured: +After having instanciate a SerialDriver implementation, the created serial driver instance could be configured using the following services: * init method to read the configuration to used from a property file * get/set port id to configure the serial port id to used for the serial driver connection </pre>Thierry CHOMAUDSat, 12 May 2012 19:31:21 -0000https://sourceforge.netb0e71cbbeb66ebf07bc69204136f8ba0fd2743eahttps://sourceforge.net/p/coronissdk/wiki/SerialDriver%2520Configuration%2520functions/<pre>--- v5 +++ v6 @@ -1,4 +1,4 @@ -**Configuration functions** +##Configuration functions## After having instanciate a SerialDriver implementation, serial driver could be configured: </pre>Thierry CHOMAUDFri, 11 May 2012 13:34:47 -0000https://sourceforge.netac291dfb89836380568563f56d637b1c5e905b12https://sourceforge.net/p/coronissdk/wiki/SerialDriver%2520Configuration%2520functions/<pre>--- v4 +++ v5 @@ -8,70 +8,70 @@ * set the serial port flow control mode (flowControl IN and OUT) * set the listening period for the scrutation of serial port -**C API extract** - - /** +**C source API extract** + + /** * Get the serial port ID, if previously setted * @param driver The SerialDriver instance * @param Setted literal value of serial port ID (dependent from OS) * Prealocated char buffer where to write port id * @param Size of the setted literal value, <code>0</code> if not setted * Size of prealocated buffer where ID is stored */ WAVENIS_API int driver_get_port_id( const void* driver, char* id, int idLen ); /** * Set the serial port ID to which SerialDriver must be connected * @param driver The SerialDriver instance * @param id The serial port identifier to set * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_SERIALPORTID_NOT_EXIST if id is not valid for the OS */ WAVENIS_API int driver_set_port_id( const void* driver, const char* id ); /** * Set the standard serial port parameters * Valid serial port parameters are listed in serial_port_constants.h * @param driver The SerialDriver instance * @param baudRate The baud rate * @param dataBits The number of data bits * @param stopBits The number of stop bits * @param parity The type of parity * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_xxx_NOT_VALID if param xxx is not valid */ WAVENIS_API int driver_set_port_params( const void* driver, int baudRate, int dataBit, int stopBit, int parity ); /** * Set the listening period parameter of the serial port listener * @param driver The SerialDriver instance * @param receiveTimeout Listening period to set (between 1 ms and 100 ms) * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_LISTENINGPERIOD_NOT_VALID if period is not valid for the OS */ WAVENIS_API int driver_set_listening_period_param( const void* driver, int receiveTimeout ); /** * Set the flowcontrol mode parameter of the serial port * Valid serial port parameters are listed in serial_port_constants.h * @param driver The SerialDriver instance * @param flowControlIn Type of flow control for receiving (SerialPort constants) * @param flowControlOut Type of flow control for sending (SerialPort constants) * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_xxx_NOT_VALID if param xxx is not valid */ WAVENIS_API int driver_set_flow_control_mode_params( const void* driver, int flowControlIn, int flowControlOut ); - -**Java API extract** +<br> +**Java source API extract** /** * Get the serial port ID, if previously setted </pre>Thierry CHOMAUDFri, 11 May 2012 13:33:11 -0000https://sourceforge.netfe553f32900a277b9f34ecdfc7fba77765c93fe8https://sourceforge.net/p/coronissdk/wiki/SerialDriver%2520Configuration%2520functions/<pre>--- v3 +++ v4 @@ -8,27 +8,27 @@ * set the serial port flow control mode (flowControl IN and OUT) * set the listening period for the scrutation of serial port -**C API** - - /** - * Get the serial port ID, if previously setted - * @param driver The SerialDriver instance +**C API extract** + + /** + * Get the serial port ID, if previously setted + * @param driver The SerialDriver instance * @param Setted literal value of serial port ID (dependent from OS) * Prealocated char buffer where to write port id * @param Size of the setted literal value, <code>0</code> if not setted * Size of prealocated buffer where ID is stored */ WAVENIS_API int driver_get_port_id( const void* driver, char* id, int idLen ); /** * Set the serial port ID to which SerialDriver must be connected * @param driver The SerialDriver instance * @param id The serial port identifier to set * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_SERIALPORTID_NOT_EXIST if id is not valid for the OS */ WAVENIS_API int driver_set_port_id( const void* driver, const char* id ); /** @@ -44,20 +44,20 @@ * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_xxx_NOT_VALID if param xxx is not valid */ WAVENIS_API int driver_set_port_params( const void* driver, int baudRate, int dataBit, int stopBit, int parity ); /** * Set the listening period parameter of the serial port listener * @param driver The SerialDriver instance * @param receiveTimeout Listening period to set (between 1 ms and 100 ms) * @return the set status (serial_driver_status) * OK_SERIALDRIVER_SUCCESS if setting succeed * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_LISTENINGPERIOD_NOT_VALID if period is not valid for the OS */ WAVENIS_API int driver_set_listening_period_param( const void* driver, int receiveTimeout ); /** * Set the flowcontrol mode parameter of the serial port * Valid serial port parameters are listed in serial_port_constants.h * @param driver The SerialDriver instance @@ -68,61 +68,62 @@ * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open * KO_PARAM_xxx_NOT_VALID if param xxx is not valid */ WAVENIS_API int driver_set_flow_control_mode_params( const void* driver, int flowControlIn, int flowControlOut ); -**Java API** - - /** - * Get the serial port ID, if previously setted - * @return Literal value of serial port ID (dependent from OS), <code>null</code> if not setted - */ - public String getSerialPortId(); - - /** - * Set the serial port ID to which SerialDriver must be connected - * @param serialPortId serial port identifier (must be valid for the OS) - * @throws SerialDriverException if setting fails - * SERIALDRIVER_ALREADY_OPEN if driver is already open - * SERIALPORTID_NOT_EXIST if id is not valid for the OS - */ - public void setSerialPortId(String serialPortId) throws SerialDriverException; - - /** - * Set the standard serial port parameters - * Valid serial port parameters are listed in SerialPortConstants - * @param baudRate The baud rate - * @param dataBits The number of data bits - * @param stopBits The number of stop bits - * @param parity The type of parity - * @throws SerialDriverException if setting fails - * SERIALDRIVER_ALREADY_OPEN if driver is already open - * PARAM_xxx_NOT_VALID if param xxx is not valid - */ - public void setSerialPortParams ( - int baudRate, - int dataBits, - int stopBits, - int parity) throws SerialDriverException; - - /** - * Set the listening period parameter - * @param listeningPeriod Listening period to set (between 1 ms and 100 ms) - * @throws SerialDriverException if setting fails - * SERIALDRIVER_ALREADY_OPEN if driver is already open - * PARAM_LISTENINGPERIOD_NOT_VALID if period is not valid - */ - public void setListeningPeriodParam ( - int listeningPeriod) throws SerialDriverException; - - /** - * Set the flowControlMode parameters - * Valid serial port parameters are listed in SerialPortConstants - * @param flowControlIn Type of flow control for receiving (SerialPort constants) - * @param flowControlOut Type of flow control for sending (SerialPort constants) - * @throws SerialDriverException if setting fails - * SERIALDRIVER_ALREADY_OPEN if driver is already open - * PARAM_xxx_NOT_VALID if param xxx is not valid - */ - public void setFlowControlModeParam ( - int flowControlIn, - int flowControlOut) throws SerialDriverException; + +**Java API extract** + + /** + * Get the serial port ID, if previously setted + * @return Literal value of serial port ID (dependent from OS), <code>null</code> if not setted + */ + public String getSerialPortId(); + + /** + * Set the serial port ID to which SerialDriver must be connected + * @param serialPortId serial port identifier (must be valid for the OS) + * @throws SerialDriverException if setting fails + * SERIALDRIVER_ALREADY_OPEN if driver is already open + * SERIALPORTID_NOT_EXIST if id is not valid for the OS + */ + public void setSerialPortId(String serialPortId) throws SerialDriverException; + + /** + * Set the standard serial port parameters + * Valid serial port parameters are listed in SerialPortConstants + * @param baudRate The baud rate + * @param dataBits The number of data bits + * @param stopBits The number of stop bits + * @param parity The type of parity + * @throws SerialDriverException if setting fails + * SERIALDRIVER_ALREADY_OPEN if driver is already open + * PARAM_xxx_NOT_VALID if param xxx is not valid + */ + public void setSerialPortParams ( + int baudRate, + int dataBits, + int stopBits, + int parity) throws SerialDriverException; + + /** + * Set the listening period parameter + * @param listeningPeriod Listening period to set (between 1 ms and 100 ms) + * @throws SerialDriverException if setting fails + * SERIALDRIVER_ALREADY_OPEN if driver is already open + * PARAM_LISTENINGPERIOD_NOT_VALID if period is not valid + */ + public void setListeningPeriodParam ( + int listeningPeriod) throws SerialDriverException; + + /** + * Set the flowControlMode parameters + * Valid serial port parameters are listed in SerialPortConstants + * @param flowControlIn Type of flow control for receiving (SerialPort constants) + * @param flowControlOut Type of flow control for sending (SerialPort constants) + * @throws SerialDriverException if setting fails + * SERIALDRIVER_ALREADY_OPEN if driver is already open + * PARAM_xxx_NOT_VALID if param xxx is not valid + */ + public void setFlowControlModeParam ( + int flowControlIn, + int flowControlOut) throws SerialDriverException; </pre>Thierry CHOMAUDFri, 11 May 2012 13:30:56 -0000https://sourceforge.netabdf7edee20faf61008dd98285f2bb7e8f4d7752https://sourceforge.net/p/coronissdk/wiki/SerialDriver%2520Configuration%2520functions/<pre>--- v2 +++ v3 @@ -1,100 +1,128 @@ **Configuration functions** - - /** - * Get driver(port) identifier - */ - int driver_get_port_id ( const void* driver, char* id, int idLen ); -* Parameter *driver*: Driver descriptor for which to get port id. -* Parameter *id*: prealocated char buffer where to write port id. -* Parameter *idLen*: the size of prealocated buffer where ID is stored. -* Return : the operation completion status [Serial Driver status codes]. -* Possible status codes: -~~~~~~ -* OK_SERIALDRIVER_SUCCESS -* KO_PARAM_NOT_VALID -~~~~~~ - -Code example: [Serial Driver Set and Get port Id example] - - /** - * Set driver(port) identifier, If driver(port) was not - * connected then it simple set id. If current port is opened already opened error - * will be returned. - */ - int driver_set_port_id ( const void* driver, const char* id ); -* Parameter *driver*: Driver descriptor for which to set port id. -* Parameter *id*: port id string. -* Return : the operation completion status [Serial Driver status codes]. -* Note: For windows serial port id must be like "COM ...", for linux like "/dev/tty ...". -* Possible status codes: -~~~~~~ -* OK_SERIALDRIVER_SUCCESS -* KO_PARAM_NOT_VALID -* KO_SERIALDRIVER_ALREADY_OPEN -* KO_PARAM_SERIALPORTID_NOT_EXIST -~~~~~~ - -Code example: [Serial Driver Set and Get port Id example] - - /** - * Set driver(port) baud rate, data bit, stop bit, parity, if driver(port) was not - * connected then it simple set data. If current port is opened already opened error - * will be returned. - */ - int driver_set_port_params ( const void* driver, int baudRate, int dataBit, int stopBit, int parity ); -* Parameter *driver*: Driver descriptor for which to set port params. -* Parameter *baudRate*: the port baudrate - [Serial Driver Baudrates]. -* Parameter *dataBit*: the port data bit size- [Serial Driver Data bits size]. -* Parameter *stopBit*: the port stop bits cout- [Serial Driver Stop bits count]. -* Parameter *parity*: the port stop bits cout- [Serial Driver parity values]. -* Return : the operation completion status [Serial Driver status codes]. -* Note: parameter values are universal, internally they are converted to a right platform value. -* Possible status codes: -~~~~~~ -* OK_SERIALDRIVER_SUCCESS -* KO_PARAM_NOT_VALID -* KO_SERIALDRIVER_ALREADY_IN_USE -* KO_PARAM_BAUDRATE_NOT_VALID -* KO_PARAM_BAUDRATE_NOT_VALID -* KO_PARAM_BAUDRATE_NOT_VALID -* KO_PARAM_PARITY_NOT_VALID -~~~~~~ - -Code example: [Serial Driver Set port parameters example] - - /** - * Set driver(port) timeout. - */ - int driver_set_listening_period_param ( const void* driver, int receiveTimeout ); -* Parameter *driver*: Driver descriptor for which to set port timeout. -* Parameter *receiveTimeout *: the port listening timeout. -* Return : the operation completion status [Serial Driver status codes]. -* Possible status codes: -~~~~~~ -* OK_SERIALDRIVER_SUCCESS -* KO_PARAM_NOT_VALID -* KO_SERIALDRIVER_ALREADY_OPEN -* KO_PARAM_LISTENINGPERIOD_NOT_VALID -~~~~~~ - -Code example: [Serial Driver Set port parameters example]. - - /** - * Set driver(port) flow control mode. - */ - int driver_set_flow_control_mode_params ( const void* driver, int flowControlIn, int flowControlOut); -* Parameter *driver*: Driver descriptor for which to set flow control mode. -* Parameter *flowControlIn*: the IN flow control from [Serial Driver IN flow control mode]. -* Parameter *flowControlOut*: the OUT flow control from [Serial Driver OUT flow control mode]. -* Return : the operation completion status [Serial Driver status codes]. -* Possible status codes: -~~~~~~ -* OK_SERIALDRIVER_SUCCESS -* KO_PARAM_NOT_VALID -* KO_SERIALDRIVER_ALREADY_OPEN -* KO_PARAM_FLOWCONTROLIN_NOT_VALID -* KO_PARAM_FLOWCONTROLOUT_NOT_VALID -~~~~~~ - -Code example: [Serial Driver Set port parameters example]. +After having instanciate a SerialDriver implementation, serial driver could be configured: + +* init method to read the configuration to used from a property file +* get/set port id to configure the serial port id to used for the serial driver connection +* set standard serial port parameters (baudrate, dataBit, stopBit, parity) +* set the serial port flow control mode (flowControl IN and OUT) +* set the listening period for the scrutation of serial port + +**C API** + + /** + * Get the serial port ID, if previously setted + * @param driver The SerialDriver instance + * @param Setted literal value of serial port ID (dependent from OS) + * Prealocated char buffer where to write port id + * @param Size of the setted literal value, <code>0</code> if not setted + * Size of prealocated buffer where ID is stored + */ + WAVENIS_API int driver_get_port_id( const void* driver, char* id, int idLen ); + + /** + * Set the serial port ID to which SerialDriver must be connected + * @param driver The SerialDriver instance + * @param id The serial port identifier to set + * @return the set status (serial_driver_status) + * OK_SERIALDRIVER_SUCCESS if setting succeed + * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open + * KO_SERIALPORTID_NOT_EXIST if id is not valid for the OS + */ + WAVENIS_API int driver_set_port_id( const void* driver, const char* id ); + + /** + * Set the standard serial port parameters + * Valid serial port parameters are listed in serial_port_constants.h + * @param driver The SerialDriver instance + * @param baudRate The baud rate + * @param dataBits The number of data bits + * @param stopBits The number of stop bits + * @param parity The type of parity + * @return the set status (serial_driver_status) + * OK_SERIALDRIVER_SUCCESS if setting succeed + * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open + * KO_PARAM_xxx_NOT_VALID if param xxx is not valid + */ + WAVENIS_API int driver_set_port_params( const void* driver, int baudRate, int dataBit, int stopBit, int parity ); + + /** + * Set the listening period parameter of the serial port listener + * @param driver The SerialDriver instance + * @param receiveTimeout Listening period to set (between 1 ms and 100 ms) + * @return the set status (serial_driver_status) + * OK_SERIALDRIVER_SUCCESS if setting succeed + * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open + * KO_PARAM_LISTENINGPERIOD_NOT_VALID if period is not valid for the OS + */ + WAVENIS_API int driver_set_listening_period_param( const void* driver, int receiveTimeout ); + + /** + * Set the flowcontrol mode parameter of the serial port + * Valid serial port parameters are listed in serial_port_constants.h + * @param driver The SerialDriver instance + * @param flowControlIn Type of flow control for receiving (SerialPort constants) + * @param flowControlOut Type of flow control for sending (SerialPort constants) + * @return the set status (serial_driver_status) + * OK_SERIALDRIVER_SUCCESS if setting succeed + * KO_SERIALDRIVER_ALREADY_OPEN if driver is already open + * KO_PARAM_xxx_NOT_VALID if param xxx is not valid + */ + WAVENIS_API int driver_set_flow_control_mode_params( const void* driver, int flowControlIn, int flowControlOut ); + +**Java API** + + /** + * Get the serial port ID, if previously setted + * @return Literal value of serial port ID (dependent from OS), <code>null</code> if not setted + */ + public String getSerialPortId(); + + /** + * Set the serial port ID to which SerialDriver must be connected + * @param serialPortId serial port identifier (must be valid for the OS) + * @throws SerialDriverException if setting fails + * SERIALDRIVER_ALREADY_OPEN if driver is already open + * SERIALPORTID_NOT_EXIST if id is not valid for the OS + */ + public void setSerialPortId(String serialPortId) throws SerialDriverException; + + /** + * Set the standard serial port parameters + * Valid serial port parameters are listed in SerialPortConstants + * @param baudRate The baud rate + * @param dataBits The number of data bits + * @param stopBits The number of stop bits + * @param parity The type of parity + * @throws SerialDriverException if setting fails + * SERIALDRIVER_ALREADY_OPEN if driver is already open + * PARAM_xxx_NOT_VALID if param xxx is not valid + */ + public void setSerialPortParams ( + int baudRate, + int dataBits, + int stopBits, + int parity) throws SerialDriverException; + + /** + * Set the listening period parameter + * @param listeningPeriod Listening period to set (between 1 ms and 100 ms) + * @throws SerialDriverException if setting fails + * SERIALDRIVER_ALREADY_OPEN if driver is already open + * PARAM_LISTENINGPERIOD_NOT_VALID if period is not valid + */ + public void setListeningPeriodParam ( + int listeningPeriod) throws SerialDriverException; + + /** + * Set the flowControlMode parameters + * Valid serial port parameters are listed in SerialPortConstants + * @param flowControlIn Type of flow control for receiving (SerialPort constants) + * @param flowControlOut Type of flow control for sending (SerialPort constants) + * @throws SerialDriverException if setting fails + * SERIALDRIVER_ALREADY_OPEN if driver is already open + * PARAM_xxx_NOT_VALID if param xxx is not valid + */ + public void setFlowControlModeParam ( + int flowControlIn, + int flowControlOut) throws SerialDriverException; </pre>Thierry CHOMAUDFri, 11 May 2012 13:29:42 -0000https://sourceforge.net2c1ca7ac6f129a488dcd06375d6e1d760f5ed217https://sourceforge.net/p/coronissdk/wiki/SerialDriver%2520Configuration%2520functions/<pre>--- v1 +++ v2 @@ -1,4 +1,3 @@ - **Configuration functions** </pre>Thierry CHOMAUDFri, 11 May 2012 13:09:22 -0000https://sourceforge.net32f06d3030fc53631f8ce40f0019531335c4cb5ehttps://sourceforge.net/p/coronissdk/wiki/Serial%2520Driver%2520Configuration%2520functions/ **Configuration functions** /** * Get driver(port) identifier */ int driver_get_port_id ( const void* driver, char* id, int idLen ); * Parameter *driver*: Driver descriptor for which to get port id. * Parameter *id*: prealocated char buffer where to write port id. * Parameter *idLen*: the size of prealocated buffer where ID is stored. * Return : the operation completion status [Serial Driver status codes]. * Possible status codes: ~~~~~~ * OK_SERIALDRIVER_SUCCESS * KO_PARAM_NOT_VALID ~~~~~~ Code example: [Serial Driver Set and Get port Id example] /** * Set driver(port) identifier, If driver(port) was not * connected then it simple set id. If current port is opened already opened error * will be returned. */ int driver_set_port_id ( const void* driver, const char* id ); * Parameter *driver*: Driver descriptor for which to set port id. * Parameter *id*: port id string. * Return : the operation completion status [Serial Driver status codes]. * Note: For windows serial port id must be like "COM ...", for linux like "/dev/tty ...". * Possible status codes: ~~~~~~ * OK_SERIALDRIVER_SUCCESS * KO_PARAM_NOT_VALID * KO_SERIALDRIVER_ALREADY_OPEN * KO_PARAM_SERIALPORTID_NOT_EXIST ~~~~~~ Code example: [Serial Driver Set and Get port Id example] /** * Set driver(port) baud rate, data bit, stop bit, parity, if driver(port) was not * connected then it simple set data. If current port is opened already opened error * will be returned. */ int driver_set_port_params ( const void* driver, int baudRate, int dataBit, int stopBit, int parity ); * Parameter *driver*: Driver descriptor for which to set port params. * Parameter *baudRate*: the port baudrate - [Serial Driver Baudrates]. * Parameter *dataBit*: the port data bit size- [Serial Driver Data bits size]. * Parameter *stopBit*: the port stop bits cout- [Serial Driver Stop bits count]. * Parameter *parity*: the port stop bits cout- [Serial Driver parity values]. * Return : the operation completion status [Serial Driver status codes]. * Note: parameter values are universal, internally they are converted to a right platform value. * Possible status codes: ~~~~~~ * OK_SERIALDRIVER_SUCCESS * KO_PARAM_NOT_VALID * KO_SERIALDRIVER_ALREADY_IN_USE * KO_PARAM_BAUDRATE_NOT_VALID * KO_PARAM_BAUDRATE_NOT_VALID * KO_PARAM_BAUDRATE_NOT_VALID * KO_PARAM_PARITY_NOT_VALID ~~~~~~ Code example: [Serial Driver Set port parameters example] /** * Set driver(port) timeout. */ int driver_set_listening_period_param ( const void* driver, int receiveTimeout ); * Parameter *driver*: Driver descriptor for which to set port timeout. * Parameter *receiveTimeout *: the port listening timeout. * Return : the operation completion status [Serial Driver status codes]. * Possible status codes: ~~~~~~ * OK_SERIALDRIVER_SUCCESS * KO_PARAM_NOT_VALID * KO_SERIALDRIVER_ALREADY_OPEN * KO_PARAM_LISTENINGPERIOD_NOT_VALID ~~~~~~ Code example: [Serial Driver Set port parameters example]. /** * Set driver(port) flow control mode. */ int driver_set_flow_control_mode_params ( const void* driver, int flowControlIn, int flowControlOut); * Parameter *driver*: Driver descriptor for which to set flow control mode. * Parameter *flowControlIn*: the IN flow control from [Serial Driver IN flow control mode]. * Parameter *flowControlOut*: the OUT flow control from [Serial Driver OUT flow control mode]. * Return : the operation completion status [Serial Driver status codes]. * Possible status codes: ~~~~~~ * OK_SERIALDRIVER_SUCCESS * KO_PARAM_NOT_VALID * KO_SERIALDRIVER_ALREADY_OPEN * KO_PARAM_FLOWCONTROLIN_NOT_VALID * KO_PARAM_FLOWCONTROLOUT_NOT_VALID ~~~~~~ Code example: [Serial Driver Set port parameters example]. vmacariTue, 08 May 2012 14:13:02 -0000https://sourceforge.net2f2f9cbecb8771fdeca164a1b8a24f3bee738d75