Skip to content

merge. #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 7, 2023
Merged

merge. #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/sfeTk/sfeTkIBus.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,10 @@ class sfeTkIBus
param devReg The device's register's address.
@param data Data to write.

@retval int returns the number of bytes written, or kSTkErrFail on error
@retval sfeTkError_t kSTkErrOk on successful execution

*/
virtual int32_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) = 0;
virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) = 0;

/*--------------------------------------------------------------------------
@brief Read a single byte from the given register
Expand Down
4 changes: 2 additions & 2 deletions src/sfeTkArdI2C.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ sfeTkError_t sfeTkArdI2C::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite
//
// Returns the number of bytes written, < 0 is an error
//
int32_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length)
sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length)
{
if (!_i2cPort)
return kSTkErrBusNullPtr;
Expand All @@ -135,7 +135,7 @@ int32_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *data, si
_i2cPort->write(devReg);
_i2cPort->write(data, (int)length);

return _i2cPort->endTransmission() ? length : kSTkErrOk;
return _i2cPort->endTransmission() ? kSTkErrFail : kSTkErrOk;
}

//---------------------------------------------------------------------------------
Expand Down
12 changes: 6 additions & 6 deletions src/sfeTkArdI2C.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ class sfeTkArdI2C : public sfeTkII2C
@param devReg The device's register's address.
@param data Data to write.

@retval returns on error on success
@retval returns kStkErrOk on success
*/
sfeTkError_t writeRegisterByte(uint8_t devReg, uint8_t data);

Expand All @@ -110,7 +110,7 @@ class sfeTkArdI2C : public sfeTkII2C
@param devReg The device's register's address.
@param data Data to write.

@retval returns on error on success
@retval returns kStkErrOk on success
*/
sfeTkError_t writeRegisterWord(uint8_t devReg, uint16_t data);

Expand All @@ -123,9 +123,9 @@ class sfeTkArdI2C : public sfeTkII2C
@param devReg The device's register's address.
@param data Data to write.

@retval returns number of bytes written, < 0 is an error code
@retval kStkErrOk on success
*/
virtual int32_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);
virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);

/*--------------------------------------------------------------------------
@brief Reads a byte of data from the given register.
Expand All @@ -135,7 +135,7 @@ class sfeTkArdI2C : public sfeTkII2C
@param devReg The device's register's address.
@param data Data to read.

@retval on error on success
@retval kStkErrOk on success
*/
sfeTkError_t readRegisterByte(uint8_t devReg, uint8_t &data);

Expand All @@ -160,7 +160,7 @@ class sfeTkArdI2C : public sfeTkII2C
@param devReg The device's register's address.
@param data Data to write.

@retval 0 on success, < 0 on error - see error code
@retval kStkErrOk on success
*/
sfeTkError_t readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes);

Expand Down
12 changes: 6 additions & 6 deletions src/sfeTkArdSPI.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ sfeTkError_t sfeTkArdSPI::init(bool bInit)
//
// Writes a byte to a given register.
//
// Returns true on success, false on failure
// Returns kSTkErrOk on success
//
sfeTkError_t sfeTkArdSPI::writeRegisterByte(uint8_t devReg, uint8_t dataToWrite)
{
Expand All @@ -113,7 +113,7 @@ sfeTkError_t sfeTkArdSPI::writeRegisterByte(uint8_t devReg, uint8_t dataToWrite)
//
// Writes a world to a given register.
//
// Returns true on success, false on failure
// Returns kSTkErrOk on success
//
sfeTkError_t sfeTkArdSPI::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite)
{
Expand All @@ -124,9 +124,9 @@ sfeTkError_t sfeTkArdSPI::writeRegisterWord(uint8_t devReg, uint16_t dataToWrite
//
// Writes an array of bytes to a given register on the target address
//
// Returns the number of bytes written, < 0 is an error
// Returns kSTkErrOk on success
//
int32_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length)
sfeTkError_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length)
{
if (!_spiPort)
return kSTkErrBusNullPtr;
Expand All @@ -145,7 +145,7 @@ int32_t sfeTkArdSPI::writeRegisterRegion(uint8_t devReg, const uint8_t *data, si
digitalWrite(cs(), HIGH);
_spiPort->endTransaction();

return length;
return kSTkErrOk;
}

sfeTkError_t sfeTkArdSPI::readRegisterByte(uint8_t devReg, uint8_t &data)
Expand All @@ -162,7 +162,7 @@ sfeTkError_t sfeTkArdSPI::readRegisterWord(uint8_t devReg, uint16_t &data)
//
// Reads an array of bytes to a given register on the target address
//
// Returns the number of bytes read, < 0 is an error
// Returns kSTkErrOk on success
//
sfeTkError_t sfeTkArdSPI::readRegisterRegion(uint8_t devReg, uint8_t *data, size_t numBytes)
{
Expand Down
4 changes: 2 additions & 2 deletions src/sfeTkArdSPI.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ class sfeTkArdSPI : public sfeTkISPI
@param devReg The device's register's address.
@param data Data to write.

@retval int32_t - number of bytes written, < 0 = error value
@retval sfeTkError_t - kSTkErrOk on success
*/
virtual int32_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);
virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length);

/*--------------------------------------------------------------------------
@brief Read a single byte from the given register
Expand Down