Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

Ethernet class

Ethernet class
[Drivers]

Functions

class MBED_DEPRECATED ("EthInterface is now the preferred way to get an Ethernet object. ""Alternatively, use NetworkInterface to get an instance of an appropriate network ""interface (WiFi or Ethernet).") Ethernet
 An ethernet interface, to use with the ethernet pins.

Function Documentation

class mbed::MBED_DEPRECATED ( "EthInterface is now the preferred way to get an Ethernet object. ""  Alternatively,
use NetworkInterface to get an instance of an appropriate network" "interface(WiFi or Ethernet)."   
)

An ethernet interface, to use with the ethernet pins.

Note:
Synchronization level: Not protected

Example:

 // Read destination and source from every ethernet packet

 #include "mbed.h"

 Ethernet eth;

 int main() {
     char buf[0x600];

     while(1) {
         int size = eth.receive();
         if(size > 0) {
             eth.read(buf, size);
             printf("Destination:  %02X:%02X:%02X:%02X:%02X:%02X\n",
                     buf[0], buf[1], buf[2], buf[3], buf[4], buf[5]);
             printf("Source: %02X:%02X:%02X:%02X:%02X:%02X\n",
                     buf[6], buf[7], buf[8], buf[9], buf[10], buf[11]);
         }

         wait(1);
     }
 }

It will append size bytes of data to the previously written bytes.

Parameters:
dataAn array to write.
sizeThe size of data.
Returns:
The number of written bytes.

After filling in the data in an ethernet packet it must be send. Send will provide a new packet to write to.

Returns:
0 if the sending was failed, or the size of the packet successfully sent.

Receiving an ethernet packet will drop the last received ethernet packet and make a new ethernet packet ready to read. If no ethernet packet is arrived it will return 0.

Returns:
0 if no ethernet packet is arrived, or the size of the arrived packet.

After receive returned a number bigger than 0 it is possible to read bytes from this packet.

Parameters:
dataPointer to data packet
sizeSize of data to be read.
Returns:
The number of byte read.
Note:
It is possible to use read multiple times. Each time read will start reading after the last read byte before.
Parameters:
macMust be a pointer to a 6 byte char array to copy the ethernet address in.
Returns:
0 if no ethernet link is present, 1 if an ethernet link is present.

Example:

 // Using the Ethernet link function
 #include "mbed.h"

 Ethernet eth;

 int main() {
     wait(1); // Needed after startup.
     if (eth.link()) {
          printf("online\n");
     } else {
          printf("offline\n");
     }
 }
  • AutoNegotiate Auto negotiate speed and duplex
  • HalfDuplex10 10 Mbit, half duplex
  • FullDuplex10 10 Mbit, full duplex
  • HalfDuplex100 100 Mbit, half duplex
  • FullDuplex100 100 Mbit, full duplex
Parameters:
modethe speed and duplex mode to set the link to:

Definition at line 71 of file Ethernet.h.