sEscape (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Windows management functions

Serial/Parallel Ports functions

sEscape

Presentation

Example

Using an external library: RXTX

Features specific to Android and Android widget

See also

sEscape (Function)

In french: sEchap

Runs different functions that directly affect the bits of serial port, parallel port or infrared port, independently of the communication protocol. These functions are used to manage:

the DTR signal,
the RTS signal,
the XOFF and XON characters.

Remarks:

The port must be opened beforehand (sOpen).
Infrared ports are not supported.
This function returns information regarding the server.

Example

// Clears the DTR signal
sEscape(PortNum, "CLRDTR")

Syntax

<Result> = sEscape(<Port number> , <Function>)

<Result>: Boolean

True if the function was run,
False otherwise. If the port was not opened beforehand (by sOpen), sEscape has no effect.

<Port number>: Integer

Identifier of the port used:
Port number:
Number of the serial port: 1, 2, 3, ... 32 for COM1, COM2, COM3, ... COM32.
Number of the parallel port: -1, -2, -3 or -4 for LPT1, LPT2, LPT3 or LPT4.
Number of the infrared port: 1, 2, 3, ... 32 for IR1, IR2, IR3, ... IR32.
Port identifier returned by sOpen (if this function was called with a port name).
Only this type of parameter is available.

<Function>: Character string

Function to run:
CLRBREAK Clears the "Break line" signal.
This function is not supported.
CLRDTR Clears the DTR signal.
CLRRTS Clears the RTS signal.
RESETDEV Re-initializes the device if possible.
This function is not supported.
SETBREAK Enables the "Break Line" signal.
This function is not supported.
SETDTR Sends the DTR signal.
SETRTS Sends the RTS signal.
SETXOFF The transmission behaves like if the XOFF character was received.
This function is not supported.
SETXON The transmission behaves like if the XON character was received.
This function is not supported.

Remarks

Special case for Linux:

Only serial ports can be opened and initialized.
By default, users do not have access to serial ports. It is necessary to grant them specific rights to manage serial ports.

Using an external library: RXTX

In Java, the use of functions for handling the serial and parallel ports (sOpen, sWrite, sRead, ...) requires the presence of an external library: RXTX.

This library includes a Jar archive and one or more native libraries that depend on the operating system on which the application is run. To use these functions:

the Jar archive (RXTXComm.jar) must:
- be found in the same directory as the Java application generated by WINDEV,
- be found in the execution classpath of the application,
- be directly included in the generated application (from the wizard for Java generation).
the native libraries corresponding to the operating system on which the application is run must be found:
- in the same directory as the Java application generated by WINDEV,
- in the path of the application libraries (librarypath).

The RXTX library and its documentation can be downloaded from: http://users.frii.com/jarvi/rxtx/index.html (link valid at the time this documentation was published).

Caution: The management of infrared ports is not available in Java.

Features specific to Android and Android widget

In Android and Android widget mode, the serial and parallel port functions can be used:

Only on serial (not parallel or infrared) ports.
Only with devices that support the CDC/ACM protocol (Arduino ATmega32U4) and the following USB to serial converter chips:
- FTDI FT232R, FT232H, FT2232H, FT4232H, FT230X, FT231X, FT234XD
- Silabs CP210x
- Qinheng CH340, CH341A
- Prolific PL2303

Business / UI classification: Business Logic

Component: wd280com.dll