Difference between revisions of "Component: IrDA (EB012, MCP1250, MCP2120) (Wireless)"

Latest revision as of 13:11, 7 February 2023

Author	Matrix Ltd.
Version	2.0
Category	Wireless

IrDA (EB012, MCP1250, MCP2120) component

Low level routines for controlling a standard IrDA interface. Also available in the form of the EB012 IrDA E-block.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

Transmit

Basic example which repeatedly transmits a string of data via the IrDA interface. IrDA Transmit

Receive

Basic example which waits for any incoming data and then displays the data on the LCD. IrDA Receive

Macro reference

Initialise

	Initialise
Initialises the UART ready for IrDA data to be sent or received,
- VOID	Return

ReceiveChar

	ReceiveChar
Receives byte character from the IrDA connection.
- INT	Timeout
Max amount of time in milliseconds to wait for data.
- INT	Return

SendChar

	SendChar
Sends a byte character to the IrDA connection.
- INT	Char

- VOID	Return

Property reference

	Properties
	Comms Settings
	Interface
Decides which IrDA interface IC we wish to communicate via.
	Baud Options
Baud rate option selector
	Baud Rate

	Data Bits
Number of data bits
	Echo
Echo selection
	Connections
	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.
	TX
Pin to be used for Transmit data
	RX
Pin to be used for Receive data
	Use Flow Control
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.
	Simulation
	Label
Label used to help identify the component on the panel.
	Scope Traces
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
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
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 API - Routes the communication data via a data API component on the Panel.

Difference between revisions of "Component: IrDA (EB012, MCP1250, MCP2120) (Wireless)"

Latest revision as of 13:11, 7 February 2023

Contents

IrDA (EB012, MCP1250, MCP2120) component

Component Source Code

Detailed description

Examples

Transmit

Receive

Macro reference

Initialise

ReceiveChar

SendChar

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 14: / Line 14: @@
 ==IrDA (EB012, MCP1250, MCP2120) component==
 Low level routines for controlling a standard IrDA interface. Also available in the form of the EB012 IrDA E-block.
+==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_IrDA.fcfx FC_Comp_Source_IrDA.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_IrDA.fcfx FC_Comp_Source_IrDA.fcfx]
 ==Detailed description==
 ''No detailed description exists yet for this component''
 ==Examples==
@@ Line 31: / Line 81: @@
 {{Fcfile|IrDA_Rx.fcfx|IrDA Receive}}
-==Downloadable 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;" | '''SendChar'''
-|-
-| colspan="2" | Sends a byte character to the IrDA connection.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | Char
-|-
-| colspan="2" | &nbsp;
-|-
-| 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;" | '''ReceiveChar'''
-|-
-| colspan="2" | Receives byte character from the IrDA connection.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | Timeout
-|-
-| colspan="2" | Max amount of time in milliseconds to wait for data.&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
-| 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;" | '''Initialise'''
-|-
-| colspan="2" | Initialises the UART ready for IrDA data to be sent or received,&nbsp;
-|-
-|-
-| 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;" | '''Disconnect'''
-|-
-| colspan="2" | Disconnects from the MQTT server and the network&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| 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;" | '''Ping'''
-|-
-| colspan="2" | Ping packet is sent to the Server and checks for a reply. Returns non-zero value if successful &nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
+==Macro reference==
+===Initialise===
 {| 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;" | '''GetPayload'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Get the Payload of the last received (Read) packet. Returns the number of bytes for the Payload&nbsp;
+| colspan="2" | Initialises the UART ready for IrDA data to be sent or received,&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Payload
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Size
-|-
-| colspan="2" | Byte count the Payload buffer&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===ReceiveChar===
 {| 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;" | '''Subscribe'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveChar'''
 |-
-| colspan="2" | Subscribe to a Topic. Must be Connected first Returns non-zero if successful &nbsp;
+| colspan="2" | Receives byte character from the IrDA connection.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | Topic
+| width="90%" | Timeout
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Max amount of time in milliseconds to wait for data.&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| 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''
 |}
+===SendChar===
 {| 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;" | '''Unsubscribe'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendChar'''
 |-
-| colspan="2" | Unsubscribe from a Topic. Must be Connected first Returns non-zero if successful &nbsp;
+| colspan="2" | Sends a byte character to the IrDA connection.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
-| width="90%" | Topic
+| width="90%" | Char
 |-
 | colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| 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;" | '''Initialise'''
-|-
-| colspan="2" | &nbsp;
-|-
-|-
-| 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;" | '''GetPayloadString'''
-|-
-| colspan="2" | Get the Payload of the last received (Read) packet as a string value&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | Payload
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Size
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| 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;" | '''Initialise'''
-|-
-| colspan="2" | Starts up the MQTT component - call this after initialising the NetworkComms component.&nbsp;
-|-
 |-
 | 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''
 |}
@@ Line 224: / Line 151: @@
 | 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Comms Settings
 |-
 |-
@@ Line 251: / Line 182: @@
 | colspan="2" | Echo selection&nbsp;
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 |-
 |-
@@ Line 275: / Line 206: @@
 | colspan="2" | 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.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 |-
 |-