commit ad7414e5720a2359187dffeb89432dadadb6462c Author: Tim AtLee Date: Sun Jul 19 13:25:16 2020 -0600 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..7c486f1 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,67 @@ +# Continuous Integration (CI) is the practice, in software +# engineering, of merging all developer working copies with a shared mainline +# several times a day < https://docs.platformio.org/page/ci/index.html > +# +# Documentation: +# +# * Travis CI Embedded Builds with PlatformIO +# < https://docs.travis-ci.com/user/integration/platformio/ > +# +# * PlatformIO integration with Travis CI +# < https://docs.platformio.org/page/ci/travis.html > +# +# * User Guide for `platformio ci` command +# < https://docs.platformio.org/page/userguide/cmd_ci.html > +# +# +# Please choose one of the following templates (proposed below) and uncomment +# it (remove "# " before each line) or use own configuration according to the +# Travis CI documentation (see above). +# + + +# +# Template #1: General project. Test it using existing `platformio.ini`. +# + +# language: python +# python: +# - "2.7" +# +# sudo: false +# cache: +# directories: +# - "~/.platformio" +# +# install: +# - pip install -U platformio +# - platformio update +# +# script: +# - platformio run + + +# +# Template #2: The project is intended to be used as a library with examples. +# + +# language: python +# python: +# - "2.7" +# +# sudo: false +# cache: +# directories: +# - "~/.platformio" +# +# env: +# - PLATFORMIO_CI_SRC=path/to/test/file.c +# - PLATFORMIO_CI_SRC=examples/file.ino +# - PLATFORMIO_CI_SRC=path/to/test/directory +# +# install: +# - pip install -U platformio +# - platformio update +# +# script: +# - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..e80666b --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,7 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ] +} diff --git a/include/README b/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/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 diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in a an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..ea23b77 --- /dev/null +++ b/platformio.ini @@ -0,0 +1,14 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:uno] +platform = atmelavr +board = uno +framework = arduino diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..9ae8b43 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,291 @@ +#include +#include +#include +#include +#include + +// Various variables. +int iDeflection = 48; +int iDelay = 500; +int iSpeed = 5; +bool bRunning = false; + +// LCD setup +const int rs = 13, en = 12, d4 = 11, d5 = 10, d6 = 9, d7 = 8; +LiquidCrystal lcd(rs, en, d4, d5, d6, d7); +int displayCycle = 0; + +// Keypad setup. +const byte KEYPAD_ROWS = 2; +const byte KEYPAD_COLS = 4; +char hexaKeys[KEYPAD_ROWS][KEYPAD_COLS] = { + {'1', '2', '3', 'A'}, + {'4', '5', '6', 'B'}}; +byte rowPins[KEYPAD_ROWS] = {A5, A4}; +byte colPins[KEYPAD_COLS] = {A3, A2, A1, A0}; +Keypad customKeypad = Keypad(makeKeymap(hexaKeys), rowPins, colPins, KEYPAD_ROWS, KEYPAD_COLS); + +// Servo setup +Servo mainServo; +int servoPosition = 0; + +// Timer setup +auto timer = timer_create_default(); // create a timer with default settings + +bool printSerialSetting(void *) +{ + Serial.println("ACNH A button clicker, the debug interface."); + + Serial.print("Run State: "); + if (bRunning) + { + Serial.println("Is running. A to stop."); + } + else + { + Serial.println("Is not running. B to test, A to start."); + } + Serial.print("Deflection (1/4): "); + Serial.println(iDeflection); + + Serial.print("Delay (2/5): "); + Serial.println(iDelay); + + Serial.print("Speed (3/6): "); + Serial.println(iSpeed); + + Serial.print("Total cycle time (2 x (Speed * Deflection)) + Delay): "); + Serial.println((iSpeed * iDeflection) + 15 + (iSpeed * iDeflection) + iDelay); + + Serial.println(); + + return (true); +} + +bool printLCDSettings(void *) +{ + lcd.clear(); + switch (displayCycle % 4) + { + case 0: + lcd.setCursor(0, 0); + lcd.print("Deflection (1/4)"); + lcd.setCursor(0, 1); + lcd.print(iDeflection); + break; + + case 1: + lcd.setCursor(0, 0); + lcd.print("Push Speed (2,5)"); + lcd.setCursor(0, 1); + lcd.print(iSpeed); + break; + + case 2: + lcd.setCursor(0, 0); + lcd.print("Push Delay (3,6)"); + lcd.setCursor(0, 1); + lcd.print(iDelay); + break; + + case 3: + lcd.setCursor(0, 0); + lcd.print("Total Cycle: "); + lcd.setCursor(0, 1); + lcd.print((iSpeed * iDeflection) + 15 + (iSpeed * iDeflection) + iDelay); + break; + } + displayCycle++; + + return (true); +} + +void doPulse() +{ + for (int i = 0; i <= iDeflection; i++) + { + mainServo.write(i); + delay(iSpeed); + } + delay(15); + for (int i = iDeflection; i > servoPosition; i--) + { + mainServo.write(i); + delay(iSpeed); + } +} + +void setup() +{ + //set up the LCD's number of columns and rows: + lcd.begin(16, 2); + + // put your setup code here, to run once: + Serial.begin(9600); + + // Setup the main server + mainServo.attach(6); + mainServo.write(0); + + Serial.println("Setup complete"); + lcd.setCursor(0, 0); + lcd.print("ACNH AutoClicker"); + + displayCycle = 0; + + timer.every(10000, printSerialSetting); + timer.every(2500, printLCDSettings); +} + +void parseInput(char c) { + switch(c) { + case '1': + iDeflection++; + displayCycle = 0; + break; + case '4': + iDeflection--; + displayCycle = 0; + break; + case '2': + iSpeed++; + displayCycle = 1; + break; + case '5': + iSpeed--; + displayCycle = 1; + break; + case '3': + iDelay+=10; + displayCycle = 2; + break; + case '6': + iDelay-=10; + displayCycle = 3; + break; + } + + iDeflection = constrain(iDeflection,0,180); + iSpeed = constrain(iSpeed, 1, 1000); + iDelay = constrain(iDelay, 10, 10000); + + printLCDSettings(0); +} + +void loop() +{ + timer.tick(); + + char customKey = customKeypad.getKey(); + + if (customKey){ + Serial.print("Console received: "); + Serial.println(customKey); + parseInput(customKey); + + } +} + +/* +void loop() +{ + // put your main code here, to run repeatedly: + //Serial.println("Hello."); + //delay(1000); + //printSetting(); + + // print the string when a newline arrives: + if (stringComplete) + { + + switch (inputString[0]) + { + case 's': + if (bRunning) + { + bRunning = false; + } + else + { + bRunning = true; + } + break; + + case 't': + // If we're running, don't do anything. + if (bRunning) + { + break; + } + else + { + doPulse(); + } + break; + + case 'a': + iDeflection++; + break; + + case 'z': + iDeflection--; + break; + + case 'd': + iDelay += 100; + break; + + case 'c': + iDelay -= 100; + break; + + case 'f': + iSpeed++; + break; + + case 'v': + iSpeed--; + break; + } + iDeflection = constrain(iDeflection, 0, 180); + iDelay = constrain(iDelay, 10, 1000); + iSpeed = constrain(iSpeed, 0, 100); + + printSetting(); + + // Serial.println(inputString); + // clear the string: + inputString = ""; + stringComplete = false; + } + + if (bRunning) + { + doPulse(); + delay(iDelay); + } +} + */ + +/* + SerialEvent occurs whenever a new data comes in the hardware serial RX. This + routine is run between each time loop() runs, so using delay inside loop can + delay response. Multiple bytes of data may be available. + +void serialEvent() +{ + while (Serial.available()) + { + // get the new byte: + char inChar = (char)Serial.read(); + // add it to the inputString: + inputString += inChar; + // if the incoming character is a newline, set a flag so the main loop can + // do something about it: + if (inChar == '\n') + { + stringComplete = true; + } + } +} +*/ diff --git a/test/README b/test/README new file mode 100644 index 0000000..df5066e --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PIO Unit Testing and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PIO Unit Testing: +- https://docs.platformio.org/page/plus/unit-testing.html