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