mirror of
https://github.com/adrigongv23/G26---Telemetry-Software.git
synced 2026-08-25 11:33:17 +02:00
193 lines
No EOL
7.8 KiB
C++
193 lines
No EOL
7.8 KiB
C++
/*==============================================================================================================*
|
|
|
|
@file PCA9557.h
|
|
@author Patryk Wagner
|
|
@license MIT (c) 2016 Nadav Matalon
|
|
PCA9557 Driver (8-Channel GPIO I2C Expander) based on Madav Matalon PCA9536 driver
|
|
Ver. 1.0.0 - First release (16.05.18)
|
|
*===============================================================================================================*
|
|
INTRODUCTION
|
|
*===============================================================================================================*
|
|
|
|
The PCA9557 is a 8-Channel GPIO Expander with a hardware I2C interface.
|
|
|
|
The PCA9557's 8 channels (or IO pins) can be controlled as a single unit or individually in terms of their
|
|
Mode (INPUT /OUTPUT) and Polarity (NON-INVERTED INPUT / INVERTED INPUT). The pins' states (LOW / HIGH) can
|
|
be read (in INPUT mode) or written (in OUTPUT mode).
|
|
|
|
This library contains a complete driver for the PCA9557 exposing all the above functionality.
|
|
*===============================================================================================================*
|
|
I2C ADDRESS
|
|
*===============================================================================================================*
|
|
The PCA9557 has a single I2C address (factory hardwired):
|
|
|
|
PART DEVICE I2C ADDRESS PART
|
|
NUMBER (BIN) (HEX) (DEC) MARKING
|
|
PCA9557D 01000001 0x41 65 PCA9557
|
|
*===============================================================================================================*
|
|
REGISTER POINTERS
|
|
*===============================================================================================================*
|
|
REG_INPUT 0x00 // Input Port Register (R) B00000000 (Default)
|
|
REG_OUTPUT 0x01 // Output Port Register (R/W) B00000001
|
|
REG_POLARITY 0x02 // Polarity Inversion Register (R/W) B00000010
|
|
REG_CONFIG 0x03 // Configuration Register (R/W) B00000011
|
|
*===============================================================================================================*
|
|
REGISTER 0: INPUT REGIASTER - READ ONLY (0 = LOW / 1 = HIGH)
|
|
*===============================================================================================================*
|
|
DEFAULT (WITH NO EXTENRAL INPUT SIGNAL CONNECTED): 'HIGH' (ALL IO PINS HAVE WEAK PULL-UP RESISTORS)
|
|
|
|
DEFAULT
|
|
PIN_IO0 BIT 0 1
|
|
PIN_IO1 BIT 1 1
|
|
PIN_IO2 BIT 2 1
|
|
PIN_IO3 BIT 3 1
|
|
PIN_IO4 BIT 4 1
|
|
PIN_IO5 BIT 5 1
|
|
PIN_IO6 BIT 6 1
|
|
PIN_IO7 BIT 7 1
|
|
*===============================================================================================================*
|
|
REGISTER 1: OUTPUT REGIASTER - READ / WRITE (0 = LOW / 1 = HIGH)
|
|
*===============================================================================================================*
|
|
DEFAULT
|
|
IO0 BIT 0 1
|
|
IO1 BIT 1 1
|
|
IO2 BIT 2 1
|
|
IO3 BIT 3 1
|
|
IO4 BIT 4 1
|
|
IO5 BIT 5 1
|
|
IO6 BIT 6 1
|
|
IO7 BIT 7 1
|
|
*===============================================================================================================*
|
|
REGISTER 2: POLARITY REGIASTER - READ / WRITE (0 = NON-INVERTED / 1 = INVERTED)
|
|
*===============================================================================================================*
|
|
DEFAULT
|
|
PIN_IO0 BIT 0 0
|
|
PIN_IO1 BIT 1 0
|
|
PIN_IO2 BIT 2 0
|
|
PIN_IO3 BIT 3 0
|
|
PIN_IO4 BIT 4 0
|
|
PIN_IO5 BIT 5 0
|
|
PIN_IO6 BIT 6 0
|
|
PIN_IO7 BIT 7 0
|
|
|
|
|
|
*===============================================================================================================*
|
|
REGISTER 3: CONFIGURATION - READ / WRITE (0 = OUTPUT / 1 = INPUT)
|
|
*===============================================================================================================*
|
|
POWER-UP DEFAULT: ALL PINS ARE SET AS 'INPUT' (1)
|
|
|
|
DEFAULT
|
|
PIN_IO0 BIT 0 1
|
|
PIN_IO1 BIT 1 1
|
|
PIN_IO2 BIT 2 1
|
|
PIN_IO3 BIT 3 1
|
|
PIN_IO4 BIT 4 1
|
|
PIN_IO5 BIT 5 1
|
|
PIN_IO6 BIT 6 1
|
|
PIN_IO7 BIT 7 1
|
|
|
|
|
|
*===============================================================================================================*
|
|
LICENSE
|
|
*===============================================================================================================*
|
|
|
|
The MIT License (MIT)
|
|
Copyright (c) 2016 Nadav Matalon
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
|
|
documentation files (the "Software"), to deal in the Software without restriction, including without
|
|
limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
the Software, and to permit persons to whom the Software is furnished to do so, subject to the following
|
|
conditions:
|
|
The above copyright notice and this permission notice shall be included in all copies or substantial
|
|
portions of the Software.
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
|
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*==============================================================================================================*/
|
|
|
|
#include <Arduino.h>
|
|
#include <Wire.h>
|
|
|
|
const byte DEV_ADDR = 0x18;//0b0011010R/W
|
|
const byte NUM_BYTES = 0x01;
|
|
const byte ALL_INPUT = 0xFF;
|
|
const byte ALL_OUTPUT = 0x00;
|
|
const byte ALL_LOW = 0x00;
|
|
const byte ALL_NON_INVERTED = 0x00;
|
|
const byte ALL_HIGH = 0xFF;
|
|
const byte ALL_INVERTED = 0xFF;
|
|
const byte COM_SUCCESS = 0x00;
|
|
|
|
typedef enum:
|
|
byte
|
|
{
|
|
REG_INPUT = 0, // default
|
|
REG_OUTPUT = 1,
|
|
REG_POLARITY = 2,
|
|
REG_CONFIG = 3
|
|
} reg_ptr_t;
|
|
|
|
typedef enum:
|
|
byte
|
|
{
|
|
IO0 = 0,
|
|
IO1 = 1,
|
|
IO2 = 2,
|
|
IO3 = 3,
|
|
IO4 = 4,
|
|
IO5 = 5,
|
|
IO6 = 6,
|
|
IO7 = 7
|
|
} pin_t;
|
|
|
|
typedef enum:
|
|
byte
|
|
{
|
|
IO_OUTPUT = 0,
|
|
IO_INPUT = 1
|
|
} mode_tt;
|
|
|
|
typedef enum:
|
|
byte
|
|
{
|
|
IO_LOW = 0,
|
|
IO_HIGH = 1
|
|
} state_t;
|
|
|
|
typedef enum:
|
|
byte
|
|
{
|
|
IO_NON_INVERTED = 0,
|
|
IO_INVERTED = 1
|
|
} polarity_t;
|
|
|
|
class PCA9557
|
|
{
|
|
public:
|
|
PCA9557();
|
|
~PCA9557();
|
|
byte ping();
|
|
byte getMode(pin_t pin);
|
|
byte getState(pin_t pin);
|
|
byte getPolarity(pin_t pin);
|
|
void setMode(pin_t pin, mode_tt newMode);
|
|
void setMode(mode_tt newMode);
|
|
void setState(pin_t pin, state_t newState);
|
|
void setState(state_t newState);
|
|
void toggleState(pin_t pin);
|
|
void toggleState();
|
|
void setPolarity(pin_t pin, polarity_t newPolarity);
|
|
void setPolarity(polarity_t newPolarity);
|
|
void reset();
|
|
byte getComResult();
|
|
private:
|
|
byte _comBuffer;
|
|
byte getReg(reg_ptr_t regPtr);
|
|
byte getPin(pin_t pin, reg_ptr_t regPtr);
|
|
void setReg(reg_ptr_t ptr, byte newSetting);
|
|
void setPin(pin_t pin, reg_ptr_t regPtr, byte newSetting);
|
|
void initCall(reg_ptr_t regPtr);
|
|
void endCall();
|
|
}; |