You are here: Technical Reference > Serial Port Control
FLIR

Firefly®

FFY-U3-16S2C-DL

 

Serial Port Control

Serial Port

The serial port can be used to transmit and receive serial data through the device using the transport layer. The serial data can be sent through the transport layer in image data (via the SerialData Chunk Data), in control data (via the File Access Control), or in event data (via the SerialPortReceive Event).

The serial port to configure is selected using the SerialPortSelector. The physical line on which to receive serial data is set using the SerialPortSource. The physical line on which to transmit serial data is set using the LineSource in the Digital IO Control. The serial port settings for both the receive and transmit can be set using the SerialPortBaudRate, SerialPortDataBits, SerialPortStopBits¸ and SerialPortParity.

Serial data can be transmitted and received through the File Access Control. Once the serial port file is opened, data can be transmitted via Write operations and received via Read operations. Received serial data can also be obtained through the SerialPortReceive Event which will be generated when data is available or through the SerialData Chunk Data which is appended into each image payload.

The total number of characters in the serial port transmit and receive queues can be monitored using the SerialTransmitQueueMaxCharacterCount and the SerialReceiveQueueMaxCharacterCount. The current number of characters in the queues can be monitored using the SerialTransmitQueueCurrentCharacterCount and SerialReceiveQueueCurrentCharacterCount. The SerialReceiveQueueCurrentCharacterCount reports the maximum number of characters that can be obtained using the File Access Control. The receive queue can be emptied by executing the SerialReceiveQueueClear.

Serial port framing and parity errors are reported using the SerialRecieveFramingErrorCount and the SerialReceiveParityErrorCount. Overflow errors are reported within the SerialData Chunk Data, the SerialPortReceive Event, or in the FileOperationStatus after executing a Read.

Summary Table

Name Interface Access Visibility Description
Serial Port Selector IEnumeration RW Expert Selects which serial port of the device to control.
Serial Port Source [Serial Port Selector] IEnumeration RW Expert Specifies the physical input Line on which to receive serial data.
Serial Port Baud Rate [Serial Port Selector] IEnumeration RW Expert This feature controls the baud rate used by the selected serial port.
Serial Port Data Bits [Serial Port Selector] IInteger RW Expert This feature controls the number of data bits used by the selected serial port. Possible values that can be used are between 5 and 9.
Serial Port Stop Bits [Serial Port Selector] IEnumeration RW Expert This feature controls the number of stop bits used by the selected serial port.
Serial Port Parity [Serial Port Selector] IEnumeration RW Expert This feature controls the parity used by the selected serial port.
Transmit Queue Max Character Count [Serial Port Selector] IInteger RO Expert >Returns the maximum number of characters in the serial port transmit queue.
Transmit Queue Current Character Count [Serial Port Selector] IInteger RO Expert Returns the number of characters currently in the serial port transmit queue.
Receive Queue Max Character Count [Serial Port Selector] IInteger RO Expert >Returns the maximum number of characters in the serial port receive queue.
Receive Queue Current Character Count [Serial Port Selector] IInteger RO Expert Returns the number of characters currently in the serial port receive queue.
Receive Queue Clear [Serial Port Selector] ICommand WO Expert This is a command that clears the device serial port receive queue.
Receive Framing Error Count [Serial Port Selector] IInteger RO Expert Returns the number of framing errors that have occurred on the serial port.
Receive Parity Error Count [Serial Port Selector] IInteger RO Expert Returns the number of parity errors that have occurred on the serial port.

Serial Port Control Features


Serial Port Selector

Selects which serial port of the device to control.

Property Value
Name SerialPortSelector
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
SerialPort0

Serial Port Source

Specifies the physical input Line on which to receive serial data.

Property Value
Name SerialPortSource [Serial Port Selector]
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
Line0
Line1
Off

Serial Port Baud Rate

This feature controls the baud rate used by the selected serial port.

Property Value
Name SerialPortBaudRate [Serial Port Selector]
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
Baud300
Baud600
Baud1200
Baud2400
Baud4800
Baud9600
Baud14400
Baud19200
Baud38400
Baud57600
Baud115200

Serial Port Data Bits

This feature controls the number of data bits used by the selected serial port. Possible values that can be used are between 5 and 9.

Property Value
Name SerialPortDataBits [Serial Port Selector]
Interface IInteger
Access RW
Unit
Visibility Expert

Serial Port Stop Bits

This feature controls the number of stop bits used by the selected serial port.

Property Value
Name SerialPortStopBits [Serial Port Selector]
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
Bits1
Bits1AndAHalf
Bits2

Serial Port Parity

This feature controls the parity used by the selected serial port.

Property Value
Name SerialPortParity [Serial Port Selector]
Interface IEnumeration
Access RW
Visibility Expert

Enumeration Values
None
Odd
Even
Mark
Space

Transmit Queue Max Character Count

>Returns the maximum number of characters in the serial port transmit queue.

Property Value
Name SerialTransmitQueueMaxCharacterCount [Serial Port Selector]
Interface IInteger
Access RO
Unit
Visibility Expert

Transmit Queue Current Character Count

Returns the number of characters currently in the serial port transmit queue.

Property Value
Name SerialTransmitQueueCurrentCharacterCount [Serial Port Selector]
Interface IInteger
Access RO
Unit
Visibility Expert

Receive Queue Max Character Count

>Returns the maximum number of characters in the serial port receive queue.

Property Value
Name SerialReceiveQueueMaxCharacterCount [Serial Port Selector]
Interface IInteger
Access RO
Unit
Visibility Expert

Receive Queue Current Character Count

Returns the number of characters currently in the serial port receive queue.

Property Value
Name SerialReceiveQueueCurrentCharacterCount [Serial Port Selector]
Interface IInteger
Access RO
Unit
Visibility Expert

Receive Queue Clear

This is a command that clears the device serial port receive queue.

Property Value
Name SerialReceiveQueueClear [Serial Port Selector]
Interface ICommand
Access WO
Visibility Expert

Receive Framing Error Count

Returns the number of framing errors that have occurred on the serial port.

Property Value
Name SerialReceiveFramingErrorCount [Serial Port Selector]
Interface IInteger
Access RO
Unit
Visibility Expert

Receive Parity Error Count

Returns the number of parity errors that have occurred on the serial port.

Property Value
Name SerialReceiveParityErrorCount [Serial Port Selector]
Interface IInteger
Access RO
Unit
Visibility Expert

 

5/8/2020
© 2015-2020 FLIR® Integrated Imaging Solutions Inc.
All rights reserved.
Legal
| Contact Support

Firefly® FFY-U3-16S2C-DL
Camera Reference