Tushar Sachdeva / FRDM_K64F_LCD

A simple 128x32 graphical LCD program to quickstart with LCD on ARM mbed IoT Starter Kit. This requires mbed Applciation Shield with FRDM-K64F platform.

Dependencies:   C12832

mbed/I2C.h@1:eb68c94a8ee5, 2015-04-12 (annotated)

Committer:
tushki7
Date:
Sun Apr 12 15:45:52 2015 +0000
Revision:
1:eb68c94a8ee5
Parent:
0:60d829a0353a 
A simple 128x32 LCD program with ARM mbed IoT Starter Kit;

Who changed what in which revision?

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