George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/Ethernet.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:dd0fea342ad2 1 /* mbed Microcontroller Library
gkroussos 0:dd0fea342ad2 2 * Copyright (c) 2006-2013 ARM Limited
gkroussos 0:dd0fea342ad2 3 *
gkroussos 0:dd0fea342ad2 4 * Licensed under the Apache License, Version 2.0 (the "License");
gkroussos 0:dd0fea342ad2 5 * you may not use this file except in compliance with the License.
gkroussos 0:dd0fea342ad2 6 * You may obtain a copy of the License at
gkroussos 0:dd0fea342ad2 7 *
gkroussos 0:dd0fea342ad2 8 * http://www.apache.org/licenses/LICENSE-2.0
gkroussos 0:dd0fea342ad2 9 *
gkroussos 0:dd0fea342ad2 10 * Unless required by applicable law or agreed to in writing, software
gkroussos 0:dd0fea342ad2 11 * distributed under the License is distributed on an "AS IS" BASIS,
gkroussos 0:dd0fea342ad2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gkroussos 0:dd0fea342ad2 13 * See the License for the specific language governing permissions and
gkroussos 0:dd0fea342ad2 14 * limitations under the License.
gkroussos 0:dd0fea342ad2 15 */
gkroussos 0:dd0fea342ad2 16 #ifndef MBED_ETHERNET_H
gkroussos 0:dd0fea342ad2 17 #define MBED_ETHERNET_H
gkroussos 0:dd0fea342ad2 18
gkroussos 0:dd0fea342ad2 19 #include "platform.h"
gkroussos 0:dd0fea342ad2 20
gkroussos 0:dd0fea342ad2 21 #if DEVICE_ETHERNET
gkroussos 0:dd0fea342ad2 22
gkroussos 0:dd0fea342ad2 23 namespace mbed {
gkroussos 0:dd0fea342ad2 24
gkroussos 0:dd0fea342ad2 25 /** An ethernet interface, to use with the ethernet pins.
gkroussos 0:dd0fea342ad2 26 *
gkroussos 0:dd0fea342ad2 27 * Example:
gkroussos 0:dd0fea342ad2 28 * @code
gkroussos 0:dd0fea342ad2 29 * // Read destination and source from every ethernet packet
gkroussos 0:dd0fea342ad2 30 *
gkroussos 0:dd0fea342ad2 31 * #include "mbed.h"
gkroussos 0:dd0fea342ad2 32 *
gkroussos 0:dd0fea342ad2 33 * Ethernet eth;
gkroussos 0:dd0fea342ad2 34 *
gkroussos 0:dd0fea342ad2 35 * int main() {
gkroussos 0:dd0fea342ad2 36 * char buf[0x600];
gkroussos 0:dd0fea342ad2 37 *
gkroussos 0:dd0fea342ad2 38 * while(1) {
gkroussos 0:dd0fea342ad2 39 * int size = eth.receive();
gkroussos 0:dd0fea342ad2 40 * if(size > 0) {
gkroussos 0:dd0fea342ad2 41 * eth.read(buf, size);
gkroussos 0:dd0fea342ad2 42 * printf("Destination: %02X:%02X:%02X:%02X:%02X:%02X\n",
gkroussos 0:dd0fea342ad2 43 * buf[0], buf[1], buf[2], buf[3], buf[4], buf[5]);
gkroussos 0:dd0fea342ad2 44 * printf("Source: %02X:%02X:%02X:%02X:%02X:%02X\n",
gkroussos 0:dd0fea342ad2 45 * buf[6], buf[7], buf[8], buf[9], buf[10], buf[11]);
gkroussos 0:dd0fea342ad2 46 * }
gkroussos 0:dd0fea342ad2 47 *
gkroussos 0:dd0fea342ad2 48 * wait(1);
gkroussos 0:dd0fea342ad2 49 * }
gkroussos 0:dd0fea342ad2 50 * }
gkroussos 0:dd0fea342ad2 51 * @endcode
gkroussos 0:dd0fea342ad2 52 */
gkroussos 0:dd0fea342ad2 53 class Ethernet {
gkroussos 0:dd0fea342ad2 54
gkroussos 0:dd0fea342ad2 55 public:
gkroussos 0:dd0fea342ad2 56
gkroussos 0:dd0fea342ad2 57 /** Initialise the ethernet interface.
gkroussos 0:dd0fea342ad2 58 */
gkroussos 0:dd0fea342ad2 59 Ethernet();
gkroussos 0:dd0fea342ad2 60
gkroussos 0:dd0fea342ad2 61 /** Powers the hardware down.
gkroussos 0:dd0fea342ad2 62 */
gkroussos 0:dd0fea342ad2 63 virtual ~Ethernet();
gkroussos 0:dd0fea342ad2 64
gkroussos 0:dd0fea342ad2 65 enum Mode {
gkroussos 0:dd0fea342ad2 66 AutoNegotiate,
gkroussos 0:dd0fea342ad2 67 HalfDuplex10,
gkroussos 0:dd0fea342ad2 68 FullDuplex10,
gkroussos 0:dd0fea342ad2 69 HalfDuplex100,
gkroussos 0:dd0fea342ad2 70 FullDuplex100
gkroussos 0:dd0fea342ad2 71 };
gkroussos 0:dd0fea342ad2 72
gkroussos 0:dd0fea342ad2 73 /** Writes into an outgoing ethernet packet.
gkroussos 0:dd0fea342ad2 74 *
gkroussos 0:dd0fea342ad2 75 * It will append size bytes of data to the previously written bytes.
gkroussos 0:dd0fea342ad2 76 *
gkroussos 0:dd0fea342ad2 77 * @param data An array to write.
gkroussos 0:dd0fea342ad2 78 * @param size The size of data.
gkroussos 0:dd0fea342ad2 79 *
gkroussos 0:dd0fea342ad2 80 * @returns
gkroussos 0:dd0fea342ad2 81 * The number of written bytes.
gkroussos 0:dd0fea342ad2 82 */
gkroussos 0:dd0fea342ad2 83 int write(const char *data, int size);
gkroussos 0:dd0fea342ad2 84
gkroussos 0:dd0fea342ad2 85 /** Send an outgoing ethernet packet.
gkroussos 0:dd0fea342ad2 86 *
gkroussos 0:dd0fea342ad2 87 * After filling in the data in an ethernet packet it must be send.
gkroussos 0:dd0fea342ad2 88 * Send will provide a new packet to write to.
gkroussos 0:dd0fea342ad2 89 *
gkroussos 0:dd0fea342ad2 90 * @returns
gkroussos 0:dd0fea342ad2 91 * 0 if the sending was failed,
gkroussos 0:dd0fea342ad2 92 * or the size of the packet successfully sent.
gkroussos 0:dd0fea342ad2 93 */
gkroussos 0:dd0fea342ad2 94 int send();
gkroussos 0:dd0fea342ad2 95
gkroussos 0:dd0fea342ad2 96 /** Recevies an arrived ethernet packet.
gkroussos 0:dd0fea342ad2 97 *
gkroussos 0:dd0fea342ad2 98 * Receiving an ethernet packet will drop the last received ethernet packet
gkroussos 0:dd0fea342ad2 99 * and make a new ethernet packet ready to read.
gkroussos 0:dd0fea342ad2 100 * If no ethernet packet is arrived it will return 0.
gkroussos 0:dd0fea342ad2 101 *
gkroussos 0:dd0fea342ad2 102 * @returns
gkroussos 0:dd0fea342ad2 103 * 0 if no ethernet packet is arrived,
gkroussos 0:dd0fea342ad2 104 * or the size of the arrived packet.
gkroussos 0:dd0fea342ad2 105 */
gkroussos 0:dd0fea342ad2 106 int receive();
gkroussos 0:dd0fea342ad2 107
gkroussos 0:dd0fea342ad2 108 /** Read from an recevied ethernet packet.
gkroussos 0:dd0fea342ad2 109 *
gkroussos 0:dd0fea342ad2 110 * After receive returnd a number bigger than 0it is
gkroussos 0:dd0fea342ad2 111 * possible to read bytes from this packet.
gkroussos 0:dd0fea342ad2 112 * Read will write up to size bytes into data.
gkroussos 0:dd0fea342ad2 113 *
gkroussos 0:dd0fea342ad2 114 * It is possible to use read multible times.
gkroussos 0:dd0fea342ad2 115 * Each time read will start reading after the last read byte before.
gkroussos 0:dd0fea342ad2 116 *
gkroussos 0:dd0fea342ad2 117 * @returns
gkroussos 0:dd0fea342ad2 118 * The number of byte read.
gkroussos 0:dd0fea342ad2 119 */
gkroussos 0:dd0fea342ad2 120 int read(char *data, int size);
gkroussos 0:dd0fea342ad2 121
gkroussos 0:dd0fea342ad2 122 /** Gives the ethernet address of the mbed.
gkroussos 0:dd0fea342ad2 123 *
gkroussos 0:dd0fea342ad2 124 * @param mac Must be a pointer to a 6 byte char array to copy the ethernet address in.
gkroussos 0:dd0fea342ad2 125 */
gkroussos 0:dd0fea342ad2 126 void address(char *mac);
gkroussos 0:dd0fea342ad2 127
gkroussos 0:dd0fea342ad2 128 /** Returns if an ethernet link is pressent or not. It takes a wile after Ethernet initializion to show up.
gkroussos 0:dd0fea342ad2 129 *
gkroussos 0:dd0fea342ad2 130 * @returns
gkroussos 0:dd0fea342ad2 131 * 0 if no ethernet link is pressent,
gkroussos 0:dd0fea342ad2 132 * 1 if an ethernet link is pressent.
gkroussos 0:dd0fea342ad2 133 *
gkroussos 0:dd0fea342ad2 134 * Example:
gkroussos 0:dd0fea342ad2 135 * @code
gkroussos 0:dd0fea342ad2 136 * // Using the Ethernet link function
gkroussos 0:dd0fea342ad2 137 * #include "mbed.h"
gkroussos 0:dd0fea342ad2 138 *
gkroussos 0:dd0fea342ad2 139 * Ethernet eth;
gkroussos 0:dd0fea342ad2 140 *
gkroussos 0:dd0fea342ad2 141 * int main() {
gkroussos 0:dd0fea342ad2 142 * wait(1); // Needed after startup.
gkroussos 0:dd0fea342ad2 143 * if (eth.link()) {
gkroussos 0:dd0fea342ad2 144 * printf("online\n");
gkroussos 0:dd0fea342ad2 145 * } else {
gkroussos 0:dd0fea342ad2 146 * printf("offline\n");
gkroussos 0:dd0fea342ad2 147 * }
gkroussos 0:dd0fea342ad2 148 * }
gkroussos 0:dd0fea342ad2 149 * @endcode
gkroussos 0:dd0fea342ad2 150 */
gkroussos 0:dd0fea342ad2 151 int link();
gkroussos 0:dd0fea342ad2 152
gkroussos 0:dd0fea342ad2 153 /** Sets the speed and duplex parameters of an ethernet link
gkroussos 0:dd0fea342ad2 154 *
gkroussos 0:dd0fea342ad2 155 * - AutoNegotiate Auto negotiate speed and duplex
gkroussos 0:dd0fea342ad2 156 * - HalfDuplex10 10 Mbit, half duplex
gkroussos 0:dd0fea342ad2 157 * - FullDuplex10 10 Mbit, full duplex
gkroussos 0:dd0fea342ad2 158 * - HalfDuplex100 100 Mbit, half duplex
gkroussos 0:dd0fea342ad2 159 * - FullDuplex100 100 Mbit, full duplex
gkroussos 0:dd0fea342ad2 160 *
gkroussos 0:dd0fea342ad2 161 * @param mode the speed and duplex mode to set the link to:
gkroussos 0:dd0fea342ad2 162 */
gkroussos 0:dd0fea342ad2 163 void set_link(Mode mode);
gkroussos 0:dd0fea342ad2 164 };
gkroussos 0:dd0fea342ad2 165
gkroussos 0:dd0fea342ad2 166 } // namespace mbed
gkroussos 0:dd0fea342ad2 167
gkroussos 0:dd0fea342ad2 168 #endif
gkroussos 0:dd0fea342ad2 169
gkroussos 0:dd0fea342ad2 170 #endif