George Roussos / BLE_iBeacon_Exercise

Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2

Dependencies:   BLE_API_Native_blog

mbed/I2C.h@0:e8fdba0ed044, 2015-03-07 (annotated)

Committer:
gkroussos
Date:
Sat Mar 07 16:34:53 2015 +0000
Revision:
0:e8fdba0ed044
MUC IoT Workshop v1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:e8fdba0ed044 1 /* mbed Microcontroller Library
gkroussos 0:e8fdba0ed044 2 * Copyright (c) 2006-2013 ARM Limited
gkroussos 0:e8fdba0ed044 3 *
gkroussos 0:e8fdba0ed044 4 * Licensed under the Apache License, Version 2.0 (the "License");
gkroussos 0:e8fdba0ed044 5 * you may not use this file except in compliance with the License.
gkroussos 0:e8fdba0ed044 6 * You may obtain a copy of the License at
gkroussos 0:e8fdba0ed044 7 *
gkroussos 0:e8fdba0ed044 8 * http://www.apache.org/licenses/LICENSE-2.0
gkroussos 0:e8fdba0ed044 9 *
gkroussos 0:e8fdba0ed044 10 * Unless required by applicable law or agreed to in writing, software
gkroussos 0:e8fdba0ed044 11 * distributed under the License is distributed on an "AS IS" BASIS,
gkroussos 0:e8fdba0ed044 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gkroussos 0:e8fdba0ed044 13 * See the License for the specific language governing permissions and
gkroussos 0:e8fdba0ed044 14 * limitations under the License.
gkroussos 0:e8fdba0ed044 15 */
gkroussos 0:e8fdba0ed044 16 #ifndef MBED_I2C_H
gkroussos 0:e8fdba0ed044 17 #define MBED_I2C_H
gkroussos 0:e8fdba0ed044 18
gkroussos 0:e8fdba0ed044 19 #include "platform.h"
gkroussos 0:e8fdba0ed044 20
gkroussos 0:e8fdba0ed044 21 #if DEVICE_I2C
gkroussos 0:e8fdba0ed044 22
gkroussos 0:e8fdba0ed044 23 #include "i2c_api.h"
gkroussos 0:e8fdba0ed044 24
gkroussos 0:e8fdba0ed044 25 namespace mbed {
gkroussos 0:e8fdba0ed044 26
gkroussos 0:e8fdba0ed044 27 /** An I2C Master, used for communicating with I2C slave devices
gkroussos 0:e8fdba0ed044 28 *
gkroussos 0:e8fdba0ed044 29 * Example:
gkroussos 0:e8fdba0ed044 30 * @code
gkroussos 0:e8fdba0ed044 31 * // Read from I2C slave at address 0x62
gkroussos 0:e8fdba0ed044 32 *
gkroussos 0:e8fdba0ed044 33 * #include "mbed.h"
gkroussos 0:e8fdba0ed044 34 *
gkroussos 0:e8fdba0ed044 35 * I2C i2c(p28, p27);
gkroussos 0:e8fdba0ed044 36 *
gkroussos 0:e8fdba0ed044 37 * int main() {
gkroussos 0:e8fdba0ed044 38 * int address = 0x62;
gkroussos 0:e8fdba0ed044 39 * char data[2];
gkroussos 0:e8fdba0ed044 40 * i2c.read(address, data, 2);
gkroussos 0:e8fdba0ed044 41 * }
gkroussos 0:e8fdba0ed044 42 * @endcode
gkroussos 0:e8fdba0ed044 43 */
gkroussos 0:e8fdba0ed044 44 class I2C {
gkroussos 0:e8fdba0ed044 45
gkroussos 0:e8fdba0ed044 46 public:
gkroussos 0:e8fdba0ed044 47 enum RxStatus {
gkroussos 0:e8fdba0ed044 48 NoData,
gkroussos 0:e8fdba0ed044 49 MasterGeneralCall,
gkroussos 0:e8fdba0ed044 50 MasterWrite,
gkroussos 0:e8fdba0ed044 51 MasterRead
gkroussos 0:e8fdba0ed044 52 };
gkroussos 0:e8fdba0ed044 53
gkroussos 0:e8fdba0ed044 54 enum Acknowledge {
gkroussos 0:e8fdba0ed044 55 NoACK = 0,
gkroussos 0:e8fdba0ed044 56 ACK = 1
gkroussos 0:e8fdba0ed044 57 };
gkroussos 0:e8fdba0ed044 58
gkroussos 0:e8fdba0ed044 59 /** Create an I2C Master interface, connected to the specified pins
gkroussos 0:e8fdba0ed044 60 *
gkroussos 0:e8fdba0ed044 61 * @param sda I2C data line pin
gkroussos 0:e8fdba0ed044 62 * @param scl I2C clock line pin
gkroussos 0:e8fdba0ed044 63 */
gkroussos 0:e8fdba0ed044 64 I2C(PinName sda, PinName scl);
gkroussos 0:e8fdba0ed044 65
gkroussos 0:e8fdba0ed044 66 /** Set the frequency of the I2C interface
gkroussos 0:e8fdba0ed044 67 *
gkroussos 0:e8fdba0ed044 68 * @param hz The bus frequency in hertz
gkroussos 0:e8fdba0ed044 69 */
gkroussos 0:e8fdba0ed044 70 void frequency(int hz);
gkroussos 0:e8fdba0ed044 71
gkroussos 0:e8fdba0ed044 72 /** Read from an I2C slave
gkroussos 0:e8fdba0ed044 73 *
gkroussos 0:e8fdba0ed044 74 * Performs a complete read transaction. The bottom bit of
gkroussos 0:e8fdba0ed044 75 * the address is forced to 1 to indicate a read.
gkroussos 0:e8fdba0ed044 76 *
gkroussos 0:e8fdba0ed044 77 * @param address 8-bit I2C slave address [ addr | 1 ]
gkroussos 0:e8fdba0ed044 78 * @param data Pointer to the byte-array to read data in to
gkroussos 0:e8fdba0ed044 79 * @param length Number of bytes to read
gkroussos 0:e8fdba0ed044 80 * @param repeated Repeated start, true - don't send stop at end
gkroussos 0:e8fdba0ed044 81 *
gkroussos 0:e8fdba0ed044 82 * @returns
gkroussos 0:e8fdba0ed044 83 * 0 on success (ack),
gkroussos 0:e8fdba0ed044 84 * non-0 on failure (nack)
gkroussos 0:e8fdba0ed044 85 */
gkroussos 0:e8fdba0ed044 86 int read(int address, char *data, int length, bool repeated = false);
gkroussos 0:e8fdba0ed044 87
gkroussos 0:e8fdba0ed044 88 /** Read a single byte from the I2C bus
gkroussos 0:e8fdba0ed044 89 *
gkroussos 0:e8fdba0ed044 90 * @param ack indicates if the byte is to be acknowledged (1 = acknowledge)
gkroussos 0:e8fdba0ed044 91 *
gkroussos 0:e8fdba0ed044 92 * @returns
gkroussos 0:e8fdba0ed044 93 * the byte read
gkroussos 0:e8fdba0ed044 94 */
gkroussos 0:e8fdba0ed044 95 int read(int ack);
gkroussos 0:e8fdba0ed044 96
gkroussos 0:e8fdba0ed044 97 /** Write to an I2C slave
gkroussos 0:e8fdba0ed044 98 *
gkroussos 0:e8fdba0ed044 99 * Performs a complete write transaction. The bottom bit of
gkroussos 0:e8fdba0ed044 100 * the address is forced to 0 to indicate a write.
gkroussos 0:e8fdba0ed044 101 *
gkroussos 0:e8fdba0ed044 102 * @param address 8-bit I2C slave address [ addr | 0 ]
gkroussos 0:e8fdba0ed044 103 * @param data Pointer to the byte-array data to send
gkroussos 0:e8fdba0ed044 104 * @param length Number of bytes to send
gkroussos 0:e8fdba0ed044 105 * @param repeated Repeated start, true - do not send stop at end
gkroussos 0:e8fdba0ed044 106 *
gkroussos 0:e8fdba0ed044 107 * @returns
gkroussos 0:e8fdba0ed044 108 * 0 on success (ack),
gkroussos 0:e8fdba0ed044 109 * non-0 on failure (nack)
gkroussos 0:e8fdba0ed044 110 */
gkroussos 0:e8fdba0ed044 111 int write(int address, const char *data, int length, bool repeated = false);
gkroussos 0:e8fdba0ed044 112
gkroussos 0:e8fdba0ed044 113 /** Write single byte out on the I2C bus
gkroussos 0:e8fdba0ed044 114 *
gkroussos 0:e8fdba0ed044 115 * @param data data to write out on bus
gkroussos 0:e8fdba0ed044 116 *
gkroussos 0:e8fdba0ed044 117 * @returns
gkroussos 0:e8fdba0ed044 118 * '1' if an ACK was received,
gkroussos 0:e8fdba0ed044 119 * '0' otherwise
gkroussos 0:e8fdba0ed044 120 */
gkroussos 0:e8fdba0ed044 121 int write(int data);
gkroussos 0:e8fdba0ed044 122
gkroussos 0:e8fdba0ed044 123 /** Creates a start condition on the I2C bus
gkroussos 0:e8fdba0ed044 124 */
gkroussos 0:e8fdba0ed044 125
gkroussos 0:e8fdba0ed044 126 void start(void);
gkroussos 0:e8fdba0ed044 127
gkroussos 0:e8fdba0ed044 128 /** Creates a stop condition on the I2C bus
gkroussos 0:e8fdba0ed044 129 */
gkroussos 0:e8fdba0ed044 130 void stop(void);
gkroussos 0:e8fdba0ed044 131
gkroussos 0:e8fdba0ed044 132 protected:
gkroussos 0:e8fdba0ed044 133 void aquire();
gkroussos 0:e8fdba0ed044 134
gkroussos 0:e8fdba0ed044 135 i2c_t _i2c;
gkroussos 0:e8fdba0ed044 136 static I2C *_owner;
gkroussos 0:e8fdba0ed044 137 int _hz;
gkroussos 0:e8fdba0ed044 138 };
gkroussos 0:e8fdba0ed044 139
gkroussos 0:e8fdba0ed044 140 } // namespace mbed
gkroussos 0:e8fdba0ed044 141
gkroussos 0:e8fdba0ed044 142 #endif
gkroussos 0:e8fdba0ed044 143
gkroussos 0:e8fdba0ed044 144 #endif