0.1.0 PCA9671

Author: RobTillaart

libraries/PCA9671/.arduino-ci.yml

@@ -0,0 +1,30 @@
+platforms:
+  rpipico:
+    board: rp2040:rp2040:rpipico
+    package: rp2040:rp2040
+    gcc:
+      features:
+      defines:
+        - ARDUINO_ARCH_RP2040
+      warnings:
+      flags:
+
+packages:
+  rp2040:rp2040:
+    url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
+
+compile:
+  # Choosing to run compilation tests on 2 different Arduino platforms
+  platforms:
+    - uno
+    # - due
+    # - zero
+    # - leonardo
+    - m4
+    - esp32
+    - esp8266
+    # - mega2560
+    - rpipico
+
+  libraries:
+    - "printHelpers"

libraries/PCA9671/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: RobTillaart
+custom: "https://www.paypal.me/robtillaart"

libraries/PCA9671/.github/workflows/arduino-lint.yml

@@ -0,0 +1,13 @@
+name: Arduino-lint
+
+on: [push, pull_request]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: arduino/arduino-lint-action@v1
+        with:
+          library-manager: update
+          compliance: strict

libraries/PCA9671/.github/workflows/arduino_test_runner.yml

@@ -0,0 +1,17 @@
+name: Arduino CI
+
+on: [push, pull_request]
+
+jobs:
+  runTest:
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: |
+          gem install arduino_ci
+          arduino_ci.rb

libraries/PCA9671/.github/workflows/jsoncheck.yml

@@ -0,0 +1,18 @@
+name: JSON check
+
+on:
+  push:
+    paths:
+      - '**.json'
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - name: json-syntax-check
+        uses: limitusus/json-syntax-check@v2
+        with:
+          pattern: "\\.json$"

libraries/PCA9671/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log PCA9671
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+
+## [0.1.0] - 2025-03-16
+
+- initial version based upon PCF8575 library.
+
+
+

libraries/PCA9671/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2025 Rob Tillaart
+
+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.

libraries/PCA9671/PCA9671.cpp

@@ -0,0 +1,271 @@
+//
+//    FILE: PCA9671.cpp
+//  AUTHOR: Rob Tillaart
+//    DATE: 2025-03-16
+// VERSION: 0.1.0
+// PURPOSE: Arduino library for the PCA9671, I2C 16-bit I/O expander
+//     URL: https://github.com/RobTillaart/PCA9671
+
+
+
+#include "PCA9671.h"
+
+
+
+PCA9671::PCA9671(const uint8_t deviceAddress, TwoWire *wire)
+{
+  _address    = deviceAddress;
+  _wire       = wire;
+  _dataIn     = 0;
+  _dataOut    = 0xFFFF;
+  _buttonMask = 0xFFFF;
+  _error      = PCA9671_OK;
+}
+
+
+bool PCA9671::begin(uint16_t value)
+{
+  if (! isConnected()) return false;
+  PCA9671::write16(value);
+  return true;
+}
+
+
+bool PCA9671::isConnected()
+{
+  _wire->beginTransmission(_address);
+  return ( _wire->endTransmission() == 0);
+}
+
+
+bool PCA9671::setAddress(const uint8_t deviceAddress)
+{
+  if ((deviceAddress < 0x20) || (deviceAddress > 0x27)) return false;
+  _address = deviceAddress;
+  return isConnected();
+}
+
+
+uint8_t PCA9671::getAddress()
+{
+  return _address;
+}
+
+
+uint16_t PCA9671::read16()
+{
+  if (_wire->requestFrom(_address, (uint8_t)2) != 2)
+  {
+    _error = PCA9671_I2C_ERROR;
+    return _dataIn;                   //  last value
+  }
+  _dataIn = _wire->read();            //  low 8 bits
+  _dataIn |= (_wire->read() << 8);    //  high 8 bits
+  return _dataIn;
+}
+
+
+uint8_t PCA9671::read(const uint8_t pin)
+{
+  if (pin > 15)
+  {
+    _error = PCA9671_PIN_ERROR;
+    return 0;
+  }
+  PCA9671::read16();
+  return (_dataIn & (1 << pin)) > 0;
+}
+
+
+uint16_t PCA9671::value()
+{
+  return _dataIn;
+};
+
+
+void PCA9671::write16(const uint16_t value)
+{
+  _dataOut = value;
+  _wire->beginTransmission(_address);
+  _wire->write(_dataOut & 0xFF);      //  low 8 bits
+  _wire->write(_dataOut >> 8);        //  high 8 bits
+  _error = _wire->endTransmission();
+}
+
+
+void PCA9671::write(const uint8_t pin, const uint8_t value)
+{
+  if (pin > 15)
+  {
+    _error = PCA9671_PIN_ERROR;
+    return;
+  }
+  if (value == LOW)
+  {
+    _dataOut &= ~(1 << pin);
+  }
+  else
+  {
+    _dataOut |= (1 << pin);
+  }
+  PCA9671::write16(_dataOut);
+}
+
+
+uint16_t PCA9671::valueOut()
+{
+  return _dataOut;
+}
+
+
+void PCA9671::toggle(const uint8_t pin)
+{
+  if (pin > 15)
+  {
+    _error = PCA9671_PIN_ERROR;
+    return;
+  }
+  toggleMask(1 << pin);
+}
+
+
+void PCA9671::toggleMask(const uint16_t mask)
+{
+  _dataOut ^= mask;
+  PCA9671::write16(_dataOut);
+}
+
+
+void PCA9671::shiftRight(const uint8_t n)
+{
+  if ((n == 0) || (_dataOut == 0)) return;
+  if (n > 15)        _dataOut = 0;     //  shift 15++ clears all, valid...
+  if (_dataOut != 0) _dataOut >>= n;   //  only shift if there are bits set
+  PCA9671::write16(_dataOut);
+}
+
+
+void PCA9671::shiftLeft(const uint8_t n)
+{
+  if ((n == 0) || (_dataOut == 0)) return;
+  if (n > 15)        _dataOut = 0;    //  shift 15++ clears all, valid...
+  if (_dataOut != 0) _dataOut <<= n;  //  only shift if there are bits set
+  PCA9671::write16(_dataOut);
+}
+
+
+void PCA9671::rotateRight(const uint8_t n)
+{
+  uint8_t r = n & 15;
+  if (r == 0) return;
+  _dataOut = (_dataOut >> r) | (_dataOut << (15 - r));
+  PCA9671::write16(_dataOut);
+}
+
+
+void PCA9671::rotateLeft(const uint8_t n)
+{
+  rotateRight(16 - (n & 15));
+}
+
+
+void PCA9671::reverse()   //  quite fast
+{                                                     //      1 char === 1 bit
+  uint16_t x = _dataOut;                              //  x = 0123456789ABCDEF
+  x = (((x & 0xAAAA) >> 1) | ((x & 0x5555) << 1));    //  x = 1032547698BADCFE
+  x = (((x & 0xCCCC) >> 2) | ((x & 0x3333) << 2));    //  x = 32107654BA98FEDC
+  x = (((x & 0xF0F0) >> 4) | ((x & 0x0F0F) << 4));    //  x = 76543210FEDCBA98
+  x = (x >> 8) | ( x << 8);                           //  x = FEDCBA9876543210
+  PCA9671::write16(x);
+}
+
+
+//////////////////////////////////////////////////
+//
+//  READBUTTON
+//
+uint16_t PCA9671::readButton16(const uint16_t mask)
+{
+  uint16_t temp = _dataOut;
+  PCA9671::write16(mask | _dataOut);  //  read only selected lines
+  PCA9671::read16();
+  PCA9671::write16(temp);             //  restore
+  return _dataIn;
+}
+
+
+uint16_t PCA9671::readButton16()
+{
+  return readButton16(_buttonMask);
+}
+
+
+uint8_t PCA9671::readButton(const uint8_t pin)
+{
+  if (pin > 15)
+  {
+    _error = PCA9671_PIN_ERROR;
+    return 0;
+  }
+  uint16_t temp = _dataOut;
+  PCA9671::write(pin, HIGH);
+  uint8_t rtn = PCA9671::read(pin);
+  PCA9671::write16(temp);
+  return rtn;
+}
+
+
+void PCA9671::setButtonMask(uint16_t mask)
+{
+  _buttonMask = mask;
+};
+
+
+uint16_t PCA9671::getButtonMask()
+{
+  return _buttonMask;
+};
+
+
+//////////////////////////////////////////////////
+//
+//  SELECT
+//
+void PCA9671::select(const uint8_t pin)
+{
+  uint16_t n = 0x0000;
+  if (pin < 16) n = 1L << pin;
+  PCA9671::write16(n);
+};
+
+
+void PCA9671::selectN(const uint8_t pin)
+{
+  uint16_t n = 0xFFFF;
+  if (pin < 16) n = (2L << pin) - 1;
+  PCA9671::write16(n);
+};
+
+
+void PCA9671::selectNone()
+{
+  PCA9671::write16(0x0000);
+};
+
+
+void PCA9671::selectAll()
+{
+  PCA9671::write16(0xFFFF);
+};
+
+
+int PCA9671::lastError()
+{
+  int e = _error;
+  _error = PCA9671_OK;  //  reset error after read, is this wise?
+  return e;
+}
+
+
+//  -- END OF FILE --
+