Jeremy Hammel / Mbed 2 deprecated ATT_Smart_Home

FRDM-K64F, Avnet M14A2A, Grove Shield, to create smart home system. In use with AT&Ts M2x & Flow.

Dependencies:   mbed FXOS8700CQ MODSERIAL

mbed/SPISlave.h@85:0cf65ceb4492, 2019-04-29 (annotated)

Committer:
jwhammel
Date:
Mon Apr 29 04:24:38 2019 +0000
Revision:
85:0cf65ceb4492
Parent:
84:fc8c9b39723a 
We have added an alarm trigger that gets sent to AT&T Flow.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jwhammel 84:fc8c9b39723a 1 /* mbed Microcontroller Library
jwhammel 84:fc8c9b39723a 2 * Copyright (c) 2006-2013 ARM Limited
jwhammel 84:fc8c9b39723a 3 *
jwhammel 84:fc8c9b39723a 4 * Licensed under the Apache License, Version 2.0 (the "License");
jwhammel 84:fc8c9b39723a 5 * you may not use this file except in compliance with the License.
jwhammel 84:fc8c9b39723a 6 * You may obtain a copy of the License at
jwhammel 84:fc8c9b39723a 7 *
jwhammel 84:fc8c9b39723a 8 * http://www.apache.org/licenses/LICENSE-2.0
jwhammel 84:fc8c9b39723a 9 *
jwhammel 84:fc8c9b39723a 10 * Unless required by applicable law or agreed to in writing, software
jwhammel 84:fc8c9b39723a 11 * distributed under the License is distributed on an "AS IS" BASIS,
jwhammel 84:fc8c9b39723a 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jwhammel 84:fc8c9b39723a 13 * See the License for the specific language governing permissions and
jwhammel 84:fc8c9b39723a 14 * limitations under the License.
jwhammel 84:fc8c9b39723a 15 */
jwhammel 84:fc8c9b39723a 16 #ifndef MBED_SPISLAVE_H
jwhammel 84:fc8c9b39723a 17 #define MBED_SPISLAVE_H
jwhammel 84:fc8c9b39723a 18
jwhammel 84:fc8c9b39723a 19 #include "platform.h"
jwhammel 84:fc8c9b39723a 20
jwhammel 84:fc8c9b39723a 21 #if DEVICE_SPISLAVE
jwhammel 84:fc8c9b39723a 22
jwhammel 84:fc8c9b39723a 23 #include "spi_api.h"
jwhammel 84:fc8c9b39723a 24
jwhammel 84:fc8c9b39723a 25 namespace mbed {
jwhammel 84:fc8c9b39723a 26
jwhammel 84:fc8c9b39723a 27 /** A SPI slave, used for communicating with a SPI Master device
jwhammel 84:fc8c9b39723a 28 *
jwhammel 84:fc8c9b39723a 29 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
jwhammel 84:fc8c9b39723a 30 *
jwhammel 84:fc8c9b39723a 31 * Example:
jwhammel 84:fc8c9b39723a 32 * @code
jwhammel 84:fc8c9b39723a 33 * // Reply to a SPI master as slave
jwhammel 84:fc8c9b39723a 34 *
jwhammel 84:fc8c9b39723a 35 * #include "mbed.h"
jwhammel 84:fc8c9b39723a 36 *
jwhammel 84:fc8c9b39723a 37 * SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel
jwhammel 84:fc8c9b39723a 38 *
jwhammel 84:fc8c9b39723a 39 * int main() {
jwhammel 84:fc8c9b39723a 40 * device.reply(0x00); // Prime SPI with first reply
jwhammel 84:fc8c9b39723a 41 * while(1) {
jwhammel 84:fc8c9b39723a 42 * if(device.receive()) {
jwhammel 84:fc8c9b39723a 43 * int v = device.read(); // Read byte from master
jwhammel 84:fc8c9b39723a 44 * v = (v + 1) % 0x100; // Add one to it, modulo 256
jwhammel 84:fc8c9b39723a 45 * device.reply(v); // Make this the next reply
jwhammel 84:fc8c9b39723a 46 * }
jwhammel 84:fc8c9b39723a 47 * }
jwhammel 84:fc8c9b39723a 48 * }
jwhammel 84:fc8c9b39723a 49 * @endcode
jwhammel 84:fc8c9b39723a 50 */
jwhammel 84:fc8c9b39723a 51 class SPISlave {
jwhammel 84:fc8c9b39723a 52
jwhammel 84:fc8c9b39723a 53 public:
jwhammel 84:fc8c9b39723a 54
jwhammel 84:fc8c9b39723a 55 /** Create a SPI slave connected to the specified pins
jwhammel 84:fc8c9b39723a 56 *
jwhammel 84:fc8c9b39723a 57 * Pin Options:
jwhammel 84:fc8c9b39723a 58 * (5, 6, 7i, 8) or (11, 12, 13, 14)
jwhammel 84:fc8c9b39723a 59 *
jwhammel 84:fc8c9b39723a 60 * mosi or miso can be specfied as NC if not used
jwhammel 84:fc8c9b39723a 61 *
jwhammel 84:fc8c9b39723a 62 * @param mosi SPI Master Out, Slave In pin
jwhammel 84:fc8c9b39723a 63 * @param miso SPI Master In, Slave Out pin
jwhammel 84:fc8c9b39723a 64 * @param sclk SPI Clock pin
jwhammel 84:fc8c9b39723a 65 * @param ssel SPI chip select pin
jwhammel 84:fc8c9b39723a 66 * @param name (optional) A string to identify the object
jwhammel 84:fc8c9b39723a 67 */
jwhammel 84:fc8c9b39723a 68 SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel);
jwhammel 84:fc8c9b39723a 69
jwhammel 84:fc8c9b39723a 70 /** Configure the data transmission format
jwhammel 84:fc8c9b39723a 71 *
jwhammel 84:fc8c9b39723a 72 * @param bits Number of bits per SPI frame (4 - 16)
jwhammel 84:fc8c9b39723a 73 * @param mode Clock polarity and phase mode (0 - 3)
jwhammel 84:fc8c9b39723a 74 *
jwhammel 84:fc8c9b39723a 75 * @code
jwhammel 84:fc8c9b39723a 76 * mode | POL PHA
jwhammel 84:fc8c9b39723a 77 * -----+--------
jwhammel 84:fc8c9b39723a 78 * 0 | 0 0
jwhammel 84:fc8c9b39723a 79 * 1 | 0 1
jwhammel 84:fc8c9b39723a 80 * 2 | 1 0
jwhammel 84:fc8c9b39723a 81 * 3 | 1 1
jwhammel 84:fc8c9b39723a 82 * @endcode
jwhammel 84:fc8c9b39723a 83 */
jwhammel 84:fc8c9b39723a 84 void format(int bits, int mode = 0);
jwhammel 84:fc8c9b39723a 85
jwhammel 84:fc8c9b39723a 86 /** Set the spi bus clock frequency
jwhammel 84:fc8c9b39723a 87 *
jwhammel 84:fc8c9b39723a 88 * @param hz SCLK frequency in hz (default = 1MHz)
jwhammel 84:fc8c9b39723a 89 */
jwhammel 84:fc8c9b39723a 90 void frequency(int hz = 1000000);
jwhammel 84:fc8c9b39723a 91
jwhammel 84:fc8c9b39723a 92 /** Polls the SPI to see if data has been received
jwhammel 84:fc8c9b39723a 93 *
jwhammel 84:fc8c9b39723a 94 * @returns
jwhammel 84:fc8c9b39723a 95 * 0 if no data,
jwhammel 84:fc8c9b39723a 96 * 1 otherwise
jwhammel 84:fc8c9b39723a 97 */
jwhammel 84:fc8c9b39723a 98 int receive(void);
jwhammel 84:fc8c9b39723a 99
jwhammel 84:fc8c9b39723a 100 /** Retrieve data from receive buffer as slave
jwhammel 84:fc8c9b39723a 101 *
jwhammel 84:fc8c9b39723a 102 * @returns
jwhammel 84:fc8c9b39723a 103 * the data in the receive buffer
jwhammel 84:fc8c9b39723a 104 */
jwhammel 84:fc8c9b39723a 105 int read(void);
jwhammel 84:fc8c9b39723a 106
jwhammel 84:fc8c9b39723a 107 /** Fill the transmission buffer with the value to be written out
jwhammel 84:fc8c9b39723a 108 * as slave on the next received message from the master.
jwhammel 84:fc8c9b39723a 109 *
jwhammel 84:fc8c9b39723a 110 * @param value the data to be transmitted next
jwhammel 84:fc8c9b39723a 111 */
jwhammel 84:fc8c9b39723a 112 void reply(int value);
jwhammel 84:fc8c9b39723a 113
jwhammel 84:fc8c9b39723a 114 protected:
jwhammel 84:fc8c9b39723a 115 spi_t _spi;
jwhammel 84:fc8c9b39723a 116
jwhammel 84:fc8c9b39723a 117 int _bits;
jwhammel 84:fc8c9b39723a 118 int _mode;
jwhammel 84:fc8c9b39723a 119 int _hz;
jwhammel 84:fc8c9b39723a 120 };
jwhammel 84:fc8c9b39723a 121
jwhammel 84:fc8c9b39723a 122 } // namespace mbed
jwhammel 84:fc8c9b39723a 123
jwhammel 84:fc8c9b39723a 124 #endif
jwhammel 84:fc8c9b39723a 125
jwhammel 84:fc8c9b39723a 126 #endif
jwhammel 84:fc8c9b39723a 127