Initial commit

include/BOARD-DEFINITIONS.h

@@ -0,0 +1,35 @@
+/**
+ * @file BOARD-DEFINITIONS.h
+ * @brief This file contains the definitions for the board
+*/
+
+#pragma once
+
+#include "PINOUT.h"
+#include "CubeStack.h"
+
+// define the physical dimensions of the board
+#define BOARD_WIDTH 3
+#define BOARD_LENGTH 3
+#define BOARD_HEIGHT 3
+
+// define the number of stacks
+#define NUMBER_STACKS BOARD_WIDTH * BOARD_LENGTH
+
+// define the CubeStacks
+CubeStack stack1(STACK1_ADC_PIN, STACK1_LED_PIN, BOARD_HEIGHT);
+CubeStack stack2(STACK2_ADC_PIN, STACK2_LED_PIN, BOARD_HEIGHT);
+CubeStack stack3(STACK3_ADC_PIN, STACK3_LED_PIN, BOARD_HEIGHT);
+CubeStack stack4(STACK4_ADC_PIN, STACK4_LED_PIN, BOARD_HEIGHT);
+CubeStack stack5(STACK5_ADC_PIN, STACK5_LED_PIN, BOARD_HEIGHT);
+CubeStack stack6(STACK6_ADC_PIN, STACK6_LED_PIN, BOARD_HEIGHT);
+CubeStack stack7(STACK7_ADC_PIN, STACK7_LED_PIN, BOARD_HEIGHT);
+CubeStack stack8(STACK8_ADC_PIN, STACK8_LED_PIN, BOARD_HEIGHT);
+CubeStack stack9(STACK9_ADC_PIN, STACK9_LED_PIN, BOARD_HEIGHT);
+
+// define the array of stacks
+CubeStack * stacks[] = {
+    &stack1, &stack2, &stack3,
+    &stack4, &stack5, &stack6,
+    &stack7, &stack8, &stack9
+};

include/PINOUT.h

@@ -0,0 +1,44 @@
+/**
+ * @file PINOUT.h
+ * @brief This file contains the pinout for the board
+*/
+
+#pragma once
+
+// Stack 1 pins
+#define STACK1_ADC_PIN 34
+#define STACK1_LED_PIN 5
+
+// Stack 2 pins
+#define STACK2_ADC_PIN 39
+#define STACK2_LED_PIN 18
+
+// Stack 3 pins
+#define STACK3_ADC_PIN 36
+#define STACK3_LED_PIN 19
+
+// Stack 4 pins
+#define STACK4_ADC_PIN 35
+#define STACK4_LED_PIN 17
+
+// Stack 5 pins
+#define STACK5_ADC_PIN 32
+#define STACK5_LED_PIN 16
+
+// Stack 6 pins
+#define STACK6_ADC_PIN 33
+#define STACK6_LED_PIN 4
+
+// Stack 7 pins
+#define STACK7_ADC_PIN 25
+#define STACK7_LED_PIN 0
+
+// Stack 8 pins
+#define STACK8_ADC_PIN 26
+#define STACK8_LED_PIN 2
+
+// Stack 9 pins
+#define STACK9_ADC_PIN 27
+#define STACK9_LED_PIN 15
+
+

include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html