mirror of
https://github.com/mytechnotalent/Embedded-Hacking.git
synced 2026-04-21 10:36:03 +02:00
Kevin Thomas
3604b3c921
Rust (all 15 projects):
- Refactored overlength functions: format_counter, format_u8, format_f32_1,
format_u32_minimal, gpio_drive, read_sensor, poll_sensor, format_round_trip,
format_u32, prepare_write_buf, write_min_digits, write_temp, UartDriver::init,
init_spi, angle_to_pulse_us, compute_servo_level
- Added 200+ docstrings to test functions, mock structs, impl blocks
- Fixed pub static comments (//) to doc comments (///) in all main.rs files
- Fixed helper function ordering (helpers above callers)
- Fixed Fn(u32) -> FnMut(u32) bound in button poll_button
- Moved OneShot trait import from main.rs to board.rs in adc project
- Added unsafe {} blocks in flash unsafe fn bodies (Rust 2024 edition)
- Removed unused hal::Clock imports from pwm/servo main.rs
- All 15 projects build with zero errors and zero warnings
C Pico SDK (all 15 projects):
- Added docstrings to all public functions, macros, and static variables
- All 15 projects rebuilt with zero errors
Cleanup:
- Removed build/ and target/ directories from git tracking
- Added target/ to .gitignore
- Deleted temporary fix_rust_docs.py script
98 lines
3.1 KiB
C
98 lines
3.1 KiB
C
/**
|
|
* @file button.c
|
|
* @brief Implementation of the push-button GPIO input driver with debounce
|
|
* @author Kevin Thomas
|
|
* @date 2025
|
|
*
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2025 Kevin Thomas
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#include "button.h"
|
|
#include "pico/stdlib.h"
|
|
#include "hardware/gpio.h"
|
|
|
|
/** @brief Debounce settling time stored from button_init() */
|
|
static uint32_t debounce_delay_ms = 20;
|
|
|
|
/**
|
|
* @brief Confirm a raw active-low pin read by waiting for the debounce period
|
|
*
|
|
* After an initial low reading on the pin, this helper re-samples the pin
|
|
* after debounce_delay_ms milliseconds to confirm the reading is stable.
|
|
* This eliminates false triggers caused by mechanical contact bounce.
|
|
*
|
|
* @param pin GPIO pin number to re-sample
|
|
* @return bool true if the pin is still low after the debounce delay
|
|
*/
|
|
static bool _debounce_confirm(uint32_t pin) {
|
|
sleep_ms(debounce_delay_ms);
|
|
return !gpio_get(pin);
|
|
}
|
|
|
|
/**
|
|
* @brief Initialize a GPIO pin as an active-low button input with pull-up
|
|
*
|
|
* @param pin GPIO pin number to configure as a button input
|
|
* @param debounce_ms Debounce settling time in milliseconds
|
|
*/
|
|
void button_init(uint32_t pin, uint32_t debounce_ms) {
|
|
debounce_delay_ms = debounce_ms;
|
|
gpio_init(pin);
|
|
gpio_set_dir(pin, GPIO_IN);
|
|
gpio_pull_up(pin);
|
|
}
|
|
|
|
/**
|
|
* @brief Read the debounced state of the button
|
|
*
|
|
* @param pin GPIO pin number previously initialized with button_init()
|
|
* @return bool true if the button is firmly pressed, false if released
|
|
*/
|
|
bool button_is_pressed(uint32_t pin) {
|
|
if (!gpio_get(pin)) {
|
|
return _debounce_confirm(pin);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @brief Initialize a GPIO pin as a push-pull digital output for an indicator LED
|
|
*
|
|
* @param pin GPIO pin number to configure as an LED output
|
|
*/
|
|
void button_led_init(uint32_t pin) {
|
|
gpio_init(pin);
|
|
gpio_set_dir(pin, GPIO_OUT);
|
|
gpio_put(pin, false);
|
|
}
|
|
|
|
/**
|
|
* @brief Set the indicator LED state
|
|
*
|
|
* @param pin GPIO pin number
|
|
* @param on true to turn the LED on, false to turn it off
|
|
*/
|
|
void button_led_set(uint32_t pin, bool on) {
|
|
gpio_put(pin, on);
|
|
}
|