bme688x8devKit/led_controller.cpp at master · guiott/bme688x8devKit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*!
 * Copyright (c) 2021 Bosch Sensortec GmbH. All rights reserved.
 *
 * BSD-3-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @file	    led_controller.cpp
 * @date		03 Jan 2024
 * @version		2.1.5
 *
 * @brief    	led controller
 *
 *
 */

/* own header include */
#include "led_controller.h"

/*!
 * @brief The constructor of the led_controller class
 */
ledController::ledController()
{
	previous_ret_code = EDK_OK;
}

/*!
 * @brief This function initializes the led controller module
 */
void ledController::begin()
{
	/* LED pin initialization for runtime monitoring and error indication */
	pinMode(PIN_LED, OUTPUT);
	digitalWrite(PIN_LED, LOW);

	_led_on = false;
}

/*!
 * @brief This function updates the led blinking pattern according to the
 * 		  provided period
 */
void ledController::switch_led(uint32_t period)
{
	uint32_t time_stamp = millis();

	if ((time_stamp - _time_stamp) >= period)
	{

		if (_led_on)
		{
			digitalWrite(PIN_LED, LOW);
			_led_on = false;
		}
		else
		{
			digitalWrite(PIN_LED, HIGH);
			_led_on = true;
		}
		_time_stamp = time_stamp;
	}
}

/*!
 * @brief This function updates the led controller status
 */
void ledController::update(demo_ret_code retcode)
{

	if (retcode >= EDK_OK)
	{
		switch_led(LED_OK_PERIOD);
	}
	else
	{

		if (retcode != previous_ret_code)
		{
			Serial.println("Error code = " + String((int32_t) retcode));
			previous_ret_code = retcode;
		}
		switch_led(LED_ERROR_PERIOD);
	}
}