Initial commit

lib/Board/BoardLayout.cpp

@@ -0,0 +1,38 @@
+#include "BoardLayout.h"
+
+uint8_t BoardLayout::GetNumberStacks(){
+    return this->boardWidth * this->boardHeight;
+}
+
+void BoardLayout::SetStackColors(uint8_t stackNum, Color * colors){
+    CubeStack * stack = this->stacks[stackNum];
+    stack->SetLEDColors(colors, this->boardHeight);
+}
+
+bool BoardLayout::BoardStateHasChanged(){
+    uint16_t boardState[this->boardWidth * this->boardLength];
+    this->GetBoardState(boardState);
+
+    // compare the board state to the last board state
+    for(int i = 0; i < (this->boardWidth * this->boardLength); i++){
+        uint16_t stackState = boardState[i];
+        uint16_t lastStackState = (this->lastBoardState)[i];
+        if(stackState != lastStackState){
+            // copy the board state into the last board state
+            for(int k = 0; k < (this->boardWidth * this->boardLength); k++){
+                this->lastBoardState[k] = boardState[k];
+            }
+            return true;
+        }
+    }
+    return false;
+}
+
+void BoardLayout::GetBoardState(uint16_t * boardStateBuffer){
+    for(int i = 0; i < (this->boardLength * this->boardWidth); i++){
+        CubeStack * stack = this->stacks[i];
+        stack->SendLEDData(); // Enable this if you want to constantly stream LED data
+        boardStateBuffer[i] = stack->GetNumberCubes();
+    }
+}
+

lib/Board/BoardLayout.h

@@ -0,0 +1,69 @@
+/**
+ * @brief This is the full board manager which handles the state of every stack on the board
+*/
+
+#pragma once
+
+#include "CubeStack.h"
+#include "Color.h"
+
+class BoardLayout{
+    public:
+    /**
+     * @brief BoardLayout COnstructor
+    */
+    BoardLayout(uint8_t boardWidth, uint8_t boardLength, uint8_t boardHeight, CubeStack ** stacks) :
+        boardWidth(boardWidth),
+        boardLength(boardLength),
+        boardHeight(boardHeight),
+        stacks(stacks)
+    {
+      this->lastBoardState = new uint16_t[boardWidth * boardLength];
+    }
+
+    /**
+     * @brief Check if our board state has changed
+     * @return true if the board state has changed, false otherwise
+    */
+    bool BoardStateHasChanged();
+
+    /**
+     * @brief Get the Number of Stacks
+     * @return the number of stacks
+    */
+    uint8_t GetNumberStacks();
+
+    /**
+     * @brief Set the LED Colors
+     * @param stackNum the stack index you would like to address.
+     * From top left to bottom right, the stack numbers are as follows:
+     * | 0 1 2 |
+     * | 3 4 5 |
+     * | 6 7 8 |
+     * @param Colors the array of colors to set the LEDs in a stack to
+    */
+    void SetStackColors(uint8_t stackNum, Color * colors);
+
+    /**
+     * @brief Get the board population state
+     * @param boardStateBuffer the buffer to write the board state to. It must be at least boardWidth * boardLength in length
+     */
+    void GetBoardState(uint16_t * boardStateBuffer);
+
+    private:
+    uint8_t boardWidth;
+    uint8_t boardLength;
+    uint8_t boardHeight;
+    /*
+    An array of arrays of stacks
+    [ [stack1, stack2, stack3],
+      [stack4, stack5, stack6],
+      [stack7, stack8, stack9] ]
+    etc
+    */
+    CubeStack ** stacks;
+
+    // records the last known board state
+    uint16_t * lastBoardState;
+
+};

lib/Board/Color.h

@@ -0,0 +1,21 @@
+/**
+ * @file Color.h
+ * @brief This file contains the color struct
+*/
+
+#pragma once
+#include <Arduino.h>
+
+// store a color
+struct Color{
+    // create a constructor for this struct
+    Color(uint8_t red, uint8_t green, uint8_t blue) :
+        red(red),
+        green(green),
+        blue(blue)
+    {}
+    Color() = default;
+    uint8_t red{0};
+    uint8_t green{0};
+    uint8_t blue{0};
+};

lib/Board/CubeStack.cpp

