0.1.0 PCA9549

Author: RobTillaart

libraries/PCA9549/.arduino-ci.yml

@@ -0,0 +1,28 @@
+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/PCA9549/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+github: RobTillaart
+

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

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

libraries/PCA9549/.github/workflows/arduino_test_runner.yml

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

libraries/PCA9549/.github/workflows/jsoncheck.yml

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

libraries/PCA9549/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log PCA9549
+
+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] - 2023-12-12
+- initial version
+

libraries/PCA9549/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-2023 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/PCA9549/PCA9549.cpp

@@ -0,0 +1,141 @@
+//
+//    FILE: PCA9549.cpp
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.1.0
+//    DATE: 2023-12-12
+// PURPOSE: Arduino Library for PCA9549 I2C octal bus switch.
+//     URL: https://github.com/RobTillaart/PCA9549
+
+
+#include "PCA9549.h"
+
+
+PCA9549::PCA9549(uint8_t deviceAddress, TwoWire *wire)
+{
+  _address  = deviceAddress;
+  _wire     = wire;
+  _mask     = 0x00;
+  _resetPin = -1;
+  _forced   = false;
+  _error    = PCA9549_OK;
+}
+
+
+bool PCA9549::begin(uint8_t mask)
+{
+  if (! isConnected()) return false;
+  setChannelMask(mask);
+  return true;
+}
+
+
+bool PCA9549::isConnected()
+{
+  _wire->beginTransmission(_address);
+  return ( _wire->endTransmission() == 0);
+}
+
+
+bool PCA9549::enableChannel(uint8_t channel)
+{
+  if (channel >= 8) return false;
+  if (!isEnabled(channel))
+  {
+    setChannelMask(_mask | (0x01 << channel));
+  }
+  return true;
+}
+
+
+bool PCA9549::disableChannel(uint8_t channel)
+{
+  if (channel >= 8) return false;
+  if (!isEnabled(channel))
+  {
+    setChannelMask(_mask & ~(0x01 << channel));
+  }
+  return true;
+}
+
+
+bool PCA9549::selectChannel(uint8_t channel)
+{
+  if (channel >= 8) return false;
+  setChannelMask(0x01 << channel);
+  return true;
+}
+
+
+bool PCA9549::isEnabled(uint8_t channel)
+{
+  if (channel >= 8) return false;
+  return (_mask & (0x01 << channel));
+}
+
+
+bool PCA9549::disableAllChannels()
+{
+  return setChannelMask(0x00);
+}
+
+
+bool PCA9549::setChannelMask(uint8_t mask)
+{
+  if ((_mask == mask) && (not _forced)) return true;
+  _mask = mask;
+  _wire->beginTransmission(_address);
+  _wire->write(_mask);
+  _error = _wire->endTransmission();
+  return (_error == 0);
+}
+
+
+uint8_t PCA9549::getChannelMask()
+{
+  if (_forced)  //  read from device.
+  {
+    _wire->requestFrom(_address, (uint8_t)1);
+    _mask = _wire->read();
+  }
+  return _mask;
+}
+
+
+void PCA9549::setResetPin(uint8_t resetPin)
+{
+  _resetPin = resetPin;
+  pinMode(_resetPin, OUTPUT);
+  digitalWrite(_resetPin, HIGH);
+}
+
+
+void PCA9549::reset()
+{
+  digitalWrite(_resetPin, LOW);
+  delayMicroseconds(1);           //  TODO datasheet page ? - 500 ns
+  digitalWrite(_resetPin, HIGH);
+}
+
+
+void PCA9549::setForced(bool forced)
+{
+  _forced = forced;
+};
+
+
+bool PCA9549::getForced()
+{
+  return _forced;
+};
+
+
+int PCA9549::getError()
+{
+  int error = _error;
+  _error = PCA9549_OK;
+  return error;
+}
+
+
+//  -- END OF FILE --
+

libraries/PCA9549/PCA9549.h

@@ -0,0 +1,65 @@
+#pragma once
+//
+//    FILE: PCA9549.h
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.1.0
+//    DATE: 2023-12-12
+// PURPOSE: Arduino Library for PCA9549 I2C octal bus switch.
+//     URL: https://github.com/RobTillaart/PCA9549
+
+
+#include "Arduino.h"
+#include "Wire.h"
+
+
+#define PCA9549_LIB_VERSION             (F("0.1.0"))
+
+#define PCA9549_OK                       0x00
+
+
+class PCA9549
+{
+public:
+  //  deviceAddress = 0x70 .. 0x77
+  PCA9549(uint8_t deviceAddress, TwoWire *wire = &Wire);
+
+  bool    begin(uint8_t mask = 0x00);         //  default no channels enabled
+  bool    isConnected();                      //  find multiplexer on I2C bus
+
+
+  //  channel = 0..channelCount()-1
+  bool    enableChannel(uint8_t channel);     //  enable this channel non exclusive
+  bool    disableChannel(uint8_t channel);
+  bool    selectChannel(uint8_t channel);     //  enable only this channel
+  bool    isEnabled(uint8_t channel);
+  bool    disableAllChannels();
+
+
+  //  mask = 0x00 .. 0xFF - every bit is a channel.
+  //  note 1:  these are set simultaneously.
+  bool    setChannelMask(uint8_t mask);
+  uint8_t getChannelMask();
+
+  //  reset
+  void    setResetPin(uint8_t resetPin);
+  void    reset();     //  trigger reset pin
+
+  //  set forced IO (default false)
+  void    setForced(bool forced = false);
+  bool    getForced();
+
+  int     getError();
+
+
+protected:
+  uint8_t   _address;
+  TwoWire*  _wire;
+  uint8_t   _mask;             //  caching mask = status of channels
+  uint8_t   _resetPin;         //  default not set == -1 (255)
+  bool      _forced;
+  int       _error;
+};
+
+
+//  -- END OF FILE --
+