|
| 1 | +// |
| 2 | +// FILE: ADG2128.cpp |
| 3 | +// AUTHOR: Rob Tillaart |
| 4 | +// DATE: 2025-02-28 |
| 5 | +// VERSION: 0.1.0 |
| 6 | +// PURPOSE: Arduino library for ADG2128 8x8 (cross-point) matrix switch with I2C. |
| 7 | +// URL: https://github.com/RobTillaart/ADG2128 |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +#include "ADG2128.h" |
| 12 | + |
| 13 | +#define ADG2128_LATCHED_MODE 0x00 |
| 14 | +#define ADG2128_DIRECT_MODE 0x01 |
| 15 | + |
| 16 | + |
| 17 | +ADG2128::ADG2128(uint8_t address, TwoWire *wire) |
| 18 | +{ |
| 19 | + _address = address; |
| 20 | + _wire = wire; |
| 21 | + _error = 0; |
| 22 | + _mode = ADG2128_DIRECT_MODE; |
| 23 | + _reset = 255; |
| 24 | +} |
| 25 | + |
| 26 | +bool ADG2128::begin() |
| 27 | +{ |
| 28 | + // reset variables |
| 29 | + _error = 0; |
| 30 | + |
| 31 | + if ((_address < 0x70) || (_address > 0x77)) |
| 32 | + { |
| 33 | + _error = -1; |
| 34 | + return false; |
| 35 | + } |
| 36 | + if (! isConnected()) |
| 37 | + { |
| 38 | + return false; |
| 39 | + } |
| 40 | + return true; |
| 41 | +} |
| 42 | + |
| 43 | +bool ADG2128::isConnected() |
| 44 | +{ |
| 45 | + _wire->beginTransmission(_address); |
| 46 | + return (_wire->endTransmission() == 0); |
| 47 | +} |
| 48 | + |
| 49 | +uint8_t ADG2128::getAddress() |
| 50 | +{ |
| 51 | + return _address; |
| 52 | +} |
| 53 | + |
| 54 | + |
| 55 | +///////////////////////////////////////////// |
| 56 | +// |
| 57 | +// SWITCHES |
| 58 | +// |
| 59 | +void ADG2128::on(uint8_t row, uint8_t col) |
| 60 | +{ |
| 61 | + if ((row > 7 ) || (col > 11)) return; |
| 62 | + uint8_t pins = 0x80; // 0x80 == ON |
| 63 | + if (col < 6) pins |= (col << 3) + row; |
| 64 | + else pins |= ((col + 2) << 3) + row; |
| 65 | + _send(pins, _mode); |
| 66 | +} |
| 67 | + |
| 68 | +void ADG2128::off(uint8_t row, uint8_t col) |
| 69 | +{ |
| 70 | + if ((row > 7 ) || (col > 11)) return; |
| 71 | + uint8_t pins = 0x00; // 0x00 == OFF |
| 72 | + if (col < 6) pins |= (col << 3) + row; |
| 73 | + else pins |= ((col + 2) << 3) + row; |
| 74 | + |
| 75 | + _send(pins, _mode); |
| 76 | +} |
| 77 | + |
| 78 | +bool ADG2128::isOn(uint8_t row, uint8_t col) |
| 79 | +{ |
| 80 | + if ((row > 7 ) || (col > 11)) return false; |
| 81 | + uint8_t value = isOn(col); |
| 82 | + return (value & (1 << row)) > 0; |
| 83 | +} |
| 84 | + |
| 85 | +uint8_t ADG2128::isOnMask(uint8_t col) |
| 86 | +{ |
| 87 | + if (col > 11) return false; |
| 88 | + // Table 8 datasheet |
| 89 | + uint8_t mask = 0x34; // == 0b00110100; |
| 90 | + if (col & 0x08) mask |= 0x02; |
| 91 | + if (col & 0x04) mask |= 0x01; |
| 92 | + if (col & 0x02) mask |= 0x40; |
| 93 | + if (col & 0x01) mask |= 0x08; |
| 94 | + |
| 95 | + return _readback(mask); |
| 96 | +} |
| 97 | + |
| 98 | + |
| 99 | +///////////////////////////////////////////// |
| 100 | +// |
| 101 | +// MODE |
| 102 | +// |
| 103 | +// default direct (transparent) mode |
| 104 | +void ADG2128::setMode(bool latched) |
| 105 | +{ |
| 106 | + _mode = latched ? ADG2128_LATCHED_MODE : ADG2128_DIRECT_MODE; |
| 107 | +} |
| 108 | + |
| 109 | +bool ADG2128::isLatchedMode() |
| 110 | +{ |
| 111 | + return _mode == ADG2128_LATCHED_MODE; |
| 112 | +} |
| 113 | + |
| 114 | +bool ADG2128::isDirectMode() |
| 115 | +{ |
| 116 | + return _mode == ADG2128_DIRECT_MODE; |
| 117 | +} |
| 118 | + |
| 119 | + |
| 120 | +///////////////////////////////////////////// |
| 121 | +// |
| 122 | +// RESET |
| 123 | +// |
| 124 | +void ADG2128::setResetPin(uint8_t resetPin) |
| 125 | +{ |
| 126 | + _reset = resetPin; |
| 127 | + pinMode(_reset, OUTPUT); |
| 128 | + digitalWrite(_reset, HIGH); |
| 129 | +} |
| 130 | + |
| 131 | + |
| 132 | +void ADG2128::pulseResetPin() |
| 133 | +{ |
| 134 | + digitalWrite(_reset, LOW); |
| 135 | + // need delay(1); |
| 136 | + digitalWrite(_reset, HIGH); |
| 137 | +} |
| 138 | + |
| 139 | + |
| 140 | +///////////////////////////////////////////// |
| 141 | +// |
| 142 | +// DEBUG |
| 143 | +// |
| 144 | +int ADG2128::getLastError() |
| 145 | +{ |
| 146 | + int e = _error; |
| 147 | + _error = 0; |
| 148 | + return e; |
| 149 | +} |
| 150 | + |
| 151 | + |
| 152 | +/////////////////////////////////////////////// |
| 153 | +// |
| 154 | +// PRIVATE |
| 155 | +// |
| 156 | + |
| 157 | +int ADG2128::_send(uint8_t pins, uint8_t value) |
| 158 | +{ |
| 159 | + _wire->beginTransmission(_address); |
| 160 | + _wire->write(pins); |
| 161 | + _wire->write(value); |
| 162 | + _error = _wire->endTransmission(); |
| 163 | + return _error; |
| 164 | +} |
| 165 | + |
| 166 | + |
| 167 | +int ADG2128::_readback(uint8_t value) |
| 168 | +{ |
| 169 | + _wire->beginTransmission(_address); |
| 170 | + _wire->write(value); |
| 171 | + _error = _wire->endTransmission(); |
| 172 | + uint8_t bytes = _wire->requestFrom(_address, (uint8_t)2); |
| 173 | + if (bytes != 2) |
| 174 | + { |
| 175 | + _error = -1; |
| 176 | + return 0; |
| 177 | + } |
| 178 | + _wire->read(); // skip dummy data |
| 179 | + return _wire->read(); |
| 180 | +} |
| 181 | + |
| 182 | + |
| 183 | +// -- END OF FILE -- |
| 184 | + |
0 commit comments