add SoftwareSerial support

Author: ianfixes

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Yaml files support select/reject critera for paths of unit tests for targeted testing
 - Pins now track history and can report it in Ascii (big- or little-endian) for digital sequences
 - Pins now accept an array (or string) of input bits for providing pin values across multiple reads
+- SoftwareSerial.  That took a while.
 
 ### Changed
 - Unit test executables print to STDERR just in case there are segfaults.  Uh, just in case I ever write any.

SampleProjects/TestSomething/test/pinhistory.cpp

@@ -2,15 +2,13 @@
 #include <Arduino.h>
 
 
-unittest(pin_read_history)
-{
+unittest(pin_read_history) {
   PinHistory<int> phi;
 
   const int future[6] = {33, 22, 55, 11, 44, 66};
   assertEqual(0, phi.queueSize());
   phi.fromArray(future, 6);
-  for (int i = 0; i < 6; ++i)
-  {
+  for (int i = 0; i < 6; ++i) {
     assertEqual(6 - i, phi.queueSize());
     assertEqual(future[i], phi.retrieve());
     assertEqual(6 - (i + 1), phi.queueSize());
@@ -20,19 +18,36 @@ unittest(pin_read_history)
   assertEqual(future[5], phi.retrieve());
 
   PinHistory<bool> phb;
-  assertEqual(0, phb.queueSize());
   phb.fromAscii("Yo", true);
-  assertEqual(16, phb.queueSize());
+
   // digitial history as serial data, big-endian
   bool binaryAscii[16] = {
-    0, 1, 0, 1, 1, 0, 0, 1,
-    0, 1, 1, 0, 1, 1, 1, 1
-  };
+      0, 1, 0, 1, 1, 0, 0, 1,
+      0, 1, 1, 0, 1, 1, 1, 1};
 
   for (int i = 0; i < 16; ++i) {
     assertEqual(binaryAscii[i], phb.retrieve());
   }
+
+  assertEqual("Yo", phb.toAscii(0, true));
 }
 
+unittest(ascii_stuff) {
+  PinHistory<bool> phb;
+  assertEqual(0, phb.historySize());
+  phb.reset(false);
+  assertEqual(1, phb.historySize());
+
+  assertEqual(0, phb.queueSize());
+  phb.fromAscii("Yo", true);
+  assertEqual(16, phb.queueSize());
+  assertEqual("Yo", phb.incomingToAscii(0, true));
+
+  phb.reset(false);
+  assertEqual(0, phb.queueSize());
+  assertEqual(1, phb.historySize());
+  phb.outgoingFromAscii("hi", true);
+  assertEqual("hi", phb.toAscii(1, true));
+}
 
 unittest_main()

SampleProjects/TestSomething/test/softwareserial.cpp

@@ -0,0 +1,44 @@
+#include <ArduinoUnitTests.h>
+#include <SoftwareSerial.h>
+
+unittest(software_input_output)
+{
+  GodmodeState* state = GODMODE();
+  state->reset();
+
+  SoftwareSerial ss(1, 2, false);
+
+  assertEqual(-1, ss.peek());
+
+  state->digitalPin[1].fromAscii("Holy crap ", true);
+  state->digitalPin[1].fromAscii("this took a lot of prep work", true);
+
+  assertFalse(ss.isListening());
+  assertEqual(-1, ss.peek());
+
+  ss.listen();
+  assertTrue(ss.isListening());
+  assertEqual(38, ss.available());
+  assertEqual('H', ss.peek());
+  assertEqual('H', ss.read());
+  assertEqual('o', ss.read());
+  assertEqual('l', ss.read());
+  assertEqual('y', ss.read());
+
+  ss.write('b');
+  ss.write('A');
+  ss.write('r');
+  assertEqual("bAr", state->digitalPin[2].toAscii(1, true));
+}
+
+unittest(print) {
+  GodmodeState* state = GODMODE();
+  state->reset();
+
+  SoftwareSerial ss(1, 2, false);
+  ss.listen();
+  ss.print(1.3, 2);
+  assertEqual("1.30", state->digitalPin[2].toAscii(1, true));
+}
+
+unittest_main()

cpp/arduino/Arduino.cpp

@@ -1,23 +1,2 @@
-#include "Arduino.h"
 #include "Godmode.h"
 
-
-void digitalWrite(unsigned char pin, unsigned char val) {
-  GodmodeState* godmode = GODMODE();
-  godmode->digitalPin[pin] = val;
-}
-
-int digitalRead(unsigned char pin) {
-  GodmodeState* godmode = GODMODE();
-  return godmode->digitalPin[pin].retrieve();
-}
-
-void analogWrite(unsigned char pin, int val) {
-  GodmodeState* godmode = GODMODE();
-  godmode->analogPin[pin] = val;
-}
-
-int analogRead(unsigned char pin) {
-  GodmodeState* godmode = GODMODE();
-  return godmode->analogPin[pin].retrieve();
-}

cpp/arduino/Arduino.h

@@ -57,16 +57,7 @@ typedef unsigned int word;
 
 #define bit(b) (1UL << (b))
 
-// io pins
-#define pinMode(...) _NOP()
-#define analogReference(...) _NOP()
-
-void digitalWrite(uint8_t, uint8_t);
-int digitalRead(uint8_t);
-int analogRead(uint8_t);
-void analogWrite(uint8_t, int);
-#define analogReadResolution(...) _NOP()
-#define analogWriteResolution(...) _NOP()
+
 
 
 // Get the bit location within the hardware port of the given virtual pin.

cpp/arduino/Godmode.cpp

@@ -46,6 +46,27 @@ long random(long vmin, long vmax)
   return vmin < vmax ? (random(vmax - vmin) + vmin) : vmin;
 }
 
+void digitalWrite(unsigned char pin, unsigned char val) {
+  GodmodeState* godmode = GODMODE();
+  godmode->digitalPin[pin] = val;
+}
+
+int digitalRead(unsigned char pin) {
+  GodmodeState* godmode = GODMODE();
+  return godmode->digitalPin[pin].retrieve();
+}
+
+void analogWrite(unsigned char pin, int val) {
+  GodmodeState* godmode = GODMODE();
+  godmode->analogPin[pin] = val;
+}
+
+int analogRead(unsigned char pin) {
+  GodmodeState* godmode = GODMODE();
+  return godmode->analogPin[pin].retrieve();
+}
+
+
 // Serial ports
 #if defined(HAVE_HWSERIAL0)
   HardwareSerial Serial(&godmode.serialPort[0].dataIn, &godmode.serialPort[0].dataOut, &godmode.serialPort[0].readDelayMicros);

cpp/arduino/Godmode.h

@@ -80,5 +80,17 @@ class GodmodeState {
 
 };
 
+// io pins
+#define pinMode(...) _NOP()
+#define analogReference(...) _NOP()
+
+void digitalWrite(uint8_t, uint8_t);
+int digitalRead(uint8_t);
+int analogRead(uint8_t);
+void analogWrite(uint8_t, int);
+#define analogReadResolution(...) _NOP()
+#define analogWriteResolution(...) _NOP()
+
+
 GodmodeState* GODMODE();
 

cpp/arduino/PinHistory.h

@@ -14,6 +14,49 @@ class PinHistory {
       qIn.clear();
     }
 
+    // enqueue ascii bits
+    void a2q(Queue<T> &q, String input, bool bigEndian) {
+      // 8 chars at a time, form up
+      for (int j = 0; j < input.length(); ++j) {
+        for (int i = 0; i < 8; ++i) {
+          int shift = bigEndian ? 7 - i : i;
+          unsigned char mask = (0x01 << shift);
+          q.push(mask & input[j]);
+        }
+      }
+    }
+
+
+    // convert a queue to a string as if it was serial bits
+    // start from offset, consider endianness
+    String q2a(const Queue<T> &q, unsigned int offset, bool bigEndian) const {
+      String ret = "";
+
+      Queue<T> q2(q);
+
+      while (offset) {
+        q2.pop();
+        --offset;
+      }
+
+      if (offset) return ret;
+
+      // 8 chars at a time, form up
+      while (q2.size() >= 8) {
+        unsigned char acc = 0x00;
+        for (int i = 0; i < 8; ++i) {
+          int shift = bigEndian ? 7 - i : i;
+          T val = q2.front();
+          unsigned char bit = val ? 0x1 : 0x0;
+          acc |= (bit << shift);
+          q2.pop();
+        }
+        ret.append(String((char)acc));
+      }
+
+      return ret;
+    }
+
   public:
     PinHistory() {}
 
@@ -59,18 +102,17 @@ class PinHistory {
     }
 
     // enqueue ascii bits
-    void fromAscii(String input, bool bigEndian) {
-      String ret = "";
+    void fromAscii(String input, bool bigEndian) { a2q(qIn, input, bigEndian); }
 
-      // 8 chars at a time, form up
-      for (int j = 0; j < input.length(); ++j) {
-        for (int i = 0; i < 8; ++i) {
-          int shift = bigEndian ? 7 - i : i;
-          unsigned char mask = (0x01 << shift);
-          qIn.push(mask & input[j]);
-        }
-      }
-    }
+    void outgoingFromAscii(String input, bool bigEndian) { a2q(qOut, input, bigEndian); }
+
+    // convert the queue of incoming data to a string as if it was Serial comms
+    // start from offset, consider endianness
+    String incomingToAscii (unsigned int offset, bool bigEndian) const { return q2a(qIn, offset, bigEndian); }
+
+    // convert the pin history to a string as if it was Serial comms
+    // start from offset, consider endianness
+    String toAscii (unsigned int offset, bool bigEndian) const { return q2a(qOut, offset, bigEndian); }
 
     // copy elements to an array, up to a given length
     // return the number of elements moved
@@ -97,34 +139,5 @@ class PinHistory {
       return i == length;
     }
 
-    // convert the pin history to a string as if it was Serial comms
-    // start from offset, consider endianness
-    String toAscii (unsigned int offset, bool bigEndian) const {
-      String ret = "";
-
-      Queue<T> q2(qOut);
-
-      while (offset) {
-        q2.pop();
-        --offset;
-      }
-
-      if (offset) return ret;
-
-      // 8 chars at a time, form up
-      while (q2.size() >= 8) {
-        unsigned char acc = 0x00;
-        for (int i = 0; i < 8; ++i) {
-          int shift = bigEndian ? 7 - i : i;
-          T val = q2.front();
-          unsigned char bit = val ? 0x1 : 0x0;
-          acc |= (bit << shift);
-          q2.pop();
-        }
-        ret.append(String((char)acc));
-      }
-
-      return ret;
-    }
 };
 

cpp/arduino/SoftwareSerial.h

@@ -0,0 +1,75 @@
+#pragma once
+#include "Print.h"
+#include "Stream.h"
+#include "Godmode.h"
+
+// definitions neeeded for Serial.begin's config arg
+
+class SoftwareSerial : public Stream
+{
+  private:
+    int mPinIn;
+    int mPinOut;
+    bool mInverse;
+    bool mIsListening;
+    GodmodeState* mState;
+    unsigned long mOffset; // bits to offset stream
+
+  public:
+    SoftwareSerial(uint8_t receivePin, uint8_t transmitPin, bool inverse_logic = false) {
+      mPinIn = receivePin;
+      mPinOut = transmitPin;
+      mIsListening = false;
+      mOffset = 0; // godmode starts with 1 bit in the queue
+      mState = GODMODE();
+    }
+
+    ~SoftwareSerial() {};
+
+    void setGodmodeOffset(unsigned long offset) {
+      mOffset = offset;
+    }
+
+    bool listen() { return mIsListening = true; }
+    bool isListening() { return mIsListening; }
+    bool stopListening() {
+      bool ret = mIsListening;
+      mIsListening = false;
+      return ret;
+    }
+    void begin(long speed) { listen(); }
+    void end() { stopListening(); }
+    bool overflow() { return false; }
+
+    int peek() {
+      if (!isListening()) return -1;
+      String input = mState->digitalPin[mPinIn].incomingToAscii(mOffset, true);
+      if (input.empty()) return -1;
+      return input[0];
+    }
+
+    virtual int read() {
+      if (!isListening()) return -1;
+      String input = mState->digitalPin[mPinIn].incomingToAscii(mOffset, true);
+      if (input.empty()) return -1;
+      int ret = input[0];
+      for (int i = 0; i < 8; ++i) digitalRead(mPinIn);
+      return ret;
+    }
+
+    //using Print::write;
+
+    virtual size_t write(uint8_t byte) {
+      mState->digitalPin[mPinOut].outgoingFromAscii(String((char)byte), true);
+      return 1;
+    }
+
+    virtual int available() { return mState->digitalPin[mPinIn].incomingToAscii(mOffset, true).length();  }
+    virtual void flush() {}
+    operator bool() { return true; }
+
+    static inline void handle_interrupt() {};
+
+};
+
+