OpenSource/floatpump-firmware
1
0
Fork 0
Code Pull Requests Releases 4 Wiki Activity

REWORK: Completely refactored new menu structure

Browse Source
This commit is contained in:
Robin Dietzel 2023-01-26 13:22:43 +01:00
parent e4d5173d26
commit c247e0f40f
6 changed files with 300 additions and 258 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Core/Inc/git_rev.h
View File

@ -7,6 +7,6 @@
// Auto generated header file containing the last git revision
#define GIT_HASH "49c43ab"
#define GIT_HASH "f4e1b25"
#endif //FLOATPUMP_GIT_REVISION_TEMPLATE_H

2
Core/Src/main.cpp
View File

@ -10,7 +10,7 @@
#include "PressureChannel.h"
#include "RelayChannel.h"
#include "GPIChannel.h"
#include "NewMenu.h"
#include "Menu.h"
#define SLAVE_ADDRESS_LCD 0x4e

169
Middlewares/floatpump/Inc/Menu.h Normal file
View File

@ -0,0 +1,169 @@
//
// Created by robtor on 26.01.23.
//
#ifndef FLOATPUMP_MENU_H
#define FLOATPUMP_MENU_H
#include <cstdint>
#include <string>
#include <vector>
#include <memory>
#include <optional>
namespace floatpump {
namespace menu {
struct IMenuEntry {
virtual ~IMenuEntry() = default;
virtual auto u_press() -> void = 0;
virtual auto u_increase(uint16_t steps = 1) -> void = 0;
virtual auto u_decrease(uint16_t steps = 1) -> void = 0;
virtual auto is_entered() -> bool = 0;
virtual auto toString() -> std::string = 0;
};
template<typename T>
class MenuEntry : public IMenuEntry {
public:
MenuEntry(T *linked_config, std::string name) : m_name(name) {
m_storage = linked_config;
};
auto getValue() -> T & {
return (*m_storage);
}
auto setValue(T &value) -> void {
*m_storage = value;
}
auto relinkConfig(T *linked_config) -> void {
m_storage = linked_config;
}
protected:
T *m_storage;
std::string m_name;
bool m_entered = false;
auto buildString(std::string appendix) -> std::string;
};
class MenuEntryCheckable : public MenuEntry<bool> {
public:
MenuEntryCheckable(bool *linked_config, const std::string &name) : MenuEntry(linked_config, name) {}
auto toString() -> std::string override;
auto u_press() -> void override;
auto u_increase(uint16_t steps) -> void override {}
auto u_decrease(uint16_t steps) -> void override {}
auto is_entered() -> bool override {
return false;
}
};
class MenuEntryExecute : public MenuEntry<bool> {
public:
MenuEntryExecute(bool *linked_config, const std::string &name) : MenuEntry(linked_config, name) {}
auto u_press() -> void override;
auto u_increase(uint16_t steps) -> void override {}
auto u_decrease(uint16_t steps) -> void override {}
auto is_entered() -> bool override {
return false;
}
auto toString() -> std::string override;
};
class MenuEntryNumeric : public MenuEntry<uint16_t> {
public:
MenuEntryNumeric(uint16_t *linked_config, const std::string &name) : MenuEntry(linked_config, name) {}
auto u_press() -> void override;
auto u_increase(uint16_t steps) -> void override;
auto u_decrease(uint16_t steps) -> void override;
auto is_entered() -> bool override;
auto toString() -> std::string override;
};
class MenuEntryPercent : public MenuEntry<uint8_t> {
public:
MenuEntryPercent(uint8_t *linked_config, const std::string &name) : MenuEntry(linked_config, name) {}
auto u_press() -> void override;
auto u_increase(uint16_t steps) -> void override;
auto u_decrease(uint16_t steps) -> void override;
auto is_entered() -> bool override;
auto toString() -> std::string override;
};
class Menu {
public:
explicit Menu(const std::string &m_name) : m_name(m_name) {}
template<typename T, typename... As>
auto addEntry(As &&...args) -> void {
m_entries.push_back(std::make_unique<T>(std::forward<As>(args)...));
}
auto addSubmenu(Menu *submenu) -> void {
submenu->m_parent = this;
m_submenus.push_back(submenu);
}
auto printLine() -> const std::string {
return m_name;
}
auto getDisplayList() -> std::vector<std::string>;
auto getAllEntriesNum() -> unsigned const int {
return (m_entries.size() + m_submenus.size()) + ((m_parent != nullptr) ? 1 : 0);
}
auto getSubmenu(int index) -> Menu *;
auto getEntry(int index) -> std::optional<std::reference_wrapper<IMenuEntry>>;
auto getParent() -> Menu * {
return m_parent;
}
private:
std::vector<std::unique_ptr<IMenuEntry>> m_entries;
std::vector<Menu *> m_submenus;
Menu *m_parent = nullptr;
std::string m_name;
};
}
}
#endif //FLOATPUMP_MENU_H

2
Middlewares/floatpump/Inc/Menu_Controller.h
View File

@ -5,7 +5,7 @@
#ifndef FLOATPUMP_MENU_CONTROLLER_H
#define FLOATPUMP_MENU_CONTROLLER_H
#include "NewMenu.h"
#include "Menu.h"
#include "LCD_I2C_Driver.h"
namespace floatpump::menu {

255
Middlewares/floatpump/Inc/NewMenu.h
View File

@ -1,255 +0,0 @@
//
// Created by robtor on 26.01.23.
//
#ifndef FLOATPUMP_NEWMENU_H
#define FLOATPUMP_NEWMENU_H
#include <cstdint>
#include <string>
#include <vector>
#include <memory>
#include <optional>
namespace floatpump {
namespace menu {
struct IMenuEntry {
virtual ~IMenuEntry() = default;
virtual auto u_press() -> void = 0;
virtual auto u_increase(uint16_t steps = 1) -> void = 0;
virtual auto u_decrease(uint16_t steps = 1) -> void = 0;
virtual auto is_entered() -> bool = 0;
virtual auto toString() -> std::string = 0;
};
template<typename T>
class MenuEntry : public IMenuEntry {
public:
MenuEntry(T *linked_config, std::string name) : m_name(name) {
m_storage = linked_config;
};
auto getValue() -> T & {
return (*m_storage);
}
auto setValue(T &value) -> void {
*m_storage = value;
}
auto relinkConfig(T *linked_config) -> void {
m_storage = linked_config;
}
protected:
T *m_storage;
std::string m_name;
bool m_entered = false;
auto buildString(std::string appendix) -> std::string {
int spaces = 19 - (m_name.length() + appendix.length());
std::string spacer;
if (spaces > 0)
spacer.append(spaces, ' ');
else if (spaces < 0)
return "ERROR";
return {m_name + spacer + appendix};
}
};
class MenuEntryCheckable : public MenuEntry<bool> {
public:
MenuEntryCheckable(bool *linked_config, const std::string &name) : MenuEntry(linked_config, name) {}
auto toString() -> std::string override {
return buildString({(*m_storage) ? "ON " : "OFF"});
}
auto u_press() -> void override {
*m_storage = !(*m_storage);
}
auto u_increase(uint16_t steps) -> void override {
}
auto u_decrease(uint16_t steps) -> void override {
}
auto is_entered() -> bool override {
return false;
}
};
class MenuEntryExecute : public MenuEntry<bool> {
public:
MenuEntryExecute(bool *linked_config, const std::string &name) : MenuEntry(linked_config, name) {}
auto u_press() -> void override {
*m_storage = true;
}
auto u_increase(uint16_t steps) -> void override {
}
auto u_decrease(uint16_t steps) -> void override {
}
auto is_entered() -> bool override {
return false;
}
auto toString() -> std::string override {
return buildString({(*m_storage) ? "[--]" : "[XX]"});
}
};
class MenuEntryNumeric : public MenuEntry<uint16_t> {
public:
MenuEntryNumeric(uint16_t *linked_config, const std::string &name) : MenuEntry(linked_config, name) {}
auto u_press() -> void override {
m_entered = !m_entered;
}
auto u_increase(uint16_t steps) -> void override {
(*m_storage)++;
}
auto u_decrease(uint16_t steps) -> void override {
(*m_storage)--;
}
auto is_entered() -> bool override {
return m_entered;
}
auto toString() -> std::string override {
if (m_entered) {
return buildString({"> " + std::to_string(*m_storage)});
} else {
return buildString({" " + std::to_string(*m_storage)});
}
}
};
class MenuEntryPercent : public MenuEntry<uint8_t> {
public:
MenuEntryPercent(uint8_t *linked_config, const std::string &name) : MenuEntry(linked_config, name) {}
auto u_press() -> void override {
m_entered = !m_entered;
}
auto u_increase(uint16_t steps) -> void override {
if (*m_storage < 100)
(*m_storage)++;
}
auto u_decrease(uint16_t steps) -> void override {
if (*m_storage > 0) {
(*m_storage)--;
}
}
auto is_entered() -> bool override {
return m_entered;
}
auto toString() -> std::string override {
if (m_entered) {
return buildString({"> %" + std::to_string(*m_storage)});
} else {
return buildString({" %" + std::to_string(*m_storage)});
}
}
};
class Menu {
public:
explicit Menu(const std::string &m_name) : m_name(m_name) {}
template<typename T, typename... As>
auto addEntry(As &&...args) -> void {
m_entries.push_back(std::make_unique<T>(std::forward<As>(args)...));
}
auto addSubmenu(Menu *submenu) -> void {
submenu->m_parent = this;
m_submenus.push_back(submenu);
}
auto printLine() -> const std::string {
return m_name;
}
auto getDisplayList() -> std::vector<std::string> {
std::vector<std::string> list;
list.reserve(m_submenus.size() + m_entries.size());
//Append all Submenus
for (auto &m_submenu: m_submenus) {
list.push_back(m_submenu->printLine());
}
//Append all Entries
for (auto &m_entry: m_entries) {
list.push_back(m_entry->toString());
}
//Append Go-Back-Entry if we are within a submenu
if (m_parent != nullptr) {
list.emplace_back("<- Zurueck");
}
return list;
}
auto getAllEntriesNum() -> unsigned const int {
return (m_entries.size() + m_submenus.size()) + ((m_parent != nullptr) ? 1 : 0);
}
auto getSubmenu(int index) -> Menu * {
if (index >= 0 && index < m_submenus.size()) {
return m_submenus[index];
} else {
return nullptr;
}
}
auto getEntry(int index) -> std::optional<std::reference_wrapper<IMenuEntry>> {
if (index >= m_submenus.size() && index < m_entries.size() + m_submenus.size()) {
return *m_entries[index - m_submenus.size()];
} else {
return std::nullopt;
}
}
auto getParent() -> Menu * {
return m_parent;
}
private:
std::vector<std::unique_ptr<IMenuEntry>> m_entries;
std::vector<Menu *> m_submenus;
Menu *m_parent = nullptr;
std::string m_name;
};
}
}
#endif //FLOATPUMP_NEWMENU_H

128
Middlewares/floatpump/Src/Menu.cpp Normal file
View File

@ -0,0 +1,128 @@
//
// Created by robtor on 26.01.23.
//
#include "Menu.h"
namespace floatpump::menu {
auto MenuEntryCheckable::toString() -> std::string {
return buildString({(*m_storage) ? "ON " : "OFF"});
}
auto MenuEntryCheckable::u_press() -> void {
*m_storage = !(*m_storage);
}
auto MenuEntryExecute::u_press() -> void {
*m_storage = true;
}
auto MenuEntryExecute::toString() -> std::string {
return buildString({(*m_storage) ? "[--]" : "[XX]"});
}
auto MenuEntryNumeric::u_press() -> void {
m_entered = !m_entered;
}
auto MenuEntryNumeric::u_increase(uint16_t steps) -> void {
(*m_storage)++;
}
auto MenuEntryNumeric::u_decrease(uint16_t steps) -> void {
(*m_storage)--;
}
auto MenuEntryNumeric::is_entered() -> bool {
return m_entered;
}
auto MenuEntryNumeric::toString() -> std::string {
if (m_entered) {
return buildString({"> " + std::to_string(*m_storage)});
} else {
return buildString({" " + std::to_string(*m_storage)});
}
}
auto MenuEntryPercent::u_press() -> void {
m_entered = !m_entered;
}
auto MenuEntryPercent::u_increase(uint16_t steps) -> void {
if (*m_storage < 100)
(*m_storage)++;
}
auto MenuEntryPercent::u_decrease(uint16_t steps) -> void {
if (*m_storage > 0) {
(*m_storage)--;
}
}
auto MenuEntryPercent::is_entered() -> bool {
return m_entered;
}
auto MenuEntryPercent::toString() -> std::string {
if (m_entered) {
return buildString({"> %" + std::to_string(*m_storage)});
} else {
return buildString({" %" + std::to_string(*m_storage)});
}
}
auto Menu::getDisplayList() -> std::vector<std::string> {
std::vector<std::string> list;
list.reserve(m_submenus.size() + m_entries.size());
//Append all Submenus
for (auto &m_submenu: m_submenus) {
list.push_back(m_submenu->printLine());
}
//Append all Entries
for (auto &m_entry: m_entries) {
list.push_back(m_entry->toString());
}
//Append Go-Back-Entry if we are within a submenu
if (m_parent != nullptr) {
list.emplace_back("<- Zurueck");
}
return list;
}
auto Menu::getSubmenu(int index) -> Menu * {
if (index >= 0 && index < m_submenus.size()) {
return m_submenus[index];
} else {
return nullptr;
}
}
auto Menu::getEntry(int index) -> std::optional<std::reference_wrapper<IMenuEntry>> {
if (index >= m_submenus.size() && index < m_entries.size() + m_submenus.size()) {
return *m_entries[index - m_submenus.size()];
} else {
return std::nullopt;
}
}
template<typename T>
auto MenuEntry<T>::buildString(std::string appendix) -> std::string {
int spaces = 19 - (m_name.length() + appendix.length());
std::string spacer;
if (spaces > 0)
spacer.append(spaces, ' ');
else if (spaces < 0)
return "ERROR";
return {m_name + spacer + appendix};
}
}