94 lines
2.2 KiB
C
Raw Normal View History

2021-01-29 12:31:58 +01:00
#pragma once
//
// FILE: PCF8575.h
// AUTHOR: Rob Tillaart
// DATE: 2020-07-20
2021-12-23 13:53:35 +01:00
// VERSION: 0.1.4
2021-01-29 12:31:58 +01:00
// PURPOSE: Arduino library for PCF8575 - 16 channel I2C IO expander
// URL: https://github.com/RobTillaart/PCF8575
//
// HISTORY:
// see PCF8575.cpp file
//
2021-07-09 13:02:35 +02:00
2021-01-29 12:31:58 +01:00
#include "Arduino.h"
#include "Wire.h"
2021-07-09 13:02:35 +02:00
2021-12-23 13:53:35 +01:00
#define PCF8575_LIB_VERSION (F("0.1.4"))
2021-07-09 13:02:35 +02:00
2021-01-29 12:31:58 +01:00
#ifndef PCF8575_INITIAL_VALUE
#define PCF8575_INITIAL_VALUE 0xFFFF
#endif
#define PCF8575_OK 0x00
#define PCF8575_PIN_ERROR 0x81
#define PCF8575_I2C_ERROR 0x82
class PCF8575
{
public:
// deviceAddress base = 0x20 + depends on address bits
2021-12-23 13:53:35 +01:00
explicit PCF8575(const uint8_t deviceAddress = 0x20, TwoWire *wire = &Wire);
2021-01-29 12:31:58 +01:00
#if defined (ESP8266) || defined(ESP32)
2021-12-23 13:53:35 +01:00
bool begin(uint8_t sda, uint8_t scl, uint16_t value = PCF8575_INITIAL_VALUE);
2021-01-29 12:31:58 +01:00
#endif
2021-12-23 13:53:35 +01:00
bool begin(uint16_t value = PCF8575_INITIAL_VALUE);
2021-01-29 12:31:58 +01:00
bool isConnected();
2021-07-09 13:02:35 +02:00
// note: setting the address corrupt internal buffer values
// a read8() / write8() call updates them.
bool setAddress(const uint8_t deviceAddress);
uint8_t getAddress();
2021-01-29 12:31:58 +01:00
uint16_t read16();
uint8_t read(uint8_t pin);
uint16_t value() const { return _dataIn; };
2021-07-09 13:02:35 +02:00
2021-01-29 12:31:58 +01:00
void write16(const uint16_t value);
void write(const uint8_t pin, const uint8_t value);
uint16_t valueOut() const { return _dataOut; }
2021-07-09 13:02:35 +02:00
2021-01-29 12:31:58 +01:00
// added 0.1.07/08 Septillion
uint16_t readButton16() { return readButton16(_buttonMask); }
uint16_t readButton16(const uint16_t mask);
uint8_t readButton(const uint8_t pin);
void setButtonMask(uint16_t mask) { _buttonMask = mask; };
2021-12-01 14:50:20 +01:00
uint16_t getButtonMask() { return _buttonMask; };
2021-01-29 12:31:58 +01:00
2021-07-09 13:02:35 +02:00
2021-01-29 12:31:58 +01:00
// rotate, shift, toggle, reverse expect all lines are output
void toggle(const uint8_t pin);
void toggleMask(const uint16_t mask = 0xFFFF); // default invertAll()
void shiftRight(const uint8_t n = 1);
void shiftLeft(const uint8_t n = 1);
void rotateRight(const uint8_t n = 1);
void rotateLeft(const uint8_t n = 1);
void reverse();
2021-07-09 13:02:35 +02:00
2021-01-29 12:31:58 +01:00
int lastError();
2021-12-01 14:50:20 +01:00
2021-01-29 12:31:58 +01:00
private:
uint8_t _address;
uint16_t _dataIn;
uint16_t _dataOut;
uint16_t _buttonMask;
int _error;
TwoWire* _wire;
};
2021-07-09 13:02:35 +02:00
2021-01-29 12:31:58 +01:00
// -- END OF FILE --
2021-12-23 13:53:35 +01:00