Jump to content

Component: UART Free (Peripheral CAL): Difference between revisions

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
No edit summary
No edit summary
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_UART_Free.fcfx FC_Comp_Source_UART_Free.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_UART_Free.fcfx FC_Comp_Source_UART_Free.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_UART_Free.fcfx FC_Comp_Source_UART_Free.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_UART_Free.fcfx FC_Comp_Source_UART_Free.fcfx]


==Detailed description==
==Detailed description==




Line 46: Line 48:


==Examples==
==Examples==




Line 73: Line 77:


==Macro reference==
==Macro reference==
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UpdateBaud'''
|-
| colspan="2" | Changes the UART Baud rate. 0 = 1200 / 1 = 2400 / 3 = 4800 / 3 = 9600 / 4 = 19200 / 5 = 38400 6 = 57600 / 7 = 115200 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | new_baud
|-
| colspan="2" | The new baud rate (0=1200, 7=115200) 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
|-
| colspan="2" | Get Value of Named property 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Receive'''
|-
| colspan="2" | Receive a Character 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Timeout
|-
| colspan="2" | Period to wait for the character to be received 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Send'''
|-
| colspan="2" | Send the Character  
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Char
|-
| colspan="2" | The Character to send 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetConsoleHandle'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Init'''
|-
| colspan="2" | Initialize the component with the specified properties 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Delay'''
|-
| colspan="2" | Software UART Bit Delay 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
|-
| colspan="2" | set Value of Named property 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Value
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Uninit'''
|-
| colspan="2" | Un-initialize the UART and release the resources 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
|-
| colspan="2" | Gets Named property List 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
==Property reference==
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | UART Channel selector 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | TX
|-
| colspan="2" | Pin to be used for Transmit data 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | RX
|-
| colspan="2" | Pin to be used for Receive data 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Options
|-
| colspan="2" | Baud rate option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud Rate
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Bits
|-
| colspan="2" | Number of data bits 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Return
|-
| colspan="2" | Return data width from Receive macro 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Echo
|-
| colspan="2" | Echo selection 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Interrupt
|-
| colspan="2" | Interrupt mode enable or disable 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Flow Control
|-
| colspan="2" | Flow Control (Handshake) enable or disable 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | Selects if the console data is automatically generated or not 
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 10:00, 27 January 2023

Author Matrix Ltd
Version 1.3
Category Peripheral CAL


UART Free component

A low level implementation giving direct access to the CAL

Component Source Code

Please click here to download the component source project: FC_Comp_Source_UART_Free.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_UART_Free.fcfx

Detailed description

No detailed description exists yet for this component

Examples

Example showing how to build a component using a CAL component Using CAL Components.


Macro reference

UpdateBaud
Changes the UART Baud rate. 0 = 1200 / 1 = 2400 / 3 = 4800 / 3 = 9600 / 4 = 19200 / 5 = 38400 6 = 57600 / 7 = 115200 
- BYTE new_baud
The new baud rate (0=1200, 7=115200) 
- VOID Return


GetValue
Get Value of Named property 
- STRING Name
 
- STRING Return


Receive
Receive a Character 
- BYTE Timeout
Period to wait for the character to be received 
- INT Return


Send
Send the Character  
- UINT Char
The Character to send 
- VOID Return


GetConsoleHandle
 
- HANDLE Return


Init
Initialize the component with the specified properties 
- VOID Return


Delay
Software UART Bit Delay 
- VOID Return


SetValue
set Value of Named property 
- STRING Name
 
- STRING Value
 
- VOID Return


Uninit
Un-initialize the UART and release the resources 
- VOID Return


GetList
Gets Named property List 
- STRING Name
 
- STRING Return



Property reference

Properties
Channel
UART Channel selector 
TX
Pin to be used for Transmit data 
RX
Pin to be used for Receive data 
Baud Options
Baud rate option selector 
Baud Rate
 
Data Bits
Number of data bits 
Return
Return data width from Receive macro 
Echo
Echo selection 
Interrupt
Interrupt mode enable or disable 
Flow Control
Flow Control (Handshake) enable or disable 
Simulation
Scope Traces
Selects if the scope traces are automatically generated or not 
Console Data
Selects if the console data is automatically generated or not 

==Macro reference==

UpdateBaud
Changes the UART Baud rate. 0 = 1200 / 1 = 2400 / 3 = 4800 / 3 = 9600 / 4 = 19200 / 5 = 38400 6 = 57600 / 7 = 115200 
- BYTE new_baud
The new baud rate (0=1200, 7=115200) 
- VOID Return


