User manual

mikroBasic PRO for dsPIC30/33 and PIC24
MikroElektronika
481
SPI_Ethernet_doPacket
SPI_Ethernet_putByte
Prototype
sub function SPI_Ethernet_doPacket() as byte
Description This is MAC module routine. It processes next received packet if such exists. Packets are processed
in the following manner:
- ARP & ICMP requests are replied automatically.
- upon TCP request the SPI_Ethernet_UserTCP function is called for further processing.
- upon UDP request the SPI_Ethernet_UserUDP function is called for further processing.
Parameters None.
Returns - 0 - upon successful packet processing (zero packets received or received packet processed
successfully).
- 1 - upon reception error or receive buffer corruption. ENC28J60 controller needs to be restarted.
- 2 - received packet was not sent to us (not our IP, nor IP broadcast address).
- 3 - received IP packet was not IPv4.
- 4 - received packet was of type unknown to the library.
Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.
Example
while TRUE
...
SPI_Ethernet_doPacket() ‘ process received packets
...
wend
Notes SPI_Ethernet_doPacket must be called as often as possible in user’s code.
Prototype
sub procedure SPI_Ethernet_putByte(dim v as byte)
Description This is MAC module routine. It stores one byte to address pointed by the current ENC28J60 write
pointer (EWRPT).
Parameters - v: value to store
Returns Nothing.
Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.
Example
dim data as byte
...
SPI_Ethernet_putByte(data) ‘ put an byte into ENC28J60 buffer
Notes None.