An I2C text LCD library for Displaytronic ACM1602NI-FLW-FBW-M01

Dependents:   ACM1602NI_Demo ROBOT_v01 ROBOT_v02 Boku-Transmit ... more

ACM1602NI.h

Committer:
takuo
Date:
2013-05-13
Revision:
2:6a201d126c69
Parent:
1:84527dcd3fcc
Child:
3:bac80efb323e

File content as of revision 2:6a201d126c69:

/* An mbed text LCD library for Displaytronic ACM1602NI-FLW-FBW-M01
 * Copyright 2013, wtakuo
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ACM1602NI_H
#define ACM1602NI_H

#include "mbed.h"

/** An I2C Text LCD interface for driving Displaytronic ACM1602NI-FLW-FBW-M01
 * The interface is basically the same as TextLCD by Simon Ford.
 *
 * @code
 * #include "mbed.h"
 * #include "ACM1602NI.h"
 * 
 * I2C i2c(p9, p10);
 * ACM1602NI lcd(i2c);
 *
 * int main() {
 *     lcd.printf("Hello, World!\n");
 * }
 * @endcode
 */
class ACM1602NI : public Stream
{
public:
    /** Create an ACM1602NI object connected to the specified I2C port.
     *
     * @param i2c     The I2C port to connect to
     */
    ACM1602NI(I2C &i2c);

    /** Locate to a screen column and row
     *
     * @param column  The horizontal position from the left, indexed from 0
     * @param row     The vertical position from the top, indexed from 0
     */
    void locate(int column, int row);
    
    /** Clear the screen and locate to 0,0 */
    void cls();

    int rows();
    int columns();

protected:
    virtual int _putc(int value);
    virtual int _getc();

    void init();
    int address(int column, int raw);
    void character(int column, int row, int c);
    int writeBytes(const char *data, int length, bool repeated = false);
    void writeCommand(int command);
    void writeData(int data);

    static const int i2c_addr = 0x50 << 1;
    static const int i2c_bit_wait_us = 20;
    static const int i2c_command_wait_ms = 4;

    static const int display_columns = 16;
    static const int display_rows = 2;

    I2C &_i2c;
    int _column, _row;
};

#endif