Albin Sebastian / WIZnetInterface

Library for ethernet

Dependents:   VC0706_FTP_Client_Ethernet_MQTT

Fork of WIZnetInterface by Akshay Tom

EthernetInterface.h@22:01ea4b74d8eb, 2018-07-16 (annotated)

Committer:
Albinarackal
Date:
Mon Jul 16 09:21:17 2018 +0000
Revision:
22:01ea4b74d8eb
Parent:
8:4c02de1dbf3a 
For MQTT and FTP connection

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Soohwan Kim 0:6f28332c466f 1 /* Copyright (C) 2012 mbed.org, MIT License
Soohwan Kim 0:6f28332c466f 2 *
Soohwan Kim 0:6f28332c466f 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Soohwan Kim 0:6f28332c466f 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
Soohwan Kim 0:6f28332c466f 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
Soohwan Kim 0:6f28332c466f 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
Soohwan Kim 0:6f28332c466f 7 * furnished to do so, subject to the following conditions:
Soohwan Kim 0:6f28332c466f 8 *
Soohwan Kim 0:6f28332c466f 9 * The above copyright notice and this permission notice shall be included in all copies or
Soohwan Kim 0:6f28332c466f 10 * substantial portions of the Software.
Soohwan Kim 0:6f28332c466f 11 *
Soohwan Kim 0:6f28332c466f 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Soohwan Kim 0:6f28332c466f 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Soohwan Kim 0:6f28332c466f 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Soohwan Kim 0:6f28332c466f 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Soohwan Kim 0:6f28332c466f 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Soohwan Kim 0:6f28332c466f 17 */
Soohwan Kim 0:6f28332c466f 18
Soohwan Kim 0:6f28332c466f 19 #pragma once
Soohwan Kim 0:6f28332c466f 20 #include "eth_arch.h"
Soohwan Kim 0:6f28332c466f 21 /** Interface using Wiznet chip to connect to an IP-based network
Soohwan Kim 0:6f28332c466f 22 *
Soohwan Kim 0:6f28332c466f 23 */
Soohwan Kim 0:6f28332c466f 24 class EthernetInterface: public WIZnet_Chip {
Soohwan Kim 0:6f28332c466f 25 public:
Soohwan Kim 8:4c02de1dbf3a 26
embeddist 7:da6fcec0f3fe 27 #if not defined(TARGET_WIZwiki_W7500)
Soohwan Kim 8:4c02de1dbf3a 28 /**
Soohwan Kim 8:4c02de1dbf3a 29 * Constructor
Soohwan Kim 8:4c02de1dbf3a 30 *
Soohwan Kim 8:4c02de1dbf3a 31 * \param mosi mbed pin to use for SPI
Soohwan Kim 8:4c02de1dbf3a 32 * \param miso mbed pin to use for SPI
Soohwan Kim 8:4c02de1dbf3a 33 * \param sclk mbed pin to use for SPI
Soohwan Kim 8:4c02de1dbf3a 34 * \param cs chip select of the WIZnet_Chip
Soohwan Kim 8:4c02de1dbf3a 35 * \param reset reset pin of the WIZnet_Chip
Soohwan Kim 8:4c02de1dbf3a 36 */
embeddist 3:f8c6efc8bf83 37 EthernetInterface(PinName mosi, PinName miso, PinName sclk, PinName cs, PinName reset);
embeddist 3:f8c6efc8bf83 38 EthernetInterface(SPI* spi, PinName cs, PinName reset);
embeddist 7:da6fcec0f3fe 39 #endif
Soohwan Kim 8:4c02de1dbf3a 40
Soohwan Kim 0:6f28332c466f 41 /** Initialize the interface with DHCP.
Soohwan Kim 0:6f28332c466f 42 * Initialize the interface and configure it to use DHCP (no connection at this point).
Soohwan Kim 0:6f28332c466f 43 * \return 0 on success, a negative number on failure
Soohwan Kim 0:6f28332c466f 44 */
Soohwan Kim 0:6f28332c466f 45 int init(uint8_t * mac); //With DHCP
Soohwan Kim 0:6f28332c466f 46
Soohwan Kim 0:6f28332c466f 47 /** Initialize the interface with a static IP address.
Soohwan Kim 0:6f28332c466f 48 * Initialize the interface and configure it with the following static configuration (no connection at this point).
Soohwan Kim 0:6f28332c466f 49 * \param ip the IP address to use
Soohwan Kim 0:6f28332c466f 50 * \param mask the IP address mask
Soohwan Kim 0:6f28332c466f 51 * \param gateway the gateway to use
Soohwan Kim 0:6f28332c466f 52 * \return 0 on success, a negative number on failure
Soohwan Kim 0:6f28332c466f 53 */
Soohwan Kim 0:6f28332c466f 54 int init(uint8_t * mac, const char* ip, const char* mask, const char* gateway);
Soohwan Kim 0:6f28332c466f 55
Soohwan Kim 0:6f28332c466f 56 /** Connect
Soohwan Kim 0:6f28332c466f 57 * Bring the interface up, start DHCP if needed.
Soohwan Kim 0:6f28332c466f 58 * \return 0 on success, a negative number on failure
Soohwan Kim 0:6f28332c466f 59 */
Soohwan Kim 0:6f28332c466f 60 int connect();
Soohwan Kim 0:6f28332c466f 61
Soohwan Kim 0:6f28332c466f 62 /** Disconnect
Soohwan Kim 0:6f28332c466f 63 * Bring the interface down
Soohwan Kim 0:6f28332c466f 64 * \return 0 on success, a negative number on failure
Soohwan Kim 0:6f28332c466f 65 */
Soohwan Kim 0:6f28332c466f 66 int disconnect();
Soohwan Kim 0:6f28332c466f 67
Soohwan Kim 0:6f28332c466f 68 /** Get IP address & MAC address
Soohwan Kim 0:6f28332c466f 69 *
Soohwan Kim 0:6f28332c466f 70 * @ returns ip address
Soohwan Kim 0:6f28332c466f 71 */
Soohwan Kim 0:6f28332c466f 72 char* getIPAddress();
Soohwan Kim 0:6f28332c466f 73 char* getNetworkMask();
Soohwan Kim 0:6f28332c466f 74 char* getGateway();
Soohwan Kim 0:6f28332c466f 75 char* getMACAddress();
Soohwan Kim 0:6f28332c466f 76
Soohwan Kim 0:6f28332c466f 77 int IPrenew(int timeout_ms = 15*1000);
Soohwan Kim 0:6f28332c466f 78
Soohwan Kim 0:6f28332c466f 79 private:
Soohwan Kim 0:6f28332c466f 80 char ip_string[20];
Soohwan Kim 0:6f28332c466f 81 char mask_string[20];
Soohwan Kim 0:6f28332c466f 82 char gw_string[20];
Soohwan Kim 0:6f28332c466f 83 char mac_string[20];
Soohwan Kim 0:6f28332c466f 84 bool ip_set;
Soohwan Kim 0:6f28332c466f 85 };
Soohwan Kim 0:6f28332c466f 86
Soohwan Kim 0:6f28332c466f 87 #include "TCPSocketConnection.h"
Soohwan Kim 0:6f28332c466f 88 #include "TCPSocketServer.h"
Soohwan Kim 0:6f28332c466f 89 #include "UDPSocket.h"