commit d2cf921cd530757bf1b62a0850844e95942ebe93 Author: drake Date: Thu Oct 31 19:30:53 2024 -0500 init 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/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..645dc73 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,72 @@ +{ + "C_Cpp_Runner.cCompilerPath": "/home/drake/.platformio/packages/toolchain-atmelavr/bin/avr-gcc", + "C_Cpp_Runner.cppCompilerPath": "/home/drake/.platformio/packages/toolchain-atmelavr/bin/avr-g++", + "C_Cpp_Runner.debuggerPath": "/home/drake/.platformio/packages/toolchain-atmelavr/bin/avr-gdb", + "C_Cpp_Runner.cStandard": "gnu11", + "C_Cpp_Runner.cppStandard": "gnu++11", + "C_Cpp_Runner.msvcBatchPath": "", + "C_Cpp_Runner.useMsvc": false, + "C_Cpp_Runner.warnings": [ + "-Wall", + "-Wextra", + "-Wpedantic", + "-Wshadow", + "-Wformat=2", + "-Wcast-align", + "-Wconversion", + "-Wsign-conversion", + "-Wnull-dereference" + ], + "C_Cpp_Runner.msvcWarnings": [ + "/W4", + "/permissive-", + "/w14242", + "/w14287", + "/w14296", + "/w14311", + "/w14826", + "/w44062", + "/w44242", + "/w14905", + "/w14906", + "/w14263", + "/w44265", + "/w14928" + ], + "C_Cpp_Runner.enableWarnings": true, + "C_Cpp_Runner.warningsAsError": false, + "C_Cpp_Runner.compilerArgs": [], + "C_Cpp_Runner.linkerArgs": [], + "C_Cpp_Runner.includePaths": [ + "/home/drake/Documents/PlatformIO/Projects/clock-controller/include", + "/home/drake/Documents/PlatformIO/Projects/clock-controller/src", + "/home/drake/Documents/PlatformIO/Projects/clock-controller/.pio/libdeps/uno/DMXSerial/src", + "/home/drake/Documents/PlatformIO/Projects/clock-controller/.pio/libdeps/uno/AccelStepper/src", + "/home/drake/.platformio/packages/framework-arduino-avr/cores/arduino", + "/home/drake/.platformio/packages/framework-arduino-avr/variants/standard", + "/home/drake/.platformio/packages/framework-arduino-avr/libraries/EEPROM/src", + "/home/drake/.platformio/packages/framework-arduino-avr/libraries/HID/src", + "/home/drake/.platformio/packages/framework-arduino-avr/libraries/SPI/src", + "/home/drake/.platformio/packages/framework-arduino-avr/libraries/SoftwareSerial/src", + "/home/drake/.platformio/packages/framework-arduino-avr/libraries/Wire/src", + "" + ], + "C_Cpp_Runner.includeSearch": [ + "*", + "**/*" + ], + "C_Cpp_Runner.excludeSearch": [ + "**/build", + "**/build/**", + "**/.*", + "**/.*/**", + "**/.vscode", + "**/.vscode/**" + ], + "C_Cpp_Runner.useAddressSanitizer": false, + "C_Cpp_Runner.useUndefinedSanitizer": false, + "C_Cpp_Runner.useLeakSanitizer": false, + "C_Cpp_Runner.showCompilationTime": false, + "C_Cpp_Runner.useLinkTimeOptimization": false, + "C_Cpp_Runner.msvcSecureNoWarnings": false +} \ No newline at end of file diff --git a/include/README b/include/README new file mode 100644 index 0000000..45496b1 --- /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..a10cade --- /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 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..c8113b7 --- /dev/null +++ b/platformio.ini @@ -0,0 +1,17 @@ +; 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 +lib_deps = + waspinator/AccelStepper@^1.64 + mathertel/DMXSerial@^1.5.3 diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..5e56996 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,67 @@ +#include +#include +#include + +#define HOUR_STEP_PIN 2 +#define HOUR_DIR_PIN 5 +#define MINUTE_STEP_PIN 3 +#define MINUTE_DIR_PIN 6 +#define STEPPER_MAX_SPEED 800 // steps/s +// #define STEPS_PER_REV 32 * 32/9 * 22/11 * 26/9 * 31/10 // steps/rev * gear ratios +#define ENABLE_PIN 8 +#define DMX_HOUR_CHANNEL 3 +#define DMX_MINUTE_CHANNEL 4 + +// Create a new instance of the AccelStepper class: +AccelStepper hourStepper = AccelStepper(1, HOUR_STEP_PIN, HOUR_DIR_PIN); +AccelStepper minuteStepper = AccelStepper(1, MINUTE_STEP_PIN, MINUTE_DIR_PIN); + +// Global Variables: +int hourVelocity; // steps per second for hour hand +int minuteVelocity; // steps per second for minute hand + +void setup() { + // Configure DMX shield (MAX485 chipset) + DMXSerial.init(DMXReceiver); + DMXSerial.write(DMX_HOUR_CHANNEL, 0); + DMXSerial.write(DMX_MINUTE_CHANNEL, 0); + + // Set the maximum speed in steps per second: + hourStepper.setMaxSpeed(STEPPER_MAX_SPEED); + minuteStepper.setMaxSpeed(STEPPER_MAX_SPEED); + + pinMode(ENABLE_PIN, OUTPUT); + digitalWrite(ENABLE_PIN, LOW); +} + +void loop() { + if (DMXSerial.noDataSince() < 5000) { + + // DMX expected values range 1-201, 101 is zero, <101 is CW, >101 is CCW. 1 & 201 map to max steps/sec + // DMX 0 is disable and maps to 0 + int HourDMXVal = DMXSerial.read(DMX_HOUR_CHANNEL); + if (HourDMXVal >= 1 && HourDMXVal <= 201) { + hourVelocity = (int)(((float)(HourDMXVal - 101) / 100.0f) * STEPPER_MAX_SPEED); + } else { + hourVelocity = 0; + } + + int minuteDMXVal = DMXSerial.read(DMX_MINUTE_CHANNEL); + if (minuteDMXVal >= 1 && minuteDMXVal <= 201) { + minuteVelocity = (int)(((float)(minuteDMXVal - 101) / 100.0f) * STEPPER_MAX_SPEED); + } else { + minuteVelocity = 0; + } + } else { + hourVelocity = 0; + minuteVelocity = 0; + } + + // Set the motor speed (steps per second): + hourStepper.setSpeed(hourVelocity); + minuteStepper.setSpeed(minuteVelocity); + // Step the motor with a constant speed as set by setSpeed(): + hourStepper.runSpeed(); + minuteStepper.runSpeed(); + +} diff --git a/test/README b/test/README new file mode 100644 index 0000000..b0416ad --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner 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 PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html