149 lines
5.0 KiB
Objective-C
149 lines
5.0 KiB
Objective-C
// ---------------------------------------------------------------------------
|
|
// Created by Francisco Malpartida on 20/08/11.
|
|
// Copyright 2011 - Under creative commons license 3.0:
|
|
// Attribution-ShareAlike CC BY-SA
|
|
//
|
|
// This software is furnished "as is", without technical support, and with no
|
|
// warranty, express or implied, as to its usefulness for any purpose.
|
|
//
|
|
// Thread Safe: No
|
|
// Extendable: Yes
|
|
//
|
|
// @file SI2CIO.h
|
|
// This file implements a basic IO library using the PCF8574 I2C IO Expander
|
|
// chip, but using software I2C.
|
|
//
|
|
// @brief
|
|
// Implement a basic IO library to drive the PCF8574* I2C IO Expander ASIC.
|
|
// The library implements basic IO general methods to configure IO pin direction
|
|
// read and write uint8_t operations and basic pin level routines to set or read
|
|
// a particular IO port.
|
|
//
|
|
// @version API 1.0.0
|
|
//
|
|
// @author F. Malpartida - fmalpartida@gmail.com
|
|
// Adapted to SoftIC2 by Adrian Piccioli - adrianpiccioli@gmail.com
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#ifndef _SI2CIO_H_
|
|
#define _SI2CIO_H_
|
|
|
|
#include <inttypes.h>
|
|
|
|
#define _SI2CIO_VERSION "1.0.0"
|
|
|
|
/*!
|
|
@class
|
|
@abstract SI2CIO
|
|
@discussion Library driver to control PCF8574 based ASICs. Implementing
|
|
library calls to set/get port through I2C bus.
|
|
*/
|
|
|
|
class SI2CIO
|
|
{
|
|
public:
|
|
/*!
|
|
@method
|
|
@abstract Constructor method
|
|
@discussion Class constructor constructor.
|
|
*/
|
|
SI2CIO ( );
|
|
|
|
/*!
|
|
@method
|
|
@abstract Initializes the device.
|
|
@discussion This method initializes the device allocating an I2C address.
|
|
This method is the first method that should be call prior to calling any
|
|
other method form this class. On initialization all pins are configured
|
|
as INPUT on the device.
|
|
|
|
@param i2cAddr: I2C Address where the device is located.
|
|
@result 1 if the device was initialized correctly, 0 otherwise
|
|
*/
|
|
int begin ( uint8_t i2cAddr );
|
|
|
|
/*!
|
|
@method
|
|
@abstract Sets the mode of a particular pin.
|
|
@discussion Sets the mode of a particular pin to INPUT, OUTPUT. digitalWrite
|
|
has no effect on pins which are not declared as output.
|
|
|
|
@param pin[in] Pin from the I2C IO expander to be configured. Range 0..7
|
|
@param dir[in] Pin direction (INPUT, OUTPUT).
|
|
*/
|
|
void pinMode ( uint8_t pin, uint8_t dir );
|
|
|
|
/*!
|
|
@method
|
|
@abstract Sets all the pins of the device in a particular direction.
|
|
@discussion This method sets all the pins of the device in a particular
|
|
direction. This method is useful to set all the pins of the device to be
|
|
either inputs or outputs.
|
|
@param dir[in] Direction of all the pins of the device (INPUT, OUTPUT).
|
|
*/
|
|
void portMode ( uint8_t dir );
|
|
|
|
/*!
|
|
@method
|
|
@abstract Reads all the pins of the device that are configured as INPUT.
|
|
@discussion Reads from the device the status of the pins that are configured
|
|
as INPUT. During initialization all pins are configured as INPUTs by default.
|
|
Please refer to pinMode or portMode.
|
|
|
|
@param none
|
|
*/
|
|
uint8_t read ( void );
|
|
|
|
/*!
|
|
@method
|
|
@abstract Read a pin from the device.
|
|
@discussion Reads a particular pin from the device. To read a particular
|
|
pin it has to be configured as INPUT. During initialization all pins are
|
|
configured as INPUTs by default. Please refer to pinMode or portMode.
|
|
|
|
@param pin[in] Pin from the port to read its status. Range (0..7)
|
|
@result Returns the pin status (HIGH, LOW) if the pin is configured
|
|
as an output, reading its value will always return LOW regardless of its
|
|
real state.
|
|
*/
|
|
uint8_t digitalRead ( uint8_t pin );
|
|
|
|
/*!
|
|
@method
|
|
@abstract Write a value to the device.
|
|
@discussion Writes to a set of pins in the device. The value is the binary
|
|
representation of all the pins in device. The value written is masked with
|
|
the configuration of the direction of the pins; to change the state of
|
|
a particular pin with this method, such pin has to be configured as OUTPUT
|
|
using the portMode or pinMode methods. If no pins have been configured as
|
|
OUTPUTs this method will have no effect.
|
|
|
|
@param value[in] value to be written to the device.
|
|
@result 1 on success, 0 otherwise
|
|
*/
|
|
int write ( uint8_t value );
|
|
|
|
/*!
|
|
@method
|
|
@abstract Writes a digital level to a particular pin.
|
|
@discussion Write a level to the indicated pin of the device. For this
|
|
method to have effect, the pin has to be configured as OUTPUT using the
|
|
pinMode or portMode methods.
|
|
|
|
@param pin[in] device pin to change level. Range (0..7).
|
|
@para level[in] logic level to set the pin at (HIGH, LOW).
|
|
@result 1 on success, 0 otherwise.
|
|
*/
|
|
int digitalWrite ( uint8_t pin, uint8_t level );
|
|
|
|
|
|
|
|
private:
|
|
uint8_t _shadow; // Shadow output
|
|
uint8_t _dirMask; // Direction mask
|
|
uint8_t _i2cAddr; // I2C address
|
|
bool _initialised; // Initialised object
|
|
|
|
};
|
|
|
|
#endif |