alerts.h

Go to the documentation of this file.

 
#ifndef ALERTS_H
#define ALERTS_H
 
#include <cstdint>
 
namespace lampda {
namespace logic {
namespace alerts {
 
enum class Type : uint32_t
{
  // 0 means no errors
 
  // always sort them by importance
  MAIN_LOOP_FREEZE = 1 << 0,            // main loop does not respond
  BATTERY_READINGS_INCOHERENT = 1 << 1, // the pin that reads the battery value is not coherent with
                                        // it's givent min and max
  BATTERY_CRITICAL = 1 << 2,            // battery is too low, shutdown immediatly
  BATTERY_LOW = 1 << 3,                 // battery is dangerously low
  LONG_LOOP_UPDATE = 1 << 4,            // the main loop is taking too long to execute
                                        // (bugs when reading button inputs)
  TEMP_TOO_HIGH = 1 << 5,               // Processor temperature is too high
  TEMP_CRITICAL = 1 << 6,               // Processor temperature is critical
 
  BLUETOOTH_ADVERT = 1 << 7, // bluetooth is advertising
 
  HARDWARE_ALERT = 1 << 8, // any hardware alert
 
  FAVORITE_SET = 1 << 9, // user favorite mode is set
 
  OTG_FAILED = 1 << 10, // OTG activation failed
 
  SYSTEM_OFF_FAILED = 1 << 11,     // system failed to go to sleep, big trouble here
  SYSTEM_IN_ERROR_STATE = 1 << 12, // system is locked in an error state
 
  SYSTEM_IN_LOCKOUT = 1 << 13, // system lockout, the lamp should not output any light
 
  SUNSET_TIMER_ENABLED = 1 << 14, // active sunset timer, system will auto turn off
 
  SYSTEM_SLEEP_SKIPPED = 1 << 15, // the system skipped the sleep clean phase (crash ? new flash ?)
 
  USB_PORT_SHORT = 1 << 16, // the usb port is dirty, or wet
 
  BATTERY_MISSING = 1 << 17, // no battery plugged in the system
 
  CHARGER_ERROR = 1 << 18, // the charger signaled an error
};
 
class AlertManager_t
{
public:
  void raise(const Type type);
 
  void clear(const Type type);
 
  bool is_raised(const Type type) const { return (_current & static_cast<uint32_t>(type)) != 0x00; }
 
  bool is_clear() const { return _current == 0x00; }
 
  uint32_t get_time_since_raised(const Type type) const;
 
  bool can_use_output_power() const;
 
  bool can_charge_battery() const;
 
  bool can_use_usb_port() const;
 
private:
  uint32_t _current;
};
 
extern AlertManager_t manager;
 
void signal_wake_up_from_charger();
 
void handle_all(const bool shouldIgnoreAlerts);
 
void show_all();
 
bool is_request_shutdown();
 
} // namespace alerts
} // namespace logic
} // namespace lampda
 
#endif