GetValue
Get Value of Named property 
- STRING Name
 
- STRING Return


Receive
Receive a Character 
- BYTE Timeout
Period to wait for the character to be received 
- INT Return


Send
Send the Character  
- UINT Char
The Character to send 
- VOID Return


GetConsoleHandle
 
- HANDLE Return


Init
Initialize the component with the specified properties 
- VOID Return


Delay
Software UART Bit Delay 
- VOID Return


SetValue
set Value of Named property 
- STRING Name
 
- STRING Value
 
- VOID Return


Uninit
Un-initialize the UART and release the resources 
- VOID Return


GetList
Gets Named property List 
- STRING Name
 
- STRING Return



Property reference

Properties
Channel
UART Channel selector 
TX
Pin to be used for Transmit data 
RX
Pin to be used for Receive data 
Baud Options
Baud rate option selector 
Baud Rate
 
Data Bits
Number of data bits 
Return
Return data width from Receive macro 
Echo
Echo selection 
Interrupt
Interrupt mode enable or disable 
Flow Control
Flow Control (Handshake) enable or disable 
Simulation
Scope Traces
Selects if the scope traces are automatically generated or not 
Console Data
Selects if the console data is automatically generated or not 

==Macro reference==

UpdateBaud
Changes the UART Baud rate. 0 = 1200 / 1 = 2400 / 3 = 4800 / 3 = 9600 / 4 = 19200 / 5 = 38400 6 = 57600 / 7 = 115200 
- BYTE new_baud
The new baud rate (0=1200, 7=115200) 
- VOID Return


GetValue
Get Value of Named property 
- STRING Name
 
- STRING Return


Receive
Receive a Character 
- BYTE Timeout
Period to wait for the character to be received 
- INT Return


Send
Send the Character  
- UINT Char
The Character to send 
- VOID Return


GetConsoleHandle
 
- HANDLE Return


Init
Initialize the component with the specified properties 
- VOID Return


Delay
Software UART Bit Delay 
- VOID Return


SetValue
set Value of Named property 
- STRING Name
 
- STRING Value
 
- VOID Return


Uninit
Un-initialize the UART and release the resources 
- VOID Return


GetList
Gets Named property List 
- STRING Name
 
- STRING Return



Property reference

Properties
Channel
UART Channel selector 
TX
Pin to be used for Transmit data 
RX
Pin to be used for Receive data 
Baud Options
Baud rate option selector 
Baud Rate
 
Data Bits
Number of data bits 
Return
Return data width from Receive macro 
Echo
Echo selection 
Interrupt
Interrupt mode enable or disable 
Flow Control
Flow Control (Handshake) enable or disable 
Simulation
Scope Traces
Selects if the scope traces are automatically generated or not 
Console Data
Selects if the console data is automatically generated or not 

==Macro reference==

UpdateBaud
Changes the UART Baud rate. 0 = 1200 / 1 = 2400 / 3 = 4800 / 3 = 9600 / 4 = 19200 / 5 = 38400 6 = 57600 / 7 = 115200 
- BYTE new_baud
The new baud rate (0=1200, 7=115200) 
- VOID Return


GetValue
Get Value of Named property 
- STRING Name
 
- STRING Return


Receive
Receive a Character 
- BYTE Timeout
Period to wait for the character to be received 
- INT Return


Send
Send the Character  
- UINT Char
The Character to send 
- VOID Return


GetConsoleHandle
 
- HANDLE Return


Init
Initialize the component with the specified properties 
- VOID Return


Delay
Software UART Bit Delay 
- VOID Return


SetValue
set Value of Named property 
- STRING Name
 
- STRING Value
 
- VOID Return


Uninit
Un-initialize the UART and release the resources 
- VOID Return


GetList
Gets Named property List 
- STRING Name
 
- STRING Return



Property reference

Properties
Channel
UART Channel selector 
TX
Pin to be used for Transmit data 
RX
Pin to be used for Receive data 
Baud Options
Baud rate option selector 
Baud Rate
 
Data Bits
Number of data bits 
Return
Return data width from Receive macro 
Echo
Echo selection 
Interrupt
Interrupt mode enable or disable 
Flow Control
Flow Control (Handshake) enable or disable 
Simulation
Scope Traces
Selects if the scope traces are automatically generated or not 
Console Data
Selects if the console data is automatically generated or not 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_UART_Free_(Peripheral_CAL)&oldid=34589"