This is historical information of device classes implemented in SerialLine device server.

Use this link to find the valid information.

Development status: Released
Information status: New

Contact:



Class Description


C++ source for the SerialClass

Families: Communication

Key words:

Platform: All Platforms

Language: Cpp

License:

Contact:

Hardware


Manufacturer: none

Bus: Serial Line

Class interface


Attributes:

Commands:

Name Description
DevSerReadNBinDataInput: DevLong
nb char to read
Output: DevVarCharArray
array of data
Read the specified number of char from the serial line. If the number of caracters is greater than caracters avaiable, this command returns all caracters avaiables. If there are no characters to be read returns an empty array.
DevSerReadRetryInput: DevLong
number of reading retries
Output: DevString
pointer to the string read updated
read a string from the serialline device in mode raw (no end of string expected, just empty the entire serialline receiving buffer). If read successfull, read again "nretry" times.
DevSerSetNewlineInput: DevShort
The new line character to set
Output: DevVoid
no argout
The new ending character in hexa. Default is 0x13 (=CR
DevSerSetBaudrateInput: DevULong
The new baudrate to set
Output: DevVoid
no argout
Sets the new baudrateof the serial line ( up to 4 Mega). Default is 9600.
DevSerSetStopbitInput: DevShort
The new stopbit to set
Output: DevVoid
no argout
Sets the new stop bit. 0 = none 1 = one stop 2 = 1.5 stop bit
DevSerSetCharLengthInput: DevShort
The new charlength to set
Output: DevVoid
no argout
Sets the new charlength. 0 = 8 bits 1 = 7 bits 2 = 6 bits 3 = 5 bits
DevSerSetParityInput: DevShort
The new parity to set.
Output: DevVoid
no argout
Sets the new parity of the serial line. NONE 0 ODD 1 EVEN 3
DevSerSetTimeoutInput: DevShort
Value of the timeout to set
Output: DevVoid
no argout
This command sets the new timeout (in ms).
DevSerSetParameterInput: DevVarLongArray
device parameters in pair
Output: DevVoid
no argout
Set serial line parameters
DevSerFlushInput: DevLong
flush to do 0=input 1=output 2=both
Output: DevVoid
no argout
Win32 method : Flush serial line port according to argin passed.
DevSerReadLineInput: DevVoid
no argin
Output: DevString
pointer to the string read updated
read a string from the serialline device in mode line (up to and including the character specified by the NewLine property
DevSerReadRawInput: DevVoid
no argin
Output: DevString
pointer to the string read updated
read a string from the serialline device in mode raw (no end of string expected, just empty the entire serialline receiving buffer).
DevSerReadNCharInput: DevLong
number of the caracters to read on the serial line
Output: DevString
pointer to the string read updated
Read a string of N characters from the serial line If there are no characters to be read returns an empty string.
DevSerGetNCharInput: DevVoid
no argin
Output: DevLong
number of char available in receiving buffer
Return the number of chars available in receiving buffer
WriteReadInput: DevVarLongStringArray
type of reading strategy(RAW,NCHAR..),command to write on the port com
Output: DevString
response of the device behind the serial line
This method permit to send a request to a device throw the serial line and returns the response of the device. The commands write and read don't return until they have not finished.
DevSerReadCharInput: DevLong
type of read SL_RAW SL_NCHAR SL_LINE
Output: DevVarCharArray
Array of characters read
Win32 method : Read an array of characters, the type of read is specified in the input parameter, it can be SL_RAW SL_NCHAR SL_LINE
DevSerReadStringInput: DevLong
type of read SL_RAW SL_NCHAR SL_LINE
Output: DevString
String read
Win32 method : Read a string of characters, the type of read is specified in the input parameter SL_RAW SL_NCHAR SL_LINE
DevSerWriteCharInput: DevVarCharArray
Characters to write
Output: DevLong
Number of characters written
Write N characters to a seria line and return the number of characters written.
DevSerWriteStringInput: DevString
String to write
Output: DevLong
Number of characters written
Write a string of characters to a serial line and return the number of characters written.
StatusInput: DevVoid
Output: ConstDevString
Status description
This command gets the device status (stored in its <i>device_status</i> data member) and returns it to the caller.
StateInput: DevVoid
Output: State
State Code
This command gets the device state (stored in its <i>device_state</i> data member) and returns it to the caller.

Pipes:

Properties:

Name Description
NewlineDevShort End of message Character used in particular by the DevSerReadLine command Default = 13
BaudrateDevLong The communication speed in baud used with the serial line protocol.
StopbitsDevShort The number of stop bits used with the serial line protocol. The possibilities are 1 or 2 stop bits
CharlengthDevShort The character length used with the serial line protocol. The possibilities are 8, 7, 6 or 5 bits per character.
ParityDevString The parity used with the serial line protocol. The possibilities are none, even or odd.
TimeoutDevShort The timout value im ms for for answers of requests send to the serial line. This value should be lower than the Tango client server timout value.
SeriallineDevString The path and name of the serial line device to be used.

23 Feb 2017, Piotr Goryl
Updated:
The device class has been updated.
You can see previous version here .



19 Jan 2017, Piotr Goryl
Updated:
The device server has been updated.
You are looking at this version now.



3 Jan 2017, Piotr Goryl
Created:
The device server has been added to catalogue.
Added by:pgoryl2 on:19 Jan 2017, 11:38 a.m.