George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

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