solenoid.c 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. /* Copyright 2018 mtdjr - modified by ishtob
  2. * Driver for solenoid written for QMK
  3. *
  4. * This program is free software: you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License as published by
  6. * the Free Software Foundation, either version 2 of the License, or
  7. * (at your option) any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful,
  10. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. * GNU General Public License for more details.
  13. *
  14. * You should have received a copy of the GNU General Public License
  15. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  16. */
  17. #include "timer.h"
  18. #include "solenoid.h"
  19. #include "haptic.h"
  20. #include "gpio.h"
  21. #include "usb_device_state.h"
  22. bool solenoid_on = false;
  23. bool solenoid_buzzing = false;
  24. uint16_t solenoid_start = 0;
  25. uint8_t solenoid_dwell = SOLENOID_DEFAULT_DWELL;
  26. extern haptic_config_t haptic_config;
  27. void solenoid_buzz_on(void) {
  28. haptic_set_buzz(1);
  29. }
  30. void solenoid_buzz_off(void) {
  31. haptic_set_buzz(0);
  32. }
  33. void solenoid_set_buzz(int buzz) {
  34. haptic_set_buzz(buzz);
  35. }
  36. void solenoid_set_dwell(uint8_t dwell) {
  37. solenoid_dwell = dwell;
  38. }
  39. void solenoid_stop(void) {
  40. SOLENOID_PIN_WRITE_INACTIVE();
  41. solenoid_on = false;
  42. solenoid_buzzing = false;
  43. }
  44. void solenoid_fire(void) {
  45. if (!haptic_config.buzz && solenoid_on) return;
  46. if (haptic_config.buzz && solenoid_buzzing) return;
  47. solenoid_on = true;
  48. solenoid_buzzing = true;
  49. solenoid_start = timer_read();
  50. SOLENOID_PIN_WRITE_ACTIVE();
  51. }
  52. void solenoid_check(void) {
  53. uint16_t elapsed = 0;
  54. if (!solenoid_on) return;
  55. elapsed = timer_elapsed(solenoid_start);
  56. // Check if it's time to finish this solenoid click cycle
  57. if (elapsed > solenoid_dwell) {
  58. solenoid_stop();
  59. return;
  60. }
  61. // Check whether to buzz the solenoid on and off
  62. if (haptic_config.buzz) {
  63. if ((elapsed % (SOLENOID_BUZZ_ACTUATED + SOLENOID_BUZZ_NONACTUATED)) < SOLENOID_BUZZ_ACTUATED) {
  64. if (!solenoid_buzzing) {
  65. solenoid_buzzing = true;
  66. SOLENOID_PIN_WRITE_ACTIVE();
  67. }
  68. } else {
  69. if (solenoid_buzzing) {
  70. solenoid_buzzing = false;
  71. SOLENOID_PIN_WRITE_INACTIVE();
  72. }
  73. }
  74. }
  75. }
  76. void solenoid_setup(void) {
  77. SOLENOID_PIN_WRITE_INACTIVE();
  78. setPinOutput(SOLENOID_PIN);
  79. if ((!HAPTIC_OFF_IN_LOW_POWER) || (usb_device_state == USB_DEVICE_STATE_CONFIGURED)) {
  80. solenoid_fire();
  81. }
  82. }
  83. void solenoid_shutdown(void) {
  84. SOLENOID_PIN_WRITE_INACTIVE();
  85. }