Component: LIN Slave (Comms)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix Ltd |
| Version | 1.2 |
| Category | Comms |
Contents
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
|
PowerDown |
| Power Down the device | |
 - VOID
|
Return |
|
|
GetState |
| Returns the state of the device | |
 - BYTE
|
Return |
|
|
ListenForMessages |
| Listens for messages with Timeout and returns the state | |
| - BYTE
|
Timeout |
| - BYTE
|
ChecksumType |
| 0=Classic, 1=Enhanced | |
| - BYTE
|
Return |
|
|
ReadAddress |
| Returns the Identifier read | |
| - BYTE
|
Return |
|
|
ReadDataCount |
| Return the data count size for Message | |
| - BYTE
|
Message |
| - BYTE
|
Return |
|
|
ReadData |
| Returns the message data byte | |
| - BYTE
|
Message |
| Message to be read | |
| - BYTE
|
Index |
| Index of data byte to be returned | |
| - BYTE
|
Return |
|
|
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 |
|
|
Initialize |
| Initialises the device | |
| - VOID
|
Return |
|
|
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 |
==Macro reference==
|
|
PowerDown |
| Power Down the device | |
| - VOID
|
Return |
|
|
GetState |
| Returns the state of the device | |
| - BYTE
|
Return |
|
|
ListenForMessages |
| Listens for messages with Timeout and returns the state | |
| - BYTE
|
Timeout |
| - BYTE
|
ChecksumType |
| 0=Classic, 1=Enhanced | |
| - BYTE
|
Return |
|
|
ReadAddress |
| Returns the Identifier read | |
| - BYTE
|
Return |
|
|
ReadDataCount |
| Return the data count size for Message | |
| - BYTE
|
Message |
| - BYTE
|
Return |
|
|
ReadData |
| Returns the message data byte | |
| - BYTE
|
Message |
| Message to be read | |
| - BYTE
|
Index |
| Index of data byte to be returned | |
| - BYTE
|
Return |
|
|
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 |
|
|
Initialize |
| Initialises the device | |
| - VOID
|
Return |
|
|
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 |
==Macro reference==
|
|
PowerDown |
| Power Down the device | |
| - VOID
|
Return |
|
|
GetState |
| Returns the state of the device | |
| - BYTE
|
Return |
|
|
ListenForMessages |
| Listens for messages with Timeout and returns the state | |
| - BYTE
|
Timeout |
| - BYTE
|
ChecksumType |
| 0=Classic, 1=Enhanced | |
| - BYTE
|
Return |
|
|
ReadAddress |
| Returns the Identifier read | |
| - BYTE
|
Return |
|
|
ReadDataCount |
| Return the data count size for Message | |
| - BYTE
|
Message |
| - BYTE
|
Return |
|
|
ReadData |
| Returns the message data byte | |
| - BYTE
|
Message |
| Message to be read | |
| - BYTE
|
Index |
| Index of data byte to be returned | |
| - BYTE
|
Return |
|
|
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 |
|
|
Initialize |
| Initialises the device | |
| - VOID
|
Return |
|
|
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 |
