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/I2CSlave.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_I2C_SLAVE_H
jwhammel 84:fc8c9b39723a 17 #define MBED_I2C_SLAVE_H
jwhammel 84:fc8c9b39723a 18
jwhammel 84:fc8c9b39723a 19 #include "platform.h"
jwhammel 84:fc8c9b39723a 20
jwhammel 84:fc8c9b39723a 21 #if DEVICE_I2CSLAVE
jwhammel 84:fc8c9b39723a 22
jwhammel 84:fc8c9b39723a 23 #include "i2c_api.h"
jwhammel 84:fc8c9b39723a 24
jwhammel 84:fc8c9b39723a 25 namespace mbed {
jwhammel 84:fc8c9b39723a 26
jwhammel 84:fc8c9b39723a 27 /** An I2C Slave, used for communicating with an I2C Master device
jwhammel 84:fc8c9b39723a 28 *
jwhammel 84:fc8c9b39723a 29 * Example:
jwhammel 84:fc8c9b39723a 30 * @code
jwhammel 84:fc8c9b39723a 31 * // Simple I2C responder
jwhammel 84:fc8c9b39723a 32 * #include <mbed.h>
jwhammel 84:fc8c9b39723a 33 *
jwhammel 84:fc8c9b39723a 34 * I2CSlave slave(p9, p10);
jwhammel 84:fc8c9b39723a 35 *
jwhammel 84:fc8c9b39723a 36 * int main() {
jwhammel 84:fc8c9b39723a 37 * char buf[10];
jwhammel 84:fc8c9b39723a 38 * char msg[] = "Slave!";
jwhammel 84:fc8c9b39723a 39 *
jwhammel 84:fc8c9b39723a 40 * slave.address(0xA0);
jwhammel 84:fc8c9b39723a 41 * while (1) {
jwhammel 84:fc8c9b39723a 42 * int i = slave.receive();
jwhammel 84:fc8c9b39723a 43 * switch (i) {
jwhammel 84:fc8c9b39723a 44 * case I2CSlave::ReadAddressed:
jwhammel 84:fc8c9b39723a 45 * slave.write(msg, strlen(msg) + 1); // Includes null char
jwhammel 84:fc8c9b39723a 46 * break;
jwhammel 84:fc8c9b39723a 47 * case I2CSlave::WriteGeneral:
jwhammel 84:fc8c9b39723a 48 * slave.read(buf, 10);
jwhammel 84:fc8c9b39723a 49 * printf("Read G: %s\n", buf);
jwhammel 84:fc8c9b39723a 50 * break;
jwhammel 84:fc8c9b39723a 51 * case I2CSlave::WriteAddressed:
jwhammel 84:fc8c9b39723a 52 * slave.read(buf, 10);
jwhammel 84:fc8c9b39723a 53 * printf("Read A: %s\n", buf);
jwhammel 84:fc8c9b39723a 54 * break;
jwhammel 84:fc8c9b39723a 55 * }
jwhammel 84:fc8c9b39723a 56 * for(int i = 0; i < 10; i++) buf[i] = 0; // Clear buffer
jwhammel 84:fc8c9b39723a 57 * }
jwhammel 84:fc8c9b39723a 58 * }
jwhammel 84:fc8c9b39723a 59 * @endcode
jwhammel 84:fc8c9b39723a 60 */
jwhammel 84:fc8c9b39723a 61 class I2CSlave {
jwhammel 84:fc8c9b39723a 62
jwhammel 84:fc8c9b39723a 63 public:
jwhammel 84:fc8c9b39723a 64 enum RxStatus {
jwhammel 84:fc8c9b39723a 65 NoData = 0,
jwhammel 84:fc8c9b39723a 66 ReadAddressed = 1,
jwhammel 84:fc8c9b39723a 67 WriteGeneral = 2,
jwhammel 84:fc8c9b39723a 68 WriteAddressed = 3
jwhammel 84:fc8c9b39723a 69 };
jwhammel 84:fc8c9b39723a 70
jwhammel 84:fc8c9b39723a 71 /** Create an I2C Slave interface, connected to the specified pins.
jwhammel 84:fc8c9b39723a 72 *
jwhammel 84:fc8c9b39723a 73 * @param sda I2C data line pin
jwhammel 84:fc8c9b39723a 74 * @param scl I2C clock line pin
jwhammel 84:fc8c9b39723a 75 */
jwhammel 84:fc8c9b39723a 76 I2CSlave(PinName sda, PinName scl);
jwhammel 84:fc8c9b39723a 77
jwhammel 84:fc8c9b39723a 78 /** Set the frequency of the I2C interface
jwhammel 84:fc8c9b39723a 79 *
jwhammel 84:fc8c9b39723a 80 * @param hz The bus frequency in hertz
jwhammel 84:fc8c9b39723a 81 */
jwhammel 84:fc8c9b39723a 82 void frequency(int hz);
jwhammel 84:fc8c9b39723a 83
jwhammel 84:fc8c9b39723a 84 /** Checks to see if this I2C Slave has been addressed.
jwhammel 84:fc8c9b39723a 85 *
jwhammel 84:fc8c9b39723a 86 * @returns
jwhammel 84:fc8c9b39723a 87 * A status indicating if the device has been addressed, and how
jwhammel 84:fc8c9b39723a 88 * - NoData - the slave has not been addressed
jwhammel 84:fc8c9b39723a 89 * - ReadAddressed - the master has requested a read from this slave
jwhammel 84:fc8c9b39723a 90 * - WriteAddressed - the master is writing to this slave
jwhammel 84:fc8c9b39723a 91 * - WriteGeneral - the master is writing to all slave
jwhammel 84:fc8c9b39723a 92 */
jwhammel 84:fc8c9b39723a 93 int receive(void);
jwhammel 84:fc8c9b39723a 94
jwhammel 84:fc8c9b39723a 95 /** Read from an I2C master.
jwhammel 84:fc8c9b39723a 96 *
jwhammel 84:fc8c9b39723a 97 * @param data pointer to the byte array to read data in to
jwhammel 84:fc8c9b39723a 98 * @param length maximum number of bytes to read
jwhammel 84:fc8c9b39723a 99 *
jwhammel 84:fc8c9b39723a 100 * @returns
jwhammel 84:fc8c9b39723a 101 * 0 on success,
jwhammel 84:fc8c9b39723a 102 * non-0 otherwise
jwhammel 84:fc8c9b39723a 103 */
jwhammel 84:fc8c9b39723a 104 int read(char *data, int length);
jwhammel 84:fc8c9b39723a 105
jwhammel 84:fc8c9b39723a 106 /** Read a single byte from an I2C master.
jwhammel 84:fc8c9b39723a 107 *
jwhammel 84:fc8c9b39723a 108 * @returns
jwhammel 84:fc8c9b39723a 109 * the byte read
jwhammel 84:fc8c9b39723a 110 */
jwhammel 84:fc8c9b39723a 111 int read(void);
jwhammel 84:fc8c9b39723a 112
jwhammel 84:fc8c9b39723a 113 /** Write to an I2C master.
jwhammel 84:fc8c9b39723a 114 *
jwhammel 84:fc8c9b39723a 115 * @param data pointer to the byte array to be transmitted
jwhammel 84:fc8c9b39723a 116 * @param length the number of bytes to transmite
jwhammel 84:fc8c9b39723a 117 *
jwhammel 84:fc8c9b39723a 118 * @returns
jwhammel 84:fc8c9b39723a 119 * 0 on success,
jwhammel 84:fc8c9b39723a 120 * non-0 otherwise
jwhammel 84:fc8c9b39723a 121 */
jwhammel 84:fc8c9b39723a 122 int write(const char *data, int length);
jwhammel 84:fc8c9b39723a 123
jwhammel 84:fc8c9b39723a 124 /** Write a single byte to an I2C master.
jwhammel 84:fc8c9b39723a 125 *
jwhammel 84:fc8c9b39723a 126 * @data the byte to write
jwhammel 84:fc8c9b39723a 127 *
jwhammel 84:fc8c9b39723a 128 * @returns
jwhammel 84:fc8c9b39723a 129 * '1' if an ACK was received,
jwhammel 84:fc8c9b39723a 130 * '0' otherwise
jwhammel 84:fc8c9b39723a 131 */
jwhammel 84:fc8c9b39723a 132 int write(int data);
jwhammel 84:fc8c9b39723a 133
jwhammel 84:fc8c9b39723a 134 /** Sets the I2C slave address.
jwhammel 84:fc8c9b39723a 135 *
jwhammel 84:fc8c9b39723a 136 * @param address The address to set for the slave (ignoring the least
jwhammel 84:fc8c9b39723a 137 * signifcant bit). If set to 0, the slave will only respond to the
jwhammel 84:fc8c9b39723a 138 * general call address.
jwhammel 84:fc8c9b39723a 139 */
jwhammel 84:fc8c9b39723a 140 void address(int address);
jwhammel 84:fc8c9b39723a 141
jwhammel 84:fc8c9b39723a 142 /** Reset the I2C slave back into the known ready receiving state.
jwhammel 84:fc8c9b39723a 143 */
jwhammel 84:fc8c9b39723a 144 void stop(void);
jwhammel 84:fc8c9b39723a 145
jwhammel 84:fc8c9b39723a 146 protected:
jwhammel 84:fc8c9b39723a 147 i2c_t _i2c;
jwhammel 84:fc8c9b39723a 148 };
jwhammel 84:fc8c9b39723a 149
jwhammel 84:fc8c9b39723a 150 } // namespace mbed
jwhammel 84:fc8c9b39723a 151
jwhammel 84:fc8c9b39723a 152 #endif
jwhammel 84:fc8c9b39723a 153
jwhammel 84:fc8c9b39723a 154 #endif
jwhammel 84:fc8c9b39723a 155