Component: EtherCAT Slave (EasyCAT) (Comms: IoT/Cloud): Difference between revisions

Revision as of 17:46, 9 November 2022

Author	Matrix TSL
Version	1.0
Category	Comms: IoT/Cloud

EtherCAT Slave (EasyCAT) component

Provides support for the EtherCAT Slave industrial protocol using an EasyCAT Arduino shield. The shield can be driven from a Flowcode compatible Arduino type board or can be driven using an Arduino using the SCADA Slave firmware to drive EtherCAT from the Flowcode simulation runtime. Compatible with the EasyCAT Easy Configurator tool.

Component Source Code

Please click here for the component source code: FC_Comp_Source_EasyCat.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	SetInt
Write a 16-bit value to the In receive buffer
- BYTE	Index
Data Index
- UINT	Data

- VOID	Return

	MainTask
Must be called as part of the application main program loop.
- BYTE	Return

	SetLong
Write a 32-bit value to the In receive buffer
- BYTE	Index
Data Index
- ULONG	Data

- VOID	Return

	GetFloat
Read a 32-bit floating point value from the Out receive buffer
- BYTE	Index
Data Index
- FLOAT	Return

	GetLong
Read a 32-bit value from the Out receive buffer
- BYTE	Index
Data Index
- ULONG	Return

	GetInt
Read a 16-bit value from the Out receive buffer
- BYTE	Index
Data Index
- UINT	Return

	SetByte
Write an 8-bit value to the In receive buffer
- BYTE	Index
Data Index
- BYTE	Data

- VOID	Return

	GetByte
Read a 8-bit value from the Out receive buffer
- BYTE	Index
Data Index
- BYTE	Return

	SetFloat
Write a 32-bit floating point value to the In receive buffer
- BYTE	Index
Data Index
- FLOAT	Data

- VOID	Return

	Initialise
Starts up the SPI connection to the EasyCAT board and configures the board. Returns 1 for a sucessful initialise.
- BOOL	Return

Property reference

	Properties
	Synchronisation Mode
ASYNC = free running i.e. no synchronization between master and slave (default) DC_SYNC = interrupt is generated from the distributed clock unit SM_SYNC = interrupt is generated from the syncronisation manager
	Header File
Used to load a header file from Easy CAT Configurator tool to describe the units inputs and outputs
	Data Rx
	Total Byte Num Out
Total number of bytes to come out from the EtherCAT master
	Data Tx
	Total Byte Num In
Total bytes to come in from the EtherCAT master
	SPI Properties
	Connections
	Channel
SPI Channel selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Prescale
Prescale option selector
	Simulation
	Simulation Comms

@@ Line 15: / Line 15: @@
 Provides support for the EtherCAT Slave industrial protocol using an EasyCAT Arduino shield. The shield can be driven from a Flowcode compatible Arduino type board or can be driven using an Arduino using the SCADA Slave firmware to drive EtherCAT from the Flowcode simulation runtime. Compatible with the EasyCAT Easy Configurator tool.
-==Component Pack==
+==Component Source Code==
-FREE
+Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_EasyCat.fcfx FC_Comp_Source_EasyCat.fcfx]
 ==Detailed description==
@@ Line 32: / Line 34: @@
 ==Examples==
@@ Line 256: / Line 260: @@
 |-
 | colspan="2" | Used to load a header file from Easy CAT Configurator tool to describe the units inputs and outputs&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Data Rx
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
@@ Line 261: / Line 269: @@
 |-
 | colspan="2" | Total number of bytes to come out from the EtherCAT master&nbsp;
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Data Tx
+|-
 |-
 | width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
@@ Line 267: / Line 279: @@
 | colspan="2" | Total bytes to come in from the EtherCAT master&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;" | SPI Properties
+|-
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 |-
 |-
@@ Line 301: / Line 317: @@
 | colspan="2" | Prescale option selector&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
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 | width="90%" | Simulation Comms
-|-
-| colspan="2" | &nbsp;
-|-
-| 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&nbsp;
-|-
-| 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&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-| width="90%" | API
 |-
 | colspan="2" | &nbsp;
 |}

Wiki bot (talk | contribs)