61 lines
2.1 KiB
C++
61 lines
2.1 KiB
C++
/*
|
|
* Copyright (c) 2023 Fancy Code.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
#ifndef LEDS_HANDLE_H
|
|
#define LEDS_HANDLE_H
|
|
#include "SetLedState.h"
|
|
enum class DeviceStatus
|
|
{
|
|
NORMAL = 0,
|
|
TAKING_PICTURE_OR_VIDEO,
|
|
FORMATTING, ///< Prompt the user that the formatting operation is being performed.
|
|
FORMAT_KEY_HOLD_DOWN_TIPS, ///< Prompt the user that the format button has been pressed.
|
|
SD_CARD_REMOVE,
|
|
SD_CARD_INSERT,
|
|
SD_CARD_ABNORMAL,
|
|
CLOSE_WATCHDOG,
|
|
END
|
|
};
|
|
/**
|
|
* @brief LedsHandle-LED light control class, mainly used to inherit LED light control functions in different states.
|
|
*/
|
|
class LedsHandle
|
|
{
|
|
public:
|
|
LedsHandle();
|
|
virtual ~LedsHandle() = default;
|
|
|
|
protected:
|
|
/**
|
|
* @brief This function is designed as a virtual function so that when the board uses different LED circuits, this
|
|
* function can be overloaded to achieve polymorphic control of the light.
|
|
* @param status
|
|
* @param keepAliveTime
|
|
* @param blinkPeriod
|
|
*/
|
|
virtual void ControlDeviceStatusLed(const DeviceStatus &status, const long int &keepAliveTime = KEEP_ALIVE_FOREVER,
|
|
const unsigned int &blinkPeriod = LED_NOT_BLINK);
|
|
void DeleteDeviceStatusLed(void);
|
|
void DeleteAllLeds(void);
|
|
|
|
private:
|
|
/**
|
|
* @brief Definitions of various LED indicators.
|
|
* NOTE: When indicator lights with different functions switch states, the previous light state should be cleared by
|
|
* calling the DeleteState function.
|
|
*/
|
|
std::shared_ptr<SetLedState> mDeviceStatus; ///< Device status indicator.
|
|
DeviceStatus mDeviceStatusFlag;
|
|
};
|
|
#endif |