Skip to content

Commit

Permalink
Merge pull request #66 from saleemhamo/development
Browse files Browse the repository at this point in the history 
Release v1.3.0
  • Loading branch information
@MikoRosa
MikoRosa authored Apr 15, 2024
2 parents 8cc6cb0 + f91a582 commit fd193cc
Show file tree
Hide file tree
Showing 327 changed files with 14,219 additions and 2,607 deletions.
9 changes: 5 additions & 4 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@

# Compiled source #
# OS generated files
.DS_Store

build/

latex/

# C++
.idea/
cmake-build-debug/
.vscode/

# CMake
CMakeFiles/
build/
app.log
cmake_install.cmake
CMakeCache.txt
Expand Down
25 changes: 24 additions & 1 deletion CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ add_executable(CrossGuard
src/main/WarningSystem.cpp
src/main/CheckingSystem.cpp
src/main/MainSystem.cpp
# include/utils/Timer.cpp
src/utils/FirestoreLogger.cpp
)

Expand Down Expand Up @@ -107,6 +106,17 @@ function(add_hardware_test TEST_NAME TEST_FILE)
endfunction(add_hardware_test)


# Assuming the Timer class is part of the 'utils' group of files
set(TIMER_SOURCES include/utils/Timer.h) # Adjust path as necessary

# Define a function for non-hardware tests if not already existing
function(add_unit_test TEST_NAME TEST_FILE)
add_executable(${TEST_NAME} ${TEST_FILE} ${TIMER_SOURCES})
target_link_libraries(${TEST_NAME} ${Boost_LIBRARIES} cpr::cpr) # Add other dependencies as needed
target_include_directories(${TEST_NAME} PRIVATE ${CMAKE_SOURCE_DIR}/include)
add_test(NAME ${TEST_NAME} COMMAND ${TEST_NAME})
endfunction(add_unit_test)

# Conditional test paths
if (CMAKE_SYSTEM_NAME STREQUAL "Linux" AND CMAKE_SYSTEM_PROCESSOR MATCHES "arm")
message(STATUS "Configuring tests for Raspberry Pi environment.")
Expand All @@ -119,5 +129,18 @@ else ()

add_hardware_test(BuzzerTest "tests/hardware_tests/actuators/Buzzer_test.cpp")
add_hardware_test(LEDTest "tests/hardware_tests/actuators/LED_test.cpp")
add_hardware_test(UltrasonicSensorTest "tests/hardware_tests/sensors/Ultrasonic_test.cpp")

# Ideas of tests to be implemented (priority order):
# add_hardware_test(CameraSensorTest "tests/hardware_tests/sensors/Camera_test.cpp")
# add_hardware_test(PushButtonTest "tests/hardware_tests/sensors/PushButton_test.cpp")
add_unit_test(TimerTest "tests/TimerTest.cpp")
# add_unit_test(CheckingSystemTest "tests/hardware_tests/main/CheckingSystem_test.cpp")
# add_unit_test(WarningSystemTest "tests/hardware_tests/main/WarningSystem_test.cpp")
# add_unit_test(TrafficLightTest "tests/hardware_tests/models/TrafficLight_test.cpp")
# add_unit_test(CarsTrafficLightSystemTest "tests/hardware_tests/main/CarsTrafficLightSystem_test.cpp")
# add_unit_test(PedestriansTrafficLightSystemTest "tests/hardware_tests/main/PedestriansTrafficLightSystem_test.cpp")
# add_unit_test(FirestoreLoggerTest "tests/hardware_tests/utils/FirestoreLogger_test.cpp")
# add_unit_test(MainSystemTest "tests/hardware_tests/main/MainSystem_test.cpp")

endif ()
87 changes: 87 additions & 0 deletions docs/Buzzer_8cpp.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CrossGuard: src/actuators/Buzzer.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CrossGuard
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_270b4e82ca98b8b59aa4791d825b6dab.html">actuators</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Buzzer.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">

