Component: TCP/IP (ENC28J60) (Comms: Networking)
From Flowcode Help
| Author | Matrix TSL |
| Version | 2.2 |
| Category | Comms: Networking |
Contents
- 1 TCP/IP (ENC28J60) component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 CheckArpPacketIsMyreplyArp
- 5.2 CheckForARP
- 5.3 CheckForIp
- 5.4 CheckForPing
- 5.5 CheckForTCPPort
- 5.6 CheckForTCPType
- 5.7 ClientSendPacket
- 5.8 ControlLEDs
- 5.9 FillTcpArray
- 5.10 FillTcpData
- 5.11 GetDataLength
- 5.12 GetModuleRevision
- 5.13 GetSendersMAC
- 5.14 GetTcpDataPointer
- 5.15 Initialise
- 5.16 InitialiseDataLengthInfo
- 5.17 MakeArpAnswerFromRequest
- 5.18 MakeArpRequest
- 5.19 MakeEchoReplyFromRequest
- 5.20 MakeTcpAckFromAny
- 5.21 MakeTcpAckWithData
- 5.22 MakeTcpSynackFromSyn
- 5.23 PacketReceive
- 5.24 PacketSend
- 5.25 ReadArrayFromBuffer
- 5.26 ReadRegister
- 5.27 ReadStringFromBuffer
- 5.28 SetMyIPAddress
- 5.29 SetMyMACAddress
- 5.30 WriteRegister
- 6 Property reference
TCP/IP (ENC28J60) component
A set of routines used to control a ENC28J60 TCP/IP Module. Required connections VCC, Reset, GND, SCK, MISO, MOSI, CS. Leave these pins disconnected CLKOUT, ENC_WOL, ENC_INT
Component Source Code
Please click here to download the component source project: FC_Comp_Source_TCPIP_ENC28J60.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_TCPIP_ENC28J60.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
CheckArpPacketIsMyreplyArp
|
CheckArpPacketIsMyreplyArp |
 - BYTE
|
Return |
CheckForARP
|
|
CheckForARP |
| Checks to see if the received data is an ARP request with my IP address. | |
 - UINT
|
Length |
| - BYTE
|
Return |
CheckForIp
|
|
CheckForIp |
| Checks to see if the received data is an IP request with my IP address. | |
| - UINT
|
Length |
| - BYTE
|
Return |
CheckForPing
|
|
CheckForPing |
| Checks to see if the received data is a Ping request | |
| - BYTE
|
Return |
CheckForTCPPort
|
|
CheckForTCPPort |
| Checks to see if the received data is requesting the server port | |
| - UINT
|
Port |
| - BYTE
|
Return |
CheckForTCPType
|
|
CheckForTCPType |
| Checks to what kind of TCP type the received data is requesting. Returns a bit field specifying the type of request. 0x01 = Ack Requires, 0x02 = Synchronise 0x10 = Ack | |
| - BYTE
|
Return |
ClientSendPacket
|
|
ClientSendPacket |
| - UINT
|
DestPort |
| - UINT
|
SourcePort |
| - BYTE
|
Flags |
| - BYTE
|
MaxSegmentSize |
| - BYTE
|
ClearSeqAck |
| - UINT
|
NextAckNum |
| - UINT
|
DataLength |
| - BYTE
|
DestMac |
| - BYTE
|
DestIp |
 - VOID
|
Return |
ControlLEDs
|
|
ControlLEDs |
| Allows both the LEDs on the Ethernet socket to be controlled. Useful for checking if the SPI communications are functioning correctly. | |
| - BYTE
|
Mode |
| 0=Off, 1=On, 2=Auto | |
| - VOID
|
Return |
FillTcpArray
|
|
FillTcpArray |
| - UINT
|
Position |
| - UINT
|
Count |
| - BYTE
|
Data |
| - VOID
|
Return |
FillTcpData
|
|
FillTcpData |
| - UINT
|
Position |
 - STRING
