Skip to content

Commit 9846401

Browse files
committed
created a overloaded set of methods for reading and writing to registers
1 parent ec20fa5 commit 9846401

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

src/sfeTk/sfeTkIBus.h

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,12 @@ class sfeTkIBus
125125
*/
126126
virtual sfeTkError_t writeRegisterByte(uint8_t devReg, uint8_t data) = 0;
127127

128+
// Overload version
129+
sfeTkError_t writeRegister(uint8_t devReg, uint8_t data)
130+
{
131+
return writeRegisterByte(devReg, data);
132+
}
133+
128134
/**--------------------------------------------------------------------------
129135
* @brief Write a single word (16 bit) to the given register
130136
*
@@ -136,6 +142,12 @@ class sfeTkIBus
136142
*/
137143
virtual sfeTkError_t writeRegisterWord(uint8_t devReg, uint16_t data) = 0;
138144

145+
// Overload version
146+
sfeTkError_t writeRegister(uint8_t devReg, uint16_t data)
147+
{
148+
return writeRegisterWord(devReg, data);
149+
}
150+
139151
/**--------------------------------------------------------------------------
140152
* @brief Writes a number of bytes starting at the given register's address.
141153
*
@@ -148,6 +160,12 @@ class sfeTkIBus
148160
*/
149161
virtual sfeTkError_t writeRegisterRegion(uint8_t devReg, const uint8_t *data, size_t length) = 0;
150162

163+
// Overload version
164+
sfeTkError_t writeRegister(uint8_t devReg, const uint8_t *data, size_t length)
165+
{
166+
return writeRegisterRegion(devReg, data, length);
167+
}
168+
151169
/**--------------------------------------------------------------------------
152170
* @brief Writes a number of bytes starting at the given register's 16-bit address.
153171
*
@@ -160,6 +178,12 @@ class sfeTkIBus
160178
*/
161179
virtual sfeTkError_t writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length) = 0;
162180

181+
// Overload version
182+
sfeTkError_t writeRegister(uint16_t devReg, const uint8_t *data, size_t length)
183+
{
184+
return writeRegister16Region(devReg, data, length);
185+
}
186+
163187
/**--------------------------------------------------------------------------
164188
* @brief Writes a number of uint16's starting at the given register's 16-bit address.
165189
*
@@ -171,6 +195,12 @@ class sfeTkIBus
171195
*
172196
*/
173197
virtual sfeTkError_t writeRegister16Region16(uint16_t devReg, const uint16_t *data, size_t length) = 0;
198+
199+
// Overload version
200+
sfeTkError_t writeRegister(uint16_t devReg, const uint16_t *data, size_t length)
201+
{
202+
return writeRegister16Region16(devReg, data, length);
203+
}
174204
/**--------------------------------------------------------------------------
175205
* @brief Read a single byte from the given register
176206
*
@@ -182,6 +212,12 @@ class sfeTkIBus
182212
*/
183213
virtual sfeTkError_t readRegisterByte(uint8_t devReg, uint8_t &data) = 0;
184214

215+
// Overload version
216+
sfeTkError_t readRegister(uint8_t devReg, uint8_t &data)
217+
{
218+
return readRegisterByte(devReg, data);
219+
}
220+
185221
/**--------------------------------------------------------------------------
186222
* @brief Read a single word (16 bit) from the given register
187223
*
@@ -192,6 +228,12 @@ class sfeTkIBus
192228
*/
193229
virtual sfeTkError_t readRegisterWord(uint8_t devReg, uint16_t &data) = 0;
194230

231+
// Overload version
232+
sfeTkError_t readRegister(uint8_t devReg, uint16_t &data)
233+
{
234+
return readRegisterWord(devReg, data);
235+
}
236+
195237
/**--------------------------------------------------------------------------
196238
* @brief Reads a block of data from the given register.
197239
*
@@ -205,6 +247,12 @@ class sfeTkIBus
205247
*/
206248
virtual sfeTkError_t readRegisterRegion(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
207249

250+
// Overload version
251+
sfeTkError_t readRegister(uint8_t reg, uint8_t *data, size_t numBytes, size_t &readBytes)
252+
{
253+
return readRegisterRegion(reg, data, numBytes, readBytes);
254+
}
255+
208256
/**--------------------------------------------------------------------------
209257
* @brief Reads a block of data from the given 16-bit register address.
210258
*
@@ -218,6 +266,11 @@ class sfeTkIBus
218266
*/
219267
virtual sfeTkError_t readRegister16Region(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes) = 0;
220268

269+
// Overload version
270+
sfeTkError_t readRegister(uint16_t reg, uint8_t *data, size_t numBytes, size_t &readBytes)
271+
{
272+
return readRegister16Region(reg, data, numBytes, readBytes);
273+
}
221274
/**--------------------------------------------------------------------------
222275
* @brief Reads a block of data from the given 16-bit register address.
223276
*
@@ -231,6 +284,12 @@ class sfeTkIBus
231284
*/
232285
virtual sfeTkError_t readRegister16Region16(uint16_t reg, uint16_t *data, size_t numBytes, size_t &readBytes) = 0;
233286

287+
// Overload version
288+
sfeTkError_t readRegister(uint16_t reg, uint16_t *data, size_t numBytes, size_t &readBytes)
289+
{
290+
return readRegister16Region16(reg, data, numBytes, readBytes);
291+
}
292+
234293
virtual uint8_t type(void)
235294
{
236295
return 0;

0 commit comments

Comments
 (0)