<p>Controls a buzzer connected to a GPIO pin on a Raspberry Pi.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;pigpio_stub.h&quot;</code><br />
<code>#include &quot;actuators/Buzzer.h&quot;</code><br />
</div><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Controls a buzzer connected to a GPIO pin on a Raspberry Pi. </p>
<p>This file contains the implementation of the <a class="el" href="classBuzzer.html" title="A class to control a buzzer connected to a GPIO pin.">Buzzer</a> class, which provides methods to turn a buzzer on and off. The class abstracts the details of using the pigpio library (or its stub for non-Raspberry Pi or non-ARM Linux environments) to manage GPIO pins.</p>
<p>If running on a typical Raspberry Pi OS and ARM architecture, the pigpio library is used. Otherwise, a stub implementation is utilized. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
97 changes: 97 additions & 0 deletions docs/Buzzer_8h_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CrossGuard: include/actuators/Buzzer.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CrossGuard
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_13d76fd5627191c8c05815bfb9a9fe9f.html">actuators</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Buzzer.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Created by Saleem Hamo on 20/02/2024.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classBuzzer.html"> 14</a></span>&#160;<span class="keyword">class </span><a class="code" href="classBuzzer.html">Buzzer</a> {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classBuzzer.html#aa7e46d651dfac39d6cd6a4466e8e1a13">Buzzer</a>(<span class="keywordtype">int</span> pin);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBuzzer.html#a9f9b9beeaa9790be935708dfb4f0d87e">on</a>();</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBuzzer.html#a5f80b023c04fa42185e431aca7c43d32">off</a>();</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">int</span> pin; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;};</div>
<div class="ttc" id="aclassBuzzer_html"><div class="ttname"><a href="classBuzzer.html">Buzzer</a></div><div class="ttdoc">A class to control a buzzer connected to a GPIO pin.</div><div class="ttdef"><b>Definition:</b> Buzzer.h:14</div></div>
<div class="ttc" id="aclassBuzzer_html_a5f80b023c04fa42185e431aca7c43d32"><div class="ttname"><a href="classBuzzer.html#a5f80b023c04fa42185e431aca7c43d32">Buzzer::off</a></div><div class="ttdeci">void off()</div><div class="ttdoc">Turns the buzzer off by setting the GPIO pin low.</div><div class="ttdef"><b>Definition:</b> Buzzer.cpp:51</div></div>
<div class="ttc" id="aclassBuzzer_html_a9f9b9beeaa9790be935708dfb4f0d87e"><div class="ttname"><a href="classBuzzer.html#a9f9b9beeaa9790be935708dfb4f0d87e">Buzzer::on</a></div><div class="ttdeci">void on()</div><div class="ttdoc">Turns the buzzer on by setting the GPIO pin high.</div><div class="ttdef"><b>Definition:</b> Buzzer.cpp:42</div></div>
<div class="ttc" id="aclassBuzzer_html_aa7e46d651dfac39d6cd6a4466e8e1a13"><div class="ttname"><a href="classBuzzer.html#aa7e46d651dfac39d6cd6a4466e8e1a13">Buzzer::Buzzer</a></div><div class="ttdeci">Buzzer(int pin)</div><div class="ttdoc">Constructs a Buzzer object associated with a specific GPIO pin.</div><div class="ttdef"><b>Definition:</b> Buzzer.cpp:32</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
98 changes: 98 additions & 0 deletions docs/CameraSensor_8h_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CrossGuard: include/sensors/CameraSensor.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">CrossGuard
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_ebe552be396c660935f2efa76e6989b7.html">sensors</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">CameraSensor.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Created by Saleem Hamo on 07/02/2024.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#ifndef _CROSS_GUARD_CAMERASENSOR_H</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#define _CROSS_GUARD_CAMERASENSOR_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="classCameraSensor.html"> 8</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCameraSensor.html">CameraSensor</a> {</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <a class="code" href="classCameraSensor.html">CameraSensor</a>();</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// ~CameraSensor();</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="keywordtype">void</span> initialize();</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <span class="keywordtype">bool</span> detectMovement(); <span class="comment">// Simulates detecting movement using the camera</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;};</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#endif </span><span class="comment">//_CROSS_GUARD_CAMERASENSOR_H</span></div>
<div class="ttc" id="aclassCameraSensor_html"><div class="ttname"><a href="classCameraSensor.html">CameraSensor</a></div><div class="ttdef"><b>Definition:</b> CameraSensor.h:8</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
Loading

0 comments on commit fd193cc

Please sign in to comment.