Mohamad Nazrin Napiah / Ethernet_communication

Connect MBED through Ethernet port

Dependencies:   Socket lwip-eth lwip-sys lwip

EthernetInterface.h@0:00d2ed14e5a0, 2018-02-21 (annotated)

Committer:
MohamadNazrin
Date:
Wed Feb 21 07:26:52 2018 +0000
Revision:
0:00d2ed14e5a0
display IP in LCD

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MohamadNazrin 0:00d2ed14e5a0 1 /* EthernetInterface.h */
MohamadNazrin 0:00d2ed14e5a0 2 /* Copyright (C) 2012 mbed.org, MIT License
MohamadNazrin 0:00d2ed14e5a0 3 *
MohamadNazrin 0:00d2ed14e5a0 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
MohamadNazrin 0:00d2ed14e5a0 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
MohamadNazrin 0:00d2ed14e5a0 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
MohamadNazrin 0:00d2ed14e5a0 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
MohamadNazrin 0:00d2ed14e5a0 8 * furnished to do so, subject to the following conditions:
MohamadNazrin 0:00d2ed14e5a0 9 *
MohamadNazrin 0:00d2ed14e5a0 10 * The above copyright notice and this permission notice shall be included in all copies or
MohamadNazrin 0:00d2ed14e5a0 11 * substantial portions of the Software.
MohamadNazrin 0:00d2ed14e5a0 12 *
MohamadNazrin 0:00d2ed14e5a0 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
MohamadNazrin 0:00d2ed14e5a0 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
MohamadNazrin 0:00d2ed14e5a0 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
MohamadNazrin 0:00d2ed14e5a0 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
MohamadNazrin 0:00d2ed14e5a0 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
MohamadNazrin 0:00d2ed14e5a0 18 */
MohamadNazrin 0:00d2ed14e5a0 19
MohamadNazrin 0:00d2ed14e5a0 20 #ifndef ETHERNETINTERFACE_H_
MohamadNazrin 0:00d2ed14e5a0 21 #define ETHERNETINTERFACE_H_
MohamadNazrin 0:00d2ed14e5a0 22
MohamadNazrin 0:00d2ed14e5a0 23 #if !defined(TARGET_LPC1768) && !defined(TARGET_LPC4088) && !defined(TARGET_K64F)
MohamadNazrin 0:00d2ed14e5a0 24 #error The Ethernet Interface library is not supported on this target
MohamadNazrin 0:00d2ed14e5a0 25 #endif
MohamadNazrin 0:00d2ed14e5a0 26
MohamadNazrin 0:00d2ed14e5a0 27 #include "rtos.h"
MohamadNazrin 0:00d2ed14e5a0 28 #include "lwip/netif.h"
MohamadNazrin 0:00d2ed14e5a0 29
MohamadNazrin 0:00d2ed14e5a0 30 /** Interface using Ethernet to connect to an IP-based network
MohamadNazrin 0:00d2ed14e5a0 31 *
MohamadNazrin 0:00d2ed14e5a0 32 */
MohamadNazrin 0:00d2ed14e5a0 33 class EthernetInterface {
MohamadNazrin 0:00d2ed14e5a0 34 public:
MohamadNazrin 0:00d2ed14e5a0 35 /** Initialize the interface with DHCP.
MohamadNazrin 0:00d2ed14e5a0 36 * Initialize the interface and configure it to use DHCP (no connection at this point).
MohamadNazrin 0:00d2ed14e5a0 37 * \return 0 on success, a negative number on failure
MohamadNazrin 0:00d2ed14e5a0 38 */
MohamadNazrin 0:00d2ed14e5a0 39 static int init(); //With DHCP
MohamadNazrin 0:00d2ed14e5a0 40
MohamadNazrin 0:00d2ed14e5a0 41 /** Initialize the interface with a static IP address.
MohamadNazrin 0:00d2ed14e5a0 42 * Initialize the interface and configure it with the following static configuration (no connection at this point).
MohamadNazrin 0:00d2ed14e5a0 43 * \param ip the IP address to use
MohamadNazrin 0:00d2ed14e5a0 44 * \param mask the IP address mask
MohamadNazrin 0:00d2ed14e5a0 45 * \param gateway the gateway to use
MohamadNazrin 0:00d2ed14e5a0 46 * \return 0 on success, a negative number on failure
MohamadNazrin 0:00d2ed14e5a0 47 */
MohamadNazrin 0:00d2ed14e5a0 48 static int init(const char* ip, const char* mask, const char* gateway);
MohamadNazrin 0:00d2ed14e5a0 49
MohamadNazrin 0:00d2ed14e5a0 50 /** Connect
MohamadNazrin 0:00d2ed14e5a0 51 * Bring the interface up, start DHCP if needed.
MohamadNazrin 0:00d2ed14e5a0 52 * \param timeout_ms timeout in ms (default: (15)s).
MohamadNazrin 0:00d2ed14e5a0 53 * \return 0 on success, a negative number on failure
MohamadNazrin 0:00d2ed14e5a0 54 */
MohamadNazrin 0:00d2ed14e5a0 55 static int connect(unsigned int timeout_ms=15000);
MohamadNazrin 0:00d2ed14e5a0 56
MohamadNazrin 0:00d2ed14e5a0 57 /** Disconnect
MohamadNazrin 0:00d2ed14e5a0 58 * Bring the interface down
MohamadNazrin 0:00d2ed14e5a0 59 * \return 0 on success, a negative number on failure
MohamadNazrin 0:00d2ed14e5a0 60 */
MohamadNazrin 0:00d2ed14e5a0 61 static int disconnect();
MohamadNazrin 0:00d2ed14e5a0 62
MohamadNazrin 0:00d2ed14e5a0 63 /** Get the MAC address of your Ethernet interface
MohamadNazrin 0:00d2ed14e5a0 64 * \return a pointer to a string containing the MAC address
MohamadNazrin 0:00d2ed14e5a0 65 */
MohamadNazrin 0:00d2ed14e5a0 66 static char* getMACAddress();
MohamadNazrin 0:00d2ed14e5a0 67
MohamadNazrin 0:00d2ed14e5a0 68 /** Get the IP address of your Ethernet interface
MohamadNazrin 0:00d2ed14e5a0 69 * \return a pointer to a string containing the IP address
MohamadNazrin 0:00d2ed14e5a0 70 */
MohamadNazrin 0:00d2ed14e5a0 71 static char* getIPAddress();
MohamadNazrin 0:00d2ed14e5a0 72
MohamadNazrin 0:00d2ed14e5a0 73 /** Get the Gateway address of your Ethernet interface
MohamadNazrin 0:00d2ed14e5a0 74 * \return a pointer to a string containing the Gateway address
MohamadNazrin 0:00d2ed14e5a0 75 */
MohamadNazrin 0:00d2ed14e5a0 76 static char* getGateway();
MohamadNazrin 0:00d2ed14e5a0 77
MohamadNazrin 0:00d2ed14e5a0 78 /** Get the Network mask of your Ethernet interface
MohamadNazrin 0:00d2ed14e5a0 79 * \return a pointer to a string containing the Network mask
MohamadNazrin 0:00d2ed14e5a0 80 */
MohamadNazrin 0:00d2ed14e5a0 81 static char* getNetworkMask();
MohamadNazrin 0:00d2ed14e5a0 82 };
MohamadNazrin 0:00d2ed14e5a0 83
MohamadNazrin 0:00d2ed14e5a0 84 #include "TCPSocketConnection.h"
MohamadNazrin 0:00d2ed14e5a0 85 #include "TCPSocketServer.h"
MohamadNazrin 0:00d2ed14e5a0 86
MohamadNazrin 0:00d2ed14e5a0 87 #include "Endpoint.h"
MohamadNazrin 0:00d2ed14e5a0 88 #include "UDPSocket.h"
MohamadNazrin 0:00d2ed14e5a0 89
MohamadNazrin 0:00d2ed14e5a0 90 #endif /* ETHERNETINTERFACE_H_ */