diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..89cc49cbd652508924b868ea609fa8f6b758ec56 --- /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 0000000000000000000000000000000000000000..e80666bfb11e75aafd3600701dc99c10acce341c --- /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 0000000000000000000000000000000000000000..194dcd43252dcbeb2044ee38510415041a0e7b47 --- /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 0000000000000000000000000000000000000000..6debab1e8b4c3faa0d06f4ff44bce343ce2cdcbf --- /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 <Foo.h> +#include <Bar.h> + +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 0000000000000000000000000000000000000000..f31498e58f6d76dbff86aebb1fedfae891ce085a --- /dev/null +++ b/platformio.ini @@ -0,0 +1,20 @@ +; 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:micro_pro] +platform = atmelavr +board = micro +framework = arduino +monitor_speed = 115200 +monitor_dtr = 1 +lib_deps = + bxparks/AceButton @ ^1.8.3 + arduino-libraries/Keyboard @ ^1.0.2 + fastled/FastLED @ ^3.4.0 diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000000000000000000000000000000000000..488aae68642bf55675d6466af652e0a79449a03c --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,133 @@ +#include <Arduino.h> +#include <AceButton.h> +#include <Keyboard.h> +#include <HID.h> +#include <FastLED.h> + +// Use this option for Windows and Linux: +const char HOTKEY_1 = KEY_LEFT_CTRL; +const char HOTKEY_2 = KEY_LEFT_ALT; +// Use this for OSX: +// const char HOTKEY_1 = KEY_LEFT_GUI; +// const char HOTKEY_2 = KEY_LEFT_ALT; + +#define BUTTON_PIN 2 +#define LED_PIN 3 +#define NUM_LEDS 4 +#define MIN_BRIGHTNESS 32 +#define MAX_BRIGHTNESS 255 +#define DOUBLECLICK_DELAY 400 + +using namespace ace_button; +AceButton button(BUTTON_PIN); + +CRGB leds[NUM_LEDS]; + +bool muted = false; +bool ptt = false; + +void sendHotkey() +{ + Keyboard.press(HOTKEY_1); + Keyboard.press(HOTKEY_2); + Keyboard.press('m'); + Keyboard.releaseAll(); +} + +void handleEvent(AceButton * /* button */, uint8_t eventType, + uint8_t buttonState) +{ + + switch (eventType) + { + case AceButton::kEventDoubleClicked: + if (muted) + { + muted = false; + Serial.println("Toggle: unmuted"); + } + else + { + muted = true; + Serial.println("Toggle: muted"); + } + sendHotkey(); + break; + case AceButton::kEventLongPressed: + if (muted) + { + muted = false; + Serial.println("PTT: unmuted"); + } + else + { + muted = true; + Serial.println("PTT: muted"); + } + ptt = true; + sendHotkey(); + break; + case AceButton::AceButton::kEventLongReleased: + if (muted) + { + muted = false; + Serial.println("PTT: unmuted"); + } + else + { + muted = true; + Serial.println("PTT: muted"); + } + ptt = false; + sendHotkey(); + break; + } +} + +void setup() +{ + Serial.begin(115200); + Keyboard.begin(); + pinMode(LED_BUILTIN_TX, INPUT); // switch off builtin LEDs + pinMode(LED_BUILTIN_RX, INPUT); // switch off builtin LEDs + pinMode(BUTTON_PIN, INPUT_PULLUP); + ButtonConfig *buttonConfig = button.getButtonConfig(); + buttonConfig->setEventHandler(handleEvent); + buttonConfig->setFeature(ButtonConfig::kFeatureDoubleClick); + buttonConfig->setFeature(ButtonConfig::kFeatureLongPress); + buttonConfig->setFeature(ButtonConfig::kFeatureSuppressAfterLongPress); + buttonConfig->setDoubleClickDelay(DOUBLECLICK_DELAY); + buttonConfig->setLongPressDelay(DOUBLECLICK_DELAY + 1); + FastLED.addLeds<NEOPIXEL, LED_PIN>(leds, NUM_LEDS); + delay(1000); + Serial.flush(); + Serial.println(); + Serial.println("Ultimute ready!"); + Serial.println(); +} + +void loop() +{ + button.check(); + + if (muted) + { + FastLED.setBrightness(MIN_BRIGHTNESS); + fill_solid(leds, NUM_LEDS, CRGB::Green); + } + else + { + FastLED.setBrightness(MAX_BRIGHTNESS); + fill_solid(leds, NUM_LEDS, CRGB::Red); + } + + if (ptt) + { + float breath = (exp(sin(millis() / 250.0 * PI)) - 0.36787944) * 108.0; + breath = map(breath, 0, 255, MIN_BRIGHTNESS, MAX_BRIGHTNESS); + FastLED.setBrightness(breath); + } + + FastLED.show(); + delay(5); +} diff --git a/test/README b/test/README new file mode 100644 index 0000000000000000000000000000000000000000..b94d0890faa00a63737892509a5ca77ad3bdc6c3 --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO 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 PlatformIO Unit Testing: +- https://docs.platformio.org/page/plus/unit-testing.html