|
Data |
| - UINT
|
Return |
GetDataLength
|
|
GetDataLength |
| Returns the number of received data bytes after the headers | |
| - UINT
|
Return |
GetModuleRevision
|
|
GetModuleRevision |
| Requets the module revision number and returns the value supplied by the module's firmware. | |
| - BYTE
|
Return |
GetSendersMAC
|
|
GetSendersMAC |
| Gets the MAC address from locations 6-11 of the IP Header | |
| - BYTE
|
MAC |
| 6-byte Array to store the MAC address | |
| - VOID
|
Return |
GetTcpDataPointer
|
|
GetTcpDataPointer |
| - UINT
|
Return |
Initialise
|
|
Initialise |
| Initialises the SPI connection to the TCPIP module and sets up some initial values. Flashes the LEDs on and off twice to confirm SPI comms are active. LEDs are then configured to auto functionality. | |
| - VOID
|
Return |
InitialiseDataLengthInfo
|
|
InitialiseDataLengthInfo |
| Initialises the data pointers to allow us to craft a response containing data | |
| - VOID
|
Return |
MakeArpAnswerFromRequest
|
|
MakeArpAnswerFromRequest |
| - VOID
|
Return |
MakeArpRequest
|
|
MakeArpRequest |
| - BYTE
|
ServerIP |
| - VOID
|
Return |
MakeEchoReplyFromRequest
|
|
MakeEchoReplyFromRequest |
| - UINT
|
Length |
| - VOID
|
Return |
MakeTcpAckFromAny
|
|
MakeTcpAckFromAny |
| - UINT
|
Port |
| - VOID
|
Return |
MakeTcpAckWithData
|
|
MakeTcpAckWithData |
| - UINT
|
DataLength |
| - VOID
|
Return |
MakeTcpSynackFromSyn
|
|
MakeTcpSynackFromSyn |
| - UINT
|
Port |
| - VOID
|
Return |
PacketReceive
|
|
PacketReceive |
| Attempts to receive a data packet from the ENC28J60 module. Returns the number of bytes received. | |
| - UINT
|
Return |
PacketSend
|
|
PacketSend |
| Attempts to transmit a data packet to the ENC28J60 module. | |
| - UINT
|
Length |
| - VOID
|
Return |
ReadArrayFromBuffer
|
|
ReadArrayFromBuffer |
| Reads an array of bytes from the buffer at location specified for the number of bytes specified. If a space character is encountered then the macro will return straight away without the space character in the string. | |
| - UINT
|
BufferLocation |
| - BYTE
|
NumberOfBytes |
| Number of bytes to read from the buffer and store into string | |
| - BYTE
|
Data |
| - VOID
|
Return |
ReadRegister
|
|
ReadRegister |
| Reads the value from a single register onboard the ENC28J60 module. | |
| - BYTE
|
Address |
| - BYTE
|
Return |
ReadStringFromBuffer
|
|
ReadStringFromBuffer |
| Reads a string from the buffer at location specified for the number of bytes specified. If a space character is encountered then the macro will return straight away without the space character in the string. | |
| - UINT
|
BufferLocation |
| - BYTE
|
NumberOfBytes |
| Number of bytes to read from the buffer and store into string | |
| - STRING
|
Return |
SetMyIPAddress
|
|
SetMyIPAddress |
| Allows the IP Address specified in the component properties to be overridden. The IP Address will revert back to the IP specified in the component properties as part of the initialise macro. | |
| - BYTE
|
IP0 |
| IP Address Parameter - e.g. 192 | |
| - BYTE
|
IP1 |
| IP Address Parameter - e.g. 168 | |
| - BYTE
|
IP2 |
| IP Address Parameter - e.g. 1 | |
| - BYTE
|
IP3 |
| IP Address Parameter - e.g. 250 | |
| - VOID
|
Return |
SetMyMACAddress
|
|
SetMyMACAddress |
| Allows the MAC Address specified in the component properties to be overridden. The MAC Address will revert back to the MAC specified in the component properties as part of the initialise macro. | |
| - BYTE
|
MAC0 |
| MAC Address Parameter | |
| - BYTE
|
MAC1 |
| MAC Address Parameter | |
| - BYTE
|
MAC2 |
| MAC Address Parameter | |
| - BYTE
|
MAC3 |
| MAC Address Parameter | |
| - BYTE
|
MAC4 |
| MAC Address Parameter | |
| - BYTE
|
MAC5 |
| MAC Address Parameter | |
| - VOID
|
Return |
WriteRegister
|
|
WriteRegister |
| Writes a value to a single register onboard the ENC28J60 module. | |
| - BYTE
|
Address |
| - BYTE
|
Data |
| - VOID
|
Return |
Property reference
|
Properties |
|
TCP IP Specifics |
|
Server Port |
| Sets the server's TCP/IP port address which is used to filter incoming TCP packets. | |
|
|
Buffer Size |
| Number of bytes to use for the transmit and receive buffer, we actually use this +1 to allow for a null termination. 8-bit PICs should set this to 255 to allow compilation to succeed. Other devices can have larger buffers. Default = 500 | |
|
|
SPI Settings |
|
Channel |
| SPI Channel selector | |
|
|
Prescale |
| Prescale option 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. | |
|
|
Reset Pin |
|
|
MAC Address |
|
|
MAC0 |
|
|
MAC1 |
|
|
MAC2 |
|
|
MAC3 |
|
|
MAC4 |
|
|
MAC5 |
|
|
IP Address |
|
|
IP0 |
|
|
IP1 |
|
|
IP2 |
|
|
IP3 |
|
|
Simulation |
|
Label |
|
|
Sim Type |
| Decides how to perform the simulation of the component. TCP IP - Communicates using the Windows TCP IP communications DLL SPI / API - Communicates using the CAL SPI to allow the communications to be analysed and debugged. | |
|
|
SPI Simulation |
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
API |
