View source for Component: TCPIP (ENC28J60) (Comms)

From Flowcode Help

← Component: TCPIP (ENC28J60) (Comms)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| width="50%" |- | width="20%" style="color: gray;" | Author | Ben Rowland |- | width="20%" style="color: gray;" | Version | 1.0 (Release) |- | width="20%" style="color: gray;" | Category | Comms |} ==[[File:Component Icon 8aab4b54_a912_449c_b11a_7c1a5db8d591.png|Image]] TCPIP (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 ==Examples== ''<span style="color:red;">No additional examples</span>'' ==Downloadable macro reference== ===<span style="font-weight: normal;"><u><tt>PacketSend</tt></u></span>=== Attempts to transmit a data packet to the ENC28J60 module. '''Parameters''' :[[Variable Types|UINT]] ''Length'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>MakeTcpSynackFromSyn</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :[[Variable Types|UINT]] ''Port'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>MakeArpRequest</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :[[Variable Types|<- BYTE]] ''ServerIP'' ::''This parameter may be returned back to the caller'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>InitialiseDataLengthInfo</tt></u></span>=== Initialises the data pointers to allow us to craft a response containing data '''Parameters''' :''This macro has no parameters'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>MakeTcpAckFromAny</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :[[Variable Types|UINT]] ''Port'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>PacketReceive</tt></u></span>=== Attempts to receive a data packet from the ENC28J60 module. Returns the number of bytes received. '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|UINT]] ===<span style="font-weight: normal;"><u><tt>CheckForTCPType</tt></u></span>=== 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 '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>CheckArpPacketIsMyreplyArp</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>CheckForIp</tt></u></span>=== Checks to see if the received data is an IP request with my IP address. '''Parameters''' :[[Variable Types|UINT]] ''Length'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>CheckForTCPPort</tt></u></span>=== Checks to see if the received data is requesting the server port '''Parameters''' :[[Variable Types|UINT]] ''Port'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>CheckForPing</tt></u></span>=== Checks to see if the received data is a Ping request '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>GetModuleRevision</tt></u></span>=== Requets the module revision number and returns the value supplied by the module's firmware. '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>MakeTcpAckWithData</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :[[Variable Types|UINT]] ''DataLength'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>MakeArpAnswerFromRequest</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :''This macro has no parameters'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>ReadRegister</tt></u></span>=== Reads the value from a single register onboard the ENC28J60 module. '''Parameters''' :[[Variable Types|BYTE]] ''Address'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>CheckForARP</tt></u></span>=== Checks to see if the received data is an ARP request with my IP address. '''Parameters''' :[[Variable Types|UINT]] ''Length'' '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>ClientSendPacket</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :[[Variable Types|UINT]] ''DestPort'' :[[Variable Types|UINT]] ''SourcePort'' :[[Variable Types|BYTE]] ''Flags'' :[[Variable Types|BYTE]] ''MaxSegmentSize'' :[[Variable Types|BYTE]] ''ClearSeqAck'' :[[Variable Types|UINT]] ''NextAckNum'' :[[Variable Types|UINT]] ''DataLength'' :[[Variable Types|BYTE]] ''DestMac'' :[[Variable Types|BYTE]] ''DestIp'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>MakeEchoReplyFromRequest</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :[[Variable Types|UINT]] ''Length'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>ControlLEDs</tt></u></span>=== Allows both the LEDs on the Ethernet socket to be controlled. Useful for checking if the SPI communications are functioning correctly. '''Parameters''' :[[Variable Types|BYTE]] ''Mode'' ::0=Off, 1=On, 2=Auto '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>GetDataLength</tt></u></span>=== Returns the number of received data bytes after the headers '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|UINT]] ===<span style="font-weight: normal;"><u><tt>GetTcpDataPointer</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :''This macro has no parameters'' '''Return value''' :[[Variable Types|UINT]] ===<span style="font-weight: normal;"><u><tt>WriteRegister</tt></u></span>=== Writes a value to a single register onboard the ENC28J60 module. '''Parameters''' :[[Variable Types|BYTE]] ''Address'' :[[Variable Types|BYTE]] ''Data'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>FillTcpData</tt></u></span>=== ''<span style="color:red;">No additional information</span>'' '''Parameters''' :[[Variable Types|UINT]] ''Position'' :[[Variable Types|<- STRING]] ''Data'' ::''This parameter may be returned back to the caller'' '''Return value''' :[[Variable Types|UINT]] ===<span style="font-weight: normal;"><u><tt>ReadStringFromBuffer</tt></u></span>=== 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. '''Parameters''' :[[Variable Types|UINT]] ''BufferLocation'' :[[Variable Types|BYTE]] ''NumberOfBytes'' ::Number of bytes to read from the buffer and store into string '''Return value''' :[[Variable Types|STRING]] ===<span style="font-weight: normal;"><u><tt>GetSendersMAC</tt></u></span>=== Gets the MAC address from locations 6-11 of the IP Header '''Parameters''' :[[Variable Types|BYTE]] ''MAC'' ::6-byte Array to store the MAC address '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>=== 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. '''Parameters''' :''This macro has no parameters'' '''Return value''' :''This call does not return a value'' ==Simulation macro reference== ''This component does not contain any simulation macros'' ==Property reference== <span style="font-weight: normal;"><u>Server Port</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Port''. Sets the server's TCP/IP port address which is used to filter incoming TCP packets. <span style="font-weight: normal;"><u>Buffer Size</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''BufferSize''. 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 <span style="font-weight: normal;"><u>SPI Channel</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''CHANNEL''. SPI peripheral onboard the target microcontroller to use. <span style="font-weight: normal;"><u>Prescale</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''PR_SCALE''. Rate by which the master oscillator is reduced before clocking the SPI peripheral <span style="font-weight: normal;"><u>Reset Pin</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''ResetPin''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>Chip Select CS</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''cs_pin''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MOSI (SDO)</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''MOSI''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MISO (SDI)</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''MISO''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>CLK</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''CLK''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MOSI Remap</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''MosiRemap''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MISO Remap</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''MisoRemap''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>CLK Remap</u></span> This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ClkRemap''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MAC0</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''MAC0''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MAC1</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''MAC1''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MAC2</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''MAC2''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MAC3</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''MAC3''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MAC4</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''MAC4''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>MAC5</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''MAC5''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>IP0</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''IP0''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>IP1</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''IP1''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>IP2</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''IP2''. ''<span style="color:red;">No additional information</span>'' <span style="font-weight: normal;"><u>IP3</u></span> This property is of type ''Unsigned integer'' and can be referenced with the variable name ''IP3''. ''<span style="color:red;">No additional information</span>''

Return to Component: TCPIP (ENC28J60) (Comms).