elduko/Arduino-Volume-Controller
1
0
Fork 0
Code Pull Requests Actions Activity

Added fontys email
All checks were successful
Generate Documentation / build (push) Successful in 12s
Details
Build Code / build (pull_request) Successful in 1m22s
Details

Browse Source
This commit is contained in:
ElDuko
2025-10-31 15:06:12 +01:00
parent 65c4f3d0ba
commit 1837e09bc1
4 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/ledControlls.cpp
View File

@@ -1,6 +1,6 @@
/** /**
* @file ledControlls.cpp * @file ledControlls.cpp
* @author Lyubomir Penev (me@lpenev.com) * @author Lyubomir Penev (me@lpenev.com, 571147@student.fontys.nl)
* @brief This file contains all the functions which control the LEDs used to indicate the current max volume * @brief This file contains all the functions which control the LEDs used to indicate the current max volume
* @version 0.1 * @version 0.1
* @date 2025-10-31 * @date 2025-10-31

14
src/potControlls.cpp
View File

@@ -1,16 +1,16 @@
/** /**
* @file potControlls.cpp * @file potControlls.cpp
* @author Lyubomir Penev (me@lpenev.com) * @author Lyubomir Penev (me@lpenev.com, 571147@student.fontys.nl)
* @brief Here are all the functions responsible for incrementing and decrementing the potentiometer * @brief Here are all the functions responsible for incrementing and decrementing the potentiometer
* @version 0.1 * @version 0.1
* @date 2025-10-31 * @date 2025-10-31
* *
* @copyright Copyright (c) 2025 * @copyright Copyright (c) 2025
* *
* Here are all the functions responsible for incrementing and decrementing the MCP4011 digital potentiometer. For more information on the protocol used to control the potentiometer you can look on pages 29 and 31 of the datasheet, and for timing information you can checkout pages 6 and 7. * Here are all the functions responsible for incrementing and decrementing the MCP4011 digital potentiometer. For more information on the protocol used to control the potentiometer you can look on pages 29 and 31 of the datasheet, and for timing information you can checkout pages 6 and 7.
* *
* Datasheet: https://ww1.microchip.com/downloads/en/devicedoc/21978a.pdf * Datasheet: https://ww1.microchip.com/downloads/en/devicedoc/21978a.pdf
* *
*/ */
#include <Arduino.h> #include <Arduino.h>
@@ -19,7 +19,7 @@
/** /**
* @brief This function moves the potentiometer wiper one step to pin A * @brief This function moves the potentiometer wiper one step to pin A
* *
*/ */
void potIncrement() void potIncrement()
{ {
@@ -39,7 +39,7 @@ void potIncrement()
/** /**
* @brief This function moves the potentiometer wiper one step to pin B * @brief This function moves the potentiometer wiper one step to pin B
* *
*/ */
void potDecrement() void potDecrement()
{ {

6
src/staffFunctions.cpp
View File

@@ -1,6 +1,6 @@
/** /**
* @file staffFunctions.cpp * @file staffFunctions.cpp
* @author Lyubomir Penev (me@lpenev.com) * @author Lyubomir Penev (me@lpenev.com, 571147@student.fontys.nl)
* @brief Here are all the implementations of the staff functions * @brief Here are all the implementations of the staff functions
* @version 1.0 * @version 1.0
* @date 2025-10-23 * @date 2025-10-23
@@ -15,7 +15,7 @@
/** /**
* @brief Used to increase the maximum staff volume * @brief Used to increase the maximum staff volume
* *
* @param maxVolume Pointer to the variable used to keep track of staff volume * @param maxVolume Pointer to the variable used to keep track of staff volume
*/ */
void staffVolumeUp(int *maxVolume) void staffVolumeUp(int *maxVolume)
@@ -28,7 +28,7 @@ void staffVolumeUp(int *maxVolume)
/** /**
* @brief Used to decrease the maximum staff volume. If the max volume is set lower than what the current user volume is, then the user volume will also be lowered. * @brief Used to decrease the maximum staff volume. If the max volume is set lower than what the current user volume is, then the user volume will also be lowered.
* *
* @param maxVolume Pointer to the variable used to keep track of the max volume * @param maxVolume Pointer to the variable used to keep track of the max volume
* @param userVolume Pointer to the variable used to keep track of the user volume * @param userVolume Pointer to the variable used to keep track of the user volume
* @param oldUserVolume Pointer to the variable used to keep track of the user volume when in mute or lowered * @param oldUserVolume Pointer to the variable used to keep track of the user volume when in mute or lowered

2
src/userFunctions.cpp
View File

@@ -1,6 +1,6 @@
/** /**
* @file userFunctions.cpp * @file userFunctions.cpp
* @author Lyubomir Penev (me@lpenev.com) * @author Lyubomir Penev (me@lpenev.com, 571147@student.fontys.nl)
* @brief Here are all the implementations for the user functions. * @brief Here are all the implementations for the user functions.
* @version 1.0 * @version 1.0
* @date 2025-10-23 * @date 2025-10-23