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

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EasyCat.fcfx FC_Comp_Source_EasyCat.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/EasyCat.fcfx FC_Comp_Source_temp/EasyCat.fcfx]
  
−
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EasyCat.fcfx FC_Comp_Source_EasyCat.fcfx]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/EasyCat.fcfx FC_Comp_Source_temp/EasyCat.fcfx]
  
 
==Detailed description==
 
==Detailed description==
Line 73: Line 73:
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
 +
 +
  
  
Line 81: Line 83:
 
==Macro reference==
 
==Macro reference==
  
−
===SetInt===
+
===GetByte===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetInt'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
 
|-
 
|-
−
| colspan="2" | Write a 16-bit value to the In receive buffer&nbsp;
+
| colspan="2" | Read a 8-bit value from the Out receive buffer&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 94: Line 96:
 
|-
 
|-
 
| colspan="2" | Data Index&nbsp;
 
| colspan="2" | Data Index&nbsp;
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
−
| width="90%" | Data
 
−
|-
 
−
| 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''
 
−
|}
 
−
 
−
 
−
===MainTask===
 
−
{| 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;" | '''MainTask'''
 
−
|-
 
−
| colspan="2" | Must be called as part of the application main program loop.&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-u8-icon.png]] - BYTE
Line 119: Line 102:
  
  
−
===SetLong===
+
===GetFloat===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLong'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloat'''
 
|-
 
|-
−
| colspan="2" | Write a 32-bit value to the In receive buffer&nbsp;
+
| colspan="2" | Read a 32-bit floating point value from the Out receive buffer&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 133: Line 116:
 
| colspan="2" | Data Index&nbsp;
 
| colspan="2" | Data Index&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
−
| width="90%" | Data
 
−
|-
 
−
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
−
===GetFloat===
+
===GetInt===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFloat'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInt'''
 
|-
 
|-
−
| colspan="2" | Read a 32-bit floating point value from the Out receive buffer&nbsp;
+
| colspan="2" | Read a 16-bit value from the Out receive buffer&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 157: Line 135:
 
| colspan="2" | Data Index&nbsp;
 
| colspan="2" | Data Index&nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 181: Line 159:
  
  
−
===GetInt===
+
===Initialise===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInt'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 +
|-
 +
| colspan="2" | Starts up the SPI connection to the EasyCAT board and configures the board. Returns 1 for a sucessful initialise.&nbsp;
 +
|-
 
|-
 
|-
−
| colspan="2" | Read a 16-bit value from the Out receive buffer&nbsp;
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
===MainTask===
 +
{| 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;" | '''MainTask'''
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| colspan="2" | Must be called as part of the application main program loop.&nbsp;
−
| width="90%" | Index
 
 
|-
 
|-
−
| colspan="2" | Data Index&nbsp;
 
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
Line 224: Line 211:
  
  
−
===GetByte===
+
===SetFloat===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetByte'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFloat'''
 
|-
 
|-
−
| colspan="2" | Read a 8-bit value from the Out receive buffer&nbsp;
+
| colspan="2" | Write a 32-bit floating point value to the In receive buffer&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 238: Line 225:
 
| colspan="2" | Data Index&nbsp;
 
| colspan="2" | Data Index&nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Data
 +
|-
 +
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
−
===SetFloat===
+
===SetInt===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFloat'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetInt'''
 
|-
 
|-
−
| colspan="2" | Write a 32-bit floating point value to the In receive buffer&nbsp;
+
| colspan="2" | Write a 16-bit value to the In receive buffer&nbsp;
 
|-
 
|-
 
|-
 
|-
Line 257: Line 249:
 
| colspan="2" | Data Index&nbsp;
 
| colspan="2" | Data Index&nbsp;
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
| width="90%" | Data
 
| width="90%" | Data
 
|-
 
|-
Line 267: Line 259:
  
  
−
===Initialise===
+
===SetLong===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLong'''
 +
|-
 +
| colspan="2" | Write a 32-bit value to the In receive buffer&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Data Index&nbsp;
 
|-
 
|-
−
| colspan="2" | Starts up the SPI connection to the EasyCAT board and configures the board. Returns 1 for a sucessful initialise.&nbsp;
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Data
 
|-
 
|-
 +
| colspan="2" | &nbsp;
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}

Revision as of 12:00, 3 February 2023

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 to download the component source project: FC_Comp_Source_temp/EasyCat.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/EasyCat.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples





Macro reference

GetByte

Fc9-comp-macro.png GetByte
Read a 8-bit value from the Out receive buffer 
Fc9-u8-icon.png - BYTE Index
Data Index 
Fc9-u8-icon.png - BYTE Return


GetFloat

Fc9-comp-macro.png GetFloat
Read a 32-bit floating point value from the Out receive buffer 
Fc9-u8-icon.png - BYTE Index
Data Index 
Fc9-f32-icon.png - FLOAT Return


GetInt

Fc9-comp-macro.png GetInt
Read a 16-bit value from the Out receive buffer 
Fc9-u8-icon.png - BYTE Index
Data Index 
Fc9-u16-icon.png - UINT Return


GetLong

Fc9-comp-macro.png GetLong
Read a 32-bit value from the Out receive buffer 
Fc9-u8-icon.png - BYTE Index
Data Index 
Fc9-u32-icon.png - ULONG Return


Initialise

Fc9-comp-macro.png Initialise
Starts up the SPI connection to the EasyCAT board and configures the board. Returns 1 for a sucessful initialise. 
Fc9-bool-icon.png - BOOL Return


MainTask

Fc9-comp-macro.png MainTask
Must be called as part of the application main program loop. 
Fc9-u8-icon.png - BYTE Return


SetByte

Fc9-comp-macro.png SetByte
Write an 8-bit value to the In receive buffer 
Fc9-u8-icon.png - BYTE Index
Data Index 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


SetFloat

Fc9-comp-macro.png SetFloat
Write a 32-bit floating point value to the In receive buffer 
Fc9-u8-icon.png - BYTE Index
Data Index 
Fc9-f32-icon.png - FLOAT Data
 
Fc9-void-icon.png - VOID Return


SetInt

Fc9-comp-macro.png SetInt
Write a 16-bit value to the In receive buffer 
Fc9-u8-icon.png - BYTE Index
Data Index 
Fc9-u16-icon.png - UINT Data
 
Fc9-void-icon.png - VOID Return


SetLong

Fc9-comp-macro.png SetLong
Write a 32-bit value to the In receive buffer 
Fc9-u8-icon.png - BYTE Index
Data Index 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png 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 
Fc9-type-13-icon.png Header File
Used to load a header file from Easy CAT Configurator tool to describe the units inputs and outputs 
Fc9-conn-icon.png Data Rx
Fc9-type-21-icon.png Total Byte Num Out
Total number of bytes to come out from the EtherCAT master 
Fc9-conn-icon.png Data Tx
Fc9-type-21-icon.png Total Byte Num In
Total bytes to come in from the EtherCAT master 
Fc9-conn-icon.png SPI Properties
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png Simulation Comms
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_EtherCAT_Slave_(EasyCAT)_(Comms:_IoT/Cloud)&oldid=36462"