Difference between revisions of "Component: LIN Slave (Comms)"

Latest revision as of 13:11, 7 February 2023

Author	Matrix Ltd
Version	1.2
Category	Comms

LIN Slave component

Low level routines for controlling the LIN bus (1.3 / 2.0) slave interface.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetState

	GetState
Returns the state of the device
- BYTE	Return

Initialize

	Initialize
Initialises the device
- VOID	Return

ListenForMessages

	ListenForMessages
Listens for messages with Timeout and returns the state
- BYTE	Timeout

- BYTE	ChecksumType
0=Classic, 1=Enhanced
- BYTE	Return

PowerDown

	PowerDown
Power Down the device
- VOID	Return

ReadAddress

	ReadAddress
Returns the Identifier read
- BYTE	Return

ReadData

	ReadData
Returns the message data byte
- BYTE	Message
Message to be read
- BYTE	Index
Index of data byte to be returned
- BYTE	Return

ReadDataCount

	ReadDataCount
Return the data count size for Message
- BYTE	Message

- BYTE	Return

SetData

	SetData
Set the Message data to be automatically sent as part of the ListenForMessages macro.
- BYTE	Message
Message to assign data for Range: 1-8
- BYTE	Data1
Data byte value
- BYTE	Data2
Data byte value
- BYTE	Data3
Data byte value
- BYTE	Data4
Data byte value
- BYTE	Data5
Data byte value
- BYTE	Data6
Data byte value
- BYTE	Data7
Data byte value
- BYTE	Data8
Data byte value
- BYTE	Return

WakeUp

	WakeUp
Wake Up the device
- VOID	Return

Property reference

	Properties
	Connections
	TX pin
LIN bus data transmit pin
	RX pin
LIN bus data receive pin
	CS pin
LIN bus chip select pin
	FAULT pin
LIN bus fault detection pin
	VREG pin
LIN bus voltage regulation pin
	MESSAGES
Number of messages the firmware is designed to listen for
	MESSAGE1
	ID
Message identifier to listen for
	BYTES
Number of bytes to expent in the packet
	TX_RX
Data direction for packet
	Simulation
	Label
A text label to aid identifying the component.
	Timing Adjustments
	Timer Adjust TX

	Timer Adjust RX

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_LinSlave.fcfx FC_Comp_Source_LinSlave.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LinSlave.fcfx FC_Comp_Source_LinSlave.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LinSlave.fcfx FC_Comp_Source_LinSlave.fcfx]
 ==Detailed description==
@@ Line 26: / Line 38: @@
 ==Examples==
@@ Line 31: / Line 53: @@
 ''<span style="color:red;">No additional examples</span>''
-==Downloadable macro reference==
+==Macro reference==
+===GetState===
 {| 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;" | '''PowerDown'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetState'''
 |-
-| colspan="2" | Power Down the device&nbsp;
+| colspan="2" | Returns the state of the device&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| 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''
 |}
+===Initialize===
 {| 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;" | '''GetState'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialize'''
 |-
-| colspan="2" | Returns the state of the device&nbsp;
+| colspan="2" | Initialises the device&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-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===ListenForMessages===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 82: / Line 117: @@
+===PowerDown===
 {| 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;" | '''ReadAddress'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PowerDown'''
 |-
-| colspan="2" | Returns the Identifier read&nbsp;
+| colspan="2" | Power Down the device&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-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===ReadAddress===
 {| 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;" | '''ReadDataCount'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAddress'''
 |-
-| colspan="2" | Return the data count size for Message&nbsp;
+| colspan="2" | Returns the Identifier read&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Message
 |-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 113: / Line 145: @@
+===ReadData===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 136: / Line 169: @@
+===ReadDataCount===
+{| 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;" | '''ReadDataCount'''
+|-
+| colspan="2" | Return the data count size for Message&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Message
+|-
+| 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''
+|}
+===SetData===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 194: / Line 247: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===WakeUp===
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialize'''
-|-
-| colspan="2" | Initialises the device&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;"
 |-
@@ Line 218: / Line 259: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}