@@ -0,0 +1,77 @@
+#include "CubeStack.h"
+
+CubeStack::CubeStack(uint16_t ADCPin, uint16_t ledPin, uint8_t numLEDs){
+    this->ADCPin = ADCPin;
+    this->blockLights = *(new Adafruit_NeoPixel(numLEDs*2, ledPin, NEO_GRB + NEO_KHZ800));
+    this->ledColors = new Color[numLEDs];
+    this->numLEDs = numLEDs;
+
+    // initialize the LED colors to off
+    for(int i = 0; i < numLEDs; i++){
+        this->ledColors[i] = *(new Color(0, 0, 0));
+    }
+};
+
+uint8_t CubeStack::GetNumberCubes(){
+    // read the ADC and return the number of cubes
+    /*
+    0 cubes: 1 : 4095-3071
+    1 cube: 1/2 3070-1706
+    2 cubes: 1/3 1705-1195
+    3 cubes: 1/4 1195-0
+    */
+    uint16_t value = analogRead(this->ADCPin);
+
+    this->lowPassADCRead = static_cast<uint16_t>((static_cast<float>(this->lowPassADCRead) * 0.9) + (static_cast<float>(value) * 0.1));
+
+    // temporary definitions to define value ranges:
+    uint16_t zeroCubesHigh = 4095;
+    uint16_t zeroCubesLow = 3071;
+    uint16_t oneCubeLow = 1706;
+    uint16_t twoCubesLow = 1000;
+    uint16_t threeCubesLow = 0;
+
+    uint8_t stackHeight = 0;
+
+    if(this->lowPassADCRead >= zeroCubesLow && this->lowPassADCRead <= zeroCubesHigh){
+        stackHeight = 0;
+    }
+    else if(this->lowPassADCRead >= oneCubeLow){
+        stackHeight = 1;
+    }
+    else if(this->lowPassADCRead >= twoCubesLow){
+        stackHeight = 2;
+    }
+    else if(this->lowPassADCRead >= threeCubesLow){
+        stackHeight = 3;
+    }
+    if(this->lastStackHeight != stackHeight){
+        this->lastStackHeight = stackHeight;
+        this->SendLEDData();
+    }
+    
+    return stackHeight;
+}
+
+void CubeStack::SetLEDColors(Color * colors, uint8_t numColors){
+    // copy the colors into the ledColors array
+    for(int i = 0; i < numColors; i++){
+        this->ledColors[i].red = colors[i].red;
+        this->ledColors[i].green = colors[i].green;
+        this->ledColors[i].blue = colors[i].blue;
+    }
+
+    this->SendLEDData();
+}
+
+void CubeStack::SendLEDData(){
+    // we always initialize before we do anything because other CubeStacks could be hogging the hardware
+    // between our writes
+    this->blockLights.begin();
+    // set the LED colors
+    for(int i = 0; i < this->numLEDs; i++){
+        this->blockLights.setPixelColor(i*2, this->blockLights.Color(this->ledColors[i].red, this->ledColors[i].green, this->ledColors[i].blue));
+        this->blockLights.setPixelColor((i*2 + 1), this->blockLights.Color(this->ledColors[i].red, this->ledColors[i].green, this->ledColors[i].blue));
+    }
+    this->blockLights.show();
+}

lib/Board/CubeStack.h

@@ -0,0 +1,52 @@
+/**
+ * @brief this manages a single cube stack and the lighting / detecting of how many cubes
+*/
+
+#pragma once
+
+#include <Arduino.h>
+#include <Adafruit_NeoPixel.h>
+#include "Color.h"
+
+
+class CubeStack{
+    public:
+    /**
+     * @brief Construct a new Cube Stack object
+     * @param ADCPin the pin that the ADC is connected to
+     * @param ledPin the pin that the LED is connected to
+    */
+    CubeStack(uint16_t ADCPin, uint16_t ledPin, uint8_t numLEDs);
+
+    /**
+     * @brief Returns the number of cubes in the stack
+     * @return the number of cubes in the stack
+    */
+    uint8_t GetNumberCubes();
+
+    /**
+     * @brief Set the led color array and then send the data to the LED strip
+     * @param colors the array of colors to set the LEDs to
+     * @param numColors the number of colors in the array
+    */
+   void SetLEDColors(Color * colors, uint8_t numColors);
+
+    /**
+     * @brief sends the LED data to the LED strip
+    */
+    void SendLEDData();
+
+   private:
+    
+
+    uint8_t ADCPin;
+    // we will probably need a pointer to a fastled object here
+    Adafruit_NeoPixel blockLights;
+
+    uint16_t lowPassADCRead{0};
+
+    // store the Color of each LED
+    Color * ledColors;
+    uint8_t numLEDs;
+    uint8_t lastStackHeight{0};
+};