Difference between revisions of "HANcoder/STM32/Blocks/UART Receive"
From OpenMBD
(Created page with "{{HANcoder/block| info= Reads a byte from the UART reception buffer. '''Outputs''' Output 1: The value of the receive byte. Output 2: When the status output is 0, the rece...") |
|||
| Line 1: | Line 1: | ||
{{HANcoder/block| | {{HANcoder/block| | ||
info= | info= | ||
| − | |||
| − | |||
Reads a byte from the UART reception buffer. | Reads a byte from the UART reception buffer. | ||
| − | |||
'''Outputs''' | '''Outputs''' | ||
| Line 10: | Line 7: | ||
Output 2: When the status output is 0, the reception buffer was empty. | Output 2: When the status output is 0, the reception buffer was empty. | ||
| + | |blockImage=UARTReceive.png | ||
| + | |maskImage=UARTReceiveMask.png | ||
| + | }} | ||
| + | == Inputs (inports) == | ||
| + | Data (byte) to send to the slave device.[uint8] | ||
| + | Note: To send multiple bytes use mutliple Master Transfer blocks | ||
| − | + | == Outputs (outports) == | |
| − | + | (optional) If this output has a value of 0, the UART driver could not be initialized. This happens if no space could be allocated on the heap for the transmit and/or receive buffer. Use the 'Get free heap' block to verify that enough space is available on the heap. The used datatype is boolean. | |
| − | |||
| + | == Block parameters == | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! style="width:150px" | Parameter | ||
| + | ! Description | ||
| + | |- | ||
| + | | Channel | ||
| + | | Select channelfor UART communication | ||
| + | |- | ||
| + | | Baudrate | ||
| + | | Select the baudrate to be used for the communication | ||
| + | |- | ||
| + | | Databits | ||
| + | | Select the number of databits per message. (8 or 9) | ||
| + | |- | ||
| + | | Parity | ||
| + | | Select whether to use the parity bit and if it should be odd or even. | ||
| + | |- | ||
| + | | Stopbits | ||
| + | | Select the number of stopbits. | ||
| + | |- | ||
| + | | TransmitBufferSize | ||
| + | | Enter the size (in bytes) of the buffer for transmitting. The buffer space is reserved in HEAP. | ||
| + | |- | ||
| + | | ReceiveBufferSize | ||
| + | | Enter the size (in bytes) of the buffer for receiving. The buffer space is reserved in HEAP. | ||
| + | |- | ||
| + | | Use status output | ||
| + | | Enable the status output to check if the initialization has been successful. | ||
| + | |} | ||
| + | == Examples == | ||
| + | [[HANcoder/Examples/??|??]] | ||
| + | {{HANcoder/BlockFooter| | ||
| + | |SeeAlso = [[HANcoder/UART_Receive|UART Receive]] {{!}} [[HANcoder/UART_Receive_Buffer_Status|UART Receive buffer status]] {{!}} [[HANcoder/UART_Send|UART Send]] | ||
}} | }} | ||
Revision as of 14:58, 28 April 2017
Supported Targets: Olimexino, E407, P405
Contents
General information about UART Receive
Reads a byte from the UART reception buffer.
Outputs Output 1: The value of the receive byte. Output 2: When the status output is 0, the reception buffer was empty.
Block
Mask
Inputs (inports)
Data (byte) to send to the slave device.[uint8] Note: To send multiple bytes use mutliple Master Transfer blocks
Outputs (outports)
(optional) If this output has a value of 0, the UART driver could not be initialized. This happens if no space could be allocated on the heap for the transmit and/or receive buffer. Use the 'Get free heap' block to verify that enough space is available on the heap. The used datatype is boolean.
Block parameters
| Parameter | Description |
|---|---|
| Channel | Select channelfor UART communication |
| Baudrate | Select the baudrate to be used for the communication |
| Databits | Select the number of databits per message. (8 or 9) |
| Parity | Select whether to use the parity bit and if it should be odd or even. |
| Stopbits | Select the number of stopbits. |
| TransmitBufferSize | Enter the size (in bytes) of the buffer for transmitting. The buffer space is reserved in HEAP. |
| ReceiveBufferSize | Enter the size (in bytes) of the buffer for receiving. The buffer space is reserved in HEAP. |
| Use status output | Enable the status output to check if the initialization has been successful. |
