GY-63_MS5611/libraries/TCA9548/README.md

67 lines
2.6 KiB
Markdown
Raw Normal View History

2021-05-26 06:09:27 -04:00
[![Arduino CI](https://github.com/RobTillaart/TCA9548/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/TCA9548/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/TCA9548.svg?maxAge=3600)](https://github.com/RobTillaart/TCA9548/releases)
# TCA9548
Arduino Library for TCA9548 I2C multiplexer.
## Description
Library for the TCA9548 and TCA9548a I2C multiplexer.
The library allows you to enable 0 to 7 I2C channels (ports) uniquely or simultaneously.
This is especially handy if you have multiple devices/sensors that have a fixed address.
**Warning**
The library is not tested extensively.
I2C address is 0x70 .. 0x77.
2021-08-22 04:49:53 -04:00
The library caches the channels enabled, and if a channel is enabled,
2021-05-26 06:09:27 -04:00
it will not be enabled again (low level) to optimize performance.
## Interface
### Constructor
- **TCA9548(const uint8_t deviceAddress, TwoWire \*wire = &Wire);)** Constructor, Address = 0x70 .. 0x77, wire = Wire or WireN.
- **bool begin(uint8_t sda, uint8_t scl, uint8_t mask = 0x00);** Set I2C pins for ESP32 alikes, set mask of channels to be enabled.
- **bool begin(uint8_t mask = 0x00);** set mask of channels to be enabled.
- **bool isConnected()** retuns true if address of the multiplexer itself is found on I2C bus.
### Find device
- **bool isConnected(uint8_t addr)** retuns true if arbitrary address is found on I2C bus.
2021-08-22 04:49:53 -04:00
This can be used to verify a certain device is available (or not) on an enabled channel.
2021-05-26 06:09:27 -04:00
### Channel functions
- **void enableChannel(uint8_t channel)** enables channel 0 .. 7. Multiple channels can be enabled in parallel.
- **void disableChannel(uint8_t channel)** disables channel 0 .. 7. Will not disable other channels.
- **void selectChannel(uint8_t channel)** enables a single channel 0 .. 7 uniquely. All other channels will be disabled, although these can be set again with enableChannel.
- **bool isEnabled(uint8_t channel)** returns true is a channel is enabled.
- **void setChannelMask(uint8_t mask)** enables 0 or more channels simultaneously with a bitmask.
- **uint8_t getChannelMask()** reads back the bitmask of the channels enabled.
- **void setResetPin(uint8_t resetPin)** sets the pin to reset the chip. (Not tested)
- **void reset()** trigger the reset pin.
- **getError()** returns the last I2C error.
## Operation
See example
## Future
- test test and test
- write unit test
- forced write to chip ? robustness vs performance
- set an "always enabled" mask (have to investigate the consequences)