Mark Turner / Mbed 2 deprecated lightsense_kl46z_basic_v1

Basic fading in and out of leds with light sensor.

Dependencies:   mbed

mbed/SPI.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_SPI_H
mturner5 0:cf7af2656659 17 #define MBED_SPI_H
mturner5 0:cf7af2656659 18
mturner5 0:cf7af2656659 19 #include "platform.h"
mturner5 0:cf7af2656659 20
mturner5 0:cf7af2656659 21 #if DEVICE_SPI
mturner5 0:cf7af2656659 22
mturner5 0:cf7af2656659 23 #include "spi_api.h"
mturner5 0:cf7af2656659 24
mturner5 0:cf7af2656659 25 namespace mbed {
mturner5 0:cf7af2656659 26
mturner5 0:cf7af2656659 27 /** A SPI Master, used for communicating with SPI slave devices
mturner5 0:cf7af2656659 28 *
mturner5 0:cf7af2656659 29 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
mturner5 0:cf7af2656659 30 *
mturner5 0:cf7af2656659 31 * Most SPI devices will also require Chip Select and Reset signals. These
mturner5 0:cf7af2656659 32 * can be controlled using <DigitalOut> pins
mturner5 0:cf7af2656659 33 *
mturner5 0:cf7af2656659 34 * Example:
mturner5 0:cf7af2656659 35 * @code
mturner5 0:cf7af2656659 36 * // Send a byte to a SPI slave, and record the response
mturner5 0:cf7af2656659 37 *
mturner5 0:cf7af2656659 38 * #include "mbed.h"
mturner5 0:cf7af2656659 39 *
mturner5 0:cf7af2656659 40 * SPI device(p5, p6, p7); // mosi, miso, sclk
mturner5 0:cf7af2656659 41 *
mturner5 0:cf7af2656659 42 * int main() {
mturner5 0:cf7af2656659 43 * int response = device.write(0xFF);
mturner5 0:cf7af2656659 44 * }
mturner5 0:cf7af2656659 45 * @endcode
mturner5 0:cf7af2656659 46 */
mturner5 0:cf7af2656659 47 class SPI {
mturner5 0:cf7af2656659 48
mturner5 0:cf7af2656659 49 public:
mturner5 0:cf7af2656659 50
mturner5 0:cf7af2656659 51 /** Create a SPI master connected to the specified pins
mturner5 0:cf7af2656659 52 *
mturner5 0:cf7af2656659 53 * Pin Options:
mturner5 0:cf7af2656659 54 * (5, 6, 7) or (11, 12, 13)
mturner5 0:cf7af2656659 55 *
mturner5 0:cf7af2656659 56 * mosi or miso can be specfied as NC if not used
mturner5 0:cf7af2656659 57 *
mturner5 0:cf7af2656659 58 * @param mosi SPI Master Out, Slave In pin
mturner5 0:cf7af2656659 59 * @param miso SPI Master In, Slave Out pin
mturner5 0:cf7af2656659 60 * @param sclk SPI Clock pin
mturner5 0:cf7af2656659 61 */
mturner5 0:cf7af2656659 62 SPI(PinName mosi, PinName miso, PinName sclk, PinName _unused=NC);
mturner5 0:cf7af2656659 63
mturner5 0:cf7af2656659 64 /** Configure the data transmission format
mturner5 0:cf7af2656659 65 *
mturner5 0:cf7af2656659 66 * @param bits Number of bits per SPI frame (4 - 16)
mturner5 0:cf7af2656659 67 * @param mode Clock polarity and phase mode (0 - 3)
mturner5 0:cf7af2656659 68 *
mturner5 0:cf7af2656659 69 * @code
mturner5 0:cf7af2656659 70 * mode | POL PHA
mturner5 0:cf7af2656659 71 * -----+--------
mturner5 0:cf7af2656659 72 * 0 | 0 0
mturner5 0:cf7af2656659 73 * 1 | 0 1
mturner5 0:cf7af2656659 74 * 2 | 1 0
mturner5 0:cf7af2656659 75 * 3 | 1 1
mturner5 0:cf7af2656659 76 * @endcode
mturner5 0:cf7af2656659 77 */
mturner5 0:cf7af2656659 78 void format(int bits, int mode = 0);
mturner5 0:cf7af2656659 79
mturner5 0:cf7af2656659 80 /** Set the spi bus clock frequency
mturner5 0:cf7af2656659 81 *
mturner5 0:cf7af2656659 82 * @param hz SCLK frequency in hz (default = 1MHz)
mturner5 0:cf7af2656659 83 */
mturner5 0:cf7af2656659 84 void frequency(int hz = 1000000);
mturner5 0:cf7af2656659 85
mturner5 0:cf7af2656659 86 /** Write to the SPI Slave and return the response
mturner5 0:cf7af2656659 87 *
mturner5 0:cf7af2656659 88 * @param value Data to be sent to the SPI slave
mturner5 0:cf7af2656659 89 *
mturner5 0:cf7af2656659 90 * @returns
mturner5 0:cf7af2656659 91 * Response from the SPI slave
mturner5 0:cf7af2656659 92 */
mturner5 0:cf7af2656659 93 virtual int write(int value);
mturner5 0:cf7af2656659 94
mturner5 0:cf7af2656659 95 public:
mturner5 0:cf7af2656659 96 virtual ~SPI() {
mturner5 0:cf7af2656659 97 }
mturner5 0:cf7af2656659 98
mturner5 0:cf7af2656659 99 protected:
mturner5 0:cf7af2656659 100 spi_t _spi;
mturner5 0:cf7af2656659 101
mturner5 0:cf7af2656659 102 void aquire(void);
mturner5 0:cf7af2656659 103 static SPI *_owner;
mturner5 0:cf7af2656659 104 int _bits;
mturner5 0:cf7af2656659 105 int _mode;
mturner5 0:cf7af2656659 106 int _hz;
mturner5 0:cf7af2656659 107 };
mturner5 0:cf7af2656659 108
mturner5 0:cf7af2656659 109 } // namespace mbed
mturner5 0:cf7af2656659 110
mturner5 0:cf7af2656659 111 #endif
mturner5 0:cf7af2656659 112
mturner5 0:cf7af2656659 113 #endif