Mark Turner / Mbed 2 deprecated lightsense_kl46z_basic_v1

Basic fading in and out of leds with light sensor.

Dependencies:   mbed

mbed/Ethernet.h@0:cf7af2656659, 2016-09-19 (annotated)

Committer:
mturner5
Date:
Mon Sep 19 03:24:58 2016 +0000
Revision:
0:cf7af2656659
Basic v1

Who changed what in which revision?

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