Add TwoWire::begin to Notecard::begin (#33)

* chore: add TwoWire::begin to Notecard::begin
* chore: unit-test new behavior

Author: zfields

src/Notecard.cpp

@@ -80,6 +80,7 @@ int _readLengthAdjustment = 0;
 void Notecard::begin(uint32_t i2caddress, uint32_t i2cmax, TwoWire &wirePort) {
 	NoteSetFnDefault(malloc, free, delay, millis);
 	_i2cPort = &wirePort;
+	_i2cPort->begin();
 
 	NoteSetFnI2C(i2caddress, i2cmax, Notecard::noteI2CReset,
 							 Notecard::noteI2CTransmit, Notecard::noteI2CReceive);
@@ -328,13 +329,14 @@ char Notecard::noteSerialReceive() {
 
 /**************************************************************************/
 /*!
-    @brief  Resets the I2C port. Required by note-c, but not implemented as
-						the developer should call `Wire.begin()` themselves before
-						initializing the library.
+    @brief  Resets the I2C port. Required by note-c.
     @return `True`.
 */
 /**************************************************************************/
 bool Notecard::noteI2CReset(uint16_t DevAddress) {
+#if WIRE_HAS_END
+	_i2cPort->end();
+#endif
 	_i2cPort->begin();
 	return true;
 }

test/mock/mock-arduino.cpp

@@ -1,12 +1,12 @@
 #include "mock-arduino.hpp"
 
 HardwareSerialBegin_Parameters hardwareSerialBegin_Parameters;
+TwoWireBegin_Parameters twoWireBegin_Parameters;
 
 void
 delay (
     unsigned int millis
 ) {
-    // Validate parameter(s)
 
 }
 
@@ -65,7 +65,8 @@ void
 TwoWire::begin (
     void
 ) {
-
+  // Capture call
+  twoWireBegin_Parameters.called = true;
 }
 
 void
@@ -75,6 +76,13 @@ TwoWire::beginTransmission (
 
 }
 
+void
+TwoWire::end (
+    void
+) {
+
+}
+
 int
 TwoWire::endTransmission (
     void

test/mock/mock-arduino.hpp

@@ -3,6 +3,8 @@
 
 #include <cstddef>
 
+#define WIRE_HAS_END 1
+
 void delay (unsigned int);
 size_t millis (void);
 
@@ -30,16 +32,27 @@ struct Stream {
 struct TwoWire {
     void begin(void);
     void beginTransmission(int);
+    void end(void);
     int endTransmission(void);
     unsigned char read(void);
     int requestFrom(int dev_addr, unsigned int read_len);
     void write(unsigned char c);
     long unsigned int write(unsigned char * msg, long unsigned int len);
 };
 
+struct TwoWireBegin_Parameters {
+    TwoWireBegin_Parameters(
+        void
+    ) :
+        called(false)
+    { }
+    bool called;
+};
+
 extern HardwareSerial Serial;
 extern HardwareSerialBegin_Parameters hardwareSerialBegin_Parameters;
-extern TwoWire Wire;
 extern Stream dbgserial;
+extern TwoWire Wire;
+extern TwoWireBegin_Parameters twoWireBegin_Parameters;
 
 #endif

test/notecard-test.cpp

@@ -940,6 +940,55 @@ int test_notecard_responseError_does_not_modify_note_c_result_value_before_retur
   return result;
 }
 
+int test_notecard_begin_i2c_default_parameter_for_wirePort_has_begin_method_called()
+{
+  int result;
+  Notecard notecard;
+
+  // Setup
+  twoWireBegin_Parameters.called = false;
+
+  // Action
+  notecard.begin();
+
+  // Evaluate Result
+  if (true == twoWireBegin_Parameters.called)
+  {
+    result = 0;
+  }
+  else
+  {
+    result = 37;
+  }
+
+  return result;
+}
+
+int test_notecard_begin_i2c_parameter_for_wirePort_has_begin_method_called()
+{
+  int result;
+  Notecard notecard;
+  TwoWire mockWire;
+
+  // Setup
+  twoWireBegin_Parameters.called = false;
+
+  // Action
+  notecard.begin(NOTE_I2C_ADDR_DEFAULT, NOTE_I2C_MAX_DEFAULT, mockWire);
+
+  // Evaluate Result
+  if (true == twoWireBegin_Parameters.called)
+  {
+    result = 0;
+  }
+  else
+  {
+    result = 38;
+  }
+
+  return result;
+}
+
 struct TestFunction;
 typedef int (*test_fn)(void);
 int runTests(TestFunction *tests_, size_t cnt_);
@@ -1002,7 +1051,10 @@ int main(void)
       {test_notecard_debugSyncStatus_does_not_modify_maxLevel_parameter_before_passing_to_note_c, "test_notecard_debugSyncStatus_does_not_modify_maxLevel_parameter_before_passing_to_note_c"},
       {test_notecard_debugSyncStatus_does_not_modify_note_c_result_value_before_returning_to_caller, "test_notecard_debugSyncStatus_does_not_modify_note_c_result_value_before_returning_to_caller"},
       {test_notecard_responseError_does_not_modify_j_object_parameter_value_before_passing_to_note_c, "test_notecard_responseError_does_not_modify_j_object_parameter_value_before_passing_to_note_c"},
-      {test_notecard_responseError_does_not_modify_note_c_result_value_before_returning_to_caller, "test_notecard_responseError_does_not_modify_note_c_result_value_before_returning_to_caller"}};
+      {test_notecard_responseError_does_not_modify_note_c_result_value_before_returning_to_caller, "test_notecard_responseError_does_not_modify_note_c_result_value_before_returning_to_caller"},
+      {test_notecard_begin_i2c_default_parameter_for_wirePort_has_begin_method_called, "test_notecard_begin_i2c_default_parameter_for_wirePort_has_begin_method_called"},
+      {test_notecard_begin_i2c_parameter_for_wirePort_has_begin_method_called, "test_notecard_begin_i2c_parameter_for_wirePort_has_begin_method_called"}
+  };
 
   return runTests(tests, (sizeof(tests) / sizeof(TestFunction)));
 }