diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..257a4bc --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 Adam Wonak + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/analog_input.h b/analog_input.h index 7838653..496899b 100644 --- a/analog_input.h +++ b/analog_input.h @@ -5,7 +5,7 @@ * @version 0.1 * @date 2025-05-23 * - * @copyright Copyright (c) 2025 + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com * */ #ifndef ANALOG_INPUT_H diff --git a/button.h b/button.h index 16bd9a9..c66ba7c 100644 --- a/button.h +++ b/button.h @@ -1,13 +1,11 @@ /** * @file button.h * @author Adam Wonak (https://github.com/awonak) - * @brief for interacting with trigger / gate inputs. + * @brief Wrapper class for interacting with trigger / gate inputs. * @version 0.1 * @date 2025-04-20 - * - * Provide methods to convey curent state (HIGH / LOW) and change in state (disengaged, engageing, engaged, disengaging). - * - * @copyright Copyright (c) 2025 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com * */ #ifndef BUTTON_H diff --git a/clock.h b/clock.h index 8fa084e..9cb2ad8 100644 --- a/clock.h +++ b/clock.h @@ -4,8 +4,8 @@ * @brief Wrapper Class for clock timing functions. * @version 0.1 * @date 2025-05-04 - * - * @copyright Copyright (c) 2025 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com * */ diff --git a/digital_output.h b/digital_output.h index 38be3d3..9c4cfc8 100644 --- a/digital_output.h +++ b/digital_output.h @@ -4,8 +4,8 @@ * @brief Class for interacting with trigger / gate outputs. * @version 0.1 * @date 2025-04-17 - * - * @copyright Copyright (c) 2023 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com * */ #ifndef DIGITAL_OUTPUT_H diff --git a/encoder.h b/encoder.h index e9a8635..85d52f1 100644 --- a/encoder.h +++ b/encoder.h @@ -4,8 +4,8 @@ * @brief Class for interacting with encoders. * @version 0.1 * @date 2025-04-19 - * - * @copyright Copyright (c) 2025 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com * */ #ifndef ENCODER_DIR_H diff --git a/firmware/Gravity/Gravity.ino b/firmware/Gravity/Gravity.ino index a7842b2..34de653 100644 --- a/firmware/Gravity/Gravity.ino +++ b/firmware/Gravity/Gravity.ino @@ -2,10 +2,11 @@ * @file Gravity.ino * @author Adam Wonak (https://github.com/awonak/) * @brief Alt firmware version of Gravity by Sitka Instruments. - * @version 0.1 - * @date 2025-05-04 + * @version v2.0.1 - June 2025 awonak - Full rewrite + * @version v1.0 - August 2023 Oleksiy H - Initial release + * @date 2025-07-04 * - * @copyright Copyright (c) 2025 + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com * * This version of Gravity firmware is a full rewrite that leverages the * libGravity hardware abstraction library. The goal of this project was to diff --git a/firmware/Gravity/app_state.h b/firmware/Gravity/app_state.h index c52fc26..e7d9ab5 100644 --- a/firmware/Gravity/app_state.h +++ b/firmware/Gravity/app_state.h @@ -1,3 +1,14 @@ +/** + * @file app_state.h + * @author Adam Wonak (https://github.com/awonak/) + * @brief Alt firmware version of Gravity by Sitka Instruments. + * @version 2.0.1 + * @date 2025-07-04 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com + * + */ + #ifndef APP_STATE_H #define APP_STATE_H diff --git a/firmware/Gravity/channel.h b/firmware/Gravity/channel.h index 309ce98..6f46b28 100644 --- a/firmware/Gravity/channel.h +++ b/firmware/Gravity/channel.h @@ -1,3 +1,14 @@ +/** + * @file channel.h + * @author Adam Wonak (https://github.com/awonak/) + * @brief Alt firmware version of Gravity by Sitka Instruments. + * @version 2.0.1 + * @date 2025-07-04 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com + * + */ + #ifndef CHANNEL_H #define CHANNEL_H diff --git a/firmware/Gravity/display.h b/firmware/Gravity/display.h index c000dde..cf37631 100644 --- a/firmware/Gravity/display.h +++ b/firmware/Gravity/display.h @@ -1,3 +1,14 @@ +/** + * @file display.h + * @author Adam Wonak (https://github.com/awonak/) + * @brief Alt firmware version of Gravity by Sitka Instruments. + * @version 2.0.1 + * @date 2025-07-04 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com + * + */ + #ifndef DISPLAY_H #define DISPLAY_H diff --git a/firmware/Gravity/euclidean.h b/firmware/Gravity/euclidean.h index 33dfe56..8956ffd 100644 --- a/firmware/Gravity/euclidean.h +++ b/firmware/Gravity/euclidean.h @@ -1,3 +1,14 @@ +/** + * @file euclidean.h + * @author Adam Wonak (https://github.com/awonak/) + * @brief Alt firmware version of Gravity by Sitka Instruments. + * @version 2.0.1 + * @date 2025-07-04 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com + * + */ + #ifndef EUCLIDEAN_H #define EUCLIDEAN_H diff --git a/firmware/Gravity/save_state.cpp b/firmware/Gravity/save_state.cpp index 3c1e9d9..052779b 100644 --- a/firmware/Gravity/save_state.cpp +++ b/firmware/Gravity/save_state.cpp @@ -1,3 +1,14 @@ +/** + * @file save_state.cpp + * @author Adam Wonak (https://github.com/awonak/) + * @brief Alt firmware version of Gravity by Sitka Instruments. + * @version 2.0.1 + * @date 2025-07-04 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com + * + */ + #include "save_state.h" #include diff --git a/firmware/Gravity/save_state.h b/firmware/Gravity/save_state.h index a8d5a7e..354253a 100644 --- a/firmware/Gravity/save_state.h +++ b/firmware/Gravity/save_state.h @@ -1,3 +1,14 @@ +/** + * @file save_state.h + * @author Adam Wonak (https://github.com/awonak/) + * @brief Alt firmware version of Gravity by Sitka Instruments. + * @version 2.0.1 + * @date 2025-07-04 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com + * + */ + #ifndef SAVE_STATE_H #define SAVE_STATE_H diff --git a/gravity.cpp b/gravity.cpp index 3ef6d2b..23d79f8 100644 --- a/gravity.cpp +++ b/gravity.cpp @@ -4,8 +4,8 @@ * @brief Library for building custom scripts for the Sitka Instruments Gravity module. * @version 0.1 * @date 2025-04-19 - * - * @copyright Copyright (c) 2025 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com * */ diff --git a/gravity.h b/gravity.h index 5701586..00539fb 100644 --- a/gravity.h +++ b/gravity.h @@ -1,3 +1,14 @@ +/** + * @file gravity.h + * @author Adam Wonak (https://github.com/awonak) + * @brief Library for building custom scripts for the Sitka Instruments Gravity module. + * @version 0.1 + * @date 2025-04-19 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com + * + */ + #ifndef GRAVITY_H #define GRAVITY_H diff --git a/peripherials.h b/peripherials.h index 5c4ec91..9eea4b6 100644 --- a/peripherials.h +++ b/peripherials.h @@ -4,10 +4,11 @@ * @brief Arduino pin definitions for the Sitka Instruments Gravity module. * @version 0.1 * @date 2025-04-19 - * - * @copyright Copyright (c) 2025 + * + * @copyright MIT - (c) 2025 - Adam Wonak - adam.wonak@gmail.com * */ + #ifndef PERIPHERIALS_H #define PERIPHERIALS_H diff --git a/uClock.cpp b/uClock.cpp index 1f53084..1003930 100755 --- a/uClock.cpp +++ b/uClock.cpp @@ -6,6 +6,12 @@ * @author Romulo Silva * @date 10/06/2017 * @license MIT - (c) 2024 - Romulo Silva - contact@midilab.co + * + * 2025-06-30 - https://github.com/awonak/uClock/tree/picoClock + * Modified by awonak to remove all unused sync callback + * methods and associated variables to dramatically reduce + * memory usage. + * See: https://github.com/midilab/uClock/issues/58 * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), diff --git a/uClock.h b/uClock.h index d8670b0..ad45334 100755 --- a/uClock.h +++ b/uClock.h @@ -6,6 +6,12 @@ * @author Romulo Silva * @date 10/06/2017 * @license MIT - (c) 2024 - Romulo Silva - contact@midilab.co + * + * 2025-06-30 - https://github.com/awonak/uClock/tree/picoClock + * Modified by awonak to remove all unused sync callback + * methods and associated variables to dramatically reduce + * memory usage. + * See: https://github.com/midilab/uClock/issues/58 * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"),