User manual

mikroBasic PRO for PIC32
MikroElektronika
421
SPI_Ethernet_putConstString
SPI_Ethernet_getByte
SPI_Ethernet_getBytes
Prototype
sub function SPI_Ethernet_putConstString(const ptr as ^byte) as word
Description This is MAC module routine. It stores whole const string (excluding null termination) into ENC28J60
RAM starting from current ENC28J60 write pointer (EWRPT) location.
Parameters - ptr: const string to be written into ENC28J60 RAM.
Returns Number of bytes written into ENC28J60 RAM.
Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.
Example
const
buffer as string[16]
...
buffer = “mikroElektronika”
...
SPI_Ethernet_putConstString(buffer) ‘ put a const string into ENC28J60 buffer
Notes None.
Prototype
sub function SPI_Ethernet_getByte() as byte
Description This is MAC module routine. It fetches a byte from address pointed to by current ENC28J60 read
pointer (ERDPT).
Parameters None.
Returns Byte read from ENC28J60 RAM.
Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.
Example
dim buffer as byte<>
...
buffer = SPI_Ethernet_getByte() ‘ read a byte from ENC28J60 buffer
Notes None.
Prototype
sub procedure SPI_Ethernet_getBytes(dim ptr as ^byte, dim addr as word, dim
n as word)
Description This is MAC module routine. It fetches equested number of bytes from ENC28J60 RAM starting from
given address. If value of 0xFFFF is passed as the address parameter, the reading will start from
current ENC28J60 read pointer (ERDPT) location.
Parameters - ptr: buffer for storing bytes read from ENC28J60 RAM.
- addr: ENC28J60 RAM start address. Valid values: 0..8192.
- n: number of bytes to be read.
Returns Nothing.
Requires Ethernet module has to be initialized. See SPI_Ethernet_Init.
Example
dim
buffer as byte[16]
...
SPI_Ethernet_getBytes(buffer, 0x100, 16) ‘ read 16 bytes, starting from
address 0x100
Notes None.