GY-63_MS5611/libraries/ADG728

ADG728

Arduino Library for I2C ADG728 matrix switch. 1x8 Multiplexer.

Description

Experimental

Library for the ADG728 1 to 8 channel multiplexer.

The library allows you to enable 0 to 8 channels uniquely or simultaneously. In fact the ADG728 is therefore a switch, although often named a multiplexer.

The library caches the channels enabled, and if a channel is enabled, it will not be enabled again (low level) to optimize performance. This can however be overruled.

The device works with 2.3 V to 5.5 V so it should work with most MCU's.

Warning

The library is not tested with hardware yet.

I2C

I2C address of the device itself is 0x4C .. 0x4F.

I2C performance

The ADG728 can work up to 400 KHz according to the datasheet.

Related

Other multiplexers

• https://github.com/RobTillaart/HC4051 (1x8 mux)
• https://github.com/RobTillaart/HC4052 (2x4 mux)
• https://github.com/RobTillaart/HC4053 (3x2 mux)
• https://github.com/RobTillaart/HC4067 (1x16 mux)
• https://github.com/RobTillaart/ADG725 (2x16 mux)
• https://github.com/RobTillaart/ADG726 (2x16 mux)
• https://github.com/RobTillaart/ADG728 (1x8 mux)
• https://github.com/RobTillaart/ADG729 (2x4 mux)
• https://github.com/RobTillaart/ADG731 (1x32 mux)
• https://github.com/RobTillaart/ADG732 (1x32 mux)
• https://github.com/RobTillaart/TCA9548 I2C multiplexer

Interface

#include "ADG728.h"

Constructor

• ADG728(const uint8_t deviceAddress, TwoWire *wire = &Wire) Constructor. deviceAddress = 0x4C .. 0x4F, wire = Wire or WireN.
• bool begin(uint8_t mask = 0x00) set mask of channels to be enabled, default all disabled.
• bool isConnected() returns true if address of the multiplexer is found on I2C bus.

Channel functions

All "channel functions" return true on success.

• bool enableChannel(uint8_t channel) enables channel 0 .. 7 non-exclusive.
  Multiple channels can be enabled in parallel.
• bool disableChannel(uint8_t channel) disables channel 0 .. 7. Will not disable other channels.
• bool selectChannel(uint8_t channel) enables a single channel 0 .. 7 exclusive.
  All other channels will be disabled in the same call, so not before or after.
• bool isEnabled(uint8_t channel) returns true if the channel is enabled.
• bool disableAllChannels() fast way to disable all channels.

Multiple channels can also be enabled in one call with a mask.

• bool setChannelMask(uint8_t mask) enables 0 or more channels simultaneously with a bit mask.
• uint8_t getChannelMask() reads back the bit mask of the channels enabled.

Reset

Optional the library can reset the device.

• void setResetPin(uint8_t resetPin) sets the pin to reset the chip.
• void reset() trigger the reset pin.

Debug

• int getError() returns the last (I2C) status / error.

Forced IO

When forced IO is set, all writes and read, e.g. uint8_t getChannelMask(), will go to the device. If the forced-IO flag is set to false, it will cache the value of the channels enabled. This will result in far more responsive and faster calls. Note that writes are only optimized if the channels are already set.
Forced IO is also used to speed up getChannelMask().

• void setForced(bool forced = false) set forced write, slower but more robust.
  • forced == false == fast mode (default).
  • forced == true == slower, robust mode.
• bool getForced() returns set flag.

Error Codes

Not implemented yet, preparation for future.

name	value	description
ADG728_OK	00	no error
ADG728_ERROR_I2C	-10	detected an I2C error
ADG728_ERROR_CHANNEL	-20	channel out of range

Future

Must

• improve documentation.
• test with hardware.

Should

• add examples.
• improve error handling.

Could

• extend the unit tests.

Wont

Support

If you appreciate my libraries, you can support the development and maintenance. Improve the quality of the libraries by providing issues and Pull Requests, or donate through PayPal or GitHub sponsors.

Thank you,