NXShieldI2C.h

/*
 * NXShield interface library
 * Copyright (C) 2011 mindsensors.com
 *
 * This file is part of NXShield interface library.
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef NXShieldI2C_H
#define NXShieldI2C_H

#include "SHDefines.h"
#include "BaseI2CDevice.h"
#include "SoftI2cMaster.h"

class NXShieldI2C : public BaseI2CDevice, public SoftI2cMaster
{
public:
  void * mp_shield;
        uint8_t *_i2c_buffer;

public:
  NXShieldI2C(uint8_t i2c_address);
  
        uint8_t m_protocol;

        void init(void * shield, SH_BankPort bp);
  
  uint8_t  readByte  (uint8_t location);
  
        uint16_t readInteger  (uint8_t location);
        
  uint32_t readLong  (uint8_t location);
        
        uint8_t*  readRegisters  (uint8_t  start_register, uint8_t  bytes, uint8_t* buf);

  char*    readString  (uint8_t  location, uint8_t  bytes_to_read,
               uint8_t* buffer = 0, uint8_t  buffer_length = 0);

  bool     writeRegisters  (uint8_t start_register, uint8_t bytes_to_write,
                uint8_t* buffer = 0);

  bool     writeByte  (uint8_t location, uint8_t data);
  
        bool     writeInteger(uint8_t location, uint16_t data);
  
        bool     writeLong  (uint8_t location, uint32_t data);

        char*           getFirmwareVersion();
        
        char*           getVendorID();
        
        char*           getDeviceID();
        
        char*           getFeatureSet();

        uint8_t getErrorCode();

        bool checkAddress();

  bool setAddress(uint8_t address);

};


#endif