Component: UART (RS232) (Comms: Interface)

Author	Matrix Ltd
Version	2.0 (Release)
Category	Comms: Interface

UART (RS232) component

Low level routines for controlling or interacting with a standard asyncronous serial interface. On a microcontroller the interface will be the onboard UART which will need voltage level shifting using a max2323 to become RS232 compatible. See the EB015 RS232 E-block for details.

Detailed description

Overview

The RS232 component is in fact nothing more than a TTL level asynchronous serial communications bus which basically means that there is no clock signal. Instead the data is sent out at a precise data rate specified by the Baud which is represented in bits per second. Both devices need to be set to the same rate to allow communications to work correctly.

There are two signals which make up the asynchronous serial connection: RX and TX. The receive RX signal is used for incoming data and the transmit TX signal is used for outgoing data. When connecting two devices together it is important to connect the TX of one device to the RX of the other and visa versa. When inactive the bus defaults to having the TX signal held in the high state. Each data byte sent then starts with a low signal for 1 period of the baud rate to signify that data is to follow.

Each RS232 transaction consists of a start bit (low) for a single clock cycle followed by data made up of 7/8/9 clock cycles followed by a stop bit (high) for a single clock cycle.

TTL

By default the RS232 component will provide TTL asynchronous serial data which is best suited for a single device to single device data connection on the same circuit board. An example might be a GSM modem or GPS module. The TTL signals are normally at VCC when the bus is idle and toggles between VCC and Ground when sending data.

RS232

By adding a driver chip such as a MAX2323 the TTL signals can be upgraded to RS232 which is best suited for single device to single device mid range off board communications. The RS232 signals replace the voltages VCC with +12V and GND with -12V to allow for better noise rejection in noisy environments.

RS485

By adding a driver chip such as a MAX3078 the TTL signals can be upgraded to RS485 which is best suited for master to multiple slave type mid range off board communications.

Auto Baud

Some devices feature an auto baud functionality and is commonly triggered by sending a known data byte to the device before any other data is sent allowing the correct baud to be worked out.

Importing from v5

The RS232 component from Flowcode v6 has a new Initialise macro which will need to be added to your program before any other calls to the component are made.

Examples

Transmit

This example transmits a string "Hello World". RS232_Example1 The Console window shows the data as it is sent and received.

Receive

This example receives a character and outputs it to the LCD, an injector has been added to allow you to type data into the console. RS232_Example2 The Console window has tabs for the human interface data injector allowing you to type in data that will be received by the component.

Again the RS232 console tabs reflect the data as it is sent and received.

LCD showing received data.

Transmit and Receive

This example echoes back any data that is received allowing a nice sanity check when connecting an embedded device to a PC or other source of communications. RS232_Example3 Again the RS232 console tabs reflect the data as it is sent and received.

UART Bridge

This example allows a microcontroller with two UART peripherals to receive data one one UART and transmit on the other and visa versa in a reliable manner using interrupts. Note that this method will only work with hardware UART channels. A software UART could be done in a similar way using a falling edge type interrupt on the UART RX pin to trigger the receive function. RS232_Example4

COM Port

The COM port property allows you to attach the RS232 component to a COM port on your PC during simulation allowing real world hardware such as RS232, Bluetooth, GPS to work with the simulation.

Injector

The Injector property allows you to select an injector component on the panel for use in the simulation. The human interface injector can be used to inject typed in data via the console window and can be seen in examples 2 and 3 above.

There are other pre-made injectors to allow you to do various aspects from simulating a generic AT terminal to simulating a specific remote device.

Downloadable macro reference

SendString

Sends out a string of bytes from the UART interface.

Parameters

<- STRING Data

This parameter may be returned back to the caller

Return value

This call does not return a value

ReceiveINTArray

Receives an array of 16-bit INT/UINT values and returns the number of values received.

Parameters

UINT Data

Array to store the incoming data

BYTE NumValues

Maximum number of values to try and receive

BOOL MSBfirst

0=Least significant byte first, 1=Most significant byte first

BYTE Timeout

Max amount of time in ms to wait between bytes

Return value

BYTE

ReceiveNumber

Attempts to receive a number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none numeric char is received, the none numeric char will be lost.

Parameters

BYTE Timeout

Max time in ms to wait in between bytes

BOOL IgnoreData

0=Dont ignore any data, 1=Ignore any initial none numeric data

Return value

LONG

SendBinary16Bit

Sends out a 16-bit binary value split across two bytes.

Parameters

UINT Value

BOOL MSBfirst

0=Least significant byte first, 1=Most significant byte first

Return value

This call does not return a value

SendINTArray

Transmits an array of 16-bit INT/UINT values via the UART peripheral

Parameters

UINT Data

Data to transmit

BYTE NumValues

Number of 16-bit values to send from the array

BOOL MSBfirst

0=Least significant byte first, 1=Most significant byte first

Return value

This call does not return a value

SendNumber

Sends out a number as an ASCII String from the UART interface.

Parameters

LONG Number

Return value

This call does not return a value

ReceiveBinary32Bit

Receives a binary 32-bit value split across four bytes.

Parameters

BOOL MSBfirst

0=Least significant byte first, 1=Most significant byte first

BYTE Timeout

Max amount of time in ms to wait between bytes

Return value

ULONG

ReceiveBinaryFloat

Receives a binary 32-bit floating point value split across four bytes.

Parameters

BOOL MSBfirst

0=Least significant byte first, 1=Most significant byte first

BYTE Timeout

Max amount of time in ms to wait between bytes

Return value

FLOAT

SendChar

Sends out a single packet from the UART interface.

Parameters

INT Char

Return value

This call does not return a value

SendByteArray

Transmits an array of bytes via the UART peripheral

Parameters

BYTE Data

Data to transmit

BYTE NumBytes

Number of bytes to send from the array

Return value

This call does not return a value

ReceiveBinary16Bit

Receives a binary 16-bit value split across two bytes.

Parameters

BOOL MSBfirst

0=Least significant byte first, 1=Most significant byte first

BYTE Timeout

Max amount of time in ms to wait between bytes

Return value

UINT

ChangeHWBaud

Changes the hardware UART baud rate allowing for dynamic speed changes.

Parameters

BYTE NewBaud

0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200, 8=250000

Return value

This call does not return a value

ReceiveFloat

Attempts to receive a floating point number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none numeric char is received, the none numeric char will be lost.

Parameters

BYTE Timeout

Max time in ms to wait in between bytes

BOOL IgnoreData

0=Dont ignore any data, 1=Ignore any initial none numeric data

Return value

FLOAT

SendFloat

Sends out a floating point number as an ASCII String from the UART interface.

Parameters

FLOAT Number

Return value

This call does not return a value

SendHexNumber

Sends out a number as an ASCII hexadecimal String from the UART interface.

Parameters

ULONG Number

BYTE NumChars

Number of characters in the string data, 0 for auto, 2 for 0x00, 4 for 0x0000

BOOL Prefix

Generate hexadecimal prefix 0x e.g. 1= 0xFF, 0= FF

Return value

This call does not return a value

ReceiveHexNumber

Attempts to receive a hex number as ASCII characters and convert back into a numeric value. Note this function will receive until a timeout or a none hexadecimal char is received, the none numeric char will be lost.

Parameters

BYTE Timeout

Max time in ms to wait in between bytes

BOOL IgnoreData

0=Dont ignore any data, 1=Ignore any initial none numeric data

BOOL Prefix

Look for prefix before receiving, 1=0xFF, 0=FF

Return value

ULONG

SendBinary32Bit

Sends out a 32-bit binary value split across four bytes.

Parameters

ULONG Value

BOOL MSBfirst

0=Least significant byte first, 1=Most significant byte first

Return value

This call does not return a value

SendBinaryFloat

Sends out a 32-bit binary floating point value split across four bytes.

Parameters

FLOAT Value

BOOL MSBfirst

0=Least significant byte first, 1=Most significant byte first

Return value

This call does not return a value

ReceiveByteArray

Receives an array of bytes and returns the number of bytes received.

Parameters

BYTE Data

Array to store the incoming data

BYTE NumBytes

Maximum number of bytes to try and receive

BYTE Timeout

Max amount of time in ms to wait between bytes

Return value

BYTE

ReceiveString

Attempts to receive a string of bytes from the UART interface.

Parameters

BYTE Timeout

Time to wait in milliseconds for valid data before returning, 0=Dont wait, 255=Wait forever.

UINT NumBytes

The number of bytes to try and receive, ideally your string variable should have at least 1 more byte to store the null termination byte

Return value

STRING

Initialise

Sets up the RS232 peripheral, must be called at the start of your program or at least before you start calling any other RS232 macros.

Parameters

This macro has no parameters

Return value

This call does not return a value

ReceiveChar

Attempts to receive a single packet from the UART interface.

Parameters

BYTE Timeout

Time to wait in milliseconds for valid data before returning, 0=Dont wait, 255=Wait forever.

Return value

INT

Simulation macro reference

This component does not contain any simulation macros

Property reference

Channel

This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::CHANNEL.

UART Channel selector

Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels.

Hardware channels use the selected peripheral on-board the target microcontroller.

Baud Options

This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::BAUD_LIST.

Baud rate option selector

Baud Rate

This property is of type Signed integer and can be referenced with the variable name cal_uart::BAUD.

No additional information

Data Bits

This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::DBITS.

Number of data bits

Return

This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::RETURN.

Return data width from Receive macro.

8-bit data mode always returns a byte ranging from 0-255, 255 could mean a timeout or could be a valid data.

16-bit data mode rereturns 0-255 for valid data, 256 for a timeout, return data must be stored into an INT or UINT variable.

Echo

This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::ECHO.

Automatically echoes back any received data when enabled by re-transmitting the received byte.

Use TX

This property is of type True or false and can be referenced with the variable name cal_uart::UseTX.

Selects if the Transmit pin is used by the component.

Yes: The TX pin is active and used to transmit data for the UART.

No: The TX pin is disabled and free to be used as general I/O.

TX

This property is of type Single digital pin and can be referenced with the variable name cal_uart::TX.

Pin to be used for Transmit data

TX Alt Pin

This property is of type True or false and can be referenced with the variable name cal_uart::TXAlt.

Allows the TX pin to be allocated to an alternate I/O pin.

Use RX

This property is of type True or false and can be referenced with the variable name cal_uart::UseRX.

Selects if the Receive pin is used by the component.

Yes: The RX pin is active and used to receive data for the UART.

No: The RX pin is disabled and free to be used as general I/O.

RX

This property is of type Single digital pin and can be referenced with the variable name cal_uart::RX.

Pin to be used for Receive data

RX Alt Pin

This property is of type True or false and can be referenced with the variable name cal_uart::RXAlt.

Allows the RX pin to be allocated to an alternate I/O pin.

Use Flow Control

This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::FLOWEN.

Flow Control (Handshake) enable or disable.

   On: Two I/O pins are used to control the flow of data in and out of the device.

   Off: Flow control is disabled.

Label

This property is of type Line of text and can be referenced with the variable name label.

Textual label shown on the component I/O flasher

Scope Traces

This property is of type True or false and can be referenced with the variable name cal_uart::ScopeTraces.

Selects if the scope traces are automatically added to the data recorder window or not.

   Simulation - draws an approximation of the UART data onto the scope trace.

   ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.

Console Data

This property is of type True or false and can be referenced with the variable name cal_uart::ConsoleData.

Selects if the console data is automatically generated or not

Console Format

This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::ConsoleFormat.

Controls if the data is shown as a log with time and date stamps or just as raw data

Console Columns

This property is of type Unsigned integer and can be referenced with the variable name cal_uart::ConsoleColumns.

Number of characters that can be displayed on a single line of the console.

Data Source

This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::DataSource.

Simulation data source used to allow the component to connect to various remote devices

   Nothing - Simulation data is ignored

   COM port - Routes the communication data to and from a physical or virtual COM port 

   Injector - Routes the communication data via a data injector component on the Panel.