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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Comms: IoT/Cloud
 
| 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.
 +
 +
==Detailed description==
  
−
==[[File:Component Icon 947089aa_ca9f_4e6f_9f86_7d49a1ae6f86.png|Image]] EtherCAT Slave (EasyCAT) component==
+
''No detailed description exists yet for this 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.
 
  
 
==Examples==
 
==Examples==
 +
 +
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
  
Line 27: Line 27:
 
==Downloadable macro reference==
 
==Downloadable macro reference==
  
−
===<span style="font-weight: normal;"><u><tt>SetInt</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Write a 16-bit value to the In receive buffer
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetInt'''
 +
|-
 +
| colspan="2" | Write a 16-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;
 +
|-
 +
| 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''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Index''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::Data Index
+
|-
 +
| 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="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
:[[Variable Types|UINT]] ''Data''
 
  
 +
{| 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;" | '''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;
 +
|-
 +
| 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-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
{| 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;" | '''GetFloat'''
 +
|-
 +
| colspan="2" | Read a 32-bit floating point value from the Out receive buffer&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Data Index&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>MainTask</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Must be called as part of the application main program loop.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLong'''
 +
|-
 +
| colspan="2" | Read a 32-bit value from the Out receive buffer&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Data Index&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
{| 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;" | '''GetInt'''
 +
|-
 +
| colspan="2" | Read a 16-bit value from the Out receive buffer&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| 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="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
{| 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;" | '''SetByte'''
 +
|-
 +
| colspan="2" | Write an 8-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;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| 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''
 +
|}
  
−
:[[Variable Types|BYTE]]
 
  
 +
{| 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;" | '''GetByte'''
 +
|-
 +
| colspan="2" | Read a 8-bit value from the Out receive buffer&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Data Index&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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>SetLong</tt></u></span>===
 
−
Write a 32-bit value to the In receive buffer
 
  
−
'''Parameters'''
+
{| 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;" | '''SetFloat'''
 +
|-
 +
| colspan="2" | Write a 32-bit floating point 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;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| 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''
 +
|}
  
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Data Index
 
  
−
:[[Variable Types|ULONG]] ''Data''
+
{| 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 SPI connection to the EasyCAT board and configures the board. Returns 1 for a sucessful initialise.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
:''This call does not return a value''
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
−
 
+
|-
−
===<span style="font-weight: normal;"><u><tt>GetFloat</tt></u></span>===
+
| colspan="2" | Sets up the component ready to collect weather data.&nbsp;
−
Read a 32-bit floating point value from the Out receive buffer
+
|-
−
 
+
|-
−
'''Parameters'''
+
| 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''
−
:[[Variable Types|BYTE]] ''Index''
+
|}
−
::Data Index
 
−
 
 
−
 
 
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
 
  
−
 
−
===<span style="font-weight: normal;"><u><tt>GetLong</tt></u></span>===
 
−
Read a 32-bit value from the Out receive buffer
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Data Index
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:[[Variable Types|ULONG]]
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>GetInt</tt></u></span>===
 
−
Read a 16-bit value from the Out receive buffer
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Data Index
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:[[Variable Types|UINT]]
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>SetByte</tt></u></span>===
 
−
Write an 8-bit value to the In receive buffer
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Data Index
 
−
 
−
:[[Variable Types|BYTE]] ''Data''
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>GetByte</tt></u></span>===
 
−
Read a 8-bit value from the Out receive buffer
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Data Index
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:[[Variable Types|BYTE]]
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>SetFloat</tt></u></span>===
 
−
Write a 32-bit floating point value to the In receive buffer
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Data Index
 
−
 
−
:[[Variable Types|FLOAT]] ''Data''
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
−
Starts up the SPI connection to the EasyCAT board and configures the board.
 
−
 
−
Returns 1 for a sucessful initialise.
 
−
 
−
'''Parameters'''
 
−
 
−
:''This macro has no parameters''
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
 
−
 
−
 
−
 
−
==Simulation macro reference==
 
−
 
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Synchronisation Mode</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SyncMode''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
ASYNC = free running i.e. no synchronization between master and slave (default)  
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
DC_SYNC = interrupt is generated from the distributed clock unit
+
|-
−
 
+
|-
−
SM_SYNC = interrupt is generated from the syncronisation manager
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Synchronisation Mode
−
<span style="font-weight: normal;"><u>Header File</u></span>
+
|-
−
 
+
| colspan="2" | 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&nbsp;
−
This property is of type ''Filename'' and can be referenced with the variable name ''HeaderFile''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-13-icon.png]]
−
Used to load a header file from Easy CAT Configurator tool to describe the units inputs and outputs
+
| width="90%" | Header File
−
 
+
|-
−
<span style="font-weight: normal;"><u>Total Byte Num Out</u></span>
+
| colspan="2" | Used to load a header file from Easy CAT Configurator tool to describe the units inputs and outputs&nbsp;
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''TotalByteNumOut''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Total Byte Num Out
−
Total number of bytes to come out from the EtherCAT master
+
|-
−
 
+
| colspan="2" | Total number of bytes to come out from the EtherCAT master&nbsp;
−
<span style="font-weight: normal;"><u>Total Byte Num In</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''TotalByteNumIn''.
+
| width="90%" | Total Byte Num In
−
 
+
|-
−
Total bytes to come in from the EtherCAT master
+
| colspan="2" | Total bytes to come in from the EtherCAT master&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Channel</u></span>
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::CHANNEL''.
+
|-
−
 
+
|-
−
SPI Channel selector
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Channel
−
<span style="font-weight: normal;"><u>MOSI</u></span>
+
|-
−
 
+
| colspan="2" | SPI Channel selector&nbsp;
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MOSI''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
+
| width="90%" | MOSI
−
 
+
|-
−
<span style="font-weight: normal;"><u>MISO</u></span>
+
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.&nbsp;
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MISO''.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | MISO
−
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
+
|-
−
 
+
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.&nbsp;
−
<span style="font-weight: normal;"><u>CLK</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::CLK''.
+
| width="90%" | CLK
−
 
+
|-
−
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
+
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>CS / SS</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | CS / SS
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::SS''.
+
|-
−
 
+
| colspan="2" | 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. &nbsp;
−
Chip Select / Slave Select Pin  
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
Master Mode: General purpose output pin used to select the remote SPI device.
+
| width="90%" | Prescale
−
 
+
|-
−
Slave Mode: Hardware chip select pin input used to select the SPI device.
+
| colspan="2" | Prescale option selector&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Prescale</u></span>
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::PR_SCALE''.
+
|-
−
 
+
|-
−
Prescale option selector
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Simulation Comms
−
<span style="font-weight: normal;"><u>Scope Traces</u></span>
+
|-
−
 
+
| colspan="2" | &nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi1::ScopeTraces''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
Selects if the scope traces are automatically generated or not
+
| width="90%" | Scope Traces
−
 
+
|-
−
<span style="font-weight: normal;"><u>Console Data</u></span>
+
| colspan="2" | Selects if the scope traces are automatically generated or not&nbsp;
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi1::ConsoleData''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Console Data
−
Selects if the console data is automatically generated or not
+
|-
−
 
+
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
−
<span style="font-weight: normal;"><u>Injector</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::Injector''.
+
| width="90%" | API
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | &nbsp;
 +
|}

Revision as of 19:48, 16 November 2021

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.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

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


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


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


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 
[[File:]] - Return


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


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


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


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


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 
[[File:]] - Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Starts up the SPI connection to the EasyCAT board and configures the board. Returns 1 for a sucessful initialise. 
[[File:]] - Return


Fc9-comp-macro.png Initialise
Sets up the component ready to collect weather 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-type-21-icon.png Total Byte Num Out
Total number of bytes to come out from the EtherCAT master 
Fc9-type-21-icon.png Total Byte Num In
Total bytes to come in from the EtherCAT master 
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 Simulations
Fc9-type-7-icon.png Simulation Comms
 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-16-icon.png API
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_EtherCAT_Slave_(EasyCAT)_(Comms:_IoT/Cloud)&oldid=25299"