From 5da9146558db50d46b8c34a51149464e51115111 Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Tue, 5 Dec 2023 13:31:44 -0700 Subject: [PATCH 001/138] Add git files. --- .gitattributes | 2 ++ .gitignore | 3 +++ 2 files changed, 5 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..eba1110 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..737bcf8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +# VSCode directories +.vscode + From c17b3a045aeb584557d1747fc3db232f40a14968 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Fri, 8 Dec 2023 13:21:20 -0700 Subject: [PATCH 002/138] lates - ready for publish --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 6f971ef..45a0a30 100644 --- a/library.properties +++ b/library.properties @@ -3,7 +3,7 @@ version=0.8.0 author=SparkFun Electronics maintainer=SparkFun Electronics sentence=A utility library that other SparkFun libraries can take advantage of. -paragraph= +paragraph=The SparkFun Toolkit provides a common set of core functionality for use across the SparkFun Arduino Driver library. Instead of each device driver library implementing a communication layers, error types and interface, the SparkFun Toolkit library is used. category=Other url=https://github.com/sparkfun/SparkFun_Toolkit architectures=* From 23d7d9a32f02987d01bef72ee3dfec7812a58ed1 Mon Sep 17 00:00:00 2001 From: Paul Date: Tue, 12 Dec 2023 10:11:49 +0000 Subject: [PATCH 003/138] See description: Add writeByte for both I2C and SPI - needed by the ADS1219 on I2C Add support for I2C restart vs. stop (many devices require a restart between set-register-address and read-register-value). This is I2C-specific and may be needed on non-Arduino platforms too. Added setStop and getStop. Corrected readRegisterRegion: the beginTransmission and endTransmission should be inside the if(bFirstInter). --- src/sfeTk/sfeTkIBus.h | 10 ++++++++++ src/sfeTk/sfeTkII2C.h | 23 ++++++++++++++++++++++- src/sfeTkArdI2C.cpp | 35 ++++++++++++++++++++++++++++------- src/sfeTkArdI2C.h | 10 ++++++++++ src/sfeTkArdSPI.cpp | 28 ++++++++++++++++++++++++++++ src/sfeTkArdSPI.h | 9 +++++++++ 6 files changed, 107 insertions(+), 8 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index a63fe07..5499f37 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -46,6 +46,16 @@ const sfeTkError_t kSTkErrBusNotEnabled = kSTkErrBaseBus + 8; class sfeTkIBus { public: + /*-------------------------------------------------------------------------- + @brief Write a single byte to the device + + @param data Data to write. + + @retval sfeTkError_t - kSTkErrOk on successful execution. + + */ + virtual sfeTkError_t writeByte(uint8_t data) = 0; + /*-------------------------------------------------------------------------- @brief Write a single byte to the given register diff --git a/src/sfeTk/sfeTkII2C.h b/src/sfeTk/sfeTkII2C.h index 8ff4d14..81a5604 100644 --- a/src/sfeTk/sfeTkII2C.h +++ b/src/sfeTk/sfeTkII2C.h @@ -34,7 +34,7 @@ class sfeTkII2C : public sfeTkIBus sfeTkII2C() : _address{kNoAddress} { } - sfeTkII2C(uint8_t addr) : _address{addr} + sfeTkII2C(uint8_t addr) : _address{addr}, _stop{true} { } @@ -68,10 +68,31 @@ class sfeTkII2C : public sfeTkIBus return _address; } + /*-------------------------------------------------------------------------- + @brief setter for I2C stops (vs restarts) + + */ + virtual void setStop(uint8_t stop) + { + _stop = stop; + } + + /*-------------------------------------------------------------------------- + @brief getter for I2C stops (vs restarts) + + @retval uint8_t returns the value of "send stop" + + */ + virtual uint8_t getStop(void) + { + return _stop; + } + static constexpr uint8_t kNoAddress = 0; private: uint8_t _address; + uint8_t _stop; }; //}; diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index d29f8f8..dc553e1 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -84,6 +84,24 @@ sfeTkError_t sfeTkArdI2C::ping() return _i2cPort->endTransmission() == 0 ? kSTkErrOk : kSTkErrFail; } +//--------------------------------------------------------------------------------- +// writeByte() +// +// Writes a single byte to the device. +// +// Returns true on success, false on failure +// +sfeTkError_t sfeTkArdI2C::writeByte(uint8_t dataToWrite) +{ + if (!_i2cPort) + return kSTkErrBusNotInit; + + // do the Arduino I2C work + _i2cPort->beginTransmission(address()); + _i2cPort->write(dataToWrite); + return _i2cPort->endTransmission() == 0 ? kSTkErrOk : kSTkErrFail; +} + //--------------------------------------------------------------------------------- // writeRegisterByte() // @@ -102,6 +120,7 @@ sfeTkError_t sfeTkArdI2C::writeRegisterByte(uint8_t devReg, uint8_t dataToWrite) _i2cPort->write(dataToWrite); return _i2cPort->endTransmission() == 0 ? kSTkErrOk : kSTkErrFail; } + //--------------------------------------------------------------------------------- // writeRegisterWord() // @@ -155,7 +174,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterByte(uint8_t devReg, uint8_t &dataToRead) _i2cPort->beginTransmission(address()); _i2cPort->write(devReg); - _i2cPort->endTransmission(); + _i2cPort->endTransmission((int)getStop()); _i2cPort->requestFrom(address(), (uint8_t)1); while (_i2cPort->available()) // slave may send less than requested @@ -207,21 +226,23 @@ int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t nu while (numBytes > 0) { - _i2cPort->beginTransmission(address()); - if (bFirstInter) { + _i2cPort->beginTransmission(address()); + _i2cPort->write(devReg); + + if (_i2cPort->endTransmission(getStop()) != 0) + return kSTkErrFail; // error with the end transmission + bFirstInter = false; } - if (_i2cPort->endTransmission() != 0) - return kSTkErrFail; // error with the end transmission - // We're chunking in data - keeping the max chunk to kMaxI2CBufferLength nChunk = numBytes > _bufferChunkSize ? _bufferChunkSize : numBytes; - nReturned = _i2cPort->requestFrom((int)address(), (int)nChunk, (int)true); + // Request the bytes. If this is the last chunk, always send a stop + nReturned = _i2cPort->requestFrom((int)address(), (int)nChunk, (int)(nChunk == numBytes ? true : getStop())); // No data returned, no dice if (nReturned == 0) diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index 2a9e0e0..34f3327 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -92,6 +92,16 @@ class sfeTkArdI2C : public sfeTkII2C */ sfeTkError_t ping(); + /*-------------------------------------------------------------------------- + @brief Write a single byte to the device + @note sfeTkIBus interface method + + @param data Data to write. + + @retval returns kStkErrOk on success + */ + sfeTkError_t writeByte(uint8_t data); + /*-------------------------------------------------------------------------- @brief Write a single byte to the given register @note sfeTkIBus interface method diff --git a/src/sfeTkArdSPI.cpp b/src/sfeTkArdSPI.cpp index 2c5fa58..c933ed3 100644 --- a/src/sfeTkArdSPI.cpp +++ b/src/sfeTkArdSPI.cpp @@ -81,6 +81,33 @@ sfeTkError_t sfeTkArdSPI::init(bool bInit) return init(cs(), bInit); } +//--------------------------------------------------------------------------------- +// writeRegisterByte() +// +// Writes a single byte to the device. +// +// Returns kSTkErrOk on success +// +sfeTkError_t sfeTkArdSPI::writeByte(uint8_t dataToWrite) +{ + + if (!_spiPort) + return kSTkErrBusNotInit; + + // Apply settings + _spiPort->beginTransaction(_sfeSPISettings); + // Signal communication start + digitalWrite(cs(), LOW); + + _spiPort->transfer(dataToWrite); + + // End communication + digitalWrite(cs(), HIGH); + _spiPort->endTransaction(); + + return kSTkErrOk; +} + //--------------------------------------------------------------------------------- // writeRegisterByte() // @@ -108,6 +135,7 @@ sfeTkError_t sfeTkArdSPI::writeRegisterByte(uint8_t devReg, uint8_t dataToWrite) return kSTkErrOk; } + //--------------------------------------------------------------------------------- // writeRegisterWord() // diff --git a/src/sfeTkArdSPI.h b/src/sfeTkArdSPI.h index 0dfe73a..d8ff00b 100644 --- a/src/sfeTkArdSPI.h +++ b/src/sfeTkArdSPI.h @@ -82,6 +82,15 @@ class sfeTkArdSPI : public sfeTkISPI */ sfeTkError_t init(SPIClass &spiPort, SPISettings &busSPISettings, uint8_t csPin, bool bInit = false); + /*-------------------------------------------------------------------------- + @brief Write a single byte to the device + + @param data Data to write. + + @retval sfeTkError_t - kSTkErrOk on success + */ + sfeTkError_t writeByte(uint8_t data); + /*-------------------------------------------------------------------------- @brief Write a single byte to the given register From 702fec6abd3fc8b1d7ecfff2ffefd125601a6f8d Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Tue, 12 Dec 2023 12:19:16 -0700 Subject: [PATCH 004/138] move stop bit init to default constructor; added constexpr for default stop bit value --- src/sfeTk/sfeTkII2C.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/sfeTk/sfeTkII2C.h b/src/sfeTk/sfeTkII2C.h index 81a5604..e35d7d0 100644 --- a/src/sfeTk/sfeTkII2C.h +++ b/src/sfeTk/sfeTkII2C.h @@ -31,10 +31,11 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. class sfeTkII2C : public sfeTkIBus { public: - sfeTkII2C() : _address{kNoAddress} + // set the address to No address and stop bit to the default value of 1 + sfeTkII2C() : _address{kNoAddress}, _stop{kDefaultStopBit} { } - sfeTkII2C(uint8_t addr) : _address{addr}, _stop{true} + sfeTkII2C(uint8_t addr) : _address{addr} { } @@ -89,6 +90,7 @@ class sfeTkII2C : public sfeTkIBus } static constexpr uint8_t kNoAddress = 0; + static constexpr uint8_t kDefaultStopBit = 1; private: uint8_t _address; From 9b7a93aad87c95b695a08d31ece767e58b89e435 Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Tue, 12 Dec 2023 13:09:18 -0700 Subject: [PATCH 005/138] Update readRegisterRegion. Returns a proper error code now. ReadBytes returns number of bytes read. --- src/sfeTk/sfeTkIBus.h | 2 +- src/sfeTkArdI2C.cpp | 16 ++++++++++++---- src/sfeTkArdI2C.h | 8 +++++--- 3 files changed, 18 insertions(+), 8 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index 5499f37..cc8f1da 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -121,7 +121,7 @@ class sfeTkIBus @retval int returns kSTkErrOk on success, or kSTkErrFail code */ - virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes) = 0; + virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t *readBytes) = 0; }; //}; diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index dc553e1..e5bf936 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -200,9 +200,11 @@ sfeTkError_t sfeTkArdI2C::readRegisterWord(uint8_t devReg, uint16_t &dataToRead) if (!_i2cPort) return kSTkErrBusNotInit; - uint32_t nRead = readRegisterRegion(devReg, (uint8_t *)&dataToRead, sizeof(uint16_t)); + uint16_t nRead = 0; - return (nRead == 2 ? kSTkErrOk : kSTkErrFail); + sfeTkError_t result = readRegisterRegion(devReg, (uint8_t *)&dataToRead, sizeof(uint16_t), &nRead); + + return nRead == 2 ? kSTkErrOk : result; } //--------------------------------------------------------------------------------- @@ -212,12 +214,16 @@ sfeTkError_t sfeTkArdI2C::readRegisterWord(uint8_t devReg, uint16_t &dataToRead) // // Returns the number of bytes read, < 0 is an error // -int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes) +int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes) { // got port if (!_i2cPort) return kSTkErrBusNotInit; + // Are buffers valid? + if (!data || !readBytes) + return kSTkErrBusNullBuffer; + uint16_t nOrig = numBytes; // original number of bytes. uint8_t nChunk; uint16_t nReturned; @@ -257,5 +263,7 @@ int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t nu } // end while - return nOrig - numBytes; // Success + *readBytes = nOrig - numBytes; // Bytes read. + + return (*readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success } diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index 34f3327..94ab558 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -168,11 +168,13 @@ class sfeTkArdI2C : public sfeTkII2C @note This method is virtual to allow it to be overridden to support a device that requires a unique impl @param devReg The device's register's address. - @param data Data to write. + @param data Data being read. + @param numBytes Number of bytes to read. + @param readBytes Number of bytes read. - @retval kStkErrOk on success + @retval kSTkErrOk on success */ - sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes); + sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes); // Buffer size chunk getter/setter /*-------------------------------------------------------------------------- From bf890f68b1a74da21168d03f0509d2b6aa1fd608 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Tue, 12 Dec 2023 13:18:42 -0700 Subject: [PATCH 006/138] rework on reg region and stop --- src/sfeTk/sfeTkIBus.h | 4 +++- src/sfeTk/sfeTkII2C.h | 17 ++++++++--------- src/sfeTkArdI2C.cpp | 22 ++++++++++++++-------- src/sfeTkArdI2C.h | 4 +++- src/sfeTkArdSPI.cpp | 14 +++++++++++--- src/sfeTkArdSPI.h | 4 +++- 6 files changed, 42 insertions(+), 23 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index 5499f37..858f023 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -117,11 +117,13 @@ class sfeTkIBus @param devAddr The device's I2C address. @param devReg The device's register's address. @param data Data to write. + @param numBytes - length of data + @param[out] readBytes - number of bytes read @retval int returns kSTkErrOk on success, or kSTkErrFail code */ - virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes) = 0; + virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0; }; //}; diff --git a/src/sfeTk/sfeTkII2C.h b/src/sfeTk/sfeTkII2C.h index e35d7d0..676866c 100644 --- a/src/sfeTk/sfeTkII2C.h +++ b/src/sfeTk/sfeTkII2C.h @@ -31,8 +31,8 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. class sfeTkII2C : public sfeTkIBus { public: - // set the address to No address and stop bit to the default value of 1 - sfeTkII2C() : _address{kNoAddress}, _stop{kDefaultStopBit} + // set the address to No address and stop flag to true + sfeTkII2C() : _address{kNoAddress}, _stop{true} { } sfeTkII2C(uint8_t addr) : _address{addr} @@ -70,31 +70,30 @@ class sfeTkII2C : public sfeTkIBus } /*-------------------------------------------------------------------------- - @brief setter for I2C stops (vs restarts) + @brief setter for I2C stop message (vs restarts) */ - virtual void setStop(uint8_t stop) + virtual void setStop(bool stop) { _stop = stop; } /*-------------------------------------------------------------------------- - @brief getter for I2C stops (vs restarts) + @brief getter for I2C stops message (vs restarts) - @retval uint8_t returns the value of "send stop" + @retval bool returns the value of "send stop" */ - virtual uint8_t getStop(void) + virtual bool stop(void) { return _stop; } static constexpr uint8_t kNoAddress = 0; - static constexpr uint8_t kDefaultStopBit = 1; private: uint8_t _address; - uint8_t _stop; + bool _stop; }; //}; diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index dc553e1..34127c1 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -174,7 +174,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterByte(uint8_t devReg, uint8_t &dataToRead) _i2cPort->beginTransmission(address()); _i2cPort->write(devReg); - _i2cPort->endTransmission((int)getStop()); + _i2cPort->endTransmission(stop()); _i2cPort->requestFrom(address(), (uint8_t)1); while (_i2cPort->available()) // slave may send less than requested @@ -200,9 +200,10 @@ sfeTkError_t sfeTkArdI2C::readRegisterWord(uint8_t devReg, uint16_t &dataToRead) if (!_i2cPort) return kSTkErrBusNotInit; - uint32_t nRead = readRegisterRegion(devReg, (uint8_t *)&dataToRead, sizeof(uint16_t)); + size_t nRead; + sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&dataToRead, sizeof(uint16_t), nRead); - return (nRead == 2 ? kSTkErrOk : kSTkErrFail); + return (retval == kSTkErrOk && nRead == 2 ? kSTkErrOk : retval); } //--------------------------------------------------------------------------------- @@ -212,12 +213,15 @@ sfeTkError_t sfeTkArdI2C::readRegisterWord(uint8_t devReg, uint16_t &dataToRead) // // Returns the number of bytes read, < 0 is an error // -int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes) +sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) { + // got port if (!_i2cPort) return kSTkErrBusNotInit; + readBytes = 0; + uint16_t nOrig = numBytes; // original number of bytes. uint8_t nChunk; uint16_t nReturned; @@ -232,7 +236,7 @@ int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t nu _i2cPort->write(devReg); - if (_i2cPort->endTransmission(getStop()) != 0) + if (_i2cPort->endTransmission(stop())) return kSTkErrFail; // error with the end transmission bFirstInter = false; @@ -242,11 +246,11 @@ int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t nu nChunk = numBytes > _bufferChunkSize ? _bufferChunkSize : numBytes; // Request the bytes. If this is the last chunk, always send a stop - nReturned = _i2cPort->requestFrom((int)address(), (int)nChunk, (int)(nChunk == numBytes ? true : getStop())); + nReturned = _i2cPort->requestFrom((int)address(), (int)nChunk, (int)(nChunk == numBytes ? true : stop())); // No data returned, no dice if (nReturned == 0) - return -1; // error + return kSTkErrBusUnderRead; // error // Copy the retrieved data chunk to the current index in the data segment for (i = 0; i < nReturned; i++) @@ -257,5 +261,7 @@ int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t nu } // end while - return nOrig - numBytes; // Success + readBytes = nOrig - numBytes; + + return kSTkErrOk; } diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index 34f3327..85a74da 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -169,10 +169,12 @@ class sfeTkArdI2C : public sfeTkII2C @param devReg The device's register's address. @param data Data to write. + @param numBytes - length of data + @param[out] readBytes - Number of bytes read @retval kStkErrOk on success */ - sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes); + sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes); // Buffer size chunk getter/setter /*-------------------------------------------------------------------------- diff --git a/src/sfeTkArdSPI.cpp b/src/sfeTkArdSPI.cpp index c933ed3..e14a283 100644 --- a/src/sfeTkArdSPI.cpp +++ b/src/sfeTkArdSPI.cpp @@ -178,12 +178,18 @@ sfeTkError_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *dat sfeTkError_t sfeTkArdSPI::readRegisterByte(uint8_t devReg, uint8_t &data) { - return readRegisterRegion(devReg, &data, sizeof(data)) == 1; + size_t nRead; + sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&data, sizeof(data), nRead); + + return (retval == kSTkErrOk && nRead == sizeof(data) ? kSTkErrOk : retval); } sfeTkError_t sfeTkArdSPI::readRegisterWord(uint8_t devReg, uint16_t &data) { - return readRegisterRegion(devReg, (uint8_t *)&data, sizeof(data)) == 2; + size_t nRead; + sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&data, sizeof(data), nRead); + + return (retval == kSTkErrOk && nRead == sizeof(data) ? kSTkErrOk : retval); } //--------------------------------------------------------------------------------- // readRegisterRegion() @@ -192,7 +198,7 @@ sfeTkError_t sfeTkArdSPI::readRegisterWord(uint8_t devReg, uint16_t &data) // // Returns kSTkErrOk on success // -sfeTkError_t sfeTkArdSPI::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes) +sfeTkError_t sfeTkArdSPI::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) { if (!_spiPort) return kSTkErrBusNotInit; @@ -213,5 +219,7 @@ sfeTkError_t sfeTkArdSPI::readRegisterRegion(uint8_t devReg, uint8_t *data, size digitalWrite(cs(), HIGH); _spiPort->endTransaction(); + readBytes = numBytes; + return kSTkErrOk; } diff --git a/src/sfeTkArdSPI.h b/src/sfeTkArdSPI.h index d8ff00b..f386cc2 100644 --- a/src/sfeTkArdSPI.h +++ b/src/sfeTkArdSPI.h @@ -148,10 +148,12 @@ class sfeTkArdSPI : public sfeTkISPI @param devReg The device's register's address. @param data Data to write. + @param numBytes - length of data + @param[out] readBytes - Number of bytes read @retval sfeTkError_t - true on success */ - virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes); + virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes); protected: // note: The instance data is protected, allowing access if a sub-class is From 39a5116973c91a6bf1bb3d8f194e1aeda4aeb989 Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Tue, 12 Dec 2023 13:21:12 -0700 Subject: [PATCH 007/138] Made ref instead of ptr. --- src/sfeTk/sfeTkIBus.h | 2 +- src/sfeTkArdI2C.cpp | 10 +++++----- src/sfeTkArdI2C.h | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index cc8f1da..7889d38 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -121,7 +121,7 @@ class sfeTkIBus @retval int returns kSTkErrOk on success, or kSTkErrFail code */ - virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t *readBytes) = 0; + virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0; }; //}; diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index e5bf936..4fd1c8c 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -214,14 +214,14 @@ sfeTkError_t sfeTkArdI2C::readRegisterWord(uint8_t devReg, uint16_t &dataToRead) // // Returns the number of bytes read, < 0 is an error // -int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes) +int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) { // got port if (!_i2cPort) return kSTkErrBusNotInit; - // Are buffers valid? - if (!data || !readBytes) + // Buffer valid? + if (!data) return kSTkErrBusNullBuffer; uint16_t nOrig = numBytes; // original number of bytes. @@ -263,7 +263,7 @@ int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t nu } // end while - *readBytes = nOrig - numBytes; // Bytes read. + readBytes = nOrig - numBytes; // Bytes read. - return (*readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success + return (readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success } diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index 94ab558..a95e701 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -174,7 +174,7 @@ class sfeTkArdI2C : public sfeTkII2C @retval kSTkErrOk on success */ - sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes); + sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes); // Buffer size chunk getter/setter /*-------------------------------------------------------------------------- From aba6692c25e88a89d06d04acff9ff5495bc8ab02 Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Tue, 12 Dec 2023 13:24:16 -0700 Subject: [PATCH 008/138] retype readRegisterRegion --- src/sfeTkArdI2C.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index 4fd1c8c..6402c68 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -214,7 +214,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterWord(uint8_t devReg, uint16_t &dataToRead) // // Returns the number of bytes read, < 0 is an error // -int32_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) +sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) { // got port if (!_i2cPort) From 90ab6e02ed8ffbc229fbb548be083ae47741ba06 Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Wed, 13 Dec 2023 15:55:44 -0700 Subject: [PATCH 009/138] Invert default stop logic. --- src/sfeTk/sfeTkII2C.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/sfeTk/sfeTkII2C.h b/src/sfeTk/sfeTkII2C.h index 676866c..f2b7d40 100644 --- a/src/sfeTk/sfeTkII2C.h +++ b/src/sfeTk/sfeTkII2C.h @@ -32,7 +32,7 @@ class sfeTkII2C : public sfeTkIBus { public: // set the address to No address and stop flag to true - sfeTkII2C() : _address{kNoAddress}, _stop{true} + sfeTkII2C() : _address{kNoAddress}, _stop{false} { } sfeTkII2C(uint8_t addr) : _address{addr} From 21e5587b6218856fb2a2e9af951cf74254e3c7b5 Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Wed, 13 Dec 2023 15:57:37 -0700 Subject: [PATCH 010/138] Fix comment. --- src/sfeTk/sfeTkII2C.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/sfeTk/sfeTkII2C.h b/src/sfeTk/sfeTkII2C.h index f2b7d40..b9f284f 100644 --- a/src/sfeTk/sfeTkII2C.h +++ b/src/sfeTk/sfeTkII2C.h @@ -31,7 +31,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. class sfeTkII2C : public sfeTkIBus { public: - // set the address to No address and stop flag to true + // set the address to No address and stop flag to false sfeTkII2C() : _address{kNoAddress}, _stop{false} { } From a95c8d50b9b48ba178c5e5b1a89e079f46cf193d Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Wed, 13 Dec 2023 15:59:13 -0700 Subject: [PATCH 011/138] Rev library. --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 45a0a30..34cffae 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=SparkFun Toolkit -version=0.8.0 +version=0.9.0 author=SparkFun Electronics maintainer=SparkFun Electronics sentence=A utility library that other SparkFun libraries can take advantage of. From 17009ec0129f44d2507ef905010ceb04196deb1e Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Wed, 13 Dec 2023 17:25:38 -0700 Subject: [PATCH 012/138] Update library.properties Add include directive. --- library.properties | 1 + 1 file changed, 1 insertion(+) diff --git a/library.properties b/library.properties index 34cffae..9ffc27b 100644 --- a/library.properties +++ b/library.properties @@ -7,3 +7,4 @@ paragraph=The SparkFun Toolkit provides a common set of core functionality for u category=Other url=https://github.com/sparkfun/SparkFun_Toolkit architectures=* +includes=SparkFun_Toolkit.h From 7a93c00f67fac71af35ec64fed6bea25f0957c45 Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Thu, 14 Dec 2023 08:03:10 -0700 Subject: [PATCH 013/138] Fix changes requested. Add to docs for pointing out enabling repeat start. --- docs/ar_ibus.md | 7 +++++++ src/sfeTk/sfeTkII2C.h | 4 ++-- src/sfeTkArdI2C.cpp | 6 +++--- src/sfeTkArdSPI.cpp | 8 ++++---- 4 files changed, 16 insertions(+), 9 deletions(-) diff --git a/docs/ar_ibus.md b/docs/ar_ibus.md index 91a3933..85b972d 100644 --- a/docs/ar_ibus.md +++ b/docs/ar_ibus.md @@ -202,6 +202,9 @@ The following is an example of an I2C class in Arduino based on the previous pla > [!NOTE] > This class implements a ```isConnected()``` method that calls the ```ping()``` method of the I2C bus class being used, and if this passes, then calls the ```checkDeviceID()``` method of the superclass. +> [!NOTE] +> If your device supports repeated starts, make sure to include ```_theI2CBus.setStop(false)``` in your begin function. Otherwise this can cause issues with your device. + ```c++ class myArduinoDriverI2C : public myDriverClass @@ -214,6 +217,10 @@ class myArduinoDriverI2C : public myDriverClass { if (_theI2CBus.init(MY_DEVICE_ADDRESS) != kSTkErrOk) return false; + + // OPTIONAL: If your device supports repeat starts. + _theI2CBus.setStop(false); + setCommunicationBus(&_theI2CBus); return myDriverClass::begin(); diff --git a/src/sfeTk/sfeTkII2C.h b/src/sfeTk/sfeTkII2C.h index b9f284f..676866c 100644 --- a/src/sfeTk/sfeTkII2C.h +++ b/src/sfeTk/sfeTkII2C.h @@ -31,8 +31,8 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. class sfeTkII2C : public sfeTkIBus { public: - // set the address to No address and stop flag to false - sfeTkII2C() : _address{kNoAddress}, _stop{false} + // set the address to No address and stop flag to true + sfeTkII2C() : _address{kNoAddress}, _stop{true} { } sfeTkII2C(uint8_t addr) : _address{addr} diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index 880afb4..11aeea5 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -183,10 +183,10 @@ sfeTkError_t sfeTkArdI2C::readRegisterByte(uint8_t devReg, uint8_t &dataToRead) nData++; } - if (nData == 1) // Only update outputPointer if a single byte was returned + if (nData == sizeof(uint8_t)) // Only update outputPointer if a single byte was returned dataToRead = result; - return (nData == 1 ? kSTkErrOk : kSTkErrFail); + return (nData == sizeof(uint8_t) ? kSTkErrOk : kSTkErrFail); } //--------------------------------------------------------------------------------- // readRegisterWord() @@ -203,7 +203,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterWord(uint8_t devReg, uint16_t &dataToRead) size_t nRead; sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&dataToRead, sizeof(uint16_t), nRead); - return (retval == kSTkErrOk && nRead == 2 ? kSTkErrOk : retval); + return (retval == kSTkErrOk && nRead == sizeof(uint16_t) ? kSTkErrOk : retval); } //--------------------------------------------------------------------------------- diff --git a/src/sfeTkArdSPI.cpp b/src/sfeTkArdSPI.cpp index e14a283..62f91c8 100644 --- a/src/sfeTkArdSPI.cpp +++ b/src/sfeTkArdSPI.cpp @@ -179,17 +179,17 @@ sfeTkError_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *dat sfeTkError_t sfeTkArdSPI::readRegisterByte(uint8_t devReg, uint8_t &data) { size_t nRead; - sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&data, sizeof(data), nRead); + sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&data, sizeof(uint8_t), nRead); - return (retval == kSTkErrOk && nRead == sizeof(data) ? kSTkErrOk : retval); + return (retval == kSTkErrOk && nRead == sizeof(uint8_t) ? kSTkErrOk : retval); } sfeTkError_t sfeTkArdSPI::readRegisterWord(uint8_t devReg, uint16_t &data) { size_t nRead; - sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&data, sizeof(data), nRead); + sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&data, sizeof(uint16_t), nRead); - return (retval == kSTkErrOk && nRead == sizeof(data) ? kSTkErrOk : retval); + return (retval == kSTkErrOk && nRead == sizeof(uint16_t) ? kSTkErrOk : retval); } //--------------------------------------------------------------------------------- // readRegisterRegion() From d361f4ba4a959ce6677ddf9b693704e85fcb376a Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Thu, 14 Dec 2023 08:06:22 -0700 Subject: [PATCH 014/138] Add forgotten != 0 --- src/sfeTkArdI2C.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index 11aeea5..608b612 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -240,7 +240,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size _i2cPort->write(devReg); - if (_i2cPort->endTransmission(stop())) + if (_i2cPort->endTransmission(stop() != 0)) return kSTkErrFail; // error with the end transmission bFirstInter = false; From 3a30596c7676e773cecbe997555227f8e8ae63cb Mon Sep 17 00:00:00 2001 From: Alex Brudner <101155592+SFE-Brudnerd@users.noreply.github.com> Date: Thu, 14 Dec 2023 08:07:37 -0700 Subject: [PATCH 015/138] fix --- src/sfeTkArdI2C.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index 608b612..0f994be 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -240,7 +240,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size _i2cPort->write(devReg); - if (_i2cPort->endTransmission(stop() != 0)) + if (_i2cPort->endTransmission(stop()) != 0) return kSTkErrFail; // error with the end transmission bFirstInter = false; From bdabd84fcc907241424e336ddcae74b779f8009e Mon Sep 17 00:00:00 2001 From: MadisonC-SparkFun Date: Tue, 9 Jan 2024 13:42:34 -0700 Subject: [PATCH 016/138] Added new functions Added new functionality for reading and writing from 16-bit addressed registers. Note: The function names are likely to change as per Kirk's request/approval --- src/sfeTk/sfeTkIBus.h | 28 ++++++++++++++ src/sfeTkArdI2C.cpp | 89 +++++++++++++++++++++++++++++++++++++++++++ src/sfeTkArdI2C.h | 26 +++++++++++++ 3 files changed, 143 insertions(+) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index 858f023..803f9be 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -78,6 +78,7 @@ class sfeTkIBus */ virtual sfeTkError_t writeRegisterWord(uint8_t devReg, uint16_t data) = 0; + /*-------------------------------------------------------------------------- @brief Writes a number of bytes starting at the given register's address. @@ -90,6 +91,19 @@ class sfeTkIBus */ virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) = 0; + /*-------------------------------------------------------------------------- + @brief Writes a number of bytes starting at the given register's 16-bit address. + + @param devAddr The device's 16-bit address/pin + param devReg The device's register's address. + @param data Data to write. + + @retval sfeTkError_t kSTkErrOk on successful execution + + */ + virtual sfeTkError_t write16BitRegisterRegion(uint16_t devReg, const uint8_t *data, size_t length) = 0; + + /*-------------------------------------------------------------------------- @brief Read a single byte from the given register @@ -124,6 +138,20 @@ class sfeTkIBus */ virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0; + + /*-------------------------------------------------------------------------- + @brief Reads a block of data from the given 16-bit register address. + + @param reg The device's 16 bit register's address. + @param data Data to write. + @param numBytes - length of data + @param[out] readBytes - number of bytes read + + @retval int returns kSTkErrOk on success, or kSTkErrFail code + + */ + virtual sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0; + }; //}; diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index 0f994be..415c127 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -155,6 +155,27 @@ sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *dat return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk; } +//--------------------------------------------------------------------------------- +// write16BitRegisterRegion() +// +// Writes an array of bytes to a given 16-bit register on the target address +// +// Returns the number of bytes written, < 0 is an error +// +sfeTkError_t sfeTkArdI2C::write16BitRegisterRegion(uint16_t devReg, const uint8_t *data, size_t length) +{ + if (!_i2cPort) + return kSTkErrBusNotInit; + + _i2cPort->beginTransmission(address()); + _i2cPort->write((devReg >> 8) & 0xff); + _i2cPort->write(devReg & 0xff); + _i2cPort->write(data, (int)length); + + return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk; +} + + //--------------------------------------------------------------------------------- // readRegisterByte() // @@ -269,3 +290,71 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size return (readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success } + + + + +//--------------------------------------------------------------------------------- +// read16BitRegisterRegion() +// +// Reads an array of bytes to a given 16-bit register on the target address +// +// Returns the number of bytes read, < 0 is an error +// +sfeTkError_t sfeTkArdI2C::read16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) +{ + + // got port + if (!_i2cPort) + return kSTkErrBusNotInit; + + // Buffer valid? + if (!data) + return kSTkErrBusNullBuffer; + + readBytes = 0; + + uint16_t nOrig = numBytes; // original number of bytes. + uint8_t nChunk; + uint16_t nReturned; + uint16_t i; // counter in loop + bool bFirstInter = true; // Flag for first iteration - used to send devRegister + + while (numBytes > 0) + { + if (bFirstInter) + { + _i2cPort->beginTransmission(address()); + + _i2cPort->write((devReg >> 8) & 0xff); + _i2cPort->write(devReg & 0xff); + + if (_i2cPort->endTransmission(stop()) != 0) + return kSTkErrFail; // error with the end transmission + + bFirstInter = false; + } + + // We're chunking in data - keeping the max chunk to kMaxI2CBufferLength + nChunk = numBytes > _bufferChunkSize ? _bufferChunkSize : numBytes; + + // Request the bytes. If this is the last chunk, always send a stop + nReturned = _i2cPort->requestFrom((int)address(), (int)nChunk, (int)(nChunk == numBytes ? true : stop())); + + // No data returned, no dice + if (nReturned == 0) + return kSTkErrBusUnderRead; // error + + // Copy the retrieved data chunk to the current index in the data segment + for (i = 0; i < nReturned; i++) + *data++ = _i2cPort->read(); + + // Decrement the amount of data received from the overall data request amount + numBytes = numBytes - nReturned; + + } // end while + + readBytes = nOrig - numBytes; // Bytes read. + + return (readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success +} \ No newline at end of file diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index 69e488d..cf91d7e 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -137,6 +137,19 @@ class sfeTkArdI2C : public sfeTkII2C */ virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length); + /*-------------------------------------------------------------------------- + @brief Writes a number of bytes starting at the given register's 16-bit address. + + @param devAddr The device's 16-bit address/pin + param devReg The device's register's address. + @param data Data to write. + + @retval sfeTkError_t kSTkErrOk on successful execution + + */ + sfeTkError_t write16BitRegisterRegion(uint16_t devReg, const uint8_t *data, size_t length); + + /*-------------------------------------------------------------------------- @brief Reads a byte of data from the given register. @@ -177,6 +190,19 @@ class sfeTkArdI2C : public sfeTkII2C */ sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes); + /*-------------------------------------------------------------------------- + @brief Reads a block of data from the given 16-bit register address. + + @param reg The device's 16 bit register's address. + @param data Data to write. + @param numBytes - length of data + @param[out] readBytes - number of bytes read + + @retval int returns kSTkErrOk on success, or kSTkErrFail code + + */ + sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes); + // Buffer size chunk getter/setter /*-------------------------------------------------------------------------- @brief set the buffer chunk size From 97df40d1921a49ebe77d491374b94f3f0101c6a6 Mon Sep 17 00:00:00 2001 From: MadisonC-SparkFun Date: Thu, 18 Jan 2024 15:41:07 -0700 Subject: [PATCH 017/138] Updated 16bit register support with functional code All code is now corrected and has no errors --- src/sfeTk/sfeTkIBus.h | 2 +- src/sfeTkArdI2C.cpp | 18 ++++++++++++++---- src/sfeTkArdI2C.h | 2 +- 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index 803f9be..96512c6 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -150,7 +150,7 @@ class sfeTkIBus @retval int returns kSTkErrOk on success, or kSTkErrFail code */ - virtual sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0; + virtual sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t *readBytes = nullptr) = 0; }; diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index 415c127..c74f434 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -301,7 +301,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size // // Returns the number of bytes read, < 0 is an error // -sfeTkError_t sfeTkArdI2C::read16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) +sfeTkError_t sfeTkArdI2C::read16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes) { // got port @@ -312,7 +312,10 @@ sfeTkError_t sfeTkArdI2C::read16BitRegisterRegion(uint16_t devReg, uint8_t *data if (!data) return kSTkErrBusNullBuffer; - readBytes = 0; + if(readBytes != nullptr) + { + readBytes = 0; + } uint16_t nOrig = numBytes; // original number of bytes. uint8_t nChunk; @@ -354,7 +357,14 @@ sfeTkError_t sfeTkArdI2C::read16BitRegisterRegion(uint16_t devReg, uint8_t *data } // end while - readBytes = nOrig - numBytes; // Bytes read. + if(readBytes != nullptr) + { + *readBytes = nOrig - numBytes; // Bytes read. - return (readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success + return (*readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success + } + else + { + return (numBytes == 0) ? kSTkErrOk : kSTkErrBusUnderRead; // Success + } } \ No newline at end of file diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index cf91d7e..f7801ab 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -201,7 +201,7 @@ class sfeTkArdI2C : public sfeTkII2C @retval int returns kSTkErrOk on success, or kSTkErrFail code */ - sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes); + sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t *readBytes = nullptr); // Buffer size chunk getter/setter /*-------------------------------------------------------------------------- From 22419bbbbaa2dc0bb94cfe747101a3c713db7d62 Mon Sep 17 00:00:00 2001 From: MadisonC-SparkFun Date: Mon, 29 Jan 2024 14:04:23 -0700 Subject: [PATCH 018/138] Adjusted files for correct write operation write16BitRegisterRegion() has been adjusted to write bits to the register in the correct endianness --- src/sfeTk/sfeTkIBus.h | 2 +- src/sfeTkArdI2C.cpp | 9 +++++---- src/sfeTkArdI2C.h | 2 +- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index 96512c6..883132c 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -101,7 +101,7 @@ class sfeTkIBus @retval sfeTkError_t kSTkErrOk on successful execution */ - virtual sfeTkError_t write16BitRegisterRegion(uint16_t devReg, const uint8_t *data, size_t length) = 0; + virtual sfeTkError_t write16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t length) = 0; /*-------------------------------------------------------------------------- diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index c74f434..15c3d1c 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -162,20 +162,21 @@ sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *dat // // Returns the number of bytes written, < 0 is an error // -sfeTkError_t sfeTkArdI2C::write16BitRegisterRegion(uint16_t devReg, const uint8_t *data, size_t length) +sfeTkError_t sfeTkArdI2C::write16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t length) { if (!_i2cPort) return kSTkErrBusNotInit; - _i2cPort->beginTransmission(address()); _i2cPort->write((devReg >> 8) & 0xff); _i2cPort->write(devReg & 0xff); - _i2cPort->write(data, (int)length); + for(int i = 0; i < length; i++) + { + _i2cPort->write(data[i]); + } return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk; } - //--------------------------------------------------------------------------------- // readRegisterByte() // diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index f7801ab..fe82bfc 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -147,7 +147,7 @@ class sfeTkArdI2C : public sfeTkII2C @retval sfeTkError_t kSTkErrOk on successful execution */ - sfeTkError_t write16BitRegisterRegion(uint16_t devReg, const uint8_t *data, size_t length); + sfeTkError_t write16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t length); /*-------------------------------------------------------------------------- From a76ebbb9ca14455a808b694e5b1605ba230bebcf Mon Sep 17 00:00:00 2001 From: MadisonC-SparkFun Date: Wed, 31 Jan 2024 14:41:10 -0700 Subject: [PATCH 019/138] Changed name of 16 bit register region as per kirk's request --- src/sfeTk/sfeTkIBus.h | 4 ++-- src/sfeTkArdI2C.cpp | 7 +++++-- src/sfeTkArdI2C.h | 4 ++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index 883132c..17bb400 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -101,7 +101,7 @@ class sfeTkIBus @retval sfeTkError_t kSTkErrOk on successful execution */ - virtual sfeTkError_t write16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t length) = 0; + virtual sfeTkError_t writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) = 0; /*-------------------------------------------------------------------------- @@ -150,7 +150,7 @@ class sfeTkIBus @retval int returns kSTkErrOk on success, or kSTkErrFail code */ - virtual sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t *readBytes = nullptr) = 0; + virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t *readBytes = nullptr) = 0; }; diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index 15c3d1c..a75b6ea 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -162,7 +162,9 @@ sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *dat // // Returns the number of bytes written, < 0 is an error // -sfeTkError_t sfeTkArdI2C::write16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t length) +//sfeTkError_t sfeTkArdI2C::write16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t length) +sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) + { if (!_i2cPort) return kSTkErrBusNotInit; @@ -302,7 +304,8 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size // // Returns the number of bytes read, < 0 is an error // -sfeTkError_t sfeTkArdI2C::read16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes) +//sfeTkError_t sfeTkArdI2C::read16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes) +sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes) { // got port diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index fe82bfc..92093ee 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -147,7 +147,7 @@ class sfeTkArdI2C : public sfeTkII2C @retval sfeTkError_t kSTkErrOk on successful execution */ - sfeTkError_t write16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t length); + sfeTkError_t writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length); /*-------------------------------------------------------------------------- @@ -201,7 +201,7 @@ class sfeTkArdI2C : public sfeTkII2C @retval int returns kSTkErrOk on success, or kSTkErrFail code */ - sfeTkError_t read16BitRegisterRegion(uint16_t reg, uint8_t *data, size_t numBytes, size_t *readBytes = nullptr); + sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t *readBytes = nullptr); // Buffer size chunk getter/setter /*-------------------------------------------------------------------------- From 861c89a73e110692d5855559ad2ccbd8a4b63fa9 Mon Sep 17 00:00:00 2001 From: MadisonC-SparkFun Date: Thu, 1 Feb 2024 11:56:27 -0700 Subject: [PATCH 020/138] Operational code for 16bit registers Need to clean up a bit, but the code is now functional and able to read/write to the proper registers with the proper data. --- src/sfeTk/sfeTkIBus.h | 2 +- src/sfeTkArdI2C.cpp | 228 +++++++++++++++++------------------------- src/sfeTkArdI2C.h | 8 +- 3 files changed, 98 insertions(+), 140 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index 17bb400..6158f53 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -150,7 +150,7 @@ class sfeTkIBus @retval int returns kSTkErrOk on success, or kSTkErrFail code */ - virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t *readBytes = nullptr) = 0; + virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes) = 0; }; diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index a75b6ea..0a1a2c9 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -136,108 +136,58 @@ sfeTkError_t sfeTkArdI2C::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite return writeRegisterRegion(devReg, (uint8_t *)&dataToWrite, sizeof(uint16_t)); } -//--------------------------------------------------------------------------------- -// writeRegisterRegion() -// -// Writes an array of bytes to a given register on the target address -// -// Returns the number of bytes written, < 0 is an error -// -sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) +sfeTkError_t sfeTkArdI2C::writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length) { if (!_i2cPort) return kSTkErrBusNotInit; _i2cPort->beginTransmission(address()); - _i2cPort->write(devReg); + _i2cPort->write(devReg, regLength); _i2cPort->write(data, (int)length); return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk; } //--------------------------------------------------------------------------------- -// write16BitRegisterRegion() +// writeRegisterRegion() // -// Writes an array of bytes to a given 16-bit register on the target address +// Writes an array of bytes to a given register on the target address // // Returns the number of bytes written, < 0 is an error // -//sfeTkError_t sfeTkArdI2C::write16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t length) -sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) - +sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) { - if (!_i2cPort) - return kSTkErrBusNotInit; - _i2cPort->beginTransmission(address()); - _i2cPort->write((devReg >> 8) & 0xff); - _i2cPort->write(devReg & 0xff); - for(int i = 0; i < length; i++) - { - _i2cPort->write(data[i]); - } - - return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk; + return writeRegisterRegionAddress(&devReg, 1, data, length); } //--------------------------------------------------------------------------------- -// readRegisterByte() +// write16BitRegisterRegion() // -// Reads a byte to a given register. +// Writes an array of bytes to a given 16-bit register on the target address // -// Returns true on success, false on failure +// Returns the number of bytes written, < 0 is an error // -sfeTkError_t sfeTkArdI2C::readRegisterByte(uint8_t devReg, uint8_t &dataToRead) -{ - if (!_i2cPort) - return kSTkErrBusNotInit; - - // Return value - uint8_t result = 0; - - int nData = 0; - - _i2cPort->beginTransmission(address()); - _i2cPort->write(devReg); - _i2cPort->endTransmission(stop()); - _i2cPort->requestFrom(address(), (uint8_t)1); - - while (_i2cPort->available()) // slave may send less than requested - { - result = _i2cPort->read(); // receive a byte as a proper uint8_t - nData++; - } - - if (nData == sizeof(uint8_t)) // Only update outputPointer if a single byte was returned - dataToRead = result; +// sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) +// { +// if (!_i2cPort) +// return kSTkErrBusNotInit; +// _i2cPort->beginTransmission(address()); +// _i2cPort->write((devReg >> 8) & 0xff); +// _i2cPort->write(devReg & 0xff); +// for(int i = 0; i < length; i++) +// { +// _i2cPort->write(data[i]); +// } +// return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk; +// } - return (nData == sizeof(uint8_t) ? kSTkErrOk : kSTkErrFail); -} -//--------------------------------------------------------------------------------- -// readRegisterWord() -// -// Reads a world to a given register. -// -// Returns true on success, false on failure -// -sfeTkError_t sfeTkArdI2C::readRegisterWord(uint8_t devReg, uint16_t &dataToRead) +sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) { - if (!_i2cPort) - return kSTkErrBusNotInit; - - size_t nRead; - sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&dataToRead, sizeof(uint16_t), nRead); - - return (retval == kSTkErrOk && nRead == sizeof(uint16_t) ? kSTkErrOk : retval); + devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff); + return writeRegisterRegionAddress((uint8_t*)&devReg, 2, data, length); } -//--------------------------------------------------------------------------------- -// readRegisterRegion() -// -// Reads an array of bytes to a given register on the target address -// -// Returns the number of bytes read, < 0 is an error -// -sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) +sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes) { // got port @@ -262,7 +212,10 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size { _i2cPort->beginTransmission(address()); - _i2cPort->write(devReg); + // uint16_t *foo = (uint16_t*)devReg; + // _i2cPort->write((*foo >> 8) & 0xff); + // _i2cPort->write(*foo & 0xff); + _i2cPort->write(devReg, regLength); if (_i2cPort->endTransmission(stop()) != 0) return kSTkErrFail; // error with the end transmission @@ -295,80 +248,81 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size } - - //--------------------------------------------------------------------------------- -// read16BitRegisterRegion() +// readRegisterByte() // -// Reads an array of bytes to a given 16-bit register on the target address +// Reads a byte to a given register. // -// Returns the number of bytes read, < 0 is an error +// Returns true on success, false on failure // -//sfeTkError_t sfeTkArdI2C::read16BitRegisterRegion(uint16_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes) -sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, size_t numBytes, size_t *readBytes) +sfeTkError_t sfeTkArdI2C::readRegisterByte(uint8_t devReg, uint8_t &dataToRead) { - - // got port if (!_i2cPort) return kSTkErrBusNotInit; - // Buffer valid? - if (!data) - return kSTkErrBusNullBuffer; - - if(readBytes != nullptr) - { - readBytes = 0; - } - - uint16_t nOrig = numBytes; // original number of bytes. - uint8_t nChunk; - uint16_t nReturned; - uint16_t i; // counter in loop - bool bFirstInter = true; // Flag for first iteration - used to send devRegister - - while (numBytes > 0) - { - if (bFirstInter) - { - _i2cPort->beginTransmission(address()); - - _i2cPort->write((devReg >> 8) & 0xff); - _i2cPort->write(devReg & 0xff); - - if (_i2cPort->endTransmission(stop()) != 0) - return kSTkErrFail; // error with the end transmission + // Return value + uint8_t result = 0; - bFirstInter = false; - } + int nData = 0; - // We're chunking in data - keeping the max chunk to kMaxI2CBufferLength - nChunk = numBytes > _bufferChunkSize ? _bufferChunkSize : numBytes; + _i2cPort->beginTransmission(address()); + _i2cPort->write(devReg); + _i2cPort->endTransmission(stop()); + _i2cPort->requestFrom(address(), (uint8_t)1); - // Request the bytes. If this is the last chunk, always send a stop - nReturned = _i2cPort->requestFrom((int)address(), (int)nChunk, (int)(nChunk == numBytes ? true : stop())); + while (_i2cPort->available()) // slave may send less than requested + { + result = _i2cPort->read(); // receive a byte as a proper uint8_t + nData++; + } - // No data returned, no dice - if (nReturned == 0) - return kSTkErrBusUnderRead; // error + if (nData == sizeof(uint8_t)) // Only update outputPointer if a single byte was returned + dataToRead = result; - // Copy the retrieved data chunk to the current index in the data segment - for (i = 0; i < nReturned; i++) - *data++ = _i2cPort->read(); + return (nData == sizeof(uint8_t) ? kSTkErrOk : kSTkErrFail); +} +//--------------------------------------------------------------------------------- +// readRegisterWord() +// +// Reads a world to a given register. +// +// Returns true on success, false on failure +// +sfeTkError_t sfeTkArdI2C::readRegisterWord(uint8_t devReg, uint16_t &dataToRead) +{ + if (!_i2cPort) + return kSTkErrBusNotInit; - // Decrement the amount of data received from the overall data request amount - numBytes = numBytes - nReturned; + size_t nRead; + sfeTkError_t retval = readRegisterRegion(devReg, (uint8_t *)&dataToRead, sizeof(uint16_t), nRead); - } // end while + return (retval == kSTkErrOk && nRead == sizeof(uint16_t) ? kSTkErrOk : retval); +} - if(readBytes != nullptr) - { - *readBytes = nOrig - numBytes; // Bytes read. +//--------------------------------------------------------------------------------- +// readRegisterRegion() +// +// Reads an array of bytes to a given register on the target address +// +// Returns the number of bytes read, < 0 is an error +// +sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) +{ + return readRegisterRegionAnyAddress(&devReg, 1, data, numBytes, readBytes); +} - return (*readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success - } - else - { - return (numBytes == 0) ? kSTkErrOk : kSTkErrBusUnderRead; // Success - } -} \ No newline at end of file +//--------------------------------------------------------------------------------- +// read16BitRegisterRegion() +// +// Reads an array of bytes to a given 16-bit register on the target address +// +// Returns the number of bytes read, < 0 is an error +// +sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, size_t numBytes) +{ + size_t readBytes = 0; + devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff); +// _i2cPort->write((devReg >> 8) & 0xff); +// _i2cPort->write(devReg & 0xff); + return readRegisterRegionAnyAddress((uint8_t*)&devReg, 2, data, numBytes, readBytes); +} diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index 92093ee..056a9e2 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -200,8 +200,8 @@ class sfeTkArdI2C : public sfeTkII2C @retval int returns kSTkErrOk on success, or kSTkErrFail code - */ - sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t *readBytes = nullptr); + */ + sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes); // Buffer size chunk getter/setter /*-------------------------------------------------------------------------- @@ -237,6 +237,10 @@ class sfeTkArdI2C : public sfeTkII2C TwoWire *_i2cPort; private: +sfeTkError_t writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length); + +sfeTkError_t readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes); + static constexpr size_t kDefaultBufferChunk = 32; // the I2C buffer chunker size From ef8752bffcb25b15bb6d87799a3b06c29f2f02c0 Mon Sep 17 00:00:00 2001 From: "Ho Yun \"Bobby" Date: Thu, 1 Feb 2024 14:02:27 -0700 Subject: [PATCH 021/138] Update README.md Typo =) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 215c435..7ecf264 100644 --- a/README.md +++ b/README.md @@ -26,4 +26,4 @@ The SparkFun Toolkit is available as a *Beta* release, with the intent of testin ||| |---|---| -|[Bus Implementation](docs/ar_ibus.md) | The architecture and use of the Tookkit Communication Bus Interface +|[Bus Implementation](docs/ar_ibus.md) | The architecture and use of the Toolkit Communication Bus Interface From d68bc1e2ef1e024c14b9059831eab19df5722ac0 Mon Sep 17 00:00:00 2001 From: MadisonC-SparkFun Date: Thu, 1 Feb 2024 14:40:46 -0700 Subject: [PATCH 022/138] Cleaned up comments Cleaned up the comments by deleting the saved, unneeded code; added comments for new functions --- src/sfeTkArdI2C.cpp | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index 0a1a2c9..cdfb221 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -124,7 +124,7 @@ sfeTkError_t sfeTkArdI2C::writeRegisterByte(uint8_t devReg, uint8_t dataToWrite) //--------------------------------------------------------------------------------- // writeRegisterWord() // -// Writes a world to a given register. +// Writes a word to a given register. // // Returns true on success, false on failure // @@ -136,6 +136,14 @@ sfeTkError_t sfeTkArdI2C::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite return writeRegisterRegion(devReg, (uint8_t *)&dataToWrite, sizeof(uint16_t)); } +//--------------------------------------------------------------------------------- +// writeRegisterRegionAddress() +// +// Writes an array of bytes of specified length to a given register on the +// target address +// +// Returns the number of bytes written, < 0 is an error +// sfeTkError_t sfeTkArdI2C::writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length) { if (!_i2cPort) @@ -167,26 +175,19 @@ sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *dat // // Returns the number of bytes written, < 0 is an error // -// sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) -// { -// if (!_i2cPort) -// return kSTkErrBusNotInit; -// _i2cPort->beginTransmission(address()); -// _i2cPort->write((devReg >> 8) & 0xff); -// _i2cPort->write(devReg & 0xff); -// for(int i = 0; i < length; i++) -// { -// _i2cPort->write(data[i]); -// } -// return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk; -// } - sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) { devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff); return writeRegisterRegionAddress((uint8_t*)&devReg, 2, data, length); } +//--------------------------------------------------------------------------------- +// readRegisterRegionAnyAddress() +// +// Reads an array of bytes to a register on the target address +// +// Returns the number of bytes written, < 0 is an error +// sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes) { @@ -281,10 +282,11 @@ sfeTkError_t sfeTkArdI2C::readRegisterByte(uint8_t devReg, uint8_t &dataToRead) return (nData == sizeof(uint8_t) ? kSTkErrOk : kSTkErrFail); } + //--------------------------------------------------------------------------------- // readRegisterWord() // -// Reads a world to a given register. +// Reads a word to a given register. // // Returns true on success, false on failure // @@ -321,8 +323,6 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, size_t numBytes) { size_t readBytes = 0; - devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff); -// _i2cPort->write((devReg >> 8) & 0xff); -// _i2cPort->write(devReg & 0xff); + devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff); return readRegisterRegionAnyAddress((uint8_t*)&devReg, 2, data, numBytes, readBytes); } From f6e5ca9cdee20e570a325841fc37eb9fbb8f1bde Mon Sep 17 00:00:00 2001 From: MadisonC-SparkFun Date: Wed, 28 Feb 2024 11:04:16 -0700 Subject: [PATCH 023/138] Added SPI implementation for 16-bit register address support Copied over Kirk's code for the SPI 16-bit address register read and write --- src/sfeTkArdSPI.cpp | 56 +++++++++++++++++++++++++++++++++++++++++++++ src/sfeTkArdSPI.h | 25 ++++++++++++++++++++ 2 files changed, 81 insertions(+) diff --git a/src/sfeTkArdSPI.cpp b/src/sfeTkArdSPI.cpp index 62f91c8..15fcd60 100644 --- a/src/sfeTkArdSPI.cpp +++ b/src/sfeTkArdSPI.cpp @@ -176,6 +176,29 @@ sfeTkError_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *dat return kSTkErrOk; } +// 16 bit address version ... +sfeTkError_t sfeTkArdSPI::writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length) +{ + if (!_spiPort) + return kSTkErrBusNotInit; + + // Apply settings before work + _spiPort->beginTransaction(_sfeSPISettings); + + // Signal communication start + digitalWrite(cs(), LOW); + _spiPort->transfer16(devReg); + + for (size_t i = 0; i < length; i++) + _spiPort->transfer(*data++); + + // End communication + digitalWrite(cs(), HIGH); + _spiPort->endTransaction(); + + return kSTkErrOk; +} + sfeTkError_t sfeTkArdSPI::readRegisterByte(uint8_t devReg, uint8_t &data) { size_t nRead; @@ -223,3 +246,36 @@ sfeTkError_t sfeTkArdSPI::readRegisterRegion(uint8_t devReg, uint8_t *data, size return kSTkErrOk; } + +//--------------------------------------------------------------------------------- +// readRegister16Region() +// +// Reads an array of bytes to a given a 16 bit register on the target address +// +// Returns kSTkErrOk on success +// +sfeTkError_t sfeTkArdSPI::readRegister16Region(uint16_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) +{ + if (!_spiPort) + return kSTkErrBusNotInit; + + // Apply settings + _spiPort->beginTransaction(_sfeSPISettings); + + // Signal communication start + digitalWrite(cs(), LOW); + + // A leading "1" must be added to transfer with devRegister to indicate a "read" + _spiPort->transfer16(devReg | kSPIReadBit); + + for (size_t i = 0; i < numBytes; i++) + *data++ = _spiPort->transfer(0x00); + + // End transaction + digitalWrite(cs(), HIGH); + _spiPort->endTransaction(); + + readBytes = numBytes; + + return kSTkErrOk; +} \ No newline at end of file diff --git a/src/sfeTkArdSPI.h b/src/sfeTkArdSPI.h index f386cc2..a7d6628 100644 --- a/src/sfeTkArdSPI.h +++ b/src/sfeTkArdSPI.h @@ -122,6 +122,17 @@ class sfeTkArdSPI : public sfeTkISPI */ virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length); + /*-------------------------------------------------------------------------- + @brief Writes a number of bytes starting at the given register's address. + @note This method is virtual to allow it to be overridden to support a device that requires a unique impl + + @param devReg The device's register's address. + @param data Data to write. + + @retval sfeTkError_t - kSTkErrOk on success + */ + virtual sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length); + /*-------------------------------------------------------------------------- @brief Read a single byte from the given register @@ -155,6 +166,20 @@ class sfeTkArdSPI : public sfeTkISPI */ virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes); + /*-------------------------------------------------------------------------- + @brief Reads a block of data from the given register. + @note This method is virtual to allow it to be overridden to support a device that requires a unique impl + + @param devReg The device's register's 16 bit address. + @param data Data to write. + @param numBytes - length of data + @param[out] readBytes - Number of bytes read + + @retval sfeTkError_t - true on success + */ + virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes); + + protected: // note: The instance data is protected, allowing access if a sub-class is // created to implement a special read/write routine From 0adf92227be286d28535d68515d3941932b0cb24 Mon Sep 17 00:00:00 2001 From: MadisonC-SparkFun Date: Wed, 28 Feb 2024 15:35:27 -0700 Subject: [PATCH 024/138] Deleted unneeded code; formatted code correctly Made small adjustments as per the PR comments --- src/sfeTkArdI2C.cpp | 3 --- src/sfeTkArdI2C.h | 4 ++-- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index cdfb221..e293832 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -213,9 +213,6 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t r { _i2cPort->beginTransmission(address()); - // uint16_t *foo = (uint16_t*)devReg; - // _i2cPort->write((*foo >> 8) & 0xff); - // _i2cPort->write(*foo & 0xff); _i2cPort->write(devReg, regLength); if (_i2cPort->endTransmission(stop()) != 0) diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index 056a9e2..4c2d4d6 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -237,9 +237,9 @@ class sfeTkArdI2C : public sfeTkII2C TwoWire *_i2cPort; private: -sfeTkError_t writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length); + sfeTkError_t writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length); -sfeTkError_t readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes); + sfeTkError_t readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes); static constexpr size_t kDefaultBufferChunk = 32; From 15dbb5ff0848864ed9688bd9b10df18f5c1f1d08 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Fri, 15 Mar 2024 14:33:13 -0600 Subject: [PATCH 025/138] type cleanups and API fixes to make sure toolkit compiles --- src/sfeTk/sfeTkIBus.h | 7 ++----- src/sfeTkArdI2C.cpp | 22 +++++++++++----------- src/sfeTkArdI2C.h | 12 ++++++------ src/sfeTkArdSPI.h | 5 ++--- 4 files changed, 21 insertions(+), 25 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index 6158f53..f30e89a 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -78,7 +78,6 @@ class sfeTkIBus */ virtual sfeTkError_t writeRegisterWord(uint8_t devReg, uint16_t data) = 0; - /*-------------------------------------------------------------------------- @brief Writes a number of bytes starting at the given register's address. @@ -101,8 +100,7 @@ class sfeTkIBus @retval sfeTkError_t kSTkErrOk on successful execution */ - virtual sfeTkError_t writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) = 0; - + virtual sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length) = 0; /*-------------------------------------------------------------------------- @brief Read a single byte from the given register @@ -150,8 +148,7 @@ class sfeTkIBus @retval int returns kSTkErrOk on success, or kSTkErrFail code */ - virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes) = 0; - + virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0; }; //}; diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index e293832..60f1702 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -139,12 +139,13 @@ sfeTkError_t sfeTkArdI2C::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite //--------------------------------------------------------------------------------- // writeRegisterRegionAddress() // -// Writes an array of bytes of specified length to a given register on the +// Writes an array of bytes of specified length to a given register on the // target address // // Returns the number of bytes written, < 0 is an error // -sfeTkError_t sfeTkArdI2C::writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length) +sfeTkError_t sfeTkArdI2C::writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, + size_t length) { if (!_i2cPort) return kSTkErrBusNotInit; @@ -175,10 +176,10 @@ sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *dat // // Returns the number of bytes written, < 0 is an error // -sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length) +sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length) { devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff); - return writeRegisterRegionAddress((uint8_t*)&devReg, 2, data, length); + return writeRegisterRegionAddress((uint8_t *)&devReg, 2, data, length); } //--------------------------------------------------------------------------------- @@ -188,7 +189,8 @@ sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, uint8_t *data, // // Returns the number of bytes written, < 0 is an error // -sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes) +sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, + size_t numBytes, size_t &readBytes) { // got port @@ -198,7 +200,7 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t r // Buffer valid? if (!data) return kSTkErrBusNullBuffer; - + readBytes = 0; uint16_t nOrig = numBytes; // original number of bytes. @@ -245,7 +247,6 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t r return (readBytes == nOrig) ? kSTkErrOk : kSTkErrBusUnderRead; // Success } - //--------------------------------------------------------------------------------- // readRegisterByte() // @@ -317,9 +318,8 @@ sfeTkError_t sfeTkArdI2C::readRegisterRegion(uint8_t devReg, uint8_t *data, size // // Returns the number of bytes read, < 0 is an error // -sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, size_t numBytes) +sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, size_t numBytes, size_t &readBytes) { - size_t readBytes = 0; - devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff); - return readRegisterRegionAnyAddress((uint8_t*)&devReg, 2, data, numBytes, readBytes); + devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff); + return readRegisterRegionAnyAddress((uint8_t *)&devReg, 2, data, numBytes, readBytes); } diff --git a/src/sfeTkArdI2C.h b/src/sfeTkArdI2C.h index 4c2d4d6..8972295 100644 --- a/src/sfeTkArdI2C.h +++ b/src/sfeTkArdI2C.h @@ -135,7 +135,7 @@ class sfeTkArdI2C : public sfeTkII2C @retval kStkErrOk on success */ - virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length); + sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length); /*-------------------------------------------------------------------------- @brief Writes a number of bytes starting at the given register's 16-bit address. @@ -147,8 +147,7 @@ class sfeTkArdI2C : public sfeTkII2C @retval sfeTkError_t kSTkErrOk on successful execution */ - sfeTkError_t writeRegister16Region(uint16_t devReg, uint8_t *data, size_t length); - + sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length); /*-------------------------------------------------------------------------- @brief Reads a byte of data from the given register. @@ -200,8 +199,8 @@ class sfeTkArdI2C : public sfeTkII2C @retval int returns kSTkErrOk on success, or kSTkErrFail code - */ - sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes); + */ + sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes); // Buffer size chunk getter/setter /*-------------------------------------------------------------------------- @@ -239,7 +238,8 @@ class sfeTkArdI2C : public sfeTkII2C private: sfeTkError_t writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length); - sfeTkError_t readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes); + sfeTkError_t readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, + size_t &readBytes); static constexpr size_t kDefaultBufferChunk = 32; diff --git a/src/sfeTkArdSPI.h b/src/sfeTkArdSPI.h index a7d6628..64f1772 100644 --- a/src/sfeTkArdSPI.h +++ b/src/sfeTkArdSPI.h @@ -120,7 +120,7 @@ class sfeTkArdSPI : public sfeTkISPI @retval sfeTkError_t - kSTkErrOk on success */ - virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length); + sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length); /*-------------------------------------------------------------------------- @brief Writes a number of bytes starting at the given register's address. @@ -131,7 +131,7 @@ class sfeTkArdSPI : public sfeTkISPI @retval sfeTkError_t - kSTkErrOk on success */ - virtual sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length); + sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length); /*-------------------------------------------------------------------------- @brief Read a single byte from the given register @@ -179,7 +179,6 @@ class sfeTkArdSPI : public sfeTkISPI */ virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes); - protected: // note: The instance data is protected, allowing access if a sub-class is // created to implement a special read/write routine From 266057f3bda380032287bafd1ba809262c32d02f Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Fri, 15 Mar 2024 15:07:24 -0600 Subject: [PATCH 026/138] bump --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 9ffc27b..3269264 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=SparkFun Toolkit -version=0.9.0 +version=0.9.1 author=SparkFun Electronics maintainer=SparkFun Electronics sentence=A utility library that other SparkFun libraries can take advantage of. From 2e65cd41a4b3963557e38acecacc11f61acb420e Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Mon, 29 Apr 2024 06:15:51 -0600 Subject: [PATCH 027/138] some tweaks/flesh-out the comment headers --- src/sfeTk/sfeTkIBus.h | 1 + src/sfeTk/sfeTkII2C.h | 10 ++++++++++ 2 files changed, 11 insertions(+) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index f30e89a..144e50b 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -28,6 +28,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #pragma once #include "sfeTkError.h" +#include // Define our error codes for the bus. Note Errors are negative, warnings/info positive // BUT keep the same increment on the base diff --git a/src/sfeTk/sfeTkII2C.h b/src/sfeTk/sfeTkII2C.h index 676866c..c2b7a08 100644 --- a/src/sfeTk/sfeTkII2C.h +++ b/src/sfeTk/sfeTkII2C.h @@ -28,6 +28,12 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #include "sfeTkIBus.h" +/** + * @brief Interface that defines the I2C communication bus for the SparkFun Electronics Toolkit. + * + * The I2C bus interface extends the IBus interface and adds the ability to set and get the I2C + * address and stop flag. + */ class sfeTkII2C : public sfeTkIBus { public: @@ -72,6 +78,7 @@ class sfeTkII2C : public sfeTkIBus /*-------------------------------------------------------------------------- @brief setter for I2C stop message (vs restarts) + @param stop The value to set for "send stop" */ virtual void setStop(bool stop) { @@ -89,6 +96,9 @@ class sfeTkII2C : public sfeTkIBus return _stop; } + /* + * @brief kNoAddress is a constant to indicate no address has been set + */ static constexpr uint8_t kNoAddress = 0; private: From e8d3f14d843531ba05465e2643e1b57494478d63 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Mon, 29 Apr 2024 06:51:18 -0600 Subject: [PATCH 028/138] Add and edit doc comment blocks --- src/sfeTk/sfeTkIBus.h | 17 ++++++++++++----- src/sfeTk/sfeTkISPI.h | 22 ++++++++++++++++++++-- src/sfeTk/sfeToolkit.h | 5 +++-- src/sfeTkArdI2C.cpp | 34 ++++++++++++++++++++-------------- 4 files changed, 55 insertions(+), 23 deletions(-) diff --git a/src/sfeTk/sfeTkIBus.h b/src/sfeTk/sfeTkIBus.h index 144e50b..cc313cd 100644 --- a/src/sfeTk/sfeTkIBus.h +++ b/src/sfeTk/sfeTkIBus.h @@ -30,9 +30,11 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #include "sfeTkError.h" #include -// Define our error codes for the bus. Note Errors are negative, warnings/info positive -// BUT keep the same increment on the base - +/** + * @brief Define our error codes for the bus. Note Errors are negative, warnings/info positive, + * but keep the same increment on the base. + * + */ const sfeTkError_t kSTkErrBusNotInit = kSTkErrFail * (kSTkErrBaseBus + 1); const sfeTkError_t kSTkErrBusTimeout = kSTkErrFail * (kSTkErrBaseBus + 2); const sfeTkError_t kSTkErrBusNoResponse = kSTkErrFail * (kSTkErrBaseBus + 3); @@ -42,8 +44,13 @@ const sfeTkError_t kSTkErrBusNullBuffer = kSTkErrFail * (kSTkErrBaseBus + 6); const sfeTkError_t kSTkErrBusUnderRead = kSTkErrBaseBus + 7; const sfeTkError_t kSTkErrBusNotEnabled = kSTkErrBaseBus + 8; -// Define the bus interface. - +/** + * @brief Interface that defines the communication bus for the SparkFun Electronics Toolkit. + * + * The bus interface defines the basic methods for reading and writing data to a device. Specific + * bus implementations will extend this interface to provide the necessary functionality for the + * desired bus type. + */ class sfeTkIBus { public: diff --git a/src/sfeTk/sfeTkISPI.h b/src/sfeTk/sfeTkISPI.h index f0721d9..0660042 100644 --- a/src/sfeTk/sfeTkISPI.h +++ b/src/sfeTk/sfeTkISPI.h @@ -29,13 +29,28 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #include "sfeTkIBus.h" +/** + * @brief Interface that defines the SPI communication bus for the SparkFun Electronics Toolkit. + * + * The SPI bus interface extends the IBus interface and adds the ability to set and get the CS pin. + */ class sfeTkISPI : public sfeTkIBus { public: + /*-------------------------------------------------------------------------- + @brief Constructor for the SPI bus + + */ sfeTkISPI() : _cs{kNoCSPin} { } + /*-------------------------------------------------------------------------- + @brief Constructor for the SPI bus + + @param csPin The CS Pin for the device + + */ sfeTkISPI(uint8_t csPin) : _cs{csPin} { } @@ -53,15 +68,18 @@ class sfeTkISPI : public sfeTkIBus /*-------------------------------------------------------------------------- @brief getter for the cs pin - + @retval uint8_t returns the CS pin for the device - + */ virtual uint8_t cs(void) { return _cs; } + /*-------------------------------------------------------------------------- + @brief A constant for no CS pin + */ static constexpr uint8_t kNoCSPin = 0; private: diff --git a/src/sfeTk/sfeToolkit.h b/src/sfeTk/sfeToolkit.h index c517834..7d25a83 100644 --- a/src/sfeTk/sfeToolkit.h +++ b/src/sfeTk/sfeToolkit.h @@ -26,6 +26,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #pragma once -// Include key things that are core to the toolkit - +/* + @brief Common include file for the core of the SparkFun Electronics Toolkit +*/ #include "sfeTkError.h" diff --git a/src/sfeTkArdI2C.cpp b/src/sfeTkArdI2C.cpp index 60f1702..076807b 100644 --- a/src/sfeTkArdI2C.cpp +++ b/src/sfeTkArdI2C.cpp @@ -136,14 +136,15 @@ sfeTkError_t sfeTkArdI2C::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite return writeRegisterRegion(devReg, (uint8_t *)&dataToWrite, sizeof(uint16_t)); } -//--------------------------------------------------------------------------------- -// writeRegisterRegionAddress() -// -// Writes an array of bytes of specified length to a given register on the -// target address -// -// Returns the number of bytes written, < 0 is an error -// +/** + * @brief Writes an array of bytes to a register on the target address. Supports any address size + * + * @param devReg The device's register's address - can be any size + * @param regLength The length of the register address + * @param data The data to write + * @param length The length of the data buffer + * @return sfeTkError_t Returns kSTkErrOk on success, or kSTkErrFail code + */ sfeTkError_t sfeTkArdI2C::writeRegisterRegionAddress(uint8_t *devReg, size_t regLength, const uint8_t *data, size_t length) { @@ -183,12 +184,17 @@ sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, const uint8_t * } //--------------------------------------------------------------------------------- -// readRegisterRegionAnyAddress() -// -// Reads an array of bytes to a register on the target address -// -// Returns the number of bytes written, < 0 is an error -// + +/** + * @brief Reads an array of bytes to a register on the target address. Supports any address size + * + * @param devReg The device's register's address - can be any size + * @param regLength The length of the register address + * @param data The data to buffer to read into + * @param numBytes The length of the data buffer + * @param readBytes[out] The number of bytes read + * @return sfeTkError_t Returns kSTkErrOk on success, or kSTkErrFail code + */ sfeTkError_t sfeTkArdI2C::readRegisterRegionAnyAddress(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes) { From d702c0c620a9619f4ff55ac4a95e4b1f09d90ec2 Mon Sep 17 00:00:00 2001 From: Kirk Benell Date: Mon, 29 Apr 2024 13:59:03 -0600 Subject: [PATCH 029/138] Core of Doxygen support working Generates core site - building manually. Generating SDK/API docs. --- .gitignore | 2 + .gitmodules | 3 + docs/doxygen/doxygen-awesome-css | 1 + docs/doxygen/doxygen-config | 2818 +++++++++++++++++++++++ docs/doxygen/doxygen-custom/custom.css | 21 + docs/doxygen/doxygen-custom/header.html | 123 + docs/images/sfe_flame.png | Bin 0 -> 3832 bytes src/sfeTk/sfeTkError.h | 47 +- src/sfeTk/sfeTkIBus.h | 203 +- src/sfeTk/sfeTkII2C.h | 20 +- src/sfeTk/sfeTkISPI.h | 11 +- src/sfeTk/sfeToolkit.h | 2 +- src/sfeTkArdI2C.h | 53 +- src/sfeTkArdSPI.h | 49 +- 14 files changed, 3197 insertions(+), 156 deletions(-) create mode 100644 .gitmodules create mode 160000 docs/doxygen/doxygen-awesome-css create mode 100644 docs/doxygen/doxygen-config create mode 100644 docs/doxygen/doxygen-custom/custom.css create mode 100644 docs/doxygen/doxygen-custom/header.html create mode 100644 docs/images/sfe_flame.png diff --git a/.gitignore b/.gitignore index 737bcf8..d77645c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ # VSCode directories .vscode + +docs/html/ diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..a8d0052 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "docs/doxygen/doxygen-awesome-css"] + path = docs/doxygen/doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/docs/doxygen/doxygen-awesome-css b/docs/doxygen/doxygen-awesome-css new file mode 160000 index 0000000..9f97817 --- /dev/null +++ b/docs/doxygen/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit 9f97817e703aa2c15503067b2a72c97f9d37f46e diff --git a/docs/doxygen/doxygen-config b/docs/doxygen/doxygen-config new file mode 100644 index 0000000..7883c5a --- /dev/null +++ b/docs/doxygen/doxygen-config @@ -0,0 +1,2818 @@ +# Doxyfile 1.10.0 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "SparkFun Toolkit" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Common Library Functionality" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = ./docs/images/sfe_flame.png + +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./docs + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = src \ + README.md \ + docs + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, +# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to +# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.h \ + *.hpp \ + *.markdown \ + *.md \ + *.dox + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = docs/doxygen \ + docs/html + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = docs/images + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# multi-line macros, enums or list initialized variables directly into the +# documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = ./docs/doxygen/doxygen-custom/header.html + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = docs/doxygen/doxygen-awesome-css/doxygen-awesome.css \ + docs/doxygen/doxygen-awesome-css/doxygen-awesome-sidebar-only.css \ + docs/doxygen/doxygen-custom/custom.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 209 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 255 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 113 + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 12 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 350 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /