37 Commits

Author SHA1 Message Date
GW_MC
05a65988dd Enhance timestamp parsing and arrival data handling in MainUIHandler
- Introduced a new helper function to parse ISO 8601-like timestamps into epoch seconds.
- Improved the handling of timezones, allowing for better accuracy in arrival time calculations.
- Refactored arrival data fetching to ensure UI updates only when data changes.
- Enhanced error handling for arrival data retrieval, providing clearer messages for various error states.
- Updated formatting functions for arrival times to handle both relative and absolute formats more robustly.
2026-02-04 11:54:37 +08:00
GW_MC
af0da04e7d feat(main): Add SNTP configuration for time synchronization and update event wait conditions 2026-02-04 11:54:28 +08:00
GW_MC
a93b7fe029 feat(travel): Optimize arrival data updates and enhance UI responsiveness 2026-02-03 21:45:23 +08:00
GW_MC
1d32c7674e Replace font in Travel UI with Noto Sans TC 14
- Updated MainUI to use Noto Sans TC 14 font for labels including message, refresh time, and header.
- Modified SettingsUI to utilize Noto Sans TC 14 font for title, URL, status, and instruction labels.
2026-02-03 21:24:25 +08:00
GW_MC
6c4050e9d4 feat(travel): Enhance MTR arrival handling with retry logic and improve UI update efficiency 2026-02-03 20:49:42 +08:00
GW_MC
3617a206ff feat(travel): Refactor route handling to use direction instead of destination 2026-02-03 20:11:16 +08:00
GW_MC
c4635948e4 feat(travel): Implement settings UI and web server for MTR route configuration
- Added MainUIHandler class to manage the main UI and polling for arrival data.
- Introduced SettingsUI class for displaying QR code and configuration options.
- Created SettingsUIHandler to manage settings UI lifecycle and web server interactions.
- Developed WebHandler to handle HTTP requests for MTR route settings, including adding and removing routes.
- Implemented web endpoints for fetching MTR lines, routes, and saving settings.
- Enhanced UI with responsive design for e-ink displays and added error handling for web interactions.
2026-02-03 19:26:53 +08:00
GW_MC
0672a5fb74 feat: Enhance HttpHandler to manage response data dynamically and improve memory handling 2026-02-03 19:26:42 +08:00
GW_MC
a008106d47 feat: Organize CMakeLists for modular source management across main components 2026-02-03 15:43:56 +08:00
GW_MC
7bd230f591 feat: Implement button creation utility and refactor UI components for improved readability 2026-02-03 15:20:35 +08:00
GW_MC
f5fae825d6 fix: Correct error handling in start_web_server for web server initialization 2026-02-02 23:11:27 +08:00
GW_MC
c51991350f feat: Refactor MainUI and MainUIHandler for improved status update handling and UI consistency 2026-02-02 21:55:51 +08:00
GW_MC
08daed936e feat: Implement double buffering in LVGLHandler for improved display performance 2026-02-02 21:26:21 +08:00
GW_MC
d0c9a7c4cc update display only necessary 2026-02-02 21:17:39 +08:00
GW_MC
1dff88ed1a Fix polling error 2026-02-02 21:12:54 +08:00
GW_MC
e467951b8c feat: Implement Discord app UI and settings management
- Added MainUI class for displaying voice state, status icon, and buttons.
- Introduced MainUIHandler to manage UI interactions and bridge communication.
- Created SettingsUI for displaying QR code and configuration instructions.
- Implemented SettingsUIHandler to manage settings and web server interactions.
- Developed WebHandler for handling HTTP requests for settings configuration.
- Updated AppRegistry to initialize with the new Discord app descriptor.
- Enhanced InteractionHandler to support keyboard interactions across app switches.
- Updated UIHandler to manage app switching and rendering of app icons.
- Enabled QR code support in LVGL configuration.
2026-02-02 20:47:27 +08:00
GW_MC
12ad5be48a feat: enhance UDPClient initialization with local port binding and add WebServerHandler for HTTP server management 2026-02-02 20:46:54 +08:00
GW_MC
bcbde510e0 feat: add SystemContext class for global system component access 2026-02-02 20:46:46 +08:00
GW_MC
06e81301b2 Refactor RootLayout and UIHandler for improved structure and functionality
- Updated RootLayout to manage layout initialization and deinitialization more effectively.
- Removed unnecessary dependencies and streamlined event handling for keyboard events.
- Enhanced UIHandler to utilize shared pointers for app descriptors, improving memory management.
- Added methods for showing and hiding navigation elements in RootLayout.
- Introduced textarea widget with instant response by disabling animations.
- Improved error handling and logging throughout the UI components.
2026-02-01 13:03:56 +08:00
GW_MC
237a3a96c5 feat: add joltwallet/littlefs dependency for improved filesystem support 2026-02-01 13:00:28 +08:00
GW_MC
2a5088bec3 feat: implement LittleFSHandler and FSGuard for improved file management 2026-01-30 15:23:44 +08:00
GW_MC
b6c4477c46 feat: add littlefs dependency for improved filesystem support 2026-01-29 16:28:05 +08:00
GW_MC
7cdd5c8e53 feat: add partition configuration and update SDK settings for improved hardware support 2026-01-29 15:42:21 +08:00
GW_MC
d3d818534a feat: enhance NVS and WiFi handlers for improved credential management and error handling 2026-01-29 15:42:13 +08:00
GW_MC
2b9e9a3b04 refactor: remove old display and touch handler implementation 2026-01-29 14:42:30 +08:00
GW_MC
e2ac7f7515 refactor: clean up commented code and improve queue initialization 2026-01-29 14:42:06 +08:00
GW_MC
392bf804a2 Fix partial refresh color inversion problem 2026-01-29 14:41:48 +08:00
GW_MC
6b0dcafd8b feat: add support for inverted data transfer in SPI communication 2026-01-29 14:29:19 +08:00
GW_MC
f433abb9ec Fix: partial refresh, but color still in negative 2026-01-29 13:14:39 +08:00
GW_MC
d940027e9c refactor: remove old buffer refresh during display initialization 2026-01-29 12:47:26 +08:00
GW_MC
b7d2373b0b fix: enhance error logging for SPI data transfer and display chip info 2026-01-29 12:46:14 +08:00
GW_MC
fc79e92660 Refractored epd handler 2026-01-28 17:35:49 +08:00
GW_MC
38d5facc24 Refactor draw buffer handling 2026-01-28 13:12:49 +08:00
GW_MC
3e1a651833 refactor: remove mutex handling from LVGLHandler constructor and destructor 2026-01-28 12:20:33 +08:00
GW_MC
440a5e81ed fix: correct logic for checking display busy state 2026-01-27 20:49:27 +08:00
GW_MC
d4764b02e7 corrected naming for white and black data 2026-01-27 19:37:08 +08:00
GW_MC
3ce135a028 Squash of branch setup 2026-01-27 19:15:44 +08:00
114 changed files with 111548 additions and 2038 deletions

6
.gitignore vendored
View File

@@ -82,3 +82,9 @@ Desktop.ini
# vscode settings # vscode settings
.vscode/ .vscode/
# sample code
sample-code/
.env
*.env

View File

@@ -3,6 +3,40 @@
cmake_minimum_required(VERSION 3.16) cmake_minimum_required(VERSION 3.16)
# target_compile_options(${COMPONENT_LIB} PRIVATE -std=c++23) # target_compile_options(${COMPONENT_LIB} PRIVATE -std=c++23)
# Define the path to your .env file
set(ENV_FILE "${CMAKE_SOURCE_DIR}/.env")
# Check if the .env file exists
if(EXISTS ${ENV_FILE})
# Read the .env file line by line
file(STRINGS ${ENV_FILE} ENV_VARS)
foreach(VAR ${ENV_VARS})
# Use regex to extract the key and value
if (VAR MATCHES "([^=]+)=(.*)")
set(ENV{${CMAKE_MATCH_1}} ${CMAKE_MATCH_2})
message(STATUS "Loaded environment variable from .env: ${CMAKE_MATCH_1}")
endif()
endforeach()
else()
message(STATUS ".env file not found at ${ENV_FILE}")
endif()
# If build-time WiFi environment variables were loaded above, expose them
# as compile-time definitions so C++ can use them.
if(DEFINED ENV{WIFI_SSID})
add_compile_definitions(BUILD_WIFI_SSID="$ENV{WIFI_SSID}")
message(STATUS "Added BUILD_WIFI_SSID compile definition")
else()
message(STATUS "WIFI_SSID not defined; skipping BUILD_WIFI_SSID compile definition")
endif()
if(DEFINED ENV{WIFI_PASSWORD})
add_compile_definitions(BUILD_WIFI_PASSWORD="$ENV{WIFI_PASSWORD}")
message(STATUS "Added BUILD_WIFI_PASSWORD compile definition")
else()
message(STATUS "WIFI_PASSWORD not defined; skipping BUILD_WIFI_PASSWORD compile definition")
endif()
include($ENV{IDF_PATH}/tools/cmake/project.cmake) include($ENV{IDF_PATH}/tools/cmake/project.cmake)
# "Trim" the build. Include the minimal set of components, main, and anything it depends on. # "Trim" the build. Include the minimal set of components, main, and anything it depends on.
idf_build_set_property(MINIMAL_BUILD ON) idf_build_set_property(MINIMAL_BUILD ON)

View File

@@ -0,0 +1,556 @@
{
"AEL": {
"name": "機場快綫",
"code": "AEL",
"line_color": "#00888A",
"stations": [
{
"code": "HOK",
"name": "香港"
},
{
"code": "KOW",
"name": "九龍"
},
{
"code": "TSY",
"name": "青衣"
},
{
"code": "AIR",
"name": "機場"
},
{
"code": "AWE",
"name": "博覽館"
}
]
},
"TCL": {
"name": "東涌綫",
"code": "TCL",
"line_color": "#F38B00",
"stations": [
{
"code": "HOK",
"name": "香港"
},
{
"code": "KOW",
"name": "九龍"
},
{
"code": "OLY",
"name": "奧運"
},
{
"code": "NAC",
"name": "南昌"
},
{
"code": "LAK",
"name": "荔景"
},
{
"code": "TSY",
"name": "青衣"
},
{
"code": "SUN",
"name": "欣澳"
},
{
"code": "TUC",
"name": "東涌"
}
]
},
"TML": {
"name": "屯馬綫",
"code": "TML",
"line_color": "#9A3820",
"stations": [
{
"code": "WKS",
"name": "烏溪沙"
},
{
"code": "MOS",
"name": "馬鞍山"
},
{
"code": "HEO",
"name": "恆安"
},
{
"code": "TSH",
"name": "大水坑"
},
{
"code": "SHM",
"name": "石門"
},
{
"code": "CIO",
"name": "第一城"
},
{
"code": "STW",
"name": "沙田圍"
},
{
"code": "CKT",
"name": "車公廟"
},
{
"code": "TAW",
"name": "大圍"
},
{
"code": "HIK",
"name": "顯徑"
},
{
"code": "DIH",
"name": "鑽石山"
},
{
"code": "KAT",
"name": "啟德"
},
{
"code": "SUW",
"name": "宋皇臺"
},
{
"code": "TKW",
"name": "土瓜灣"
},
{
"code": "HOM",
"name": "何文田"
},
{
"code": "HUH",
"name": "紅磡"
},
{
"code": "ETS",
"name": "尖東"
},
{
"code": "AUS",
"name": "柯士甸"
},
{
"code": "NAC",
"name": "南昌"
},
{
"code": "MEF",
"name": "美孚"
},
{
"code": "TWW",
"name": "荃灣西"
},
{
"code": "KSR",
"name": "錦上路"
},
{
"code": "YUL",
"name": "元朗"
},
{
"code": "LOP",
"name": "朗屏"
},
{
"code": "TIS",
"name": "天水圍"
},
{
"code": "SIH",
"name": "兆康"
},
{
"code": "TUM",
"name": "屯門"
}
]
},
"TKL": {
"name": "將軍澳綫",
"code": "TKL",
"line_color": "#A35EB5",
"stations": [
{
"code": "NOP",
"name": "北角"
},
{
"code": "QUB",
"name": "鰂魚涌"
},
{
"code": "YAT",
"name": "油塘"
},
{
"code": "TIK",
"name": "調景嶺"
},
{
"code": "TKO",
"name": "將軍澳"
},
{
"code": "LHP",
"name": "康城"
},
{
"code": "HAH",
"name": "坑口"
},
{
"code": "POA",
"name": "寶琳"
}
]
},
"EAL": {
"name": "東鐵綫",
"code": "EAL",
"line_color": "#53B7E8",
"stations": [
{
"code": "ADM",
"name": "金鐘"
},
{
"code": "EXC",
"name": "會展"
},
{
"code": "HUH",
"name": "紅磡"
},
{
"code": "MKK",
"name": "旺角東"
},
{
"code": "KOT",
"name": "九龍塘"
},
{
"code": "TAW",
"name": "大圍"
},
{
"code": "SHT",
"name": "沙田"
},
{
"code": "FOT",
"name": "火炭"
},
{
"code": "RAC",
"name": "馬場"
},
{
"code": "UNI",
"name": "大學"
},
{
"code": "TAP",
"name": "大埔墟"
},
{
"code": "TWO",
"name": "太和"
},
{
"code": "FAN",
"name": "粉嶺"
},
{
"code": "SHS",
"name": "上水"
},
{
"code": "LOW",
"name": "羅湖"
},
{
"code": "LMC",
"name": "落馬洲"
}
]
},
"SIL": {
"name": "南港島綫",
"code": "SIL",
"line_color": "#B6BD00",
"stations": [
{
"code": "ADM",
"name": "金鐘"
},
{
"code": "OCP",
"name": "海洋公園"
},
{
"code": "WCH",
"name": "黃竹坑"
},
{
"code": "LET",
"name": "利東"
},
{
"code": "SOH",
"name": "海怡半島"
}
]
},
"TWL": {
"name": "荃灣綫",
"code": "TWL",
"line_color": "#E2231A",
"stations": [
{
"code": "CEN",
"name": "中環"
},
{
"code": "ADM",
"name": "金鐘"
},
{
"code": "TST",
"name": "尖沙咀"
},
{
"code": "JOR",
"name": "佐敦"
},
{
"code": "YMT",
"name": "油麻地"
},
{
"code": "MOK",
"name": "旺角"
},
{
"code": "PRE",
"name": "太子"
},
{
"code": "SSP",
"name": "深水埗"
},
{
"code": "CSW",
"name": "長沙灣"
},
{
"code": "LCK",
"name": "荔枝角"
},
{
"code": "MEF",
"name": "美孚"
},
{
"code": "LAK",
"name": "荔景"
},
{
"code": "KWF",
"name": "葵芳"
},
{
"code": "KWH",
"name": "葵興"
},
{
"code": "TWH",
"name": "大窩口"
},
{
"code": "TSW",
"name": "荃灣"
}
]
},
"ISL": {
"name": "港島綫",
"code": "ISL",
"line_color": "#007DC5",
"stations": [
{
"code": "KET",
"name": "堅尼地城"
},
{
"code": "HKU",
"name": "香港大學"
},
{
"code": "SYP",
"name": "西營盤"
},
{
"code": "SHW",
"name": "上環"
},
{
"code": "CEN",
"name": "中環"
},
{
"code": "ADM",
"name": "金鐘"
},
{
"code": "WAC",
"name": "灣仔"
},
{
"code": "CAB",
"name": "銅鑼灣"
},
{
"code": "TIH",
"name": "天后"
},
{
"code": "FOH",
"name": "炮台山"
},
{
"code": "NOP",
"name": "北角"
},
{
"code": "QUB",
"name": "鰂魚涌"
},
{
"code": "TAK",
"name": "太古"
},
{
"code": "SWH",
"name": "西灣河"
},
{
"code": "SKW",
"name": "筲箕灣"
},
{
"code": "HFC",
"name": "杏花邨"
},
{
"code": "CHW",
"name": "柴灣"
}
]
},
"KTL": {
"name": "觀塘綫",
"code": "KTL",
"line_color": "#00AB4E",
"stations": [
{
"code": "WHA",
"name": "黃埔"
},
{
"code": "HOM",
"name": "何文田"
},
{
"code": "YMT",
"name": "油麻地"
},
{
"code": "MOK",
"name": "旺角"
},
{
"code": "PRE",
"name": "太子"
},
{
"code": "SKM",
"name": "石硤尾"
},
{
"code": "KOT",
"name": "九龍塘"
},
{
"code": "LOF",
"name": "樂富"
},
{
"code": "WTS",
"name": "黃大仙"
},
{
"code": "DIH",
"name": "鑽石山"
},
{
"code": "CHH",
"name": "彩虹"
},
{
"code": "KOB",
"name": "九龍灣"
},
{
"code": "NTK",
"name": "牛頭角"
},
{
"code": "KWT",
"name": "觀塘"
},
{
"code": "LAT",
"name": "藍田"
},
{
"code": "YAT",
"name": "油塘"
},
{
"code": "TIK",
"name": "調景嶺"
}
]
},
"DRL": {
"name": "迪士尼綫",
"code": "DRL",
"line_color": "#F550A6",
"stations": [
{
"code": "SUN",
"name": "欣澳"
},
{
"code": "DIS",
"name": "迪士尼"
}
]
}
}

View File

@@ -1,4 +1,14 @@
dependencies: dependencies:
espressif/cjson:
component_hash: 9372811fb197926f522c467627cf4a8e72b681e0366e17879631da801103aef3
dependencies:
- name: idf
require: private
version: '>=5.0'
source:
registry_url: https://components.espressif.com/
type: service
version: 1.7.19
espressif/esp_lcd_touch: espressif/esp_lcd_touch:
component_hash: 3f85a7d95af876f1a6ecca8eb90a81614890d0f03a038390804e5a77e2caf862 component_hash: 3f85a7d95af876f1a6ecca8eb90a81614890d0f03a038390804e5a77e2caf862
dependencies: dependencies:
@@ -41,6 +51,16 @@ dependencies:
source: source:
type: idf type: idf
version: 5.5.2 version: 5.5.2
joltwallet/littlefs:
component_hash: 1808d73e99168f6f3c26dd31799a248484762b3a320ec4962dec11a145f4277f
dependencies:
- name: idf
require: private
version: '>=5.0'
source:
registry_url: https://components.espressif.com/
type: service
version: 1.20.3
lvgl/lvgl: lvgl/lvgl:
component_hash: 17e68bfd21f0edf4c3ee838e2273da840bf3930e5dbc3bfa6c1190c3aed41f9f component_hash: 17e68bfd21f0edf4c3ee838e2273da840bf3930e5dbc3bfa6c1190c3aed41f9f
dependencies: [] dependencies: []
@@ -49,10 +69,12 @@ dependencies:
type: service type: service
version: 9.4.0 version: 9.4.0
direct_dependencies: direct_dependencies:
- espressif/cjson
- espressif/esp_lcd_touch_gt911 - espressif/esp_lcd_touch_gt911
- espressif/esp_lvgl_port - espressif/esp_lvgl_port
- idf - idf
- joltwallet/littlefs
- lvgl/lvgl - lvgl/lvgl
manifest_hash: fef450d0c399587685f90aba8ae661965ef507d04a5fcf17633db86d5d0fbcff manifest_hash: 534b6804ed0fcb2390bfe237db938fe86c9ba00561b361035a89dde4847214f2
target: esp32 target: esp32s3
version: 2.0.0 version: 2.0.0

View File

@@ -4,7 +4,7 @@
"editor": "wokwi", "editor": "wokwi",
"parts": [ "parts": [
{ {
"type": "board-esp32-devkit-c-v4", "type": "board-esp32-s3-devkitc-1",
"id": "esp", "id": "esp",
"top": 0, "top": 0,
"left": 0, "left": 0,

View File

@@ -1,6 +1,56 @@
set(requires esp-tls spi_flash nvs_flash esp_event esp_netif esp_http_client esp_wifi) set(requires esp-tls spi_flash nvs_flash esp_event esp_netif esp_http_client esp_http_server esp_wifi esp_psram esp_lvgl_port)
file(GLOB SRCS "main.cpp" "*.cpp" "*.c" "**/*.cpp" "**/*.c")
# Start the source list with the known root source
set(SRCS "${CMAKE_CURRENT_LIST_DIR}/main.cpp")
# Delegate source collection to per-directory CMakeLists (non-recursive)
set(SUBDIRS "display" "external" "ui" "io" "network" "info" "common" "font")
foreach(dir IN LISTS SUBDIRS)
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/${dir}/CMakeLists.txt")
include("${CMAKE_CURRENT_LIST_DIR}/${dir}/CMakeLists.txt")
else()
file(GLOB DIR_SRCS "${CMAKE_CURRENT_LIST_DIR}/${dir}/*.c" "${CMAKE_CURRENT_LIST_DIR}/${dir}/*.cpp")
if(DIR_SRCS)
list(APPEND SRCS ${DIR_SRCS})
endif()
endif()
endforeach()
# Path to the source JSON in this component
set(ASSETS_SRC_DIR ${CMAKE_CURRENT_LIST_DIR}/../assets)
set(ASSETS_BINARY_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/assets)
set(MTR_JSON_SRC ${ASSETS_SRC_DIR}/MTR_LINE_STATION.json)
set(MTR_JSON_HEADER ${ASSETS_BINARY_OUTPUT_DIR}/MTR_LINE_STATION.h)
set(CUSTOM_CMAKE_MODULES_DIR ${CMAKE_CURRENT_LIST_DIR}/cmake)
## Generate a minified header at configure time using Python
find_package(Python3 COMPONENTS Interpreter)
file(MAKE_DIRECTORY ${ASSETS_BINARY_OUTPUT_DIR})
if (Python3_Interpreter_FOUND)
execute_process(
COMMAND ${Python3_EXECUTABLE} -c "import json,sys,io; sys.stdout.write(json.dumps(json.load(open(sys.argv[1], 'r', encoding='utf-8')),separators=(',',':')))"
"${MTR_JSON_SRC}"
RESULT_VARIABLE _mtr_json_minify_result
OUTPUT_VARIABLE MTR_JSON_MINIFIED
ERROR_VARIABLE _mtr_json_minify_error
OUTPUT_STRIP_TRAILING_WHITESPACE
)
if (_mtr_json_minify_result)
message(WARNING "Python minify failed (code=${_mtr_json_minify_result}): ${_mtr_json_minify_error}\nEmbedding original ${MTR_JSON_SRC} instead.")
file(READ ${MTR_JSON_SRC} MTR_JSON_MINIFIED)
elseif (NOT MTR_JSON_MINIFIED)
message(WARNING "Python minified output empty; embedding original ${MTR_JSON_SRC} instead.")
file(READ ${MTR_JSON_SRC} MTR_JSON_MINIFIED)
endif()
else()
message(WARNING "Python3 not found; embedding original JSON without minification.")
file(READ ${MTR_JSON_SRC} MTR_JSON_MINIFIED)
endif()
file(WRITE ${MTR_JSON_HEADER} "#pragma once\nstatic const char MTR_LINE_STATION_JSON[] = R\"json(${MTR_JSON_MINIFIED})json\";\n")
idf_component_register(SRCS ${SRCS} idf_component_register(SRCS ${SRCS}
PRIV_REQUIRES ${requires} PRIV_REQUIRES ${requires}
INCLUDE_DIRS "." "display" "touch" "network" "ui" "io" "common") INCLUDE_DIRS "." "${CMAKE_CURRENT_BINARY_DIR}" "display" "network" "ui" "ui/apps" "io" "common" "external")

View File

@@ -0,0 +1,20 @@
if(NOT DEFINED INPUT)
message(FATAL_ERROR "write_json_header.cmake: INPUT not defined")
endif()
if(NOT DEFINED OUTPUT)
message(FATAL_ERROR "write_json_header.cmake: OUTPUT not defined")
endif()
find_package(Python3 COMPONENTS Interpreter REQUIRED)
execute_process(
COMMAND ${Python3_EXECUTABLE} -c "import json,sys;print(json.dumps(json.load(open(sys.argv[1])),separators=(', ',':')) )" ${INPUT}
OUTPUT_VARIABLE MINIFIED_JSON
OUTPUT_STRIP_TRAILING_WHITESPACE
)
if(NOT MINIFIED_JSON)
message(FATAL_ERROR "write_json_header.cmake: failed to minify ${INPUT}")
endif()
file(WRITE ${OUTPUT} "#pragma once\nstatic const char MTR_LINE_STATION_JSON[] = R\"json(${MINIFIED_JSON})json\";\n")

View File

@@ -0,0 +1 @@
# common/ currently contains headers; no sources to add by default

View File

@@ -1,14 +1,18 @@
#pragma once #pragma once
#include "freertos/semphr.h" #include "freertos/semphr.h"
#include "freertos/portmacro.h" #include "freertos/portmacro.h"
#include "esp_log.h"
struct SemaphoreGuard { struct SemaphoreGuard {
public: public:
const SemaphoreHandle_t semaphore;
SemaphoreGuard(SemaphoreHandle_t semaphore) : semaphore(semaphore) { } SemaphoreGuard(SemaphoreHandle_t semaphore) : semaphore(semaphore) { }
portBASE_TYPE take(TickType_t ticks_to_wait = portMAX_DELAY) { portBASE_TYPE take(TickType_t ticks_to_wait = portMAX_DELAY) {
if (this->semaphore == nullptr) {
ESP_LOGE("SemaphoreGuard", "Attempted to take a null semaphore");
return pdFALSE;
}
portBASE_TYPE result = xSemaphoreTake(this->semaphore, ticks_to_wait); portBASE_TYPE result = xSemaphoreTake(this->semaphore, ticks_to_wait);
taken = (result == pdTRUE); taken = (result == pdTRUE);
return result; return result;
@@ -20,9 +24,26 @@ public:
} }
} }
// allow move semantics
SemaphoreGuard(SemaphoreGuard&& other) noexcept
: semaphore(other.semaphore), taken(other.taken) {
other.taken = false;
}
SemaphoreGuard& operator=(SemaphoreGuard&& other) noexcept {
if (this != &other) {
// move from other
taken = other.taken;
other.taken = false;
semaphore = other.semaphore;
other.semaphore = nullptr;
}
return *this;
}
private: private:
// prevent copying // prevent copying
SemaphoreGuard(const SemaphoreGuard&) = delete; SemaphoreGuard(const SemaphoreGuard&) = delete;
SemaphoreGuard& operator=(const SemaphoreGuard&) = delete; SemaphoreGuard& operator=(const SemaphoreGuard&) = delete;
SemaphoreHandle_t semaphore = nullptr;
bool taken = false; bool taken = false;
}; };

View File

@@ -0,0 +1,30 @@
#pragma once
class NetworkHandler;
class WifiHandler;
/**
* @brief System context providing access to global system components
*/
class SystemContext {
public:
static SystemContext& instance() {
static SystemContext context;
return context;
}
void set_network_handler(NetworkHandler* handler) {
network_handler_ = handler;
}
NetworkHandler* get_network_handler() const {
return network_handler_;
}
private:
SystemContext() = default;
SystemContext(const SystemContext&) = delete;
SystemContext& operator=(const SystemContext&) = delete;
NetworkHandler* network_handler_ = nullptr;
};

View File

@@ -0,0 +1,5 @@
list(APPEND SRCS
"${CMAKE_CURRENT_LIST_DIR}/eink_display_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/epd_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/lvgl_handler.cpp"
)

14
main/display/constants.h Normal file
View File

@@ -0,0 +1,14 @@
#pragma once
#include "driver/spi_master.h"
#include "driver/gpio.h"
#define PIN_TOUCH_IRQ GPIO_NUM_4
#define PIN_TOUCH_SDA GPIO_NUM_5
#define PIN_TOUCH_SCL GPIO_NUM_6
#define PIN_BUSY GPIO_NUM_7
#define PIN_RST GPIO_NUM_8
#define PIN_DC GPIO_NUM_9
#define PIN_CS GPIO_NUM_10
#define PIN_MOSI GPIO_NUM_11
#define PIN_SCK GPIO_NUM_12
#define PIN_TOUCH_RST GPIO_NUM_13

View File

@@ -1,62 +0,0 @@
#include "display.h"
#include "common/constants.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/event_groups.h"
// TODO: implement actual display functionality
DisplayHandler::DisplayHandler(QueueHandle_t touch_queue, SemaphoreHandle_t lvgl_mutex) {
(void)touch_queue;
(void)lvgl_mutex;
}
DisplayHandler::~DisplayHandler() { }
EInkDisplayHandler::EInkDisplayHandler(QueueHandle_t touch_queue, SemaphoreHandle_t lvgl_mutex)
: DisplayHandler(touch_queue, lvgl_mutex) { }
EInkDisplayHandler::~EInkDisplayHandler() { }
void EInkDisplayHandler::init(EventGroupHandle_t system_event_group) {
if (system_event_group != NULL) {
xEventGroupSetBits(system_event_group, DISPLAY_READY_BIT);
}
}
void EInkDisplayHandler::start_event_loop() {
// Minimal background task to represent display processing
xTaskCreate(
// use the static adapter and pass `this` as the task parameter
EInkDisplayHandler::task_adapter,
"display_task",
2048,
this,
tskIDLE_PRIORITY + 1,
nullptr
);
}
// static
void EInkDisplayHandler::task_adapter(void* arg) {
EInkDisplayHandler* self = static_cast<EInkDisplayHandler*>(arg);
if (self) {
self->run_event_loop();
} else {
printf("EInkDisplayHandler::task_adapter received null pointer\n");
}
// If run_event_loop ever returns, delete the task.
vTaskDelete(NULL);
}
void EInkDisplayHandler::run_event_loop() {
for (;;) {
vTaskDelay(pdMS_TO_TICKS(1000));
}
}
shutdown_display_handlerFunc EInkDisplayHandler::get_shutdown_display_handler() {
return nullptr;
}
restart_display_handlerFunc EInkDisplayHandler::get_restart_display_handler() {
return nullptr;
}

View File

@@ -1,42 +0,0 @@
#include "info/info.h"
typedef void (*shutdown_display_handlerFunc)(void);
typedef void (*restart_display_handlerFunc)(void);
class DisplayHandler {
public:
DisplayHandler(QueueHandle_t touch_queue, SemaphoreHandle_t lvgl_mutex);
// the system_event_group is used to set display-ready bit
virtual void init(EventGroupHandle_t system_event_group) = 0;
virtual void start_event_loop() = 0;
// get a handler to perform display shutdown cleanup, this is called after event loop ends and DisplayHandler is deleted
virtual shutdown_display_handlerFunc get_shutdown_display_handler() = 0;
virtual restart_display_handlerFunc get_restart_display_handler() = 0;
virtual ~DisplayHandler() = 0;
private:
DisplayHandler(const DisplayHandler&) = delete;
DisplayHandler& operator=(const DisplayHandler&) = delete;
};
class EInkDisplayHandler : public DisplayHandler {
public:
EInkDisplayHandler(QueueHandle_t touch_queue, SemaphoreHandle_t lvgl_mutex);
void init(EventGroupHandle_t system_event_group) override;
void start_event_loop() override;
shutdown_display_handlerFunc get_shutdown_display_handler() override;
restart_display_handlerFunc get_restart_display_handler() override;
~EInkDisplayHandler() override;
private:
// Task adapter used for FreeRTOS task creation. It forwards to the
// instance `run_event_loop()` method using the `this` pointer passed
// as the task parameter.
static void task_adapter(void* arg);
// Instance method that implements the display task loop.
void run_event_loop();
// prevent copying
EInkDisplayHandler(const EInkDisplayHandler&) = delete;
EInkDisplayHandler& operator=(const EInkDisplayHandler&) = delete;
};

View File

@@ -0,0 +1,789 @@
#include "display/eink_display_handler.h"
#include "display/constants.h"
#include "common/constants.h"
#include "esp_lcd_touch_gt911.h"
#include "esp_log.h"
#include <driver/i2c.h>
#include <vector>
#include "common/semaphore_guard.h"
#define TAG "EInkDisplayHandler"
#define DISPLAY_BUFFER_SIZE (EINK_HEIGHT* EINK_WIDTH) / 8 // 1 bit per pixels
#define MINIMUM_PIN_SETUP_DELAY_MS 10
#define MINIMUM_POWER_ON_DELAY_MS 100
#define PARTIAL_REFRESH_THRESHOLD 5 // Full refresh every N partial refreshes
static uint8_t* DRAW_BUFFER; // 1 bit per pixel
static uint8_t* OLD_DRAW_BUFFER; // 1 bit per pixel
static uint8_t* black_data;
static uint8_t* white_data;
EInkDisplayHandler::EInkDisplayHandler() {
black_data = static_cast<uint8_t*>(heap_caps_malloc(DISPLAY_BUFFER_SIZE, MALLOC_CAP_SPIRAM));
white_data = static_cast<uint8_t*>(heap_caps_malloc(DISPLAY_BUFFER_SIZE, MALLOC_CAP_SPIRAM));
DRAW_BUFFER = static_cast<uint8_t*>(heap_caps_malloc(DISPLAY_BUFFER_SIZE, MALLOC_CAP_SPIRAM));
OLD_DRAW_BUFFER = static_cast<uint8_t*>(heap_caps_malloc(DISPLAY_BUFFER_SIZE, MALLOC_CAP_SPIRAM));
memset(black_data, 0xFF, DISPLAY_BUFFER_SIZE); // eink uses 1 for black
memset(white_data, 0x00, DISPLAY_BUFFER_SIZE);
memset(DRAW_BUFFER, 0x00, DISPLAY_BUFFER_SIZE); // start with all white (0 = white in e-ink)
memset(OLD_DRAW_BUFFER, 0x00, DISPLAY_BUFFER_SIZE); // start with all white (0 = white in e-ink)
draw_buffer_ = DRAW_BUFFER;
old_buffer_ = OLD_DRAW_BUFFER;
refresh_mutex_ = xSemaphoreCreateMutex();
if (refresh_mutex_ == nullptr) {
ESP_LOGE(TAG, "Failed to create refresh mutex");
}
}
EInkDisplayHandler::~EInkDisplayHandler() {
if (refresh_mutex_ != nullptr) {
vSemaphoreDelete(refresh_mutex_);
}
if (tp_handle_ != nullptr) {
esp_lcd_touch_del(tp_handle_);
}
if (tp_io_handle_ != nullptr) {
esp_lcd_panel_io_del(tp_io_handle_);
}
if (black_data != nullptr) {
heap_caps_free(black_data);
}
if (white_data != nullptr) {
heap_caps_free(white_data);
}
if (DRAW_BUFFER != nullptr) {
heap_caps_free(DRAW_BUFFER);
}
if (OLD_DRAW_BUFFER != nullptr) {
heap_caps_free(OLD_DRAW_BUFFER);
}
}
esp_err_t EInkDisplayHandler::deep_sleep_display(void) {
ESP_LOGV(TAG, "Putting display into deep sleep mode...");
if (is_deep_sleep_) {
ESP_LOGW(TAG, "Display is already in deep sleep mode");
return ESP_OK;
}
{
esp_err_t err = ESP_OK;
TransactionGuard transaction_guard(this->epd_handler_);
err = transaction_guard.begin(pdMS_TO_TICKS(5000));
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to begin transaction for deep sleep: %s", esp_err_to_name(err));
return err;
}
epd_handler_.wait_for_idle();
err = epd_handler_.epd_write_cmd(0x02, transaction_guard.transaction_id()); // power off
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send power off command: %s", esp_err_to_name(err));
return err;
}
epd_handler_.wait_for_idle();
err = epd_handler_.epd_write_cmd(0x07, transaction_guard.transaction_id()); //deep sleep
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send deep sleep command: %s", esp_err_to_name(err));
return err;
}
err = epd_handler_.epd_write_data(0xA5, transaction_guard.transaction_id());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send deep sleep data: %s", esp_err_to_name(err));
return err;
}
is_deep_sleep_ = true;
return err;
}
}
esp_err_t EInkDisplayHandler::refresh_display() {
esp_err_t err = ESP_OK;
if (is_deep_sleep_) {
err = full_write(draw_buffer_, true);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Full write failed during refresh_display: %s", esp_err_to_name(err));
return err;
}
} else {
// refresh does not correctly work after recovering from deep sleep due to sram reset
{
ESP_LOGV(TAG, "Waiting for display to be idle...");
TransactionGuard transaction_guard(this->epd_handler_);
err = transaction_guard.begin(pdMS_TO_TICKS(10000));
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to begin transaction for display refresh: %s", esp_err_to_name(err));
return err;
}
if (is_deep_sleep_) {
epd_init_internal_(transaction_guard.transaction_id());
}
epd_handler_.wait_for_idle();
ESP_LOGV(TAG, "Starting display refresh...");
err = epd_handler_.epd_write_cmd(0x92, transaction_guard.transaction_id()); // enter normal mode
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to enter normal mode: %s", esp_err_to_name(err));
return err;
}
err = epd_handler_.epd_write_cmd(0x12, transaction_guard.transaction_id()); // display refresh
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send display refresh command: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS)); // at least 200us delay
epd_handler_.wait_for_idle();
}
}
{
SemaphoreGuard guard(refresh_mutex_);
if (guard.take(pdMS_TO_TICKS(5000)) != pdTRUE) {
ESP_LOGE(TAG, "Refresh mutex timeout in refresh_display");
return ESP_ERR_TIMEOUT;
}
partial_refresh_count_ = 0;
force_full_refresh_ = false;
}
ESP_LOGV(TAG, "Refresh complete");
return ESP_OK;
}
esp_err_t EInkDisplayHandler::full_write(const uint8_t* framebuffer, const bool white_basemap) {
ESP_LOGV(TAG, "Starting full refresh (3 seconds)...");
esp_err_t err = ESP_OK;
{
TransactionGuard transaction_guard(this->epd_handler_);
err = transaction_guard.begin(pdMS_TO_TICKS(10000));
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to begin transaction for full refresh: %s", esp_err_to_name(err));
return err;
}
if (is_deep_sleep_) {
epd_init_internal_(transaction_guard.transaction_id());
}
write_to_buffer_(framebuffer, RefreshArea { 0, 0, DISPLAY_WIDTH - 1, DISPLAY_HEIGHT - 1 });
epd_handler_.wait_for_idle();
// Step 0: Enter normal mode
err = epd_handler_.epd_write_cmd(0x92, transaction_guard.transaction_id()); // enter normal mode
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to enter normal mode: %s", esp_err_to_name(err));
return err;
}
// Step 1: Write old data (0x10) - Arduino uses 0xFF (all white) for base map
{
err = epd_handler_.epd_write_cmd(0x10, transaction_guard.transaction_id());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send old data command: %s", esp_err_to_name(err));
return err;
}
err = epd_handler_.transfer_spi_data(white_basemap ? black_data : white_data, DISPLAY_BUFFER_SIZE, transaction_guard.transaction_id()); // Send all white data (0xFF)
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send all white data for old data: %s", esp_err_to_name(err));
return err;
}
}
// Step 2: Write new data (0x13)
{
err = epd_handler_.epd_write_cmd(0x13, transaction_guard.transaction_id());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send new data command: %s", esp_err_to_name(err));
return err;
}
err = epd_handler_.transfer_spi_data(draw_buffer_, DISPLAY_BUFFER_SIZE, transaction_guard.transaction_id()); // Send new framebuffer data
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send framebuffer data for new data: %s", esp_err_to_name(err));
return err;
}
}
// Step 3: Trigger display refresh (DRF)
err = epd_handler_.epd_write_cmd(0x12, transaction_guard.transaction_id());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send display refresh command: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS)); // at least 200us delay
ESP_LOGV(TAG, "Display refresh triggered, BUSY pin: %d", gpio_get_level(PIN_BUSY));
// Wait for refresh to complete
epd_handler_.wait_for_idle();
}
err = deep_sleep_display();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to enter deep sleep after full refresh: %s", esp_err_to_name(err));
return err;
}
refresh_area_.reset();
memcpy(old_buffer_, draw_buffer_, DISPLAY_BUFFER_SIZE);
ESP_LOGV(TAG, "Full refresh complete");
return ESP_OK;
}
// TODO: Partial refresh is inverted in color
esp_err_t EInkDisplayHandler::partial_refresh(const uint8_t* incoming_partial_framebuffer, const RefreshArea& incoming_area, const bool is_last_partial_update) {
ESP_LOGV(TAG, "Starting partial refresh (0.3 seconds)...");
esp_err_t err = ESP_OK;
write_to_buffer_(incoming_partial_framebuffer, incoming_area);
// Always expand refresh_area_ to include incoming_area
refresh_area_.expand_to_include(incoming_area);
if (!is_last_partial_update) {
ESP_LOGV(TAG, "Partial refresh skipped (not last partial update)");
return ESP_OK;
}
{
TransactionGuard transaction_guard(this->epd_handler_);
err = transaction_guard.begin(pdMS_TO_TICKS(5000));
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to begin transaction for partial refresh: %s", esp_err_to_name(err));
return err;
}
// Wake display from deep sleep INSIDE the transaction to prevent race conditions
if (is_deep_sleep_) {
err = epd_init_internal_(transaction_guard.transaction_id());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize EPD for partial refresh: %s", esp_err_to_name(err));
return err;
}
err = refresh_old_buffer_(transaction_guard.transaction_id());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to refresh old buffer during partial refresh init: %s", esp_err_to_name(err));
return err;
}
}
RefreshArea area = refresh_area_;
if (area.x1 % 8 != 0 || area.x2 % 8 != 7) {
ESP_LOGE(TAG, "Partial refresh area x1 and x2 must be byte-aligned (x1 %% 8 == 0 and x2 %% 8 == 7)");
ESP_LOGV(TAG, "Given area: x1=%d, x2=%d", area.x1, area.x2);
return ESP_ERR_INVALID_ARG;
}
// Calculate partial buffer size based on the refresh area
const uint32_t area_width_bytes = (area.x2 - area.x1 + 1) / 8;
const uint32_t area_height = area.y2 - area.y1 + 1;
const size_t partial_buffer_size = area_width_bytes * area_height;
// uint8_t* partial_buffer = new uint8_t[partial_buffer_size];
uint8_t* partial_buffer = static_cast<uint8_t*>(heap_caps_malloc(partial_buffer_size, MALLOC_CAP_DMA | MALLOC_CAP_INTERNAL));
if (partial_buffer == nullptr) {
ESP_LOGE(TAG, "Failed to allocate partial buffer for partial refresh");
return ESP_ERR_NO_MEM;
}
// Copy the relevant area from draw_buffer_ to partial_buffer
for (int32_t row = 0; row < area_height; ++row) {
uint32_t fb_y = area.y1 + row;
uint32_t fb_x_byte_start = area.x1 / 8;
uint8_t* fb_ptr = &draw_buffer_[fb_y * (DISPLAY_WIDTH / 8) + fb_x_byte_start];
uint8_t* dest_ptr = &partial_buffer[row * area_width_bytes];
memcpy(dest_ptr, fb_ptr, area_width_bytes);
}
epd_handler_.wait_for_idle();
// Step 1 VCOM setting
std::vector<uint8_t> vcom_data = { 0xA9, 0x07 };
err = epd_handler_.epd_write_cmd_with_data(0x50, vcom_data, transaction_guard.transaction_id()); // VCOM for partial refresh
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to set VCOM for partial refresh: %s", esp_err_to_name(err));
return err;
}
// Step 2: Enter partial refresh mode
err = epd_handler_.epd_write_cmd(0x91, transaction_guard.transaction_id()); // Enter partial mode
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to enter partial refresh mode: %s", esp_err_to_name(err));
return err;
}
// Step 3: Set partial window
{
// ------DD
// DDDDD000
// ------DD
// DDDDD111
// ------DD
// DDDDDDDD
// ------DD
// DDDDDDDD
// -------D
// area should be multiple of 8 in x direction
const int32_t x_bank_start = area.x1 >> 3;
const int32_t x_bank_end = area.x2 >> 3;
std::vector<uint8_t> window_data = {
// x start, [9:8] bit -> 6 and 7 bits of x_bank_start
static_cast<uint8_t>((x_bank_start >> 5) & 0x03),
// x start, [7:3] bit + 3 bits of 0 -> 5 bits of x_bank_start and pad 3 LSBs as 0
static_cast<uint8_t>((x_bank_start & 0x1F) << 3),
// x end, [9:8] bit
static_cast<uint8_t>((x_bank_end >> 5) & 0x03),
// x end, [7:3] bit + 3 bits of 1
static_cast<uint8_t>(((x_bank_end & 0x1F) << 3) | 0x07),
// y start, [9:8] bit
static_cast<uint8_t>((area.y1 >> 8) & 0x03),
// y start, [7:0] bit
static_cast<uint8_t>(area.y1 & 0xFF),
// y end, [9:8] bit
static_cast<uint8_t>((area.y2 >> 8) & 0x03),
// y end, [7:0] bit
static_cast<uint8_t>(area.y2 & 0xFF),
0x01 // Gates scan both inside and outside of the partial window
};
ESP_LOGV(TAG, "Setting partial window: x1=%d, y1=%d, x2=%d, y2=%d",
area.x1, area.y1, area.x2, area.y2);
ESP_LOGV(TAG, "Partial window data: %02X %02X %02X %02X %02X %02X %02X %02X",
window_data[0], window_data[1], window_data[2], window_data[3], window_data[4],
window_data[5], window_data[6], window_data[7]);
err = epd_handler_.epd_write_cmd_with_data(0x90, window_data, transaction_guard.transaction_id()); // Set partial window
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send set partial window command: %s", esp_err_to_name(err));
return err;
}
}
// Step 5: Write new data (0x13)
{
err = epd_handler_.epd_write_cmd(0x13, transaction_guard.transaction_id());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send new data command for partial refresh: %s", esp_err_to_name(err));
heap_caps_free(partial_buffer);
return err;
}
// Send only the partial area data, not the full display buffer
ESP_LOGV(TAG, "Sending new partial buffer: %zu bytes (area: %dx%d)",
partial_buffer_size, area_width_bytes * 8, area_height);
err = epd_handler_.transfer_spi_data(partial_buffer, partial_buffer_size, transaction_guard.transaction_id(), true); // Inverted for partial refresh
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send partial_buffer data for partial refresh: %s", esp_err_to_name(err));
heap_caps_free(partial_buffer);
return err;
}
memcpy(old_buffer_, draw_buffer_, DISPLAY_BUFFER_SIZE);
}
// Clean up partial buffer
heap_caps_free(partial_buffer);
// Step 6: Trigger partial display refresh (DRF)
// Use 0x12 (Display Update) command - same as full refresh, per sample code
err = epd_handler_.epd_write_cmd(0x12, transaction_guard.transaction_id());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send display refresh command for partial refresh: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS)); // at least 200us delay
epd_handler_.wait_for_idle();
// Step 7: Exit partial mode
err = epd_handler_.epd_write_cmd(0x92, transaction_guard.transaction_id());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to exit partial refresh mode: %s", esp_err_to_name(err));
return err;
}
}
ESP_LOGV(TAG, "Partial refresh complete");
err = deep_sleep_display();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to enter deep sleep after partial refresh: %s", esp_err_to_name(err));
return err;
}
if (force_full_refresh_) {
ESP_LOGV(TAG, "Full refresh already requested, skipping partial refresh count increment");
err = refresh_display();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to perform forced full refresh: %s", esp_err_to_name(err));
return err;
}
return ESP_OK;
}
{
SemaphoreGuard guard(refresh_mutex_);
if (guard.take(pdMS_TO_TICKS(5000)) != pdTRUE) {
ESP_LOGE(TAG, "Refresh mutex timeout in partial_refresh");
return ESP_ERR_TIMEOUT;
}
if (partial_refresh_count_ < UINT32_MAX) {
partial_refresh_count_++;
}
if (partial_refresh_count_ >= PARTIAL_REFRESH_THRESHOLD) {
ESP_LOGV(TAG, "Partial refresh count %u reached threshold %u, next refresh will be full",
partial_refresh_count_, PARTIAL_REFRESH_THRESHOLD);
force_full_refresh_ = true;
partial_refresh_count_ = 0;
}
}
refresh_area_.reset();
return ESP_OK;
}
esp_err_t EInkDisplayHandler::clear_display(void) {
ESP_LOGV(TAG, "Clearing display to all white...");
esp_err_t err = full_write(white_data, false);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to clear display: %s", esp_err_to_name(err));
return err;
}
ESP_LOGV(TAG, "Display cleared to all white");
return ESP_OK;
}
void EInkDisplayHandler::write_to_buffer_(const uint8_t* src_buffer, const RefreshArea& area) {
// Copy the relevant area from src_buffer to draw_buffer_
const uint32_t area_width_bytes = (area.x2 - area.x1 + 1) / 8;
const uint32_t area_height = area.y2 - area.y1 + 1;
for (int32_t row = 0; row < area_height; ++row) {
uint32_t fb_y = area.y1 + row;
uint32_t fb_x_byte_start = area.x1 / 8;
const uint8_t* src_ptr = &src_buffer[row * area_width_bytes];
uint8_t* dest_ptr = &draw_buffer_[fb_y * (DISPLAY_WIDTH / 8) + fb_x_byte_start];
memcpy(dest_ptr, src_ptr, area_width_bytes);
}
}
// Request a full refresh on next flush
void EInkDisplayHandler::request_full_refresh(void) {
SemaphoreGuard guard(refresh_mutex_);
if (guard.take(pdMS_TO_TICKS(100))) {
force_full_refresh_ = true;
partial_refresh_count_ = 0;
ESP_LOGV(TAG, "Full refresh requested");
} else {
ESP_LOGE(TAG, "Failed to take refresh mutex to request full refresh");
}
}
esp_err_t EInkDisplayHandler::init_devices(EventGroupHandle_t system_event_group) {
esp_err_t err;
err = init_display_pins_();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize display pins: %s", esp_err_to_name(err));
return err;
}
err = this->epd_handler_.init();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize EPD handler: %s", esp_err_to_name(err));
return err;
}
err = init_touch_();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize touch: %s", esp_err_to_name(err));
return err;
}
// if system_event_group is provided, set display ready bits
if (system_event_group != nullptr) {
// Indicate that display is ready
xEventGroupSetBits(system_event_group, DISPLAY_READY_BIT | TOUCH_CALIBRATED_BIT);
ESP_LOGV(TAG, "Display marked as ready");
}
return ESP_OK;
}
esp_err_t EInkDisplayHandler::init_display_pins_(void) {
ESP_LOGV(TAG, "Initializing E-Ink display handler...");
esp_err_t ret;
// Initialize GPIO pins
gpio_config_t io_conf = {};
io_conf.pin_bit_mask = (1ULL << PIN_DC) | (1ULL << PIN_RST);
io_conf.mode = GPIO_MODE_OUTPUT;
io_conf.pull_up_en = GPIO_PULLUP_DISABLE;
io_conf.pull_down_en = GPIO_PULLDOWN_DISABLE;
io_conf.intr_type = GPIO_INTR_DISABLE;
ret = gpio_config(&io_conf);
if (ret != ESP_OK) {
ESP_LOGE(TAG, "Failed to configure GPIO pins: %s", esp_err_to_name(ret));
return ret;
}
// Configure BUSY pin as input (no pull-up like sample code)
io_conf.pin_bit_mask = (1ULL << PIN_BUSY);
io_conf.mode = GPIO_MODE_INPUT;
io_conf.pull_up_en = GPIO_PULLUP_DISABLE;
io_conf.pull_down_en = GPIO_PULLDOWN_DISABLE;
ret = gpio_config(&io_conf);
if (ret != ESP_OK) {
ESP_LOGE(TAG, "Failed to configure BUSY pin: %s", esp_err_to_name(ret));
return ret;
}
return ESP_OK;
}
esp_err_t EInkDisplayHandler::epd_init_internal_(uint32_t transaction_id) {
ESP_LOGV(TAG, "Initializing EPD...");
esp_err_t err;
// 1. Hardware Reset
err = gpio_set_level(PIN_RST, 0);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to set PIN_RST low: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS));
err = gpio_set_level(PIN_RST, 1);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to set PIN_RST high: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS));
// 2. Initialization Sequence
std::vector<uint8_t> panel_setting_data = { 0x1F };
err = epd_handler_.epd_write_cmd_with_data(0x00, panel_setting_data, transaction_id); // Panel Setting
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send Panel Setting command: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS));
std::vector<uint8_t> vcom_data = { 0x10, 0x07 };
err = epd_handler_.epd_write_cmd_with_data(0x50, vcom_data, transaction_id); // VCOM
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send VCOM command: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS));
err = epd_handler_.epd_write_cmd(0x04, transaction_id); // Power ON
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send Power ON command: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_POWER_ON_DELAY_MS)); // Wait for power on
// Check BUSY pin with detailed logging
ESP_LOGV(TAG, "Waiting for EPD to be ready after power on...");
ESP_LOGV(TAG, "BUSY pin level after power on: %d (0=BUSY, 1=FREE)", gpio_get_level(PIN_BUSY));
epd_handler_.wait_for_idle();
std::vector<uint8_t> booster_data = { 0x27, 0x27, 0x18, 0x17 };
err = epd_handler_.epd_write_cmd_with_data(0x06, booster_data, transaction_id); // Booster Soft Start
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send Booster Soft Start command: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS));
// Enhanced display drive commands
std::vector<uint8_t> e0_data = { 0x02 };
err = epd_handler_.epd_write_cmd_with_data(0xE0, e0_data, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send Enhanced Display Drive command: %s", esp_err_to_name(err));
return err;
}
std::vector<uint8_t> e5_data = { 0x5A };
err = epd_handler_.epd_write_cmd_with_data(0xE5, e5_data, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send Enhanced Display Drive command: %s", esp_err_to_name(err));
return err;
}
is_deep_sleep_ = false;
return err;
}
// Internal version that uses an existing transaction (no separate TransactionGuard)
esp_err_t EInkDisplayHandler::epd_init_partial_internal_(uint32_t transaction_id) {
ESP_LOGV(TAG, "Initializing EPD for partial refresh (internal)...");
esp_err_t err = ESP_OK;
// 1. Hardware Reset
err = gpio_set_level(PIN_RST, 0);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to set PIN_RST low: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS));
err = gpio_set_level(PIN_RST, 1);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to set PIN_RST high: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS));
// 2. Panel Setting
std::vector<uint8_t> panel_setting_data = { 0x1F };
err = epd_handler_.epd_write_cmd_with_data(0x00, panel_setting_data, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send Panel Setting command: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_PIN_SETUP_DELAY_MS));
// 3. Power ON
err = epd_handler_.epd_write_cmd(0x04, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send Power ON command: %s", esp_err_to_name(err));
return err;
}
vTaskDelay(pdMS_TO_TICKS(MINIMUM_POWER_ON_DELAY_MS));
epd_handler_.wait_for_idle();
// 4. Partial initialization sequence - Enhanced Display Drive
std::vector<uint8_t> e0_data = { 0x02 };
err = epd_handler_.epd_write_cmd_with_data(0xE0, e0_data, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send Enhanced Display Drive command (E0): %s", esp_err_to_name(err));
return err;
}
std::vector<uint8_t> e5_data = { 0x6E };
err = epd_handler_.epd_write_cmd_with_data(0xE5, e5_data, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send Enhanced Display Drive command (E5): %s", esp_err_to_name(err));
return err;
}
is_deep_sleep_ = false;
err = refresh_old_buffer_(transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to refresh old buffer during partial init: %s", esp_err_to_name(err));
return err;
}
ESP_LOGV(TAG, "EPD partial init (internal) complete");
return ESP_OK;
}
esp_err_t EInkDisplayHandler::init_touch_() {
ESP_LOGV(TAG, "Initializing touch...");
esp_err_t err;
// 1. Initialize I2C Bus
i2c_config_t conf = {};
conf.mode = I2C_MODE_MASTER;
conf.sda_io_num = PIN_TOUCH_SDA;
conf.scl_io_num = PIN_TOUCH_SCL;
conf.sda_pullup_en = GPIO_PULLUP_ENABLE;
conf.scl_pullup_en = GPIO_PULLUP_ENABLE;
conf.master.clk_speed = 400000;
err = i2c_param_config(I2C_NUM_0, &conf);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to configure I2C parameters: %s", esp_err_to_name(err));
return err;
}
err = i2c_driver_install(I2C_NUM_0, I2C_MODE_MASTER, 0, 0, 0);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to install I2C driver: %s", esp_err_to_name(err));
return err;
}
ESP_LOGV("DisplayHandler", "I2C driver installed");
// 2. Initialize GT911
ESP_LOGV("DisplayHandler", "Initializing GT911 touch controller...");
esp_lcd_panel_io_i2c_config_t tp_io_config = {};
// temporarily disable -Wmissing-field-initializers, as ESP_LCD_TOUCH_IO_I2C_GT911_CONFIG macro does not set all fields
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wmissing-field-initializers"
esp_lcd_panel_io_i2c_config_t default_tp_io_config = ESP_LCD_TOUCH_IO_I2C_GT911_CONFIG();
#pragma GCC diagnostic pop
tp_io_config.dev_addr = default_tp_io_config.dev_addr;
tp_io_config.control_phase_bytes = default_tp_io_config.control_phase_bytes;
tp_io_config.dc_bit_offset = default_tp_io_config.dc_bit_offset;
tp_io_config.lcd_cmd_bits = default_tp_io_config.lcd_cmd_bits;
tp_io_config.flags = default_tp_io_config.flags;
esp_lcd_new_panel_io_i2c(I2C_NUM_0, &tp_io_config, &tp_io_handle_);
// GT911-specific config with I2C address (0x5D = INT low during reset)
static esp_lcd_touch_io_gt911_config_t gt911_config = {
.dev_addr = ESP_LCD_TOUCH_IO_I2C_GT911_ADDRESS // 0x5D
};
esp_lcd_touch_config_t tp_cfg = {};
tp_cfg.x_max = DISPLAY_WIDTH;
tp_cfg.y_max = DISPLAY_HEIGHT;
tp_cfg.rst_gpio_num = PIN_TOUCH_RST;
tp_cfg.int_gpio_num = PIN_TOUCH_IRQ;
tp_cfg.driver_data = &gt911_config; // Pass GT911-specific config for automatic reset
err = esp_lcd_touch_new_i2c_gt911(tp_io_handle_, &tp_cfg, &tp_handle_);
if (err == ESP_OK && tp_handle_ != nullptr) {
ESP_LOGV(TAG, "GT911 touch controller initialized successfully");
} else {
ESP_LOGE(TAG, "GT911 touch controller initialization failed: %s", esp_err_to_name(err));
tp_handle_ = nullptr;
}
return err;
}
esp_err_t EInkDisplayHandler::refresh_old_buffer_(uint32_t transaction_id) {
ESP_LOGV(TAG, "Refreshing display SRAM to restore state after wake...");
esp_err_t err;
err = epd_handler_.epd_write_cmd(0x92, transaction_id); // enter normal mode
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to enter normal mode: %s", esp_err_to_name(err));
return err;
}
// Write OLD data (0x10) as all 0x00 (white in e-ink terms)
// This tells the controller: "assume display was all white"
// Matches sample's EPD_WhiteScreen_ALL() which uses 0x00 for old SRAM
// The differential refresh: old=0 + new=0 → stay white, old=0 + new=1 → drive to black
err = epd_handler_.epd_write_cmd(0x10, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send old data command: %s", esp_err_to_name(err));
return err;
}
// Send the old buffer as old data
err = epd_handler_.transfer_spi_data(old_buffer_, DISPLAY_BUFFER_SIZE, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send white baseline to old SRAM: %s", esp_err_to_name(err));
return err;
}
// Write NEW data (0x13) with the actual display content
// This restores the display to show old_buffer_ content
err = epd_handler_.epd_write_cmd(0x13, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send new data command: %s", esp_err_to_name(err));
return err;
}
// Send the last displayed content to new SRAM
err = epd_handler_.transfer_spi_data(old_buffer_, DISPLAY_BUFFER_SIZE, transaction_id);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send display content to new SRAM: %s", esp_err_to_name(err));
return err;
}
ESP_LOGV(TAG, "Display SRAM restored successfully");
return ESP_OK;
}

View File

@@ -0,0 +1,98 @@
#pragma once
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "esp_lcd_touch_gt911.h"
#include "common/semaphore_guard.h"
#include <vector>
#include <atomic>
#include "epd_handler.h"
// Refresh mode configuration
#define DISPLAY_WIDTH 800
#define DISPLAY_HEIGHT 480
// forward declarations
class EInkDisplayHandler;
struct RefreshArea {
public:
RefreshArea(int32_t x_start, int32_t y_start, int32_t x_end, int32_t y_end)
: x1(x_start), y1(y_start), x2(x_end), y2(y_end) { }
int32_t x1;
int32_t y1;
int32_t x2;
int32_t y2;
// reset to empty area
void reset() {
x1 = y1 = x2 = y2 = 0;
}
// expand area to include another area
void expand_to_include(const RefreshArea& other) {
expand_to_include(other.x1, other.y1, other.x2, other.y2);
}
void expand_to_include(int32_t x1, int32_t y1, int32_t x2, int32_t y2) {
const bool force_update = is_empty();
if (x1 < this->x1 || force_update) this->x1 = x1;
if (y1 < this->y1 || force_update) this->y1 = y1;
if (x2 > this->x2 || force_update) this->x2 = x2;
if (y2 > this->y2 || force_update) this->y2 = y2;
}
bool is_empty() const {
return (x1 == 0 && y1 == 0 && x2 == 0 && y2 == 0);
}
uint32_t area() const {
if (is_empty()) return 0;
return (x2 - x1 + 1) * (y2 - y1 + 1);
}
};
class EInkDisplayHandler {
public:
EInkDisplayHandler();
virtual ~EInkDisplayHandler();
esp_err_t init_devices(EventGroupHandle_t system_event_group = nullptr);
esp_err_t refresh_display(void);
esp_err_t full_write(const uint8_t* framebuffer, const bool white_basemap = true);
esp_err_t partial_refresh(const uint8_t* framebuffer, const RefreshArea& area, const bool is_last_partial_update = true);
esp_err_t clear_display(void);
esp_err_t deep_sleep_display(void);
// Request a full refresh on next flush
void request_full_refresh(void);
bool is_busy() {
return epd_handler_.is_busy();
}
esp_lcd_touch_handle_t get_touch_handle() const { return tp_handle_; }
private:
esp_err_t init_display_pins_(void);
esp_err_t epd_init_internal_(uint32_t transaction_id); // full fast refresh init
esp_err_t epd_init_partial_internal_(uint32_t transaction_id); // partial refresh init (within existing transaction)
esp_err_t init_touch_(void);
// write to the internal draw buffer
void write_to_buffer_(const uint8_t* src, const RefreshArea& area);
// write the internal draw buffer to the display's old sram
esp_err_t refresh_old_buffer_(uint32_t transaction_id);
EPDHandler epd_handler_;
uint32_t partial_refresh_count_ = 0;
bool force_full_refresh_ = false;
std::atomic<bool> is_deep_sleep_ { false };
SemaphoreHandle_t refresh_mutex_ = nullptr;
esp_lcd_panel_io_handle_t tp_io_handle_ = nullptr;
esp_lcd_touch_handle_t tp_handle_ = nullptr;
// this buffer reflects the current display state (1=black, 0=white)
uint8_t* draw_buffer_ = nullptr;
uint8_t* old_buffer_ = nullptr;
RefreshArea refresh_area_ = { 0, 0, 0, 0 };
};

View File

@@ -0,0 +1,326 @@
#include "display/epd_handler.h"
#include "esp_log.h"
#include "display/constants.h"
#include "common/constants.h"
#include "esp_lcd_touch_gt911.h"
#include <driver/i2c.h>
#define TAG "EPDHandler"
#define BUSY_ACTIVE_LEVEL 0 // BUSY pin is active low
#define BUSY_INACTIVE_LEVEL 1
#define DMA_TRANSFER_CHUNK_SIZE 4096 // 4KB chunk size for DMA transfers
EPDHandler::EPDHandler() {
spi_mutex_ = xSemaphoreCreateMutex();
if (spi_mutex_ == nullptr) {
ESP_LOGE(TAG, "Failed to create SPI mutex");
}
spi_transaction_mutex_ = xSemaphoreCreateMutex();
if (spi_transaction_mutex_ == nullptr) {
ESP_LOGE(TAG, "Failed to create SPI transaction mutex");
}
}
EPDHandler::~EPDHandler() {
if (spi_mutex_ != nullptr) {
vSemaphoreDelete(spi_mutex_);
}
if (spi_transaction_mutex_ != nullptr) {
vSemaphoreDelete(spi_transaction_mutex_);
}
if (spi_ != nullptr) {
spi_bus_remove_device(spi_);
}
}
esp_err_t EPDHandler::init() {
esp_err_t err;
// Initialize SPI bus
spi_bus_config_t buscfg = {};
buscfg.mosi_io_num = 11; // MOSI pin
buscfg.miso_io_num = -1; // No MISO for e-paper
buscfg.sclk_io_num = 12; // SCK pin
buscfg.quadwp_io_num = -1;
buscfg.quadhd_io_num = -1;
buscfg.max_transfer_sz = DMA_TRANSFER_CHUNK_SIZE;
err = spi_bus_initialize(SPI2_HOST, &buscfg, SPI_DMA_CH_AUTO);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize SPI bus: %s", esp_err_to_name(err));
return err;
}
// Add SPI device
spi_device_interface_config_t devcfg = {};
devcfg.clock_speed_hz = 10 * 1000 * 1000; // 10 MHz
devcfg.mode = 0; // SPI mode 0
devcfg.spics_io_num = PIN_CS;
devcfg.queue_size = 7; // Queue size for non-blocking transactions
devcfg.pre_cb = nullptr;
err = spi_bus_add_device(SPI2_HOST, &devcfg, &spi_);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to add SPI device: %s", esp_err_to_name(err));
return err;
}
return ESP_OK;
}
// Check if display is busy (refreshing)
bool EPDHandler::is_busy(void) const {
return gpio_get_level(PIN_BUSY) != BUSY_ACTIVE_LEVEL; // BUSY is active LOW
}
void EPDHandler::wait_for_idle(void) const {
ESP_LOGV(TAG, "Waiting for display ready (BUSY pin)...");
int initial_level = gpio_get_level(PIN_BUSY);
ESP_LOGV(TAG, "Initial BUSY pin level: %d (0=BUSY, 1=FREE)", initial_level);
// If already free, no need to wait
if (initial_level == BUSY_INACTIVE_LEVEL) {
ESP_LOGV(TAG, "Display already ready (BUSY pin = 1)");
return;
}
while (gpio_get_level(PIN_BUSY) != BUSY_INACTIVE_LEVEL) {
vTaskDelay(pdMS_TO_TICKS(10));
}
ESP_LOGV(TAG, "Display is now ready (BUSY pin = 1)");
}
esp_err_t EPDHandler::epd_write_cmd(const uint8_t cmd, uint32_t transaction_id) {
ESP_LOGV(TAG, "epd_write_cmd: waiting to send 0x%02X", cmd);
SemaphoreGuard transaction_guard(spi_transaction_mutex_);
esp_err_t err =
wait_for_transaction_end_(pdMS_TO_TICKS(5000), transaction_id, transaction_guard);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to wait for previous transaction end before sending cmd 0x%02X: %s",
cmd, esp_err_to_name(err));
return err;
}
SemaphoreGuard guard(spi_mutex_);
if (!guard.take(pdMS_TO_TICKS(5000))) {
ESP_LOGE(TAG, "SPI mutex timeout for cmd 0x%02X", cmd);
return ESP_ERR_TIMEOUT;
}
err = dangerous_epd_write_cmd_without_lock_(cmd);
ESP_LOGV(TAG, "epd_write_cmd: 0x%02X done", cmd);
return err;
}
esp_err_t EPDHandler::epd_write_data(const uint8_t data, uint32_t transaction_id) {
ESP_LOGV(TAG, "epd_write_data: waiting to send 0x%02X", data);
SemaphoreGuard transaction_guard(spi_transaction_mutex_);
esp_err_t err =
wait_for_transaction_end_(pdMS_TO_TICKS(5000), transaction_id, transaction_guard);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to wait for previous transaction end before sending data 0x%02X: %s",
data, esp_err_to_name(err));
return err;
}
SemaphoreGuard guard(spi_mutex_);
if (!guard.take(pdMS_TO_TICKS(5000))) {
ESP_LOGE(TAG, "SPI mutex timeout for data 0x%02X", data);
return ESP_ERR_TIMEOUT;
}
err = dangerous_epd_write_data_without_lock_(data);
ESP_LOGV(TAG, "epd_write_data: 0x%02X done", data);
return err;
}
esp_err_t EPDHandler::epd_write_cmd_with_data(const uint8_t cmd, std::vector<uint8_t>& data, uint32_t transaction_id) {
const size_t data_len = data.size();
ESP_LOGV(TAG, "epd_write_cmd_with_data: waiting to send cmd 0x%02X with %u bytes of data", cmd, data_len);
SemaphoreGuard transaction_guard(spi_transaction_mutex_);
esp_err_t err =
wait_for_transaction_end_(pdMS_TO_TICKS(5000), transaction_id, transaction_guard);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to wait for previous transaction end before sending cmd 0x%02X: %s, with data",
cmd, esp_err_to_name(err));
return err;
}
SemaphoreGuard guard(spi_mutex_);
if (!guard.take(pdMS_TO_TICKS(5000))) {
ESP_LOGE(TAG, "SPI mutex timeout for cmd with data 0x%02X", cmd);
return ESP_ERR_TIMEOUT;
}
err = dangerous_epd_write_cmd_without_lock_(cmd);
if (err != ESP_OK) {
return err;
};
for (size_t i = 0; i < data_len; ++i) {
err = dangerous_epd_write_data_without_lock_(data[i]);
if (err != ESP_OK) {
return err;
}
}
ESP_LOGV(TAG, "epd_write_cmd_with_data: cmd 0x%02X with %u bytes of data done", cmd, data_len);
return ESP_OK;
}
esp_err_t EPDHandler::dangerous_epd_write_cmd_without_lock_(const uint8_t cmd) {
ESP_LOGV(TAG, "dangerous_epd_write_cmd_without_lock_: sending 0x%02X", cmd);
gpio_set_level(PIN_DC, 0); // Command mode
spi_transaction_t t {};
t.length = 8;t.tx_buffer = &cmd;
esp_err_t err = spi_device_polling_transmit(spi_, &t);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send data 0x%02X", cmd);
} else {
ESP_LOGV(TAG, "dangerous_epd_write_cmd_without_lock_: 0x%02X sent", cmd);
}
return err;
}
esp_err_t EPDHandler::dangerous_epd_write_data_without_lock_(const uint8_t data) {
ESP_LOGV(TAG, "dangerous_epd_write_data_without_lock_: sending 0x%02X", data);
gpio_set_level(PIN_DC, 1); // Data mode
spi_transaction_t t = { };
t.length = 8; t.tx_buffer = &data;
esp_err_t err = spi_device_polling_transmit(spi_, &t);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send data 0x%02X", data);
} else {
ESP_LOGV(TAG, "dangerous_epd_write_data_without_lock_: 0x%02X sent", data);
}
return err;
}
esp_err_t EPDHandler::transfer_spi_data(const uint8_t* data, const size_t& length, uint32_t transaction_id, bool inverted) {
ESP_LOGV(TAG, "transfer_spi_data: waiting to send %zu bytes of data", length);
SemaphoreGuard transaction_guard(spi_transaction_mutex_);
esp_err_t err =
wait_for_transaction_end_(pdMS_TO_TICKS(5000), transaction_id, transaction_guard);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to wait for previous transaction end before sending data of %zu bytes: %s",
length, esp_err_to_name(err));
return err;
}
SemaphoreGuard guard(spi_mutex_);
if (!guard.take(pdMS_TO_TICKS(5000))) {
ESP_LOGE(TAG, "SPI mutex timeout for data transfer of %zu bytes", length);
return ESP_ERR_TIMEOUT;
}
ESP_LOGV(TAG, "transfer_spi_data: starting to send %zu bytes of data", length);
size_t offset = 0;
size_t remaining = length;
gpio_set_level(PIN_DC, 1); // Data mode
// Allocate a temporary buffer for inverted data (only if inverted)
uint8_t* temp_transfer_buffer = nullptr;
if (inverted) {
temp_transfer_buffer = (uint8_t*)heap_caps_malloc(DMA_TRANSFER_CHUNK_SIZE, MALLOC_CAP_DMA);
if (temp_transfer_buffer == nullptr) {
ESP_LOGE(TAG, "Failed to allocate memory for inverted data transfer buffer");
ESP_LOGI(TAG, "Current free heap size: %u bytes", esp_get_free_heap_size());
ESP_LOGI(TAG, "Current free DMA-capable memory size: %u bytes",
heap_caps_get_free_size(MALLOC_CAP_DMA));
return ESP_ERR_NO_MEM;
}
}
while (remaining > 0) {
size_t transfer_size = (remaining < DMA_TRANSFER_CHUNK_SIZE) ? remaining : DMA_TRANSFER_CHUNK_SIZE;
const uint8_t* transfer_buffer = nullptr;
if (inverted) {
// Invert only the current chunk into the temporary buffer
for (size_t i = 0; i < transfer_size; ++i) {
temp_transfer_buffer[i] = ~data[offset + i];
}
transfer_buffer = temp_transfer_buffer;
} else {
transfer_buffer = data + offset;
}
spi_transaction_t t = {};
t.length = transfer_size * 8; // Length in bits
t.tx_buffer = transfer_buffer;
esp_err_t ret = spi_device_polling_transmit(spi_, &t);
if (ret != ESP_OK) {
ESP_LOGE(TAG, "Failed to send SPI chunk at offset %zu: %s", offset, esp_err_to_name(ret));
if (ret == ESP_ERR_NO_MEM) {
ESP_LOGE(TAG, "Current free heap size: %u bytes", esp_get_free_heap_size());
ESP_LOGE(TAG, "Current free DMA-capable memory size: %u bytes",
heap_caps_get_free_size(MALLOC_CAP_DMA));
}
if (inverted && temp_transfer_buffer != nullptr) {
// Free the temporary inverted buffer
heap_caps_free(temp_transfer_buffer);
}
return ret;
}
remaining -= transfer_size;
offset += transfer_size;
// Yield every 16KB to prevent watchdog timeout
if (offset % (16 * 1024) == 0) {
ESP_LOGV(TAG, "New data progress: %zu/%zu bytes sent, yielding...", offset, length);
vTaskDelay(pdMS_TO_TICKS(1));
}
}
if (inverted && temp_transfer_buffer != nullptr) {
// Free the temporary inverted buffer
heap_caps_free(temp_transfer_buffer);
}
ESP_LOGV(TAG, "transfer_spi_data: completed sending %zu bytes of data", length);
return ESP_OK;
}
esp_err_t EPDHandler::begin_transaction_(TickType_t timeout, uint32_t& out_id) {
ESP_LOGV(TAG, "begin_transaction_: waiting to obtain transaction mutex");
if (xSemaphoreTake(spi_transaction_mutex_, timeout) != pdTRUE) {
ESP_LOGE(TAG, "begin_transaction_: transaction mutex timeout");
return ESP_ERR_TIMEOUT;
}
out_id = ++spi_transaction_id;
ESP_LOGV(TAG, "begin_transaction_: transaction mutex obtained");
return ESP_OK;
}
esp_err_t EPDHandler::end_transaction_(void) {
ESP_LOGV(TAG, "end_transaction_: releasing transaction mutex");
if (xSemaphoreGive(spi_transaction_mutex_) != pdTRUE) {
ESP_LOGE(TAG, "end_transaction_: failed to release transaction mutex");
return ESP_FAIL;
}
ESP_LOGV(TAG, "end_transaction_: transaction mutex released");
return ESP_OK;
}
esp_err_t EPDHandler::wait_for_transaction_end_(TickType_t timeout, uint32_t awaiting_transaction_id, SemaphoreGuard& out_transaction_guard) {
// Validate transaction ID if provided
if (awaiting_transaction_id != 0 && awaiting_transaction_id != spi_transaction_id) {
// Invalid transaction ID
ESP_LOGE(TAG, "Invalid transaction ID 0x%08X while waiting, current transaction ID: 0x%08X",
awaiting_transaction_id, spi_transaction_id);
return ESP_ERR_INVALID_ARG;
}
SemaphoreGuard transaction_guard(spi_transaction_mutex_);
if (awaiting_transaction_id == 0) {
// wait for current transaction to complete
ESP_LOGV(TAG, "Waiting for current transaction 0x%08X to complete",
spi_transaction_id);
// take the mutex to ensure no transaction is active
if (!transaction_guard.take(timeout)) {
ESP_LOGE(TAG, "SPI transaction mutex timeout while waiting for transaction end");
return ESP_ERR_TIMEOUT;
}
}
// awaited_transaction_id is valid and matches current transaction ID or 0
out_transaction_guard = std::move(transaction_guard);
return ESP_OK;
}

View File

@@ -0,0 +1,41 @@
#pragma once
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "driver/spi_master.h"
#include "common/semaphore_guard.h"
#include <vector>
#include "display/transaction_guard.h"
class EPDHandler : public WithTransaction {
public:
EPDHandler();
~EPDHandler();
esp_err_t init();
esp_err_t epd_write_cmd(const uint8_t cmd, uint32_t transaction_id);
esp_err_t epd_write_data(const uint8_t data, uint32_t transaction_id);
esp_err_t epd_write_cmd_with_data(const uint8_t cmd, std::vector<uint8_t>& data, uint32_t transaction_id);
esp_err_t transfer_spi_data(const uint8_t* data, const size_t& length, uint32_t transaction_id, bool inverted = false);
bool is_busy(void) const;
void wait_for_idle(void) const;
private:
esp_err_t dangerous_epd_write_cmd_without_lock_(const uint8_t cmd);
esp_err_t dangerous_epd_write_data_without_lock_(const uint8_t data);
esp_err_t begin_transaction_(TickType_t timeout, uint32_t& out_id) override;
esp_err_t end_transaction_(void) override;
// given a transaction ID, wait for current transaction to complete. The transaction ID will determine if the wait is needed.
esp_err_t wait_for_transaction_end_(TickType_t timeout, uint32_t awaiting_transaction_id, SemaphoreGuard& out_transaction_guard);
spi_device_handle_t spi_ = nullptr;
SemaphoreHandle_t spi_mutex_ = nullptr;
SemaphoreHandle_t spi_transaction_mutex_ = nullptr;
uint32_t spi_transaction_id = 0; // For tracking SPI transactions
friend class TransactionGuard;
};

View File

@@ -0,0 +1,336 @@
#include "display/lvgl_handler.h"
#include "esp_log.h"
#include "common/semaphore_guard.h"
#include "common/constants.h"
#include <portmacro.h>
#define DISPLAY_BUFFER_SIZE (DISPLAY_WIDTH * DISPLAY_HEIGHT) / 8 // 1 bit per pixels
#define LVGL_BUFFER_SIZE (DISPLAY_BUFFER_SIZE + 8) // 1 bit per pixels + 8 bytes for palette
#define LV_DISPLAY_RENDER_MODE LV_DISPLAY_RENDER_MODE_PARTIAL
#define TAG "LVGLHandler"
LVGLHandler::LVGLHandler(
std::unique_ptr<EInkDisplayHandler> display_handler_in
) : display_handler_(std::move(display_handler_in)) { }
LVGLHandler::~LVGLHandler() {
if (lvgl_display_ != nullptr) {
lv_display_delete(lvgl_display_);
lvgl_display_ = nullptr;
}
if (lvgl_touch_indev_ != nullptr) {
lvgl_port_remove_touch(lvgl_touch_indev_);
lvgl_touch_indev_ = nullptr;
}
if (lvgl_draw_buf_ != nullptr) {
lv_draw_buf_destroy(lvgl_draw_buf_);
lvgl_draw_buf_ = nullptr;
}
if (lvgl_draw_buf_2_ != nullptr) {
lv_draw_buf_destroy(lvgl_draw_buf_2_);
lvgl_draw_buf_2_ = nullptr;
}
}
esp_err_t LVGLHandler::initLVGL(EventGroupHandle_t system_event_group) {
esp_err_t err = initLVGLPort_();
if (err != ESP_OK) {
return err;
}
err = initLVGLDisplay_();
if (err != ESP_OK) {
return err;
}
err = registerLVGLTouch_();
if (err != ESP_OK) {
return err;
}
auto lvgl_tick_timer_callback = [](TimerHandle_t xTimer) {
lv_tick_inc(5);
};
TickType_t lvgl_tick_period = pdMS_TO_TICKS(5);
if (lvgl_tick_period == 0) {
lvgl_tick_period = 1; // ensure at least 1 tick to avoid FreeRTOS assert
}
ESP_LOGV(TAG, "Creating LVGL tick timer with period %u ticks...\n", (unsigned)lvgl_tick_period);
TimerHandle_t lvgl_tick_timer = xTimerCreate(
"lvgl_tick_timer",
lvgl_tick_period,
pdTRUE,
NULL,
lvgl_tick_timer_callback
);
if (lvgl_tick_timer == NULL) {
ESP_LOGE("Main", "Failed to create LVGL tick timer");
vTaskDelay(5000 / portTICK_PERIOD_MS);
return ESP_ERR_NO_MEM;
}
ESP_LOGV(TAG, "Starting LVGL tick timer...\n");
xTimerStart(lvgl_tick_timer, 0);
if (system_event_group != nullptr) {
xEventGroupSetBits(system_event_group, DISPLAY_READY_BIT | TOUCH_CALIBRATED_BIT);
}
return ESP_OK;
}
//
// Private methods
//
void LVGLHandler::rounder_cb_(lv_display_t* disp, lv_area_t* area) {
// align x to byte boundary
area->x1 = (area->x1 & ~0x7);
area->x2 = (area->x2 | 0x7);
}
void LVGLHandler::flush_cb_(lv_display_t* disp, const lv_area_t* area, uint8_t* px_map) {
if (disp == nullptr || area == nullptr || px_map == nullptr) {
ESP_LOGE(TAG, "Null parameters in flush callback");
if (disp != nullptr) lv_display_flush_ready(disp);
return;
}
LVGLHandler* handler = static_cast<LVGLHandler*>(lv_display_get_user_data(disp));
if (handler == nullptr || handler->display_handler_ == nullptr) {
ESP_LOGE(TAG, "Invalid handler in flush callback");
lv_display_flush_ready(disp);
return;
}
uint8_t* pixel_data = px_map + 8; // Skip palette
//
ESP_LOGI(TAG, "Flush callback: x1=%d, y1=%d, x2=%d, y2=%d", area->x1, area->y1, area->x2, area->y2);
// copy data to framebuffer
int32_t area_w = lv_area_get_width(area);
int32_t area_h = lv_area_get_height(area);
if (area->x1 == 0 && area->y1 == 0 && area_w == DISPLAY_WIDTH && area_h == DISPLAY_HEIGHT) {
// revert the pixel data for e-ink (LVGL: 1=white, 0=black; E-Ink: 1=black, 0=white)
for (size_t i = 0; i < DISPLAY_BUFFER_SIZE; ++i) {
pixel_data[i] = ~pixel_data[i];
}
esp_err_t err = handler->display_handler_->full_write(
pixel_data,
true // white basemap
);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Full refresh request failed: %s", esp_err_to_name(err));
}
} else {
// partial update
ESP_LOGI(TAG, "Partial update: x1=%d, y1=%d, w=%d, h=%d", area->x1, area->y1, area_w, area_h);
// Prepare partial buffer
const uint32_t area_width_bytes = (area->x2 - area->x1 + 1) / 8;
const uint32_t area_height = area->y2 - area->y1 + 1;
const size_t partial_buffer_size = area_width_bytes * area_height;
uint8_t* partial_buffer = new uint8_t[partial_buffer_size];
if (partial_buffer == nullptr) {
ESP_LOGE(TAG, "Failed to allocate partial buffer for flush callback");
lv_display_flush_ready(disp);
return;
}
// Copy pixel data to partial buffer and invert for e-ink
for (int32_t row = 0; row < area_height; ++row) {
for (int32_t col = 0; col < area_width_bytes; ++col) {
size_t src_index = row * area_width_bytes + col;
partial_buffer[src_index] = ~pixel_data[src_index];
}
}
esp_err_t err = handler->display_handler_->partial_refresh(partial_buffer,
RefreshArea {
area->x1,
area->y1,
area->x2,
area->y2
}, lv_display_flush_is_last(disp));
delete[] partial_buffer;
if (err != ESP_OK) {
ESP_LOGE(TAG, "Partial refresh request failed: %s", esp_err_to_name(err));
}
}
//
lv_display_flush_ready(disp);
}
void LVGLHandler::touch_read_cb_(lv_indev_t* indev, lv_indev_data_t* data) {
LVGLHandler* handler = static_cast<LVGLHandler*>(lv_indev_get_user_data(indev));
if (handler == nullptr || handler->display_handler_ == nullptr) {
data->state = LV_INDEV_STATE_RELEASED;
ESP_LOGE(TAG, "Invalid handler in touch read callback");
return;
}
// Disable touch input during display refresh (BUSY)
if (handler->display_handler_->is_busy()) {
data->state = LV_INDEV_STATE_RELEASED;
data->continue_reading = false;
return;
}
esp_lcd_touch_handle_t tp_handle = handler->display_handler_->get_touch_handle();
if (tp_handle == nullptr) {
data->state = LV_INDEV_STATE_RELEASED;
return;
}
// Read touch data from GT911
esp_err_t ret = esp_lcd_touch_read_data(tp_handle);
if (ret == ESP_OK) {
uint8_t touch_cnt = 0;
// Get touch data using new API
esp_lcd_touch_point_data_t point_data[1];
esp_lcd_touch_get_data(tp_handle, point_data, &touch_cnt, 1);
if (touch_cnt > 0) {
// ESP_LOGI(TAG, "Touch data read successfully: x=%d, y=%d", point_data[0].x, point_data[0].y);
data->point.x = point_data[0].x;
data->point.y = point_data[0].y;
data->state = LV_INDEV_STATE_PRESSED;
} else {
data->state = LV_INDEV_STATE_RELEASED;
}
} else {
data->state = LV_INDEV_STATE_RELEASED;
}
data->continue_reading = false;
}
esp_err_t LVGLHandler::initLVGLDisplay_() {
if (display_handler_ == nullptr) {
return ESP_ERR_INVALID_STATE;
}
esp_err_t err = ESP_OK;
// Lock LVGL to prevent the timer task from accessing partially initialized display
if (!lvgl_port_lock(pdMS_TO_TICKS(5000))) {
ESP_LOGE(TAG, "Failed to lock LVGL port for display initialization");
return ESP_ERR_TIMEOUT;
}
// Create LVGL display
lvgl_display_ = lv_display_create(DISPLAY_WIDTH, DISPLAY_HEIGHT);
if (lvgl_display_ == nullptr) {
ESP_LOGE(TAG, "Failed to create LVGL display");
lvgl_port_unlock();
return ESP_FAIL;
}
// Create two draw buffers for double buffering to improve performance
lvgl_draw_buf_ = lv_draw_buf_create(DISPLAY_WIDTH, DISPLAY_HEIGHT, LV_COLOR_FORMAT_I1, LV_STRIDE_AUTO);
if (lvgl_draw_buf_ == nullptr) {
ESP_LOGE(TAG, "Failed to create LVGL draw buffer 1");
lv_display_delete(lvgl_display_);
lvgl_display_ = nullptr;
lvgl_port_unlock();
return ESP_FAIL;
}
lvgl_draw_buf_2_ = lv_draw_buf_create(DISPLAY_WIDTH, DISPLAY_HEIGHT, LV_COLOR_FORMAT_I1, LV_STRIDE_AUTO);
if (lvgl_draw_buf_2_ == nullptr) {
ESP_LOGE(TAG, "Failed to create LVGL draw buffer 2");
lv_draw_buf_destroy(lvgl_draw_buf_);
lvgl_draw_buf_ = nullptr;
lv_display_delete(lvgl_display_);
lvgl_display_ = nullptr;
lvgl_port_unlock();
return ESP_FAIL;
}
// Set both buffers for double buffering
lv_display_set_draw_buffers(lvgl_display_, lvgl_draw_buf_, lvgl_draw_buf_2_);
lv_display_set_render_mode(lvgl_display_, LV_DISPLAY_RENDER_MODE);
//
// Configure LVGL display
lv_display_set_color_format(lvgl_display_, LV_COLOR_FORMAT_I1);
lv_display_set_user_data(lvgl_display_, this);
lv_display_add_event_cb(lvgl_display_, [](lv_event_t* e) {
LVGLHandler* handler = static_cast<LVGLHandler*>(lv_display_get_user_data(static_cast<lv_display_t*>(lv_event_get_target(e))));
if (handler != nullptr) {
handler->rounder_cb_(static_cast<lv_display_t*>(lv_event_get_target(e)),
static_cast<lv_area_t*>(lv_event_get_param(e)));
} else {
ESP_LOGE(TAG, "Invalid handler in rounder callback");
}
}, LV_EVENT_INVALIDATE_AREA, lvgl_display_);
lv_display_set_flush_cb(lvgl_display_, [](lv_display_t* disp, const lv_area_t* area, uint8_t* px_map) {
LVGLHandler* handler = static_cast<LVGLHandler*>(lv_display_get_user_data(disp));
if (handler != nullptr) {
handler->flush_cb_(disp, area, px_map);
} else {
lv_display_flush_ready(disp);
}
});
// Unlock LVGL now that display is fully initialized
ESP_LOGI(TAG, "Performing initial display write...");
// err = display_handler_->full_write(framebuffer_, false);
err = display_handler_->clear_display();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Initial display write failed: %d", err);
} else {
ESP_LOGI(TAG, "Initial display write complete");
}
lvgl_port_unlock();
ESP_LOGI(TAG, "LVGL display registered");
return err;
}
esp_err_t LVGLHandler::registerLVGLTouch_() {
if (display_handler_ == nullptr) {
return ESP_ERR_INVALID_STATE;
}
esp_lcd_touch_handle_t tp_handle = display_handler_->get_touch_handle();
if (tp_handle == nullptr) {
ESP_LOGE(TAG, "Touch handle is NULL — touch initialization failed; skipping LVGL touch registration");
return ESP_FAIL;
}
const lvgl_port_touch_cfg_t touch_cfg = {
.disp = lvgl_display_,
.handle = tp_handle,
.scale = {}, // Default scaling
};
lvgl_touch_indev_ = lvgl_port_add_touch(&touch_cfg);
if (lvgl_touch_indev_ == nullptr) {
ESP_LOGE(TAG, "Failed to register LVGL touch input");
return ESP_FAIL;
}
lv_indev_set_user_data(lvgl_touch_indev_, this);
lv_indev_set_read_cb(lvgl_touch_indev_, [](lv_indev_t* indev, lv_indev_data_t* data) {
LVGLHandler* handler = static_cast<LVGLHandler*>(lv_indev_get_user_data(indev));
if (handler != nullptr) {
handler->touch_read_cb_(indev, data);
} else {
data->state = LV_INDEV_STATE_RELEASED;
}
});
ESP_LOGI(TAG, "LVGL touch input registered");
return ESP_OK;
}
esp_err_t LVGLHandler::initLVGLPort_() {
const lvgl_port_cfg_t lvgl_cfg = ESP_LVGL_PORT_INIT_CONFIG();
esp_err_t err = lvgl_port_init(&lvgl_cfg);
if (err != ESP_OK) {
ESP_LOGE(TAG, "LVGL port initialization failed: %s", esp_err_to_name(err));
vTaskDelay(5000 / portTICK_PERIOD_MS);
return ESP_ERR_INVALID_STATE;
}
ESP_LOGI(TAG, "LVGL port initialized successfully.\n");
return ESP_OK;
}

View File

@@ -0,0 +1,35 @@
#pragma once
#include "lvgl.h"
#include "esp_lvgl_port.h"
#include "display/eink_display_handler.h"
#include "freertos/semphr.h"
#include "freertos/event_groups.h"
#include "esp_err.h"
#include <memory>
class LVGLHandler {
public:
LVGLHandler(
// an owning pointer to the display handler
// The display handler must outlive the LVGLHandler
// The display handler must be fully initialized before calling initLVGLDisplay
std::unique_ptr<EInkDisplayHandler> display_handler_in
);
~LVGLHandler();
esp_err_t initLVGL(EventGroupHandle_t system_event_group = nullptr);
private:
void rounder_cb_(lv_display_t* disp, lv_area_t* area);
void flush_cb_(lv_display_t* disp, const lv_area_t* area, uint8_t* px_map);
void touch_read_cb_(lv_indev_t* indev, lv_indev_data_t* data);
esp_err_t initLVGLDisplay_();
esp_err_t registerLVGLTouch_();
esp_err_t initLVGLPort_();
std::unique_ptr<EInkDisplayHandler> display_handler_ = nullptr;
lv_display_t* lvgl_display_ = nullptr;
lv_indev_t* lvgl_touch_indev_ = nullptr;
lv_draw_buf_t* lvgl_draw_buf_ = nullptr;
lv_draw_buf_t* lvgl_draw_buf_2_ = nullptr;
};

View File

@@ -0,0 +1,33 @@
#pragma once
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include <esp_err.h>
#include <type_traits>
class WithTransaction {
protected:
virtual esp_err_t end_transaction_() = 0;
virtual esp_err_t begin_transaction_(TickType_t timeout, uint32_t& out_id) = 0;
friend class TransactionGuard;
};
class TransactionGuard {
public:
TransactionGuard(WithTransaction& handler, TickType_t timeout = portMAX_DELAY)
: handler_(handler) { }
~TransactionGuard() { if (transaction_id_) handler_.end_transaction_(); }
esp_err_t begin(TickType_t timeout = portMAX_DELAY) {
esp_err_t err = handler_.begin_transaction_(timeout, transaction_id_);
return err;
}
uint32_t transaction_id() const { return transaction_id_; }
bool is_active() const { return transaction_id_ != 0; }
private:
// delete copy constructor and assignment operator
TransactionGuard(const TransactionGuard&) = delete;
TransactionGuard& operator=(const TransactionGuard&) = delete;
WithTransaction& handler_;
uint32_t transaction_id_ = 0;
};

6
main/external/CMakeLists.txt vendored Normal file
View File

@@ -0,0 +1,6 @@
list(APPEND SRCS
"${CMAKE_CURRENT_LIST_DIR}/mtr/mtr.cpp"
"${CMAKE_CURRENT_LIST_DIR}/mtr/station_info.cpp"
"${CMAKE_CURRENT_LIST_DIR}/mtr/line_info.cpp"
"${CMAKE_CURRENT_LIST_DIR}/mtr/arrival.cpp"
)

100
main/external/mtr/arrival.cpp vendored Normal file
View File

@@ -0,0 +1,100 @@
#include "external/mtr/arrival.h"
#include "cJSON.h"
#include "esp_log.h"
#include <string>
static const char* TAG = "StationArrivalInfo";
StationArrivalInfo::StationArrivalInfo(
cJSON* mtr_line_station_json,
cJSON* arrival_json,
const std::string& train_line_code,
const std::string& train_station_code
) : _status(UNKNOWN_STATUS)
, _train_line(train_line_code)
, _train_station(train_station_code) {
if (!arrival_json) {
ESP_LOGE(TAG, "arrival_json is null");
_status = FAILED_WITH_MESSAGE;
_message = "No arrival data received";
return;
}
ESP_LOGD(TAG, "Parsing arrival JSON for %s-%s", train_line_code.c_str(), train_station_code.c_str());
// Parse status
cJSON* status_json = cJSON_GetObjectItem(arrival_json, "status");
if (status_json && cJSON_IsNumber(status_json)) {
int status_value = status_json->valueint;
if (status_value >= 0 && status_value <= 3) {
_status = static_cast<StatusEnum>(status_value);
}
}
ESP_LOGD(TAG, "Status: %d, Message: %s", (int)_status, _message.c_str());
// Parse message (if present)
cJSON* message_json = cJSON_GetObjectItem(arrival_json, "message");
if (message_json && cJSON_IsString(message_json)) {
_message = message_json->valuestring;
}
// Parse UP direction arrivals
cJSON* up_json = cJSON_GetObjectItem(arrival_json, "UP");
if (up_json && cJSON_IsArray(up_json)) {
int up_count = cJSON_GetArraySize(up_json);
for (int i = 0; i < up_count; i++) {
cJSON* arrival_item = cJSON_GetArrayItem(up_json, i);
if (arrival_item) {
std::string time_str = "";
std::string dest_str = "";
cJSON* time_json = cJSON_GetObjectItem(arrival_item, "time");
if (time_json && cJSON_IsString(time_json)) {
time_str = time_json->valuestring;
}
cJSON* dest_json = cJSON_GetObjectItem(arrival_item, "dest");
if (dest_json && cJSON_IsString(dest_json)) {
dest_str = dest_json->valuestring;
}
if (!time_str.empty()) {
_up_arrivals.emplace_back(time_str, dest_str);
}
}
}
}
// Parse DOWN direction arrivals
cJSON* down_json = cJSON_GetObjectItem(arrival_json, "DOWN");
if (down_json && cJSON_IsArray(down_json)) {
int down_count = cJSON_GetArraySize(down_json);
for (int i = 0; i < down_count; i++) {
cJSON* arrival_item = cJSON_GetArrayItem(down_json, i);
if (arrival_item) {
std::string time_str = "";
std::string dest_str = "";
cJSON* time_json = cJSON_GetObjectItem(arrival_item, "time");
if (time_json && cJSON_IsString(time_json)) {
time_str = time_json->valuestring;
}
cJSON* dest_json = cJSON_GetObjectItem(arrival_item, "dest");
if (dest_json && cJSON_IsString(dest_json)) {
dest_str = dest_json->valuestring;
}
if (!time_str.empty()) {
_down_arrivals.emplace_back(time_str, dest_str);
}
}
}
}
ESP_LOGI(TAG, "Parsed arrival info for %s/%s: %zu UP, %zu DOWN trains",
train_line_code.c_str(), train_station_code.c_str(),
_up_arrivals.size(), _down_arrivals.size());
}

65
main/external/mtr/arrival.h vendored Normal file
View File

@@ -0,0 +1,65 @@
#pragma once
#include "cJSON.h"
#include <string>
#include <vector>
// Forward declaration
class MTRNextTrainHandler;
struct ArrivalInfo {
public:
// Caller transfers ownership of arrival_time to ArrivalInfo
ArrivalInfo(
const std::string& arrival_time,
const std::string& destination_name
) : _arrival_time(arrival_time)
, _destination_name(destination_name) { }
const char* arrival_time() const {
return _arrival_time.c_str();
}
const char* destination() const {
return _destination_name.c_str();
}
private:
const std::string _arrival_time;
const std::string _destination_name; // not the code of the station
};
enum StatusEnum {
SUCCESSFUL_WITHOUT_DELAY = 0,
SUCCESSFUL_WITH_DELAY = 1,
FAILED_WITH_MESSAGE = 2,
UNKNOWN_STATUS = 3
};
struct StationArrivalInfo {
public:
friend class MTRNextTrainHandler;
// Public accessors
StatusEnum status() const { return _status; }
const char* message() const { return _message.c_str(); }
const char* train_line() const { return _train_line.c_str(); }
const char* train_station() const { return _train_station.c_str(); }
const std::vector<ArrivalInfo>* up_arrivals() const { return &_up_arrivals; }
const std::vector<ArrivalInfo>* down_arrivals() const { return &_down_arrivals; }
private:
StationArrivalInfo(
cJSON* mtr_line_station_json,
cJSON* arrival_json,
const std::string& train_line_code,
const std::string& train_station_code
);
StatusEnum _status;
std::string _message; // only valid if status == FAILED_WITH_MESSAGE
std::string _train_line;
std::string _train_station;
std::vector<ArrivalInfo> _up_arrivals;
std::vector<ArrivalInfo> _down_arrivals;
};

62
main/external/mtr/line_info.cpp vendored Normal file
View File

@@ -0,0 +1,62 @@
#include "external/mtr/line_info.h"
#include "external/mtr/station_info.h"
#include "cJSON.h"
#include "esp_log.h"
LineInfo::LineInfo(cJSON* line_json) {
if (!line_json) {
ESP_LOGE(LINE_INFO_TAG, "line_json is null");
return;
}
// Parse line code
cJSON* code_json = cJSON_GetObjectItem(line_json, "code");
if (code_json && cJSON_IsString(code_json)) {
_code = code_json->valuestring;
} else {
ESP_LOGW(LINE_INFO_TAG, "Missing or invalid 'code' field");
}
// Parse line name
cJSON* name_json = cJSON_GetObjectItem(line_json, "name");
if (name_json && cJSON_IsString(name_json)) {
_name = name_json->valuestring;
} else {
ESP_LOGW(LINE_INFO_TAG, "Missing or invalid 'name' field");
}
// Parse line color (note: field is 'line_color' in JSON, not 'color')
cJSON* color_json = cJSON_GetObjectItem(line_json, "line_color");
if (color_json && cJSON_IsString(color_json)) {
_color = color_json->valuestring;
} else {
ESP_LOGW(LINE_INFO_TAG, "Missing or invalid 'line_color' field");
}
// Parse stations array
cJSON* stations_json = cJSON_GetObjectItem(line_json, "stations");
if (stations_json && cJSON_IsArray(stations_json)) {
int station_count = cJSON_GetArraySize(stations_json);
_stations.reserve(station_count);
for (int i = 0; i < station_count; i++) {
cJSON* station_json = cJSON_GetArrayItem(stations_json, i);
if (station_json) {
_stations.emplace_back(station_json);
}
}
ESP_LOGI(LINE_INFO_TAG, "Created LineInfo: %s with %d stations", _code.c_str(), station_count);
} else {
ESP_LOGW(LINE_INFO_TAG, "Missing or invalid 'stations' array");
}
}
const char* LineInfo::get_station_name(const std::string& station_code) const {
for (const auto& station : _stations) {
if (std::string(station.code()) == station_code) {
return station.name();
}
}
return "";
}

53
main/external/mtr/line_info.h vendored Normal file
View File

@@ -0,0 +1,53 @@
#pragma once
#include "cJSON.h"
#include "esp_log.h"
#include "external/mtr/station_info.h"
#include "external/mtr/mtr.h"
#include <string>
#include <vector>
#define LINE_INFO_TAG "LineInfo"
// Forward declaration
class MTRNextTrainHandler;
struct StationInfo;
struct LineInfo {
public:
// caller does not own the returned char pointers
const char* code() const {
return _code.c_str();
}
// caller does not own the returned char pointers
const char* name() const {
return _name.c_str();
}
// caller does not own the returned char pointers
const char* color() const {
return _color.c_str();
}
size_t station_count() const {
return _stations.size();
}
// caller does not own the returned array or StationInfo pointers
const std::vector<StationInfo>* stations() const {
return &_stations;
}
const char* get_station_name(const std::string& station_code) const;
friend class MTRNextTrainHandler;
private:
// Caller transfers ownership of stations array and its contents to LineInfo
LineInfo(
cJSON* line_json
);
std::string _code;
std::string _name;
std::string _color;
std::vector<StationInfo> _stations;
};

223
main/external/mtr/mtr.cpp vendored Normal file
View File

@@ -0,0 +1,223 @@
#include "external/mtr/mtr.h"
#include "external/mtr/line_info.h"
#include "external/mtr/station_info.h"
#include "external/mtr/arrival.h"
#include "assets/MTR_LINE_STATION.h"
#include "network/network.h"
#include "network/http_handler.h"
#include "cJSON.h"
#include "esp_log.h"
#include <string>
#include <stdlib.h>
#include <string.h>
#include "esp_crt_bundle.h"
static const char* TAG = "MTRNextTrainHandler";
// MTR Next Train API endpoint
static const char* MTR_API_BASE = "https://rt.data.gov.hk/v1/transport/mtr/getSchedule.php";
MTRNextTrainHandler::MTRNextTrainHandler() {
ESP_LOGI(TAG, "Initializing MTR Next Train Handler");
mtr_data = cJSON_Parse(MTR_LINE_STATION_JSON);
if (!mtr_data) {
ESP_LOGE(TAG, "Failed to parse MTR line station JSON");
} else {
ESP_LOGI(TAG, "Successfully parsed MTR line station JSON");
}
}
MTRNextTrainHandler::~MTRNextTrainHandler() {
if (mtr_data) {
cJSON_Delete(mtr_data);
mtr_data = nullptr;
}
ESP_LOGI(TAG, "MTR Next Train Handler destroyed");
}
std::vector<LineInfo> MTRNextTrainHandler::get_lines() {
std::vector<LineInfo> lines;
if (!mtr_data) {
ESP_LOGE(TAG, "MTR data not initialized");
return lines;
}
// Iterate through all line objects in the JSON
cJSON* line_json = mtr_data->child;
while (line_json) {
if (cJSON_IsObject(line_json)) {
lines.push_back(LineInfo(line_json));
}
line_json = line_json->next;
}
ESP_LOGI(TAG, "Retrieved %zu MTR lines", lines.size());
return lines;
}
MtrArrivalErrorCode MTRNextTrainHandler::get_next_arrival_info(
NetworkHandler* network_handler,
std::string& line_code,
std::string& station_code,
StationArrivalInfo*& out_info,
Language lang
) {
if (!network_handler) {
ESP_LOGE(TAG, "NetworkHandler is null");
return MtrArrivalErrorCode::UNKNOWN;
}
if (!mtr_data) {
ESP_LOGE(TAG, "MTR data not initialized");
return MtrArrivalErrorCode::UNKNOWN;
}
// Verify line exists
cJSON* line_json = cJSON_GetObjectItem(mtr_data, line_code.c_str());
if (!line_json) {
ESP_LOGW(TAG, "Line not found: %s", line_code.c_str());
return MtrArrivalErrorCode::LINE_NOT_FOUND;
}
// Verify station exists in line
bool station_found = false;
cJSON* stations_json = cJSON_GetObjectItem(line_json, "stations");
if (stations_json && cJSON_IsArray(stations_json)) {
int station_count = cJSON_GetArraySize(stations_json);
for (int i = 0; i < station_count; i++) {
cJSON* station = cJSON_GetArrayItem(stations_json, i);
cJSON* code_json = cJSON_GetObjectItem(station, "code");
if (code_json && cJSON_IsString(code_json)) {
if (station_code == code_json->valuestring) {
station_found = true;
break;
}
}
}
}
if (!station_found) {
ESP_LOGW(TAG, "Station not found: %s in line %s", station_code.c_str(), line_code.c_str());
return MtrArrivalErrorCode::STATION_NOT_FOUND;
}
// Build API URL
std::string url_str = MTR_API_BASE;
url_str += "?line=";
url_str += line_code;
url_str += "&sta=";
url_str += station_code;
if (lang == Language::EN) {
url_str += "&lang=en";
}
ESP_LOGI(TAG, "Fetching arrival info from: %s", url_str.c_str());
// Create HTTP client configuration
esp_http_client_config_t http_config = {};
http_config.url = url_str.c_str();
http_config.timeout_ms = 15000;
http_config.transport_type = HTTP_TRANSPORT_OVER_SSL;
http_config.crt_bundle_attach = esp_crt_bundle_attach;
// Retry logic for connection failures
constexpr int MAX_RETRIES = 2;
esp_err_t err = ESP_FAIL;
char* buffer = nullptr;
int total_len = 0;
for (int retry = 0; retry <= MAX_RETRIES; retry++) {
if (retry > 0) {
ESP_LOGW(TAG, "Retrying HTTP request (%d/%d)", retry, MAX_RETRIES);
vTaskDelay(pdMS_TO_TICKS(500));
}
// Create HTTP client configuration for each attempt
esp_http_client_config_t http_config = {};
http_config.url = url_str.c_str();
http_config.timeout_ms = 15000;
http_config.transport_type = HTTP_TRANSPORT_OVER_SSL;
http_config.crt_bundle_attach = esp_crt_bundle_attach;
// Get HTTP handler and perform request
auto http_handler = network_handler->get_http_handler(std::move(http_config));
if (!http_handler) {
ESP_LOGE(TAG, "Failed to create HTTP handler");
continue;
}
err = http_handler->perform_request();
if (err != ESP_OK) {
ESP_LOGE(TAG, "HTTP request failed: %s", esp_err_to_name(err));
continue;
}
// Get response body
http_handler->get_body(buffer, total_len);
if (buffer && total_len > 0) {
break;
}
if (buffer) {
free(buffer);
buffer = nullptr;
}
}
if (err != ESP_OK || !buffer || total_len <= 0) {
ESP_LOGE(TAG, "Failed to get response after retries");
if (buffer) {
free(buffer);
}
return MtrArrivalErrorCode::NO_ARRIVAL_INFO;
}
ESP_LOGI(TAG, "Received %d bytes from MTR API", total_len);
ESP_LOGI(TAG, "Parsing full API response");
cJSON* root_json = cJSON_Parse(buffer);
delete[] buffer;
if (!root_json) {
const char* error_ptr = cJSON_GetErrorPtr();
if (error_ptr) {
ESP_LOGE(TAG, "Failed to parse MTR API response at position: %s", error_ptr);
} else {
ESP_LOGE(TAG, "Failed to parse MTR API response - unknown error");
}
return MtrArrivalErrorCode::NO_ARRIVAL_INFO;
}
cJSON* data_json = cJSON_GetObjectItem(root_json, "data");
if (!data_json) {
ESP_LOGE(TAG, "Could not find 'data' object in response");
cJSON_Delete(root_json);
return MtrArrivalErrorCode::NO_ARRIVAL_INFO;
}
std::string station_key = line_code + "-" + station_code;
cJSON* station_json = cJSON_GetObjectItem(data_json, station_key.c_str());
if (!station_json) {
ESP_LOGE(TAG, "Could not find station key '%s' in data object", station_key.c_str());
cJSON_Delete(root_json);
return MtrArrivalErrorCode::NO_ARRIVAL_INFO;
}
cJSON* status_json = cJSON_GetObjectItem(root_json, "status");
if (status_json && cJSON_IsNumber(status_json)) {
cJSON_AddItemToObject(station_json, "status", cJSON_Duplicate(status_json, 1));
}
cJSON* message_json = cJSON_GetObjectItem(root_json, "message");
if (message_json && cJSON_IsString(message_json)) {
cJSON_AddItemToObject(station_json, "message", cJSON_Duplicate(message_json, 1));
}
out_info = new StationArrivalInfo(mtr_data, station_json, line_code, station_code);
cJSON_Delete(root_json);
ESP_LOGI(TAG, "Successfully retrieved arrival info for %s/%s", line_code.c_str(), station_code.c_str());
return MtrArrivalErrorCode::NONE;
}

58
main/external/mtr/mtr.h vendored Normal file
View File

@@ -0,0 +1,58 @@
#pragma once
#include "assets/MTR_LINE_STATION.h"
#include "cJSON.h"
#include <string>
#include "esp_log.h"
#include "external/mtr/line_info.h"
#include <vector>
#include "network/network.h"
// Forward declaration
struct StationArrivalInfo;
struct LineInfo;
enum class MtrArrivalErrorCode {
NONE = 0,
LINE_NOT_FOUND = 1,
STATION_NOT_FOUND = 2,
NO_ARRIVAL_INFO = 3,
UNKNOWN = 99,
};
enum class Language {
EN,
TC,
};
class MTRNextTrainHandler {
public:
/**
* @brief Construct a new MTR Next Train Handler object
* @param json Pointer to cJSON object containing MTR Next Train data
*
* > Caller transfers ownership of the cJSON object to MTRNextTrainHandler
*
* cJSON structure for MTR Next Train data
* This structure is used to parse and store the MTR Next Train JSON data.
* Record<code name string, {name: string, code: string, color: hex string, station: {code: string, name: string}[]}>
*/
MTRNextTrainHandler();
~MTRNextTrainHandler();
std::vector<LineInfo> get_lines();
MtrArrivalErrorCode get_next_arrival_info(
NetworkHandler* network_handler,
std::string& line_code,
std::string& station_code,
StationArrivalInfo*& out_info,
Language lang = Language::TC
);
private:
cJSON* mtr_data;
};

28
main/external/mtr/station_info.cpp vendored Normal file
View File

@@ -0,0 +1,28 @@
#include "external/mtr/station_info.h"
#include "cJSON.h"
#include "esp_log.h"
StationInfo::StationInfo(cJSON* station_json) {
if (!station_json) {
ESP_LOGE(STATION_INFO_TAG, "station_json is null");
return;
}
// Parse station code
cJSON* code_json = cJSON_GetObjectItem(station_json, "code");
if (code_json && cJSON_IsString(code_json)) {
_code = code_json->valuestring;
} else {
ESP_LOGW(STATION_INFO_TAG, "Missing or invalid 'code' field");
}
// Parse station name
cJSON* name_json = cJSON_GetObjectItem(station_json, "name");
if (name_json && cJSON_IsString(name_json)) {
_name = name_json->valuestring;
} else {
ESP_LOGW(STATION_INFO_TAG, "Missing or invalid 'name' field");
}
ESP_LOGD(STATION_INFO_TAG, "Created StationInfo: %s (%s)", _name.c_str(), _code.c_str());
}

27
main/external/mtr/station_info.h vendored Normal file
View File

@@ -0,0 +1,27 @@
#pragma once
#include "esp_log.h"
#include "external/mtr/line_info.h"
#include <string>
#define STATION_INFO_TAG "StationInfo"
// Forward declaration
struct LineInfo;
struct StationInfo {
public:
StationInfo(cJSON* station_json);
const char* name() const { return _name.c_str(); }
const char* code() const { return _code.c_str(); }
friend class LineInfo;
private:
// Caller transfers ownership of station_name and station_code to StationInfo
StationInfo(std::string& station_name, std::string& station_code)
: _name(station_name), _code(station_code) { }
std::string _name;
std::string _code;
};

98383
main/font/noto_sans_tc_14.c Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -17,3 +17,5 @@ dependencies:
lvgl/lvgl: ^9.4.0 lvgl/lvgl: ^9.4.0
espressif/esp_lcd_touch_gt911: ^1.2.0~1 espressif/esp_lcd_touch_gt911: ^1.2.0~1
espressif/esp_lvgl_port: ^2.7.0 espressif/esp_lvgl_port: ^2.7.0
espressif/cjson: ^1.7.19
joltwallet/littlefs: ==1.20.3

3
main/info/CMakeLists.txt Normal file
View File

@@ -0,0 +1,3 @@
list(APPEND SRCS
"${CMAKE_CURRENT_LIST_DIR}/info.cpp"
)

View File

@@ -1,3 +1,12 @@
#include <stdio.h>
#include <inttypes.h>
#include "sdkconfig.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "esp_chip_info.h"
#include "esp_flash.h"
#include "esp_system.h"
#include "esp_psram.h"
#include "info.h" #include "info.h"
void display_chip_info() { void display_chip_info() {
@@ -6,13 +15,16 @@ void display_chip_info() {
esp_chip_info_t chip_info; esp_chip_info_t chip_info;
uint32_t flash_size; uint32_t flash_size;
esp_chip_info(&chip_info); esp_chip_info(&chip_info);
printf("This is %s chip with %d CPU core(s), %s%s%s%s, ", printf("This is %s chip with %d CPU core(s), %s%s%s%s%s, ",
CONFIG_IDF_TARGET, CONFIG_IDF_TARGET,
chip_info.cores, chip_info.cores,
(chip_info.features & CHIP_FEATURE_WIFI_BGN) ? "WiFi/" : "", (chip_info.features & CHIP_FEATURE_WIFI_BGN) ? "WiFi/" : "",
(chip_info.features & CHIP_FEATURE_BT) ? "BT" : "", (chip_info.features & CHIP_FEATURE_BT) ? "BT" : "",
(chip_info.features & CHIP_FEATURE_BLE) ? "BLE" : "", (chip_info.features & CHIP_FEATURE_BLE) ? "BLE" : "",
(chip_info.features & CHIP_FEATURE_IEEE802154) ? ", 802.15.4 (Zigbee/Thread)" : ""); (chip_info.features & CHIP_FEATURE_IEEE802154) ? ", 802.15.4 (Zigbee/Thread), " : "",
// psram
(chip_info.features & CHIP_FEATURE_EMB_PSRAM) ? "with embedded PSRAM, " : ""
);
unsigned major_rev = chip_info.revision / 100; unsigned major_rev = chip_info.revision / 100;
unsigned minor_rev = chip_info.revision % 100; unsigned minor_rev = chip_info.revision % 100;
@@ -26,5 +38,10 @@ void display_chip_info() {
(chip_info.features & CHIP_FEATURE_EMB_FLASH) ? "embedded" : "external"); (chip_info.features & CHIP_FEATURE_EMB_FLASH) ? "embedded" : "external");
printf("Minimum free heap size: %" PRIu32 " bytes\n", esp_get_minimum_free_heap_size()); printf("Minimum free heap size: %" PRIu32 " bytes\n", esp_get_minimum_free_heap_size());
// psram
printf("PSRAM size: %u bytes\n", esp_psram_get_size());
// dma size
printf("DMA-capable memory size: %u bytes\n", heap_caps_get_free_size(MALLOC_CAP_DMA));
printf("DMA-capable internal memory size: %u bytes\n", heap_caps_get_free_size(MALLOC_CAP_DMA | MALLOC_CAP_INTERNAL));
} }

View File

@@ -1,10 +1 @@
#include <stdio.h>
#include <inttypes.h>
#include "sdkconfig.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "esp_chip_info.h"
#include "esp_flash.h"
#include "esp_system.h"
void display_chip_info(); void display_chip_info();

4
main/io/CMakeLists.txt Normal file
View File

@@ -0,0 +1,4 @@
list(APPEND SRCS
"${CMAKE_CURRENT_LIST_DIR}/fs_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/nvs_handler.cpp"
)

552
main/io/fs_handler.cpp Normal file
View File

@@ -0,0 +1,552 @@
#include "io/fs_handler.h"
#include <sys/stat.h>
#include <dirent.h>
#include <errno.h>
#include <cstring>
#include "esp_partition.h"
#define TAG "LittleFSHandler"
#define PARTITION_LABEL "storage"
#define BLOCK_SIZE 512 // Match typical flash sector size
//
// FSGuard implementation
//
FSGuard::FSGuard(LittleFSHandler* fs_handler, const std::string& relative_path, const char* flags)
: fs_handler_(fs_handler), file_(nullptr) {
if (fs_handler_ != nullptr) {
fs_handler_->open_file_(relative_path, flags, file_);
} else {
ESP_LOGE("FSGuard", "FSGuard initialized with null LittleFSHandler");
}
}
FSGuard::~FSGuard() {
this->close();
}
esp_err_t FSGuard::close() {
if (file_ != nullptr && fs_handler_ != nullptr) {
esp_err_t err = fs_handler_->close_file_(file_);
file_ = nullptr;
fs_handler_ = nullptr;
if (err != ESP_OK) {
ESP_LOGE("FSGuard", "Error closing file: %s", esp_err_to_name(err));
}
return err;
}
return ESP_OK;
}
//
// LittleFSHandler implementation
//
LittleFSHandler::LittleFSHandler() {
this->fs_mutex_ = xSemaphoreCreateMutex();
if (this->fs_mutex_ == nullptr) {
ESP_LOGE(TAG, "Failed to create filesystem mutex");
}
}
LittleFSHandler::~LittleFSHandler() {
if (this->is_initialized_()) {
esp_vfs_littlefs_unregister(PARTITION_LABEL);
this->initialized_ = false;
}
if (this->fs_mutex_ != nullptr) {
vSemaphoreDelete(this->fs_mutex_);
this->fs_mutex_ = nullptr;
}
}
esp_err_t LittleFSHandler::init(std::string base_path) {
// default config
esp_vfs_littlefs_conf_t config = {};
config.dont_mount = false;
config.partition_label = PARTITION_LABEL;
config.base_path = base_path.c_str();
config.format_if_mount_failed = true;
//
base_path_ = base_path;
return init(config);
}
esp_err_t LittleFSHandler::init(const esp_vfs_littlefs_conf_t& config) {
base_path_ = std::string(config.base_path);
if (this->is_initialized_()) {
ESP_LOGW(TAG, "LittleFS already initialized, skipping");
return ESP_OK;
}
esp_err_t err = esp_vfs_littlefs_register(&config);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize LittleFS: %s", esp_err_to_name(err));
if (err == ESP_ERR_NOT_FOUND) {
ESP_LOGE(TAG, "Listing all available partitions:");
esp_partition_iterator_t it = esp_partition_find(ESP_PARTITION_TYPE_ANY, ESP_PARTITION_SUBTYPE_ANY, NULL);
while (it != NULL) {
const esp_partition_t* part = esp_partition_get(it);
ESP_LOGE(TAG, " - Label: '%s', Type: 0x%02x, Subtype: 0x%02x, Address: 0x%08x, Size: 0x%08x",
part->label, part->type, part->subtype, part->address, part->size);
it = esp_partition_next(it);
}
esp_partition_iterator_release(it);
}
return ESP_ERR_INVALID_STATE;
}
this->initialized_ = true;
return ESP_OK;
}
std::string LittleFSHandler::get_base_path() const {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized, cannot get base path");
return "";
}
return base_path_;
}
std::string LittleFSHandler::get_full_path(const std::string& relative_path) const {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized, cannot get full path");
return "";
}
return base_path_ + "/" + relative_path;
}
esp_err_t LittleFSHandler::write_file(const std::string& relative_path, const uint8_t* data, size_t size, size_t& out_bytes_written) {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized");
return ESP_ERR_INVALID_STATE;
}
if (data == nullptr) {
ESP_LOGE(TAG, "Data pointer is null");
return ESP_ERR_INVALID_ARG;
}
SemaphoreGuard guard(this->fs_mutex_);
if (guard.take() != pdTRUE) {
ESP_LOGE(TAG, "Failed to acquire filesystem mutex");
return ESP_ERR_TIMEOUT;
}
// Try to open with r+b first to preserve existing content for comparison
FSGuard file_guard(this, relative_path, "r+b");
// If file doesn't exist, open with wb
if (!file_guard.is_open()) {
FSGuard new_file_guard(this, relative_path, "wb");
if (!new_file_guard.is_open()) {
return ESP_ERR_NOT_FOUND;
}
return this->write_if_different_(new_file_guard.get_file(), data, size, out_bytes_written);
}
return this->write_if_different_(file_guard.get_file(), data, size, out_bytes_written);
}
// Caller is responsible for opening the file in appropriate mode
// If the file doesn't exist, use write_file with "wb" mode
// If the file exists, use "r+b" mode to read and write
esp_err_t LittleFSHandler::write_file(FILE* file, const uint8_t* data, size_t size, size_t& out_bytes_written) {
return this->write_if_different_(file, data, size, out_bytes_written);
}
esp_err_t LittleFSHandler::append_file(const std::string& relative_path, const uint8_t* data, size_t size, size_t& out_bytes_written) {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized");
return ESP_ERR_INVALID_STATE;
}
if (data == nullptr) {
ESP_LOGE(TAG, "Data pointer is null");
return ESP_ERR_INVALID_ARG;
}
SemaphoreGuard guard(this->fs_mutex_);
if (guard.take() != pdTRUE) {
ESP_LOGE(TAG, "Failed to acquire filesystem mutex");
return ESP_ERR_TIMEOUT;
}
FSGuard file_guard(this, relative_path, "ab");
FILE* file = file_guard.get_file();
if (file == nullptr) {
return ESP_ERR_NOT_FOUND;
}
return this->append_file(file, data, size, out_bytes_written);
}
esp_err_t LittleFSHandler::append_file(FILE* file, const uint8_t* data, size_t size, size_t& out_bytes_written) {
if (file == nullptr) {
ESP_LOGE(TAG, "File pointer is null");
return ESP_ERR_INVALID_ARG;
}
if (data == nullptr) {
ESP_LOGE(TAG, "Data pointer is null");
return ESP_ERR_INVALID_ARG;
}
if (fseek(file, 0, SEEK_END) != 0) {
ESP_LOGE(TAG, "Failed to seek to end of file");
return ESP_ERR_INVALID_STATE;
}
// write data with POSIX
size_t bytes_written = fwrite(data, 1, size, file);
if (bytes_written != size) {
ESP_LOGE(TAG, "Failed to write all data to file, expected %zu bytes, wrote %zu bytes", size, bytes_written);
return ESP_ERR_NO_MEM;
}
if (fflush(file) != 0) {
ESP_LOGE(TAG, "Failed to flush file");
return ESP_ERR_INVALID_STATE;
}
out_bytes_written = bytes_written;
return ESP_OK;
}
esp_err_t LittleFSHandler::read_file(const std::string& relative_path, const size_t max_size, uint8_t* out_data, size_t& out_size) {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized");
return ESP_ERR_INVALID_STATE;
}
if (out_data == nullptr) {
ESP_LOGE(TAG, "Output data pointer is null");
return ESP_ERR_INVALID_ARG;
}
SemaphoreGuard guard(this->fs_mutex_);
if (guard.take() != pdTRUE) {
ESP_LOGE(TAG, "Failed to acquire filesystem mutex");
return ESP_ERR_TIMEOUT;
}
FSGuard file_guard(this, relative_path, "rb");
FILE* file = file_guard.get_file();
if (file == nullptr) {
return ESP_ERR_NOT_FOUND;
}
return this->read_file(file, max_size, out_data, out_size);
}
esp_err_t LittleFSHandler::read_file(FILE* file, const size_t max_size, uint8_t* out_data, size_t& out_size) {
if (file == nullptr) {
ESP_LOGE(TAG, "File pointer is null");
return ESP_ERR_INVALID_ARG;
}
if (out_data == nullptr) {
ESP_LOGE(TAG, "Output data pointer is null");
return ESP_ERR_INVALID_ARG;
}
size_t bytes_read = fread(out_data, 1, max_size, file);
if (bytes_read == 0 && ferror(file)) {
ESP_LOGE(TAG, "Failed to read from file");
return ESP_ERR_INVALID_STATE;
}
out_size = bytes_read;
return ESP_OK;
}
esp_err_t LittleFSHandler::delete_file(const std::string& relative_path) {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized");
return ESP_ERR_INVALID_STATE;
}
SemaphoreGuard guard(this->fs_mutex_);
if (guard.take() != pdTRUE) {
ESP_LOGE(TAG, "Failed to acquire filesystem mutex");
return ESP_ERR_TIMEOUT;
}
std::string full_path = this->get_full_path(relative_path);
if (remove(full_path.c_str()) != 0) {
ESP_LOGE(TAG, "Failed to delete file %s: %s", full_path.c_str(), strerror(errno));
return ESP_ERR_NOT_FOUND;
}
return ESP_OK;
}
bool LittleFSHandler::file_exists(const std::string& relative_path) {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized");
return false;
}
SemaphoreGuard guard(this->fs_mutex_);
if (guard.take() != pdTRUE) {
ESP_LOGE(TAG, "Failed to acquire filesystem mutex");
return false;
}
std::string full_path = this->get_full_path(relative_path);
struct stat st;
return (stat(full_path.c_str(), &st) == 0 && S_ISREG(st.st_mode));
}
esp_err_t LittleFSHandler::get_file_size(const std::string& relative_path, size_t& out_size) {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized");
return ESP_ERR_INVALID_STATE;
}
SemaphoreGuard guard(this->fs_mutex_);
if (guard.take() != pdTRUE) {
ESP_LOGE(TAG, "Failed to acquire filesystem mutex");
return ESP_ERR_TIMEOUT;
}
std::string full_path = this->get_full_path(relative_path);
struct stat st;
if (stat(full_path.c_str(), &st) != 0) {
ESP_LOGE(TAG, "Failed to stat file %s", full_path.c_str());
return ESP_ERR_NOT_FOUND;
}
out_size = st.st_size;
return ESP_OK;
}
esp_err_t LittleFSHandler::create_directory(const std::string& relative_path) {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized");
return ESP_ERR_INVALID_STATE;
}
SemaphoreGuard guard(this->fs_mutex_);
if (guard.take() != pdTRUE) {
ESP_LOGE(TAG, "Failed to acquire filesystem mutex");
return ESP_ERR_TIMEOUT;
}
std::string full_path = this->get_full_path(relative_path);
if (mkdir(full_path.c_str(), 0755) != 0) {
if (errno == EEXIST) {
ESP_LOGW(TAG, "Directory %s already exists", full_path.c_str());
return ESP_OK;
}
ESP_LOGE(TAG, "Failed to create directory %s: %s", full_path.c_str(), strerror(errno));
return ESP_ERR_INVALID_STATE;
}
return ESP_OK;
}
esp_err_t LittleFSHandler::list_directory(const std::string& relative_path, std::vector<std::string>& out_entries) {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized");
return ESP_ERR_INVALID_STATE;
}
SemaphoreGuard guard(this->fs_mutex_);
if (guard.take() != pdTRUE) {
ESP_LOGE(TAG, "Failed to acquire filesystem mutex");
return ESP_ERR_TIMEOUT;
}
std::string full_path = this->get_full_path(relative_path);
DIR* dir = opendir(full_path.c_str());
if (dir == nullptr) {
ESP_LOGE(TAG, "Failed to open directory %s", full_path.c_str());
return ESP_ERR_NOT_FOUND;
}
out_entries.clear();
struct dirent* entry;
while ((entry = readdir(dir)) != nullptr) {
// Skip . and ..
if (strcmp(entry->d_name, ".") == 0 || strcmp(entry->d_name, "..") == 0) {
continue;
}
out_entries.push_back(entry->d_name);
}
closedir(dir);
return ESP_OK;
}
//
// Private methods
//
esp_err_t LittleFSHandler::open_file_(const std::string& relative_path, const char* flags, FILE*& out_file) {
if (!this->is_initialized_()) {
ESP_LOGE(TAG, "LittleFS is not initialized, cannot open file");
return ESP_ERR_INVALID_STATE;
}
std::string full_path = this->get_full_path(relative_path);
FILE* file = fopen(full_path.c_str(), flags);
if (file == nullptr) {
// Use debug level if file doesn't exist (ENOENT), warning level for other errors
if (errno == ENOENT) {
ESP_LOGD(TAG, "File %s does not exist (flags %s)", full_path.c_str(), flags);
} else {
ESP_LOGW(TAG, "Failed to open file %s with flags %s: %s", full_path.c_str(), flags, strerror(errno));
}
return ESP_ERR_NOT_FOUND;
}
out_file = file;
return ESP_OK;
}
esp_err_t LittleFSHandler::close_file_(FILE* file) {
if (file == nullptr) {
return ESP_OK;
}
if (fclose(file) != 0) {
ESP_LOGE(TAG, "Failed to close file: %s", strerror(errno));
return ESP_ERR_INVALID_STATE;
}
return ESP_OK;
}
esp_err_t LittleFSHandler::write_if_different_(FILE* file, const uint8_t* data, size_t size) {
size_t out_bytes_written = 0;
return this->write_if_different_(file, data, size, out_bytes_written);
}
esp_err_t LittleFSHandler::write_if_different_(FILE* file, const uint8_t* data, size_t size, size_t& out_bytes_written) {
if (file == nullptr || data == nullptr) {
ESP_LOGE(TAG, "Invalid parameters");
return ESP_ERR_INVALID_ARG;
}
// Get existing file size
if (fseek(file, 0, SEEK_END) != 0) {
ESP_LOGE(TAG, "Failed to seek to end of file");
return ESP_ERR_INVALID_STATE;
}
long file_size_long = ftell(file);
if (file_size_long < 0) {
ESP_LOGE(TAG, "Failed to get file size");
return ESP_ERR_INVALID_STATE;
}
size_t file_size = (size_t)file_size_long;
if (fseek(file, 0, SEEK_SET) != 0) {
ESP_LOGE(TAG, "Failed to seek to beginning of file");
return ESP_ERR_INVALID_STATE;
}
out_bytes_written = 0;
size_t compare_size = (file_size < size) ? file_size : size;
// Read entire file content for comparison
std::vector<uint8_t> existing_data;
if (file_size > 0) {
existing_data.resize(file_size);
size_t bytes_read = fread(existing_data.data(), 1, file_size, file);
if (bytes_read != file_size) {
ESP_LOGE(TAG, "Failed to read existing file data");
return ESP_ERR_INVALID_STATE;
}
}
// Compare and identify blocks that need updating
std::vector<bool> block_needs_update((size + BLOCK_SIZE - 1) / BLOCK_SIZE, false);
bool any_changes = false;
for (size_t offset = 0; offset < compare_size; offset += BLOCK_SIZE) {
size_t chunk_size = BLOCK_SIZE;
if (offset + chunk_size > compare_size) {
chunk_size = compare_size - offset;
}
if (memcmp(existing_data.data() + offset, data + offset, chunk_size) != 0) {
block_needs_update[offset / BLOCK_SIZE] = true;
any_changes = true;
}
}
// Check if size changed or there are additional blocks to write
if (size != file_size) {
any_changes = true;
}
if (!any_changes) {
ESP_LOGD(TAG, "File content unchanged, skipping write");
return ESP_OK;
}
// Seek to beginning to start writing
if (fseek(file, 0, SEEK_SET) != 0) {
ESP_LOGE(TAG, "Failed to seek to beginning for writing");
return ESP_ERR_INVALID_STATE;
}
// Write only changed blocks
for (size_t offset = 0; offset < compare_size; offset += BLOCK_SIZE) {
size_t block_index = offset / BLOCK_SIZE;
if (!block_needs_update[block_index]) {
// Skip unchanged block
if (fseek(file, offset + BLOCK_SIZE, SEEK_SET) != 0) {
// If at end of compare region, this is OK
if (offset + BLOCK_SIZE > compare_size) {
if (fseek(file, compare_size, SEEK_SET) != 0) {
ESP_LOGE(TAG, "Failed to seek past unchanged block");
return ESP_ERR_INVALID_STATE;
}
} else {
ESP_LOGE(TAG, "Failed to seek past unchanged block at %zu", offset);
return ESP_ERR_INVALID_STATE;
}
}
continue;
}
size_t chunk_size = BLOCK_SIZE;
if (offset + chunk_size > compare_size) {
chunk_size = compare_size - offset;
}
if (fseek(file, offset, SEEK_SET) != 0) {
ESP_LOGE(TAG, "Failed to seek to offset %zu", offset);
return ESP_ERR_INVALID_STATE;
}
size_t written = fwrite(data + offset, 1, chunk_size, file);
if (written != chunk_size) {
ESP_LOGE(TAG, "Failed to write block at offset %zu", offset);
return ESP_ERR_INVALID_STATE;
}
out_bytes_written += written;
}
// Handle size differences
if (size > file_size) {
// Write additional data beyond original file size
if (fseek(file, file_size, SEEK_SET) != 0) {
ESP_LOGE(TAG, "Failed to seek to end for appending");
return ESP_ERR_INVALID_STATE;
}
size_t written = fwrite(data + file_size, 1, size - file_size, file);
if (written != (size - file_size)) {
ESP_LOGE(TAG, "Failed to write additional data");
return ESP_ERR_INVALID_STATE;
}
out_bytes_written += written;
} else if (size < file_size) {
// Truncate file to new size
if (ftruncate(fileno(file), size) != 0) {
ESP_LOGE(TAG, "Failed to truncate file to size %zu", size);
return ESP_ERR_INVALID_STATE;
}
}
// Flush to ensure data is written to storage
if (fflush(file) != 0) {
ESP_LOGE(TAG, "Failed to flush file after write");
return ESP_ERR_INVALID_STATE;
}
return ESP_OK;
}
bool LittleFSHandler::is_initialized_() const {
return this->initialized_;
}

95
main/io/fs_handler.h Normal file
View File

@@ -0,0 +1,95 @@
#pragma once
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "esp_littlefs.h"
#include "esp_err.h"
#include <string>
#include <vector>
#include <map>
#include <memory>
#include "esp_log.h"
#include <semaphore_guard.h>
// Forward declaration
class LittleFSHandler;
class FSGuard {
public:
FSGuard(LittleFSHandler* fs_handler, const std::string& relative_path, const char* flags);
~FSGuard();
esp_err_t close();
FILE* get_file() {
return file_;
}
bool is_open() const {
return file_ != nullptr;
}
private:
LittleFSHandler* fs_handler_ = nullptr;
FILE* file_;
// prevent copying and moving
FSGuard(const FSGuard&) = delete;
FSGuard& operator=(const FSGuard&) = delete;
FSGuard(FSGuard&& other) = delete;
FSGuard& operator=(FSGuard&& other) = delete;
};
//LittleFSHandler interface
// All paths are relative to the mounted filesystem root
// Implementations should handle initialization of the filesystem, and mounting if necessary
// When destroyed, implementations should unmount the filesystem if necessary
// All paths are relative to the mounted filesystem root, e.g. if mounted at /littlefs, and file is /data.txt, the full path is /littlefs/data.txt
// File operations use standard C FILE* wrapped in FSGuard for RAII
class LittleFSHandler {
public:
LittleFSHandler();
~LittleFSHandler();
esp_err_t init(std::string base_path);
esp_err_t init(const esp_vfs_littlefs_conf_t& config);
std::string get_base_path() const;
std::string get_full_path(const std::string& relative_path) const;
// File operations
esp_err_t write_file(const std::string& relative_path, const uint8_t* data, size_t size, size_t& out_bytes_written);
esp_err_t write_file(FILE* file, const uint8_t* data, size_t size, size_t& out_bytes_written);
//
esp_err_t append_file(const std::string& relative_path, const uint8_t* data, size_t size, size_t& out_bytes_written);
esp_err_t append_file(FILE* file, const uint8_t* data, size_t size, size_t& out_bytes_written);
//
esp_err_t read_file(const std::string& relative_path, const size_t max_size, uint8_t* out_data, size_t& out_size);
esp_err_t read_file(FILE* file, const size_t max_size, uint8_t* out_data, size_t& out_size);
//
esp_err_t delete_file(const std::string& relative_path);
//
bool file_exists(const std::string& relative_path);
esp_err_t get_file_size(const std::string& relative_path, size_t& out_size);
// Directory operations
esp_err_t create_directory(const std::string& relative_path);
esp_err_t list_directory(const std::string& relative_path, std::vector<std::string>& out_entries);
protected:
esp_err_t open_file_(const std::string& relative_path, const char* flags, FILE*& out_file);
esp_err_t close_file_(FILE* file);
// uses standard C FILE* for file operations
esp_err_t write_if_different_(FILE* file, const uint8_t* data, size_t size);
esp_err_t write_if_different_(FILE* file, const uint8_t* data, size_t size, size_t& out_bytes_written);
friend class FSGuard;
private:
//
bool is_initialized_() const;
SemaphoreHandle_t fs_mutex_ = nullptr;
bool initialized_ = false;
std::string base_path_;
};

View File

@@ -3,8 +3,8 @@
#include "freertos/event_groups.h" #include "freertos/event_groups.h"
#include <memory> #include <memory>
typedef bool(*FilterFunc)(const char* const& key); typedef bool(*FilterFunc)(const std::string& key);
typedef void (*KeyValueProcessor)(void* arg, const char* const& key, const char* const& value); typedef void (*KeyValueProcessor)(void* arg, const std::string& key, const std::string& value);
class KVStorageHandler { class KVStorageHandler {
public: public:
@@ -13,15 +13,14 @@ public:
virtual void init(const EventGroupHandle_t& system_event_group) = 0; virtual void init(const EventGroupHandle_t& system_event_group) = 0;
// Store a key-value pair // Store a key-value pair
virtual void put(const char* const& key, const char* const& value) = 0; virtual void put(const std::string& key, const std::string& value) = 0;
// Retrieve a value by key, returns nullptr if key not found // Retrieve a value by key, returns empty string if key not found
// The caller is responsible for freeing the returned memory virtual std::string get(const std::string& key) const = 0;
virtual std::unique_ptr<char[]> get(const char* const& key) const = 0;
virtual esp_err_t process_all(KeyValueProcessor processor, void* arg) const = 0; virtual esp_err_t process_all(KeyValueProcessor processor, void* arg) const = 0;
virtual esp_err_t process_filtered(const char* const& key_prefix, KeyValueProcessor processor, void* arg) const = 0; virtual esp_err_t process_filtered(const std::string& key_prefix, KeyValueProcessor processor, void* arg) const = 0;
virtual esp_err_t process_filtered(FilterFunc filter_func, KeyValueProcessor processor, void* arg) const = 0; virtual esp_err_t process_filtered(FilterFunc filter_func, KeyValueProcessor processor, void* arg) const = 0;
// Delete a key-value pair // Delete a key-value pair
virtual void remove(const char* const& key) = 0; virtual void remove(const std::string& key) = 0;
}; };

View File

@@ -2,6 +2,9 @@
#include "io/nvs_handler.h" #include "io/nvs_handler.h"
#include "nvs_flash.h" #include "nvs_flash.h"
#include "string.h" #include "string.h"
#include "esp_log.h"
#define TAG "NVSStorageHandler"
NVSStorageHandler::NVSStorageHandler( NVSStorageHandler::NVSStorageHandler(
const char* name_space const char* name_space
@@ -17,6 +20,7 @@ NVSStorageHandler::~NVSStorageHandler() {
void NVSStorageHandler::init(const EventGroupHandle_t& system_event_group) { void NVSStorageHandler::init(const EventGroupHandle_t& system_event_group) {
esp_err_t err = nvs_flash_init(); esp_err_t err = nvs_flash_init();
if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) { if (err == ESP_ERR_NVS_NO_FREE_PAGES || err == ESP_ERR_NVS_NEW_VERSION_FOUND) {
ESP_LOGW(TAG, "NVS Flash init failed with %s, erasing and retrying...", esp_err_to_name(err));
nvs_flash_erase(); nvs_flash_erase();
err = nvs_flash_init(); err = nvs_flash_init();
} }
@@ -24,49 +28,67 @@ void NVSStorageHandler::init(const EventGroupHandle_t& system_event_group) {
err = nvs_open(this->name_space, NVS_READWRITE, &this->nvsHandle); err = nvs_open(this->name_space, NVS_READWRITE, &this->nvsHandle);
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) opening NVS handle!\n", esp_err_to_name(err)); ESP_LOGE(TAG, "Error (%s) opening NVS handle!", esp_err_to_name(err));
} else { } else {
xEventGroupSetBits(system_event_group, STORAGE_READY_BIT); if (system_event_group != nullptr) {
printf("NVS Storage initialized.\n"); xEventGroupSetBits(system_event_group, STORAGE_READY_BIT);
}
ESP_LOGI(TAG, "NVS Storage initialized.");
} }
} }
void NVSStorageHandler::put(const char* const& key, const char* const& value) { void NVSStorageHandler::put(const std::string& key, const std::string& value) {
if (this->nvsHandle == 0) { if (this->nvsHandle == 0) {
printf("NVS handle is not initialized.\n"); ESP_LOGE(TAG, "NVS handle is not initialized.");
return; return;
} }
esp_err_t err = nvs_set_str(this->nvsHandle, key, value); esp_err_t err = nvs_set_str(this->nvsHandle, key.c_str(), value.c_str());
if (err != ESP_OK) { if (err == ESP_ERR_NVS_NOT_ENOUGH_SPACE) {
printf("Error (%s) setting key-value pair in NVS!\n", esp_err_to_name(err)); ESP_LOGE(TAG, "NVS storage full! Cannot store key '%s'. Consider clearing old data.", key.c_str());
} else { ESP_LOGI(TAG, "Attempting to erase and retry...");
// Try to commit pending changes first
nvs_commit(this->nvsHandle); nvs_commit(this->nvsHandle);
printf("Key-value pair (%s, %s) stored in NVS.\n", key, value); // Retry once
err = nvs_set_str(this->nvsHandle, key.c_str(), value.c_str());
if (err != ESP_OK) {
ESP_LOGE(TAG, "Retry failed: %s", esp_err_to_name(err));
return;
}
} else if (err != ESP_OK) {
ESP_LOGE(TAG, "Error (%s) setting key-value pair in NVS!", esp_err_to_name(err));
return;
}
// Commit successful write
err = nvs_commit(this->nvsHandle);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Error (%s) committing to NVS!", esp_err_to_name(err));
} }
} }
std::unique_ptr<char[]> NVSStorageHandler::get(const char* const& key) const { std::string NVSStorageHandler::get(const std::string& key) const {
if (this->nvsHandle == 0) { if (this->nvsHandle == 0) {
printf("NVS handle is not initialized.\n"); ESP_LOGE(TAG, "NVS handle is not initialized.");
return nullptr; return "";
} }
size_t required_size = 0; size_t required_size = 0;
esp_err_t err = nvs_get_str(this->nvsHandle, key, nullptr, &required_size); esp_err_t err = nvs_get_str(this->nvsHandle, key.c_str(), nullptr, &required_size);
if (err == ESP_ERR_NVS_NOT_FOUND) { if (err == ESP_ERR_NVS_NOT_FOUND) {
printf("Key %s not found in NVS.\n", key); ESP_LOGW(TAG, "Key %s not found in NVS.", key.c_str());
return nullptr; return "";
} else if (err != ESP_OK) { } else if (err != ESP_OK) {
printf("Error (%s) getting size for key %s from NVS!\n", esp_err_to_name(err), key); ESP_LOGE(TAG, "Error (%s) getting size for key %s from NVS!", esp_err_to_name(err), key.c_str());
return nullptr; return "";
} }
std::unique_ptr<char[]> value(new char[required_size]); // Allocate string buffer with correct size (includes null terminator)
err = nvs_get_str(this->nvsHandle, key, value.get(), &required_size); std::string value(required_size - 1, '\0');
err = nvs_get_str(this->nvsHandle, key.c_str(), &value[0], &required_size);
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) getting value for key %s from NVS!\n", esp_err_to_name(err), key); ESP_LOGE(TAG, "Error (%s) getting value for key %s from NVS!", esp_err_to_name(err), key.c_str());
return nullptr; return "";
} }
return value; return value;
@@ -76,7 +98,7 @@ NVSIteratorGuard NVSStorageHandler::create_iterator() const {
nvs_iterator_t it = nullptr; nvs_iterator_t it = nullptr;
esp_err_t err = nvs_entry_find(NVS_DEFAULT_PART_NAME, this->name_space, NVS_TYPE_ANY, &it); esp_err_t err = nvs_entry_find(NVS_DEFAULT_PART_NAME, this->name_space, NVS_TYPE_ANY, &it);
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) creating NVS iterator!\n", esp_err_to_name(err)); ESP_LOGE(TAG, "Error (%s) creating NVS iterator!", esp_err_to_name(err));
return NVSIteratorGuard(nullptr, err); return NVSIteratorGuard(nullptr, err);
} }
@@ -94,22 +116,23 @@ esp_err_t NVSStorageHandler::process_all(KeyValueProcessor processor, void* arg)
nvs_entry_info_t info; nvs_entry_info_t info;
esp_err_t err = nvs_entry_info(it, &info); esp_err_t err = nvs_entry_info(it, &info);
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) getting NVS entry info!\n", esp_err_to_name(err)); ESP_LOGE(TAG, "Error (%s) getting NVS entry info!", esp_err_to_name(err));
return err; return err;
} }
nvs_handle_t temp_handle; nvs_handle_t temp_handle;
err = nvs_open(this->name_space, NVS_READONLY, &temp_handle); err = nvs_open(this->name_space, NVS_READONLY, &temp_handle);
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) opening NVS handle for reading!\n", esp_err_to_name(err)); ESP_LOGE(TAG, "Error (%s) opening NVS handle for reading!", esp_err_to_name(err));
return err; return err;
} }
// call the processor with the key and value // call the processor with the key and value
processor(arg, info.key, this->get(info.key).get()); std::string key_str = info.key;
processor(arg, key_str, this->get(key_str));
} }
return ESP_OK; return ESP_OK;
} }
esp_err_t NVSStorageHandler::process_filtered(const char* const& key_prefix, KeyValueProcessor processor, void* arg) const { esp_err_t NVSStorageHandler::process_filtered(const std::string& key_prefix, KeyValueProcessor processor, void* arg) const {
NVSIteratorGuard iterator_guard = this->create_iterator(); NVSIteratorGuard iterator_guard = this->create_iterator();
if (!iterator_guard.is_valid()) { if (!iterator_guard.is_valid()) {
return iterator_guard.get_error(); return iterator_guard.get_error();
@@ -120,19 +143,19 @@ esp_err_t NVSStorageHandler::process_filtered(const char* const& key_prefix, Key
nvs_entry_info_t info; nvs_entry_info_t info;
esp_err_t err = nvs_entry_info(it, &info); esp_err_t err = nvs_entry_info(it, &info);
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) getting NVS entry info!\n", esp_err_to_name(err)); ESP_LOGE(TAG, "Error (%s) getting NVS entry info!", esp_err_to_name(err));
return err; return err;
} }
// check if the key matches the prefix // check if the key matches the prefix
if (strncmp(info.key, key_prefix, strlen(key_prefix)) == 0) { if (strncmp(info.key, key_prefix.c_str(), key_prefix.length()) == 0) {
nvs_handle_t temp_handle; nvs_handle_t temp_handle;
err = nvs_open(this->name_space, NVS_READONLY, &temp_handle); err = nvs_open(this->name_space, NVS_READONLY, &temp_handle);
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) opening NVS handle for reading!\n", esp_err_to_name(err)); ESP_LOGE(TAG, "Error (%s) opening NVS handle for reading!", esp_err_to_name(err));
return err; return err;
} }
// call the processor with the key and value // call the processor with the key and value
processor(arg, info.key, this->get(info.key).get()); processor(arg, std::string(info.key), this->get(std::string(info.key)));
} }
} }
return ESP_OK; return ESP_OK;
@@ -149,35 +172,36 @@ esp_err_t NVSStorageHandler::process_filtered(FilterFunc filter_func, KeyValuePr
nvs_entry_info_t info; nvs_entry_info_t info;
esp_err_t err = nvs_entry_info(it, &info); esp_err_t err = nvs_entry_info(it, &info);
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) getting NVS entry info!\n", esp_err_to_name(err)); ESP_LOGE(TAG, "Error (%s) getting NVS entry info!", esp_err_to_name(err));
return err; return err;
} }
// check if the key matches the filter function // check if the key matches the filter function
if (filter_func(info.key)) { std::string key_str(info.key);
if (filter_func(key_str)) {
nvs_handle_t temp_handle; nvs_handle_t temp_handle;
err = nvs_open(this->name_space, NVS_READONLY, &temp_handle); err = nvs_open(this->name_space, NVS_READONLY, &temp_handle);
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) opening NVS handle for reading!\n", esp_err_to_name(err)); ESP_LOGE(TAG, "Error (%s) opening NVS handle for reading!", esp_err_to_name(err));
return err; return err;
} }
// call the processor with the key and value // call the processor with the key and value
processor(arg, info.key, this->get(info.key).get()); processor(arg, key_str, this->get(key_str));
} }
} }
return ESP_OK; return ESP_OK;
} }
void NVSStorageHandler::remove(const char* const& key) { void NVSStorageHandler::remove(const std::string& key) {
if (this->nvsHandle == 0) { if (this->nvsHandle == 0) {
printf("NVS handle is not initialized.\n"); ESP_LOGE(TAG, "NVS handle is not initialized.");
return; return;
} }
esp_err_t err = nvs_erase_key(this->nvsHandle, key); esp_err_t err = nvs_erase_key(this->nvsHandle, key.c_str());
if (err != ESP_OK) { if (err != ESP_OK) {
printf("Error (%s) deleting key %s from NVS!\n", esp_err_to_name(err), key); ESP_LOGE(TAG, "Error (%s) deleting key %s from NVS!", esp_err_to_name(err), key.c_str());
} else { } else {
nvs_commit(this->nvsHandle); nvs_commit(this->nvsHandle);
printf("Key %s deleted from NVS.\n", key); ESP_LOGI(TAG, "Key %s deleted from NVS.", key.c_str());
} }
} }

View File

@@ -53,14 +53,14 @@ public:
void init(const EventGroupHandle_t& system_event_group) override; void init(const EventGroupHandle_t& system_event_group) override;
void put(const char* const& key, const char* const& value) override; void put(const std::string& key, const std::string& value) override;
std::unique_ptr<char[]> get(const char* const& key) const override; std::string get(const std::string& key) const override;
esp_err_t process_all(KeyValueProcessor processor, void* arg) const override; esp_err_t process_all(KeyValueProcessor processor, void* arg) const override;
esp_err_t process_filtered(const char* const& key_prefix, KeyValueProcessor processor, void* arg) const override; esp_err_t process_filtered(const std::string& key_prefix, KeyValueProcessor processor, void* arg) const override;
esp_err_t process_filtered(FilterFunc filter_func, KeyValueProcessor processor, void* arg) const override; esp_err_t process_filtered(FilterFunc filter_func, KeyValueProcessor processor, void* arg) const override;
void remove(const char* const& key) override; void remove(const std::string& key) override;
private: private:
NVSIteratorGuard create_iterator() const; NVSIteratorGuard create_iterator() const;

File diff suppressed because it is too large Load Diff

View File

@@ -1,10 +1,3 @@
/*
* SPDX-FileCopyrightText: 2010-2022 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: CC0-1.0
*/
#include <stdio.h> #include <stdio.h>
#include <inttypes.h> #include <inttypes.h>
#include <stdexcept> #include <stdexcept>
@@ -14,19 +7,32 @@
#include "esp_chip_info.h" #include "esp_chip_info.h"
#include "esp_flash.h" #include "esp_flash.h"
#include "esp_system.h" #include "esp_system.h"
#include "esp_log.h"
#include "esp_event.h"
// //
#include "common/constants.h" #include "common/constants.h"
#include "common/queue_defs.h" #include "common/queue_defs.h"
#include "common/system_context.h"
#include "io/nvs_handler.h" #include "io/nvs_handler.h"
#include "io/fs_handler.h"
#include "info/info.h" #include "info/info.h"
#include "display/display.h" #include "display/eink_display_handler.h"
#include "touch/touch.h" #include "display/lvgl_handler.h"
#include "ui/ui_handler.h"
#include "ui/apps/registry.h"
#include <tick/lv_tick.h> #include <tick/lv_tick.h>
#include "esp_lvgl_port.h"
#include "lvgl.h"
#include "network.h" #include "network.h"
#include <esp_task_wdt.h>
#include "lvgl.h"
#include <esp_netif_sntp.h>
// nvs storage namespaces, 15 characters max
#define DEFAULT_STORAGE_NAMESPACE "storage" #define DEFAULT_STORAGE_NAMESPACE "storage"
#define WIFI_CREDENTIALS_STORAGE_NAMESPACE "wifi_credentials" #define TAG "Main"
extern "C" void app_main(void); extern "C" void app_main(void);
@@ -36,152 +42,171 @@ void init_queues(
EventGroupHandle_t& system_lifecycle_event_group EventGroupHandle_t& system_lifecycle_event_group
); );
void app_main(void) { void app_main(void) {
display_chip_info(); display_chip_info();
// set to hkt
setenv("TZ", "HKT-8", 1);
tzset();
// Initialize default event loop early - required for UI events
esp_err_t err = esp_event_loop_create_default();
if (err != ESP_OK && err != ESP_ERR_INVALID_STATE) {
ESP_LOGE(TAG, "Failed to create default event loop: %s", esp_err_to_name(err));
vTaskDelay(5000 / portTICK_PERIOD_MS);
return esp_restart();
}
ESP_LOGI(TAG, "Default event loop created.\n");
try { QueueHandle_t touch_event_queue = NULL;
QueueHandle_t touch_event_queue = NULL; EventGroupHandle_t system_event_group = NULL, system_lifecycle_event_group = NULL;
EventGroupHandle_t system_event_group = NULL, system_lifecycle_event_group = NULL;
init_queues(touch_event_queue, system_event_group, system_lifecycle_event_group); init_queues(touch_event_queue, system_event_group, system_lifecycle_event_group);
if (touch_event_queue == NULL || system_event_group == NULL || system_lifecycle_event_group == NULL) { if (touch_event_queue == NULL || system_event_group == NULL || system_lifecycle_event_group == NULL) {
throw std::runtime_error("Failed to create one or more queues/event groups"); ESP_LOGE("Main", "Failed to create one or more queues/event groups");
} vTaskDelay(5000 / portTICK_PERIOD_MS);
printf("Queues initialized.\n"); return esp_restart();
SemaphoreHandle_t lvgl_mutex = xSemaphoreCreateMutex(); }
if (lvgl_mutex == NULL) { ESP_LOGI(TAG, "Queues initialized.\n");
throw std::runtime_error("Failed to create LVGL mutex");
}
//
WifiHandler wifi_handler(
new NVSStorageHandler(WIFI_CREDENTIALS_STORAGE_NAMESPACE)
);
NetworkHandler* network_handler = new NetworkHandler(std::move(wifi_handler));
KVStorageHandler* kv_storage_handler = new NVSStorageHandler(
DEFAULT_STORAGE_NAMESPACE
);
DisplayHandler* display_handler = new EInkDisplayHandler(touch_event_queue, lvgl_mutex);
TouchHandler* touch_handler = new EInkTouchHandler(touch_event_queue);
//
network_handler->init(system_event_group);
kv_storage_handler->init(system_event_group);
display_handler->init(system_event_group);
touch_handler->init(system_event_group);
//
// LVGL tick timer
auto lvgl_tick_timer_callback = [](TimerHandle_t xTimer) {
lv_tick_inc(5);
};
TimerHandle_t lvgl_tick_timer = xTimerCreate(
"lvgl_tick_timer",
pdMS_TO_TICKS(5),
pdTRUE,
NULL,
lvgl_tick_timer_callback
);
if (lvgl_tick_timer == NULL) {
throw std::runtime_error("Failed to create LVGL tick timer");
}
xTimerStart(lvgl_tick_timer, 0);
// //
printf("Waiting for system to be ready...\n"); KVStorageHandler* kv_storage_handler = new NVSStorageHandler(
xEventGroupWaitBits( DEFAULT_STORAGE_NAMESPACE
system_event_group, );
DISPLAY_READY_BIT | TOUCH_CALIBRATED_BIT | STORAGE_READY_BIT | NETWORK_READY_BIT,
// do not clear on exit, require explicit reset auto fs_handler = std::make_shared<LittleFSHandler>();
pdFALSE, esp_err_t fs_err = fs_handler->init("/littlefs");
pdTRUE, if (fs_err != ESP_OK) {
portMAX_DELAY ESP_LOGE(TAG, "Failed to initialize LittleFS: %s", esp_err_to_name(fs_err));
); vTaskDelay(5000 / portTICK_PERIOD_MS);
printf("System is ready. Starting main application...\n"); return esp_restart();
// starting event loops }
display_handler->start_event_loop();
touch_handler->start_event_loop(); auto wifi_handler = std::make_unique<WifiHandler>(fs_handler);
// wait for shutdown signal NetworkHandler* network_handler = new NetworkHandler(std::move(wifi_handler));
EInkDisplayHandler* display_handler = new EInkDisplayHandler();
// Initialize display and touch
// display_handler->init_devices(system_event_group);
display_handler->init_devices();
ESP_LOGI(TAG, "E-Ink display handler initialized.\n");
// LVGL Handler
std::unique_ptr<EInkDisplayHandler> display_uptr(display_handler);
LVGLHandler lvgl_handler(std::move(display_uptr));
err = lvgl_handler.initLVGL(system_event_group);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize LVGL handler: %s", esp_err_to_name(err));
vTaskDelay(5000 / portTICK_PERIOD_MS);
return esp_restart();
}
//
kv_storage_handler->init(system_event_group);
network_handler->init(system_event_group);
// Make network handler available to apps
SystemContext::instance().set_network_handler(network_handler);
//
ESP_LOGI(TAG, "Waiting for system to be ready...\n");
xEventGroupWaitBits(
system_event_group,
DISPLAY_READY_BIT | NETWORK_READY_BIT,
// do not clear on exit, require explicit reset
pdFALSE,
pdTRUE,
portMAX_DELAY
);
esp_sntp_config_t config = ESP_NETIF_SNTP_DEFAULT_CONFIG("pool.ntp.org");
esp_netif_sntp_init(&config);
ESP_LOGI(TAG, "System is ready. Starting main application...\n");
AppRegistry& app_registry = AppRegistry::instance();
err = app_registry.init();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize App Registry: %s", esp_err_to_name(err));
vTaskDelay(5000 / portTICK_PERIOD_MS);
return esp_restart();
}
UIHandler ui_handler;
err = ui_handler.init();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize UI handler: %s", esp_err_to_name(err));
vTaskDelay(5000 / portTICK_PERIOD_MS);
return esp_restart();
}
ESP_LOGI(TAG, "UI handler initialized.\n");
// Allow LVGL system to stabilize before creating objects
vTaskDelay(pdMS_TO_TICKS(100));
// wait for shutdown signal
ESP_LOGI(TAG, "Waiting for shutdown signal...\n");
EventBits_t bits = xEventGroupWaitBits(
system_lifecycle_event_group,
SYSTEM_SHUTDOWN_BIT | SYSTEM_RESTART_BIT,
// do not clear on exit, require explicit reset
pdFALSE,
pdFALSE,
portMAX_DELAY
);
ESP_LOGI(TAG, "Shutdown signal received. Cleaning up...\n");
// Show shutdown screen using the shutdown descriptor's app instance
// ShutdownApp* shutdown_app = dynamic_cast<ShutdownApp*>(shutdown_descriptor->get_app_instance());
// if (shutdown_app) {
// ui_handler.switch_app(shutdown_app);
// }
vTaskDelay(1000 / portTICK_PERIOD_MS); // Display shutdown message briefly
// Cleanup
// ui_handler.deinit();
// delete demo_descriptor;
// delete shutdown_descriptor;
// delete mtr_descriptor;
vEventGroupDelete(system_event_group);
vQueueDelete(touch_event_queue);
ESP_LOGI(TAG, "Cleanup complete.\n");
// handle shutdown or restart
if (bits & SYSTEM_SHUTDOWN_BIT) {
// if (shutdown_display_handler != nullptr) {
// ESP_LOGI(TAG, "Calling display shutdown handler...\n");
// shutdown_display_handler();
// } else {
// ESP_LOGI(TAG, "No display shutdown handler to call.\n");
// }
ESP_LOGI(TAG, "System is shutting down.\n");
fflush(stdout);
// wait for start bit to be set again if future restart is desired, else expect manual power cycle
EventBits_t bits = xEventGroupWaitBits( EventBits_t bits = xEventGroupWaitBits(
system_lifecycle_event_group, system_lifecycle_event_group,
SYSTEM_SHUTDOWN_BIT | SYSTEM_RESTART_BIT, SYSTEM_START_BIT,
// do not clear on exit, require explicit reset
pdFALSE, pdFALSE,
pdFALSE, pdFALSE,
portMAX_DELAY portMAX_DELAY
); );
printf("Shutdown signal received. Cleaning up...\n"); if (bits & SYSTEM_START_BIT) {
ESP_LOGI(TAG, "SYSTEM_START_BIT received, restarting system.\n");
// cleanup
shutdown_display_handlerFunc shutdown_display_handler = display_handler->get_shutdown_display_handler();
restart_display_handlerFunc restart_display_handler = display_handler->get_restart_display_handler();
delete display_handler;
delete touch_handler;
vSemaphoreDelete(lvgl_mutex);
vEventGroupDelete(system_event_group);
vQueueDelete(touch_event_queue);
printf("Cleanup complete.\n");
// handle shutdown or restart
if (bits & SYSTEM_SHUTDOWN_BIT) {
if (shutdown_display_handler != nullptr) {
printf("Calling display shutdown handler...\n");
shutdown_display_handler();
} else {
printf("No display shutdown handler to call.\n");
}
printf("System is shutting down.\n");
fflush(stdout);
// wait for start bit to be set again if future restart is desired, else expect manual power cycle
EventBits_t bits = xEventGroupWaitBits(
system_lifecycle_event_group,
SYSTEM_START_BIT,
pdFALSE,
pdFALSE,
portMAX_DELAY
);
if (bits & SYSTEM_START_BIT) {
printf("SYSTEM_START_BIT received, restarting system.\n");
} else {
printf("No restart signal received, waiting for manual power cycle.\n");
while (true) {
vTaskDelay(portMAX_DELAY);
}
}
} else if (bits & SYSTEM_RESTART_BIT) {
if (restart_display_handler != nullptr) {
printf("Calling display restart handler...\n");
restart_display_handler();
} else {
printf("No display restart handler to call.\n");
}
printf("System is restarting.\n");
fflush(stdout);
} else { } else {
printf("Unknown shutdown signal received. Restarting by default.\n"); ESP_LOGW(TAG, "No restart signal received, waiting for manual power cycle.\n");
fflush(stdout); while (true) {
vTaskDelay(portMAX_DELAY);
}
} }
} else if (bits & SYSTEM_RESTART_BIT) {
return esp_restart(); // if (restart_display_handler != nullptr) {
} // ESP_LOGI(TAG, "Calling display restart handler...\n");
catch (const std::exception& e) { // restart_display_handler();
printf("Exception occurred during initialization: %s\n", e.what()); // } else {
printf("System will restart due to the error.\n"); // ESP_LOGI(TAG, "No display restart handler to call.\n");
for (int i = 5; i >= 0; --i) { // }
printf("Restarting in %d seconds...\n", i); ESP_LOGI(TAG, "System is restarting.\n");
vTaskDelay(1000 / portTICK_PERIOD_MS); fflush(stdout);
} } else {
printf("Restarting now.\n"); ESP_LOGW(TAG, "Unknown shutdown signal received. Restarting by default.\n");
fflush(stdout); fflush(stdout);
return esp_restart();
} }
printf("Reached end of app_main unexpectedly.\n");
printf("System will restart in 10 seconds...\n");
for (int i = 10; i >= 0; --i) {
printf("Restarting in %d seconds...\n", i);
vTaskDelay(1000 / portTICK_PERIOD_MS);
}
printf("Restarting now.\n");
fflush(stdout);
return esp_restart(); return esp_restart();
} }

View File

@@ -0,0 +1,7 @@
list(APPEND SRCS
"${CMAKE_CURRENT_LIST_DIR}/http_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/wifi_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/web_server_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/udp_client.cpp"
"${CMAKE_CURRENT_LIST_DIR}/network.cpp"
)

View File

@@ -2,16 +2,46 @@
#include "esp_http_client.h" #include "esp_http_client.h"
#include "esp_log.h" #include "esp_log.h"
#include "string.h" #include "string.h"
#include <cstring>
esp_err_t http_event_handler(esp_http_client_event_t *evt) {
HttpHandler* handler = static_cast<HttpHandler*>(evt->user_data);
switch (evt->event_id) {
case HTTP_EVENT_ON_DATA:
if (handler && evt->data_len > 0) {
char* new_buffer = new char[handler->response_size + evt->data_len + 1];
if (handler->response_buffer && handler->response_size > 0) {
memcpy(new_buffer, handler->response_buffer, handler->response_size);
delete[] handler->response_buffer;
}
memcpy(new_buffer + handler->response_size, evt->data, evt->data_len);
handler->response_size += evt->data_len;
new_buffer[handler->response_size] = '\0';
handler->response_buffer = new_buffer;
}
break;
default:
break;
}
return ESP_OK;
}
HttpHandler::HttpHandler(const esp_http_client_config_t&& config, WifiHandler* wifiHandler) HttpHandler::HttpHandler(const esp_http_client_config_t&& config, WifiHandler* wifiHandler)
: wifiHandler(wifiHandler) { : wifiHandler(wifiHandler), response_buffer(nullptr), response_size(0) {
this->client = esp_http_client_init(&config); esp_http_client_config_t modified_config = config;
modified_config.event_handler = http_event_handler;
modified_config.user_data = this;
this->client = esp_http_client_init(&modified_config);
} }
HttpHandler::~HttpHandler() { HttpHandler::~HttpHandler() {
if (this->client) { if (this->client) {
esp_http_client_cleanup(this->client); esp_http_client_cleanup(this->client);
} }
if (response_buffer) {
delete[] response_buffer;
}
} }
esp_err_t HttpHandler::set_method(esp_http_client_method_t method) { esp_err_t HttpHandler::set_method(esp_http_client_method_t method) {
@@ -34,18 +64,13 @@ void HttpHandler::get_body(
char*& buffer, char*& buffer,
int& total_len int& total_len
) { ) {
total_len = esp_http_client_get_content_length(this->client); total_len = response_size;
buffer = new char[total_len + 1]; // +1 for null-terminator if (response_buffer && response_size > 0) {
if (buffer) { buffer = new char[response_size + 1];
int read_len = esp_http_client_read(this->client, buffer, total_len); memcpy(buffer, response_buffer, response_size);
if (read_len >= 0) { buffer[response_size] = '\0';
buffer[read_len] = '\0'; // null-terminate
} else {
delete[] buffer;
buffer = nullptr;
total_len = 0;
}
} else { } else {
buffer = nullptr;
total_len = 0; total_len = 0;
} }
} }

View File

@@ -41,6 +41,7 @@ public:
// only NetworkHandler can create HttpHandler instances // only NetworkHandler can create HttpHandler instances
friend class NetworkHandler; friend class NetworkHandler;
friend esp_err_t http_event_handler(esp_http_client_event_t *evt);
// disable copy constructor and assignment operator // disable copy constructor and assignment operator
HttpHandler(const HttpHandler&) = delete; HttpHandler(const HttpHandler&) = delete;
HttpHandler& operator=(const HttpHandler&) = delete; HttpHandler& operator=(const HttpHandler&) = delete;
@@ -52,4 +53,6 @@ private:
esp_http_client_handle_t client; esp_http_client_handle_t client;
// backreference to WifiHandler to ensure WiFi is connected, DO NOT DELETE // backreference to WifiHandler to ensure WiFi is connected, DO NOT DELETE
WifiHandler* wifiHandler; WifiHandler* wifiHandler;
char* response_buffer;
size_t response_size;
}; };

View File

@@ -4,7 +4,7 @@
#include "common/constants.h" #include "common/constants.h"
NetworkHandler::NetworkHandler( NetworkHandler::NetworkHandler(
WifiHandler&& wifiHandler std::unique_ptr<WifiHandler> wifiHandler
) : wifiHandler(std::move(wifiHandler)) { } ) : wifiHandler(std::move(wifiHandler)) { }
NetworkHandler::~NetworkHandler() { } NetworkHandler::~NetworkHandler() { }
@@ -14,7 +14,7 @@ void NetworkHandler::init(EventGroupHandle_t system_event_group) {
ESP_LOGW("NetworkHandler", "Already initialized, skipping"); ESP_LOGW("NetworkHandler", "Already initialized, skipping");
return; return;
} }
this->wifiHandler.init(); this->wifiHandler->init();
this->initialized = true; this->initialized = true;
xEventGroupSetBits( xEventGroupSetBits(
system_event_group, system_event_group,
@@ -23,10 +23,10 @@ void NetworkHandler::init(EventGroupHandle_t system_event_group) {
} }
WifiHandler& NetworkHandler::get_wifi_handler() { WifiHandler& NetworkHandler::get_wifi_handler() {
return this->wifiHandler; return *this->wifiHandler;
} }
std::unique_ptr<HttpHandler> NetworkHandler::get_http_handler(const esp_http_client_config_t&& config) { std::unique_ptr<HttpHandler> NetworkHandler::get_http_handler(const esp_http_client_config_t&& config) {
return std::unique_ptr<HttpHandler>(new HttpHandler(std::move(config), &this->wifiHandler)); return std::unique_ptr<HttpHandler>(new HttpHandler(std::move(config), this->wifiHandler.get()));
} }

View File

@@ -11,7 +11,7 @@ class HttpHandler;
class NetworkHandler { class NetworkHandler {
public: public:
NetworkHandler( NetworkHandler(
WifiHandler&& wifiHandler std::unique_ptr<WifiHandler> wifiHandler
); );
~NetworkHandler(); ~NetworkHandler();
@@ -22,6 +22,6 @@ public:
private: private:
WifiHandler wifiHandler; std::unique_ptr<WifiHandler> wifiHandler;
bool initialized = false; bool initialized = false;
}; };

189
main/network/udp_client.cpp Normal file
View File

@@ -0,0 +1,189 @@
#include "udp_client.h"
#include <cstring>
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
#include "esp_log.h"
static const char* TAG = "UDPClient";
UDPClient::UDPClient()
: sock_fd_(-1)
, remote_port_(0)
, configured_(false)
, initialized_(false) {
memset(&remote_addr_, 0, sizeof(remote_addr_));
}
UDPClient::~UDPClient() {
close();
}
esp_err_t UDPClient::init(uint16_t local_port) {
if (initialized_) {
ESP_LOGW(TAG, "Already initialized");
return ESP_OK;
}
sock_fd_ = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
if (sock_fd_ < 0) {
ESP_LOGE(TAG, "Failed to create socket: errno %d", errno);
return ESP_FAIL;
}
// Bind to local port if specified
if (local_port > 0) {
struct sockaddr_in local_addr;
memset(&local_addr, 0, sizeof(local_addr));
local_addr.sin_family = AF_INET;
local_addr.sin_addr.s_addr = htonl(INADDR_ANY);
local_addr.sin_port = htons(local_port);
if (bind(sock_fd_, (struct sockaddr*)&local_addr, sizeof(local_addr)) < 0) {
ESP_LOGE(TAG, "Failed to bind to port %u: errno %d", local_port, errno);
::close(sock_fd_);
sock_fd_ = -1;
return ESP_FAIL;
}
ESP_LOGI(TAG, "Bound to local port %u", local_port);
}
// Set socket to non-blocking mode
esp_err_t err = set_nonblocking();
if (err != ESP_OK) {
::close(sock_fd_);
sock_fd_ = -1;
return err;
}
initialized_ = true;
ESP_LOGI(TAG, "UDP client initialized (fd=%d)", sock_fd_);
return ESP_OK;
}
esp_err_t UDPClient::set_nonblocking() {
int flags = fcntl(sock_fd_, F_GETFL, 0);
if (flags < 0) {
ESP_LOGE(TAG, "Failed to get socket flags: errno %d", errno);
return ESP_FAIL;
}
if (fcntl(sock_fd_, F_SETFL, flags | O_NONBLOCK) < 0) {
ESP_LOGE(TAG, "Failed to set non-blocking mode: errno %d", errno);
return ESP_FAIL;
}
return ESP_OK;
}
esp_err_t UDPClient::configure(const std::string& ip, uint16_t port) {
if (ip.empty() || port == 0) {
ESP_LOGE(TAG, "Invalid IP or port");
return ESP_ERR_INVALID_ARG;
}
struct in_addr addr;
if (inet_pton(AF_INET, ip.c_str(), &addr) != 1) {
ESP_LOGE(TAG, "Invalid IP address format: %s", ip.c_str());
return ESP_ERR_INVALID_ARG;
}
remote_addr_.sin_family = AF_INET;
remote_addr_.sin_port = htons(port);
remote_addr_.sin_addr = addr;
remote_ip_ = ip;
remote_port_ = port;
configured_ = true;
ESP_LOGI(TAG, "Configured endpoint: %s:%u", ip.c_str(), port);
return ESP_OK;
}
esp_err_t UDPClient::send_command(const std::string& command) {
if (!initialized_) {
ESP_LOGE(TAG, "Not initialized");
return ESP_FAIL;
}
if (!configured_) {
ESP_LOGE(TAG, "Endpoint not configured");
return ESP_FAIL;
}
ssize_t sent = sendto(sock_fd_, command.c_str(), command.length(), 0,
(struct sockaddr*)&remote_addr_, sizeof(remote_addr_));
if (sent < 0) {
ESP_LOGE(TAG, "Failed to send command '%s': errno %d", command.c_str(), errno);
return ESP_FAIL;
}
ESP_LOGD(TAG, "Sent command: %s (%d bytes)", command.c_str(), (int)sent);
return ESP_OK;
}
esp_err_t UDPClient::receive_response(std::string& response, int timeout_ms) {
if (!initialized_) {
ESP_LOGE(TAG, "Not initialized");
return ESP_FAIL;
}
// Setup select() for timeout
fd_set read_fds;
FD_ZERO(&read_fds);
FD_SET(sock_fd_, &read_fds);
struct timeval timeout;
struct timeval* timeout_ptr = nullptr;
if (timeout_ms >= 0) {
timeout.tv_sec = timeout_ms / 1000;
timeout.tv_usec = (timeout_ms % 1000) * 1000;
timeout_ptr = &timeout;
}
int ret = select(sock_fd_ + 1, &read_fds, nullptr, nullptr, timeout_ptr);
if (ret < 0) {
ESP_LOGE(TAG, "select() failed: errno %d", errno);
return ESP_FAIL;
}
if (ret == 0) {
ESP_LOGD(TAG, "Receive timeout (%d ms)", timeout_ms);
return ESP_ERR_TIMEOUT;
}
// Data is available
char buffer[512];
struct sockaddr_in from_addr;
socklen_t from_len = sizeof(from_addr);
ssize_t received = recvfrom(sock_fd_, buffer, sizeof(buffer) - 1, 0,
(struct sockaddr*)&from_addr, &from_len);
if (received < 0) {
ESP_LOGE(TAG, "recvfrom() failed: errno %d", errno);
return ESP_FAIL;
}
buffer[received] = '\0';
response = std::string(buffer, received);
ESP_LOGD(TAG, "Received response: %s (%d bytes)", response.c_str(), (int)received);
return ESP_OK;
}
void UDPClient::close() {
if (sock_fd_ >= 0) {
::close(sock_fd_);
ESP_LOGI(TAG, "Socket closed");
sock_fd_ = -1;
}
initialized_ = false;
configured_ = false;
remote_ip_.clear();
remote_port_ = 0;
}

84
main/network/udp_client.h Normal file
View File

@@ -0,0 +1,84 @@
#pragma once
#include <string>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include "esp_err.h"
/**
* @brief UDP client for sending commands and receiving responses
*
* Implements non-blocking UDP communication with configurable timeouts.
* Socket remains open for the lifetime of the instance.
*/
class UDPClient {
public:
UDPClient();
~UDPClient();
/**
* @brief Initialize UDP socket
* @param local_port Local port to bind to (0 = system assigns port)
* @return ESP_OK on success, error code otherwise
*/
esp_err_t init(uint16_t local_port = 0);
/**
* @brief Configure remote endpoint
* @param ip Remote IP address (e.g., "192.168.50.201")
* @param port Remote port number (e.g., 4211)
* @return ESP_OK on success, ESP_ERR_INVALID_ARG if IP is invalid
*/
esp_err_t configure(const std::string& ip, uint16_t port);
/**
* @brief Send command to remote endpoint
* @param command Command string to send (e.g., "TOGGLE", "STATUS", "MUTE", "UNMUTE")
* @return ESP_OK on success, ESP_FAIL if not configured or send failed
*/
esp_err_t send_command(const std::string& command);
/**
* @brief Receive response from remote endpoint (non-blocking)
* @param response Output string for received data
* @param timeout_ms Timeout in milliseconds (0 = no wait, -1 = wait forever)
* @return ESP_OK on success, ESP_ERR_TIMEOUT on timeout, ESP_FAIL on error
*/
esp_err_t receive_response(std::string& response, int timeout_ms = 1000);
/**
* @brief Check if client is configured with valid endpoint
* @return true if IP and port are configured
*/
bool is_configured() const { return configured_; }
/**
* @brief Get current remote IP
*/
std::string get_ip() const { return remote_ip_; }
/**
* @brief Get current remote port
*/
uint16_t get_port() const { return remote_port_; }
/**
* @brief Close socket and reset configuration
*/
void close();
private:
int sock_fd_; // Socket file descriptor
struct sockaddr_in remote_addr_; // Remote endpoint address
std::string remote_ip_; // Remote IP address
uint16_t remote_port_; // Remote port number
bool configured_; // Whether endpoint is configured
bool initialized_; // Whether socket is initialized
/**
* @brief Set socket to non-blocking mode
* @return ESP_OK on success
*/
esp_err_t set_nonblocking();
};

View File

@@ -0,0 +1,113 @@
#include "web_server_handler.h"
#include "esp_log.h"
#include <cstring>
#include <sys/socket.h>
#include <netinet/in.h>
#include <unistd.h>
static const char* TAG = "WebServerHandler";
WebServerHandler::WebServerHandler() { }
WebServerHandler::~WebServerHandler() {
stop();
}
uint16_t WebServerHandler::start(const std::string& auth_key, uint16_t base_port) {
if (server_ != nullptr) {
ESP_LOGW(TAG, "Server already running on port %d", current_port_);
return current_port_;
}
auth_key_ = auth_key;
// Try to find a free port
uint16_t port = base_port;
const uint16_t max_attempts = 100;
for (uint16_t attempt = 0; attempt < max_attempts; attempt++) {
httpd_config_t config = HTTPD_DEFAULT_CONFIG();
config.server_port = port;
config.ctrl_port = port + 1000; // Control port
config.max_open_sockets = 7;
config.lru_purge_enable = true;
esp_err_t err = httpd_start(&server_, &config);
if (err == ESP_OK) {
current_port_ = port;
ESP_LOGI(TAG, "Web server started successfully on port %d", current_port_);
return current_port_;
} else if (err == ESP_ERR_HTTPD_ALLOC_MEM) {
ESP_LOGE(TAG, "Failed to allocate memory for web server");
return 0;
} else {
// Port likely in use, try next port
ESP_LOGD(TAG, "Port %d in use, trying next port", port);
port++;
}
}
ESP_LOGE(TAG, "Failed to find free port after %d attempts", max_attempts);
return 0;
}
esp_err_t WebServerHandler::stop() {
if (server_ == nullptr) {
return ESP_OK;
}
esp_err_t err = httpd_stop(server_);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to stop web server: %s", esp_err_to_name(err));
return err;
}
server_ = nullptr;
current_port_ = 0;
auth_key_.clear();
ESP_LOGI(TAG, "Web server stopped");
return ESP_OK;
}
esp_err_t WebServerHandler::register_uri_handler(const httpd_uri_t* uri_handler) {
if (server_ == nullptr) {
ESP_LOGE(TAG, "Server not running, cannot register URI handler");
return ESP_ERR_INVALID_STATE;
}
esp_err_t err = httpd_register_uri_handler(server_, uri_handler);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to register URI handler: %s", esp_err_to_name(err));
return err;
}
return ESP_OK;
}
bool WebServerHandler::validate_auth(const char* query_string) const {
if (!query_string || auth_key_.empty()) {
return false;
}
// Look for "auth=<key>" in query string
const char* auth_param = strstr(query_string, "auth=");
if (!auth_param) {
return false;
}
// Skip "auth="
auth_param += 5;
// Find end of auth value (& or end of string)
const char* end = strchr(auth_param, '&');
size_t auth_len = end ? (size_t)(end - auth_param) : strlen(auth_param);
// Compare with stored auth key
if (auth_len != auth_key_.length()) {
return false;
}
return strncmp(auth_param, auth_key_.c_str(), auth_len) == 0;
}

View File

@@ -0,0 +1,42 @@
#pragma once
#include "esp_http_server.h"
#include "esp_err.h"
#include <string>
#include <functional>
class WebServerHandler {
public:
WebServerHandler();
~WebServerHandler();
// Start web server, finds a free port starting from base_port
// Returns the actual port used, or 0 on failure
uint16_t start(const std::string& auth_key, uint16_t base_port = 8080);
// Stop web server
esp_err_t stop();
// Check if server is running
bool is_running() const { return server_ != nullptr; }
// Get the current port
uint16_t get_port() const { return current_port_; }
// Get the auth key
std::string get_auth_key() const { return auth_key_; }
// Register a URI handler
esp_err_t register_uri_handler(const httpd_uri_t* uri_handler);
// Validate auth key from query string
bool validate_auth(const char* query_string) const;
private:
// Prevent copying
WebServerHandler(const WebServerHandler&) = delete;
WebServerHandler& operator=(const WebServerHandler&) = delete;
httpd_handle_t server_ = nullptr;
uint16_t current_port_ = 0;
std::string auth_key_;
};

View File

@@ -1,42 +1,58 @@
#include "wifi_handler.h" #include "wifi_handler.h"
#include "esp_wifi.h" #include "esp_wifi.h"
#include "esp_event.h" #include "esp_event.h"
#include "esp_netif.h"
#include "freertos/event_groups.h" #include "freertos/event_groups.h"
#include "esp_log.h" #include "esp_log.h"
#include "freertos/semphr.h" #include "freertos/semphr.h"
#include "common/semaphore_guard.h" #include "common/semaphore_guard.h"
#include "cJSON.h"
static const char* TAG = "WifiHandler"; #define TAG "WifiHandler"
static const char* WIFI_SSID_KEY = "wifi_ssid"; #define WIFI_CRED_FILE_PATH "wifi_credentials.json"
static const char* WIFI_PASSWORD_KEY = "wifi_password";
/*
* WiFi Credentials JSON Structure:
* {
* "current_ssid": "MyWiFi",
* "credentials": {
* "MyWiFi": {
* "password": "mypassword123"
* },
* "OtherNetwork": {
* "password": "otherpass456"
* }
* }
* }
*/
WifiHandler::WifiHandler( WifiHandler::WifiHandler(
// this handler is used to store/retrieve WiFi credentials std::shared_ptr<LittleFSHandler> fs_handler_
// should have a unique namespace for WiFi credentials ) : fs_handler_(std::move(fs_handler_)) {
// it will be owned by WifiHandler and deleted in its destructor
KVStorageHandler* kvs
) : kvs(kvs) {
this->s_wifi_event_group = xEventGroupCreate(); this->s_wifi_event_group = xEventGroupCreate();
if (!this->s_wifi_event_group) {
ESP_LOGE(TAG, "Failed to create WiFi event group");
}
this->scan_mutex = xSemaphoreCreateMutex(); this->scan_mutex = xSemaphoreCreateMutex();
if (!this->scan_mutex) {
ESP_LOGE(TAG, "Failed to create scan mutex");
}
this->connection_mutex = xSemaphoreCreateMutex(); this->connection_mutex = xSemaphoreCreateMutex();
} if (!this->connection_mutex) {
ESP_LOGE(TAG, "Failed to create connection mutex");
// Move constructor: transfer ownership of resources }
WifiHandler::WifiHandler(WifiHandler&& other) noexcept this->credential_mutex = xSemaphoreCreateMutex();
: initialized(other.initialized), if (!this->credential_mutex) {
kvs(other.kvs), ESP_LOGE(TAG, "Failed to create credential mutex");
s_wifi_event_group(other.s_wifi_event_group), }
scan_mutex(other.scan_mutex), if (this->fs_handler_ == nullptr) {
connection_mutex(other.connection_mutex), ESP_LOGW(TAG, "FSHandler is null, WiFi credentials will not be stored");
current_ssid(other.current_ssid), } else {
expect_disconnected(other.expect_disconnected) { esp_err_t err = this->fs_handler_->init("/littlefs");
other.kvs = nullptr; if (err != ESP_OK) {
other.initialized = false; ESP_LOGE(TAG, "Failed to initialize FSHandler: %s", esp_err_to_name(err));
other.s_wifi_event_group = 0; }
other.scan_mutex = nullptr; }
other.connection_mutex = nullptr;
other.current_ssid = nullptr;
other.expect_disconnected = false;
} }
WifiHandler::~WifiHandler() { WifiHandler::~WifiHandler() {
@@ -45,29 +61,95 @@ WifiHandler::~WifiHandler() {
// Check if it should be called // Check if it should be called
esp_wifi_deinit(); esp_wifi_deinit();
vEventGroupDelete(this->s_wifi_event_group); vEventGroupDelete(this->s_wifi_event_group);
if (this->current_ssid) { if (!this->current_ssid.empty()) {
delete[] this->current_ssid; this->current_ssid.clear();
} }
vSemaphoreDelete(this->scan_mutex); vSemaphoreDelete(this->scan_mutex);
vSemaphoreDelete(this->connection_mutex); vSemaphoreDelete(this->connection_mutex);
esp_event_handler_unregister(WIFI_EVENT, ESP_EVENT_ANY_ID, &WifiHandler::wifi_event_handler);
esp_event_handler_unregister(IP_EVENT, IP_EVENT_STA_GOT_IP, &WifiHandler::wifi_event_handler);
this->initialized = false;
//
this->fs_handler_ = nullptr;
} }
} }
void WifiHandler::init() { esp_err_t WifiHandler::init() {
if (this->initialized) { if (this->initialized) {
ESP_LOGW(TAG, "Already initialized, skipping"); ESP_LOGW(TAG, "Already initialized, skipping");
return; return ESP_OK;
}
esp_err_t err;
// initialize TCP/IP stack and default event loop
err = esp_netif_init();
if (err != ESP_OK) {
ESP_LOGE(TAG, "esp_netif_init failed: %s", esp_err_to_name(err));
return err;
} }
err = esp_event_loop_create_default();
if (err != ESP_OK && err != ESP_ERR_INVALID_STATE) {
ESP_LOGE(TAG, "esp_event_loop_create_default failed: %s", esp_err_to_name(err));
return err;
}
// create default WiFi station
esp_netif_create_default_wifi_sta();
// init WiFi driver
wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
err = esp_wifi_init(&cfg);
if (err != ESP_OK) {
ESP_LOGE(TAG, "esp_wifi_init failed: %s", esp_err_to_name(err));
return err;
}
// register event handlers for WiFi and IP events
err = esp_event_handler_register(WIFI_EVENT, ESP_EVENT_ANY_ID, &WifiHandler::wifi_event_handler, this);
if (err != ESP_OK) {
ESP_LOGE(TAG, "esp_event_handler_register failed: %s", esp_err_to_name(err));
return err;
}
err = esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &WifiHandler::wifi_event_handler, this);
if (err != ESP_OK) {
ESP_LOGE(TAG, "esp_event_handler_register failed: %s", esp_err_to_name(err));
return err;
}
err = esp_wifi_set_mode(WIFI_MODE_STA);
if (err != ESP_OK) {
ESP_LOGE(TAG, "esp_wifi_set_mode failed: %s", esp_err_to_name(err));
return err;
}
err = esp_wifi_start();
if (err != ESP_OK) {
ESP_LOGE(TAG, "esp_wifi_start failed: %s", esp_err_to_name(err));
return err;
}
// get WiFi credentials from KV storage if available // get WiFi credentials from KV storage if available
char* ssid = nullptr; std::string ssid;
char* password = nullptr; std::string password;
this->get_wifi_credentials(ssid, password); this->get_wifi_credentials(ssid, password);
if (ssid && password) { // If KV storage didn't provide credentials, allow build-time injected values
ESP_LOGI(TAG, "Found stored WiFi credentials, connecting to SSID: %s", ssid); // via compile-time defines BUILD_WIFI_SSID and BUILD_WIFI_PASSWORD.
esp_err_t err = this->connect(ssid, password); #if defined(BUILD_WIFI_SSID) and defined(BUILD_WIFI_PASSWORD)
if (ssid.empty()) {
ssid = std::string(BUILD_WIFI_SSID);
ESP_LOGI(TAG, "Using build-time injected WiFi SSID");
}
if (password.empty()) {
password = std::string(BUILD_WIFI_PASSWORD);
ESP_LOGI(TAG, "Using build-time injected WiFi password");
}
#endif
if (!ssid.empty() && !password.empty()) {
ESP_LOGI(TAG, "Found stored WiFi credentials, connecting to SSID: %s", ssid.c_str());
err = this->connect(ssid, password);
if (err != ESP_OK) { if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to connect to stored WiFi credentials: %s", esp_err_to_name(err)); ESP_LOGE(TAG, "Failed to connect to stored WiFi credentials: %s", esp_err_to_name(err));
} }
@@ -75,15 +157,11 @@ void WifiHandler::init() {
ESP_LOGI(TAG, "No stored WiFi credentials found, not connecting"); ESP_LOGI(TAG, "No stored WiFi credentials found, not connecting");
} }
delete[] ssid;
delete[] password;
// TODO: setup WiFi event handlers
// TODO: add auto-reconnect logic
//
initialized = true; initialized = true;
return ESP_OK;
} }
esp_err_t WifiHandler::connect(const char* ssid, const char* password) { esp_err_t WifiHandler::connect(const std::string& ssid, const std::string& password) {
SemaphoreGuard guard(this->connection_mutex); SemaphoreGuard guard(this->connection_mutex);
// wait up to 5 seconds to take the mutex // wait up to 5 seconds to take the mutex
if (!guard.take(5000 / portTICK_PERIOD_MS)) { if (!guard.take(5000 / portTICK_PERIOD_MS)) {
@@ -92,24 +170,22 @@ esp_err_t WifiHandler::connect(const char* ssid, const char* password) {
} }
expect_disconnected = false; expect_disconnected = false;
if (this->current_ssid) { if (!this->current_ssid.empty()) {
delete[] this->current_ssid; this->current_ssid.clear();
} }
size_t ssid_len = strlen(ssid); this->current_ssid = ssid;
this->current_ssid = new char[ssid_len + 1]; this->current_password = password;
strncpy(this->current_ssid, ssid, ssid_len + 1);
this->current_ssid[ssid_len] = '\0';
// //
wifi_config_t wifi_config = {}; wifi_config_t wifi_config = {};
strncpy((char*)wifi_config.sta.ssid, this->current_ssid, sizeof(wifi_config.sta.ssid)); strncpy((char*)wifi_config.sta.ssid, this->current_ssid.c_str(), sizeof(wifi_config.sta.ssid));
wifi_config.sta.ssid[sizeof(wifi_config.sta.ssid) - 1] = '\0'; wifi_config.sta.ssid[sizeof(wifi_config.sta.ssid) - 1] = '\0';
strncpy((char*)wifi_config.sta.password, password, sizeof(wifi_config.sta.password)); strncpy((char*)wifi_config.sta.password, password.c_str(), sizeof(wifi_config.sta.password));
wifi_config.sta.password[sizeof(wifi_config.sta.password) - 1] = '\0'; wifi_config.sta.password[sizeof(wifi_config.sta.password) - 1] = '\0';
// set auth mode to WPA2_PSK minimum // set auth mode to WPA2_PSK minimum
wifi_config.sta.threshold.authmode = WIFI_AUTH_WPA2_PSK; wifi_config.sta.threshold.authmode = WIFI_AUTH_WPA2_PSK;
ESP_LOGI(TAG, "Connecting to SSID: %s", this->current_ssid); ESP_LOGI(TAG, "Connecting to SSID: %s", this->current_ssid.c_str());
esp_err_t err = esp_wifi_set_config(wifi_interface_t::WIFI_IF_STA, &wifi_config); esp_err_t err = esp_wifi_set_config(wifi_interface_t::WIFI_IF_STA, &wifi_config);
if (err != ESP_OK) { if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to set WiFi config: %s", esp_err_to_name(err)); ESP_LOGE(TAG, "Failed to set WiFi config: %s", esp_err_to_name(err));
@@ -121,40 +197,26 @@ esp_err_t WifiHandler::connect(const char* ssid, const char* password) {
return err; return err;
} }
// store credentials // Note: Credentials will be stored in the event handler after successful connection
this->kvs->put(WIFI_SSID_KEY, this->current_ssid); // to avoid storing credentials for failed connection attempts
// store password under key derived from SSID
char* password_key = this->build_password_key(this->current_ssid);
this->kvs->put(password_key, password);
delete[] password_key;
// set connected bit on successful connection
xEventGroupSetBits(
this->s_wifi_event_group,
WIFI_CONNECTED_BIT
);
return ESP_OK; return ESP_OK;
} }
esp_err_t WifiHandler::connect(const char* ssid) { esp_err_t WifiHandler::connect(const std::string& ssid) {
char* stored_ssid = nullptr; std::string stored_ssid;
char* stored_password = nullptr; std::string stored_password;
this->get_wifi_credentials(stored_ssid, stored_password); this->get_wifi_credentials(stored_ssid, stored_password);
if (!stored_ssid || strcmp(stored_ssid, ssid) != 0) { if (stored_ssid.empty() || stored_ssid != ssid) {
ESP_LOGE(TAG, "No stored credentials for SSID: %s", ssid); ESP_LOGE(TAG, "No stored credentials for SSID: %s", ssid.c_str());
delete[] stored_ssid;
delete[] stored_password;
return ESP_FAIL; return ESP_FAIL;
} }
esp_err_t err = this->connect(stored_ssid, stored_password ? stored_password : ""); esp_err_t err = this->connect(stored_ssid, stored_password);
delete[] stored_ssid;
delete[] stored_password;
return err; return err;
} }
esp_err_t WifiHandler::reconnect() { esp_err_t WifiHandler::reconnect() {
if (!this->current_ssid) { if (this->current_ssid.empty()) {
ESP_LOGE(TAG, "No current SSID set, cannot reconnect"); ESP_LOGE(TAG, "No current SSID set, cannot reconnect");
return ESP_FAIL; return ESP_FAIL;
} }
@@ -229,10 +291,15 @@ void WifiHandler::wifi_event_handler(void* arg, esp_event_base_t event_base, int
case WIFI_EVENT_STA_START: case WIFI_EVENT_STA_START:
// When the station starts, attempt to connect // When the station starts, attempt to connect
ESP_LOGI(TAG, "WIFI_EVENT_STA_START"); ESP_LOGI(TAG, "WIFI_EVENT_STA_START");
if (!self->expect_disconnected && self->current_ssid) { if (!self->expect_disconnected && !self->current_ssid.empty()) {
ESP_LOGI(TAG, "Station started, attempting to connect to SSID: %s", self->current_ssid); ESP_LOGI(TAG, "Station started, attempting to connect to SSID: %s", self->current_ssid.c_str());
self->reconnect(); self->reconnect();
} }
// set the event bit to indicate started
xEventGroupSetBits(
self->s_wifi_event_group,
WIFI_STARTED_BIT
);
break; break;
case WIFI_EVENT_STA_DISCONNECTED: case WIFI_EVENT_STA_DISCONNECTED:
ESP_LOGI(TAG, "WIFI_EVENT_STA_DISCONNECTED"); ESP_LOGI(TAG, "WIFI_EVENT_STA_DISCONNECTED");
@@ -253,6 +320,10 @@ void WifiHandler::wifi_event_handler(void* arg, esp_event_base_t event_base, int
self->s_wifi_event_group, self->s_wifi_event_group,
WIFI_CONNECTED_BIT WIFI_CONNECTED_BIT
); );
// Store credentials only after successful connection
if (!self->current_ssid.empty() && !self->current_password.empty()) {
self->store_wifi_credentials(self->current_ssid, self->current_password);
}
break; break;
} }
default: default:
@@ -265,29 +336,198 @@ void WifiHandler::wifi_event_handler(void* arg, esp_event_base_t event_base, int
// private methods // private methods
// //
char* WifiHandler::build_password_key(const char* ssid) { void WifiHandler::store_wifi_credentials(const std::string& ssid, const std::string& password) {
// `{WIFI_PASSWORD_KEY}_{ssid}` if (!fs_handler_) {
size_t password_key_len = strlen(WIFI_PASSWORD_KEY) + 1 + strlen(ssid) + 1; ESP_LOGW(TAG, "FSHandler not set, cannot store WiFi credentials");
char* password_key_buff = new char[password_key_len]; return;
snprintf(password_key_buff, password_key_len, "%s_%s", WIFI_PASSWORD_KEY, ssid); }
return password_key_buff; SemaphoreGuard guard(this->credential_mutex);
// wait up to 5 seconds to take the mutex
if (!guard.take(5000 / portTICK_PERIOD_MS)) {
ESP_LOGE(TAG, "Failed to take credential mutex");
return;
}
cJSON* json = nullptr;
// Try to read existing credentials file
if (fs_handler_->file_exists(WIFI_CRED_FILE_PATH)) {
// Read existing file
size_t file_size = 0;
esp_err_t err = fs_handler_->get_file_size(WIFI_CRED_FILE_PATH, file_size);
if (err == ESP_OK && file_size > 0) {
std::vector<uint8_t> file_data(file_size + 1); // +1 for null terminator
size_t bytes_read = 0;
err = fs_handler_->read_file(WIFI_CRED_FILE_PATH, file_size, file_data.data(), bytes_read);
if (err == ESP_OK) {
file_data[bytes_read] = '\0'; // Null terminate
json = cJSON_Parse(reinterpret_cast<const char*>(file_data.data()));
if (json == nullptr) {
ESP_LOGE(TAG, "Failed to parse existing WiFi credentials JSON, creating new");
}
}
}
}
// Create new JSON if parsing failed or file doesn't exist
if (json == nullptr) {
json = cJSON_CreateObject();
}
// Set current SSID
cJSON* current_ssid_item = cJSON_GetObjectItem(json, "current_ssid");
if (current_ssid_item != nullptr) {
cJSON_SetValuestring(current_ssid_item, ssid.c_str());
} else {
cJSON_AddStringToObject(json, "current_ssid", ssid.c_str());
}
// Get or create credentials object
cJSON* credentials = cJSON_GetObjectItem(json, "credentials");
if (credentials == nullptr || !cJSON_IsObject(credentials)) {
credentials = cJSON_CreateObject();
cJSON_AddItemToObject(json, "credentials", credentials);
}
// Limit stored credentials to prevent excessive file size (keep max 10 SSIDs)
int credential_count = cJSON_GetArraySize(credentials);
if (credential_count >= 10) {
ESP_LOGW(TAG, "Too many stored credentials (%d), keeping only current SSID", credential_count);
// Keep only the current SSID's credentials
cJSON* new_credentials = cJSON_CreateObject();
cJSON_ReplaceItemInObject(json, "credentials", new_credentials);
credentials = new_credentials;
}
// Remove existing entry for this SSID to update it
cJSON_DeleteItemFromObject(credentials, ssid.c_str());
// Create SSID object with password
cJSON* ssid_item = cJSON_CreateObject();
cJSON_AddStringToObject(ssid_item, "password", password.c_str());
cJSON_AddItemToObject(credentials, ssid.c_str(), ssid_item);
// Serialize and write to file
char* json_str = cJSON_PrintUnformatted(json);
if (json_str) {
size_t bytes_written = 0;
esp_err_t err = fs_handler_->write_file(
WIFI_CRED_FILE_PATH,
reinterpret_cast<const uint8_t*>(json_str),
strlen(json_str),
bytes_written
);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to write WiFi credentials to file: %s", esp_err_to_name(err));
} else {
ESP_LOGI(TAG, "Stored WiFi credentials for SSID: %s", ssid.c_str());
}
cJSON_free(json_str);
} else {
ESP_LOGE(TAG, "Failed to serialize WiFi credentials JSON");
}
cJSON_Delete(json);
} }
void WifiHandler::get_wifi_credentials(char*& ssid, char*& password) { void WifiHandler::get_wifi_credentials(std::string& out_ssid, std::string& out_password) {
if (!kvs) { if (!fs_handler_) {
ESP_LOGW(TAG, "KVStorageHandler not set, cannot get WiFi credentials"); ESP_LOGW(TAG, "FSHandler not set, cannot get WiFi credentials");
out_ssid = "";
out_password = "";
return; return;
} }
ssid = kvs->get(WIFI_SSID_KEY).get();
if (!ssid) { SemaphoreGuard guard(this->credential_mutex);
ssid = nullptr; // wait up to 5 seconds to take the mutex
password = nullptr; if (!guard.take(5000 / portTICK_PERIOD_MS)) {
ESP_LOGE(TAG, "Failed to take credential mutex");
out_ssid = "";
out_password = "";
return; return;
} }
// password is from KV storage, may be nullptr
char* password_key = this->build_password_key(ssid); // Check if credentials file exists
password = kvs->get(password_key).get(); if (!fs_handler_->file_exists(WIFI_CRED_FILE_PATH)) {
delete[] password_key; ESP_LOGD(TAG, "WiFi credentials file does not exist");
out_ssid = "";
out_password = "";
return;
}
// Read credentials file
size_t file_size = 0;
esp_err_t err = fs_handler_->get_file_size(WIFI_CRED_FILE_PATH, file_size);
if (err != ESP_OK || file_size == 0) {
ESP_LOGE(TAG, "Failed to get WiFi credentials file size");
out_ssid = "";
out_password = "";
return;
}
std::vector<uint8_t> file_data(file_size + 1); // +1 for null terminator
size_t bytes_read = 0;
err = fs_handler_->read_file(WIFI_CRED_FILE_PATH, file_size, file_data.data(), bytes_read);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to read WiFi credentials file: %s", esp_err_to_name(err));
out_ssid = "";
out_password = "";
return;
}
file_data[bytes_read] = '\0'; // Null terminate
// Parse JSON
cJSON* json = cJSON_Parse(reinterpret_cast<const char*>(file_data.data()));
if (json == nullptr) {
ESP_LOGE(TAG, "Failed to parse WiFi credentials JSON");
out_ssid = "";
out_password = "";
return;
}
// Get current SSID
cJSON* current_ssid_item = cJSON_GetObjectItem(json, "current_ssid");
if (current_ssid_item == nullptr || !cJSON_IsString(current_ssid_item)) {
ESP_LOGE(TAG, "WiFi credentials JSON does not contain valid 'current_ssid' field");
out_ssid = "";
out_password = "";
cJSON_Delete(json);
return;
}
out_ssid = current_ssid_item->valuestring;
// Get credentials object
cJSON* credentials = cJSON_GetObjectItem(json, "credentials");
if (credentials == nullptr || !cJSON_IsObject(credentials)) {
ESP_LOGE(TAG, "WiFi credentials JSON does not contain valid 'credentials' object");
out_ssid = "";
out_password = "";
cJSON_Delete(json);
return;
}
// Get SSID entry
cJSON* ssid_item = cJSON_GetObjectItem(credentials, out_ssid.c_str());
if (ssid_item == nullptr || !cJSON_IsObject(ssid_item)) {
ESP_LOGE(TAG, "WiFi credentials JSON does not contain entry for SSID: %s", out_ssid.c_str());
out_ssid = "";
out_password = "";
cJSON_Delete(json);
return;
}
// Get password
cJSON* password_item = cJSON_GetObjectItem(ssid_item, "password");
if (password_item == nullptr || !cJSON_IsString(password_item)) {
ESP_LOGE(TAG, "WiFi credentials JSON does not contain valid 'password' field for SSID: %s", out_ssid.c_str());
out_ssid = "";
out_password = "";
cJSON_Delete(json);
return;
}
out_password = password_item->valuestring;
cJSON_Delete(json);
ESP_LOGD(TAG, "Retrieved WiFi credentials for SSID: %s", out_ssid.c_str());
} }
EventBits_t WifiHandler::wait_for_connection(TickType_t ticks_to_wait) { EventBits_t WifiHandler::wait_for_connection(TickType_t ticks_to_wait) {
@@ -299,3 +539,23 @@ EventBits_t WifiHandler::wait_for_connection(TickType_t ticks_to_wait) {
ticks_to_wait ticks_to_wait
); );
} }
std::string WifiHandler::get_current_ip() const {
esp_netif_t* netif = esp_netif_get_handle_from_ifkey("WIFI_STA_DEF");
if (!netif) {
ESP_LOGW(TAG, "Failed to get netif handle");
return "";
}
esp_netif_ip_info_t ip_info;
esp_err_t err = esp_netif_get_ip_info(netif, &ip_info);
if (err != ESP_OK) {
ESP_LOGW(TAG, "Failed to get IP info: %s", esp_err_to_name(err));
return "";
}
// Convert IP address to string
char ip_str[16];
snprintf(ip_str, sizeof(ip_str), IPSTR, IP2STR(&ip_info.ip));
return std::string(ip_str);
}

View File

@@ -1,9 +1,12 @@
#pragma once #pragma once
#include "io/io.h" #include "freertos/FreeRTOS.h"
#include "io/fs_handler.h"
#include "esp_wifi.h" #include "esp_wifi.h"
#include "freertos/event_groups.h" #include "freertos/event_groups.h"
#define WIFI_CONNECTED_BIT (1 << 0) #define WIFI_STARTED_BIT (1 << 0)
#define WIFI_CONNECTED_BIT (1 << 1)
class WifiHandler { class WifiHandler {
public: public:
@@ -11,16 +14,13 @@ public:
// this handler is used to store/retrieve WiFi credentials // this handler is used to store/retrieve WiFi credentials
// should have a unique namespace for WiFi credentials // should have a unique namespace for WiFi credentials
// it will be owned by WifiHandler and deleted in its destructor // it will be owned by WifiHandler and deleted in its destructor
KVStorageHandler* kvs std::shared_ptr<LittleFSHandler> fs_handler_
); );
~WifiHandler(); ~WifiHandler();
// move semantics esp_err_t init();
WifiHandler(WifiHandler&& other) noexcept; esp_err_t connect(const std::string& ssid, const std::string& password);
esp_err_t connect(const std::string& ssid); // connect using stored password
void init();
esp_err_t connect(const char* ssid, const char* password);
esp_err_t connect(const char* ssid); // connect using stored password
esp_err_t reconnect(); // reconnect to current SSID esp_err_t reconnect(); // reconnect to current SSID
void disconnect(); void disconnect();
EventBits_t wait_for_connection(TickType_t ticks_to_wait); EventBits_t wait_for_connection(TickType_t ticks_to_wait);
@@ -31,23 +31,32 @@ public:
uint16_t& ap_count uint16_t& ap_count
); );
// Get current IP address (empty string if not connected)
std::string get_current_ip() const;
static void wifi_event_handler(void* arg, esp_event_base_t event_base, int32_t event_id, void* event_data); static void wifi_event_handler(void* arg, esp_event_base_t event_base, int32_t event_id, void* event_data);
private: private:
// prevent copying // prevent copying
WifiHandler(const WifiHandler&) = delete; WifiHandler(const WifiHandler&) = delete;
WifiHandler& operator=(const WifiHandler&) = delete; WifiHandler& operator=(const WifiHandler&) = delete;
// prevent moving
WifiHandler(WifiHandler&& other) = delete;
WifiHandler& operator=(WifiHandler&& other) = delete;
char* build_password_key(const char* ssid); void store_wifi_credentials(const std::string& ssid, const std::string& password);
void get_wifi_credentials(char*& ssid, char*& password); void get_wifi_credentials(std::string& out_ssid, std::string& out_password);
bool initialized = false; bool initialized = false;
KVStorageHandler* kvs = nullptr; std::shared_ptr<LittleFSHandler> fs_handler_ = nullptr;
EventGroupHandle_t s_wifi_event_group = 0; EventGroupHandle_t s_wifi_event_group = 0;
SemaphoreHandle_t scan_mutex = nullptr; SemaphoreHandle_t scan_mutex = nullptr;
SemaphoreHandle_t connection_mutex = nullptr; SemaphoreHandle_t connection_mutex = nullptr;
SemaphoreHandle_t credential_mutex = nullptr;
// current connected / preferred SSID // current connected / preferred SSID
char* current_ssid = nullptr; std::string current_ssid;
// current password (temporarily stored for successful connection event)
std::string current_password;
// prevent auto-reconnect on expected disconnection, e.g. when user calls disconnect() // prevent auto-reconnect on expected disconnection, e.g. when user calls disconnect()
// should be reset to false after connect() // should be reset to false after connect()
bool expect_disconnected = false; bool expect_disconnected = false;

View File

@@ -1,53 +0,0 @@
#include "touch.h"
#include "common/constants.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/event_groups.h"
// TODO: implement actual touch functionality
TouchHandler::TouchHandler(QueueHandle_t touch_queue) {
(void)touch_queue;
}
TouchHandler::~TouchHandler() { }
EInkTouchHandler::EInkTouchHandler(QueueHandle_t touch_queue)
: TouchHandler(touch_queue) { }
EInkTouchHandler::~EInkTouchHandler() { }
void EInkTouchHandler::init(EventGroupHandle_t system_event_group) {
if (system_event_group != NULL) {
xEventGroupSetBits(system_event_group, TOUCH_CALIBRATED_BIT);
}
}
void EInkTouchHandler::start_event_loop() {
// Minimal background task to represent touch processing
xTaskCreate(
// use static adapter and pass `this` as task parameter
EInkTouchHandler::task_adapter,
"touch_task",
2048,
this,
tskIDLE_PRIORITY + 1,
nullptr
);
}
// static
void EInkTouchHandler::task_adapter(void* arg) {
EInkTouchHandler* self = static_cast<EInkTouchHandler*>(arg);
if (self) {
self->run_event_loop();
} else {
printf("EInkTouchHandler::task_adapter received null pointer\n");
}
vTaskDelete(NULL);
}
void EInkTouchHandler::run_event_loop() {
for (;;) {
vTaskDelay(pdMS_TO_TICKS(1000));
}
}

View File

@@ -1,32 +0,0 @@
#include "info/info.h"
class TouchHandler {
public:
TouchHandler(QueueHandle_t touch_queue);
// the system_event_group is used to set touch-calibrated bit
virtual void init(EventGroupHandle_t system_event_group) = 0;
virtual void start_event_loop() = 0;
virtual ~TouchHandler() = 0;
private:
TouchHandler(const TouchHandler&) = delete;
TouchHandler& operator=(const TouchHandler&) = delete;
};
class EInkTouchHandler : public TouchHandler {
public:
EInkTouchHandler(QueueHandle_t touch_queue);
void init(EventGroupHandle_t system_event_group) override;
void start_event_loop() override;
~EInkTouchHandler() override;
private:
// Task adapter used for FreeRTOS task creation. Forwards to
// `run_event_loop()` using the `this` pointer passed as the task param.
static void task_adapter(void* arg);
// Instance method implementing the touch event loop.
void run_event_loop();
// prevent copying
EInkTouchHandler(const EInkTouchHandler&) = delete;
EInkTouchHandler& operator=(const EInkTouchHandler&) = delete;
};

14
main/ui/CMakeLists.txt Normal file
View File

@@ -0,0 +1,14 @@
list(APPEND SRCS
"${CMAKE_CURRENT_LIST_DIR}/ui_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/root_layout.cpp"
"${CMAKE_CURRENT_LIST_DIR}/interaction_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/events.cpp"
"${CMAKE_CURRENT_LIST_DIR}/apps/registry.cpp"
"${CMAKE_CURRENT_LIST_DIR}/widgets/textarea.cpp"
"${CMAKE_CURRENT_LIST_DIR}/widgets/button.cpp"
)
# Apps control: include apps/CMakeLists.txt which selects which apps to add
if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/apps/CMakeLists.txt")
include("${CMAKE_CURRENT_LIST_DIR}/apps/CMakeLists.txt")
endif()

View File

@@ -0,0 +1,19 @@
# Control which apps are included in the build.
# Override `ENABLED_APPS` from the top-level CMake command line to change apps.
if(NOT DEFINED ENABLED_APPS)
set(ENABLED_APPS "iotdis" "travel")
endif()
message(STATUS "Enabled apps: ${ENABLED_APPS}")
foreach(app IN LISTS ENABLED_APPS)
set(APP_DIR "${CMAKE_CURRENT_LIST_DIR}/${app}")
if(EXISTS "${APP_DIR}/CMakeLists.txt")
include("${APP_DIR}/CMakeLists.txt")
else()
message(WARNING "App '${app}' has no CMakeLists.txt — attempting to add any sources directly")
file(GLOB APP_SRCS "${APP_DIR}/*.c" "${APP_DIR}/*.cpp" "${APP_DIR}/*/*.c" "${APP_DIR}/*/*.cpp")
if(APP_SRCS)
list(APPEND SRCS ${APP_SRCS})
endif()
endif()
endforeach()

91
main/ui/apps/app.h Normal file
View File

@@ -0,0 +1,91 @@
#pragma once
#include "lvgl.h"
#include "esp_err.h"
#include <string>
#include <memory>
// Forward declaration
class InteractionHandler;
/**
* @brief Base class for all UI applications
*
* All UI applications (apps) must inherit from this class.
* Each app is responsible for managing its own widgets within
* the provided LVGL container. The UIHandler will manage the
* lifecycle of apps and event routing.
*/
class UIApp {
public:
virtual ~UIApp() = default;
/**
* @brief Initialize the app with the given container
*
* The app should create all its widgets as children of the
* provided container. The container is already positioned
* between the header and navigation bar.
*
* @param container LVGL container object for this app
* @param interaction_handler Pointer to interaction handler for keyboard support
* @return ESP_OK on success, error code otherwise
*/
virtual esp_err_t init(lv_obj_t* container, InteractionHandler* interaction_handler) = 0;
/**
* @brief Deinitialize and clean up app resources
*
* The app should delete all widgets and release any resources.
* The container itself will be handled by UIHandler.
*
* @return ESP_OK on success, error code otherwise
*/
virtual esp_err_t deinit(void) = 0;
/**
* @brief Get the display name of this app
*
* Used for logging and potentially showing in navigation.
*
* @return std::string app name
*/
virtual std::string get_name(void) const = 0;
/**
* @brief Handle back button press
*
* Called when the back button is pressed.
* The app can choose to handle it (e.g., close a dialog)
* or return false to let UIHandler handle it (e.g., return to main screen).
*
* @return true if the event was handled, false otherwise
*/
virtual bool on_back_button_pressed(void) {
return false; // default: not handled
}
protected:
lv_obj_t* container_ = nullptr; ///< LVGL container provided by UIHandler
};
class AppDescriptor {
public:
virtual ~AppDescriptor() = default;
virtual void draw_icon(lv_obj_t* parent) = 0;
std::string get_name() const {
return name_;
}
UIApp* get_app_instance() const {
return app_instance_.get();
}
protected:
AppDescriptor(std::string name, std::unique_ptr<UIApp> app_instance)
: name_(name), app_instance_(std::move(app_instance)) { }
std::string name_;
std::unique_ptr<UIApp> app_instance_;
};

View File

@@ -0,0 +1,12 @@
# Explicit list of iotdis app sources
list(APPEND SRCS
"${CMAKE_CURRENT_LIST_DIR}/web/web_handlers.cpp"
"${CMAKE_CURRENT_LIST_DIR}/descriptor.cpp"
"${CMAKE_CURRENT_LIST_DIR}/settings/settings_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/app.cpp"
"${CMAKE_CURRENT_LIST_DIR}/bridge/bridge.cpp"
"${CMAKE_CURRENT_LIST_DIR}/ui/settings_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/ui/settings.cpp"
"${CMAKE_CURRENT_LIST_DIR}/ui/main_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/ui/main.cpp"
)

131
main/ui/apps/iotdis/app.cpp Normal file
View File

@@ -0,0 +1,131 @@
#include "ui/apps/iotdis/app.h"
#include "ui/apps/iotdis/ui/main_handler.h"
#include "ui/apps/iotdis/ui/settings_handler.h"
#include "common/system_context.h"
#include "esp_log.h"
static const char* TAG = "IotDisApp";
// ============================================================================
// IotDisApp Implementation
// ============================================================================
IotDisApp::IotDisApp()
: main_ui_handler_(nullptr)
, settings_ui_handler_(nullptr)
, current_page_(Page::MAIN)
, setting_handler_(nullptr)
, interaction_handler_(nullptr) {
setting_handler_ = std::make_unique<SettingHandler>(
std::make_unique<NVSStorageHandler>(IotDisApp::NVS_NAMESPACE)
);
}
IotDisApp::~IotDisApp() { }
esp_err_t IotDisApp::init(lv_obj_t* container, InteractionHandler* interaction_handler) {
ESP_LOGI(TAG, "Initializing Discord app");
container_ = container;
interaction_handler_ = interaction_handler;
// Initialize storage
setting_handler_->init(nullptr);
// Load saved settings
setting_handler_->load_settings();
// Create main UI handler
main_ui_handler_ = std::make_unique<MainUIHandler>();
main_ui_handler_->init(container, interaction_handler_, setting_handler_.get());
// Register settings button callback
main_ui_handler_->register_on_settings_button_clicked(on_settings_button_clicked_static, this);
current_page_ = Page::MAIN;
return ESP_OK;
}
esp_err_t IotDisApp::deinit() {
ESP_LOGI(TAG, "Deinitializing Discord app");
// Clean up UI handlers
if (settings_ui_handler_) {
settings_ui_handler_->deinit();
settings_ui_handler_.reset();
}
if (main_ui_handler_) {
main_ui_handler_->deinit();
main_ui_handler_.reset();
}
return ESP_OK;
}
std::string IotDisApp::get_name() const {
return "Discord";
}
bool IotDisApp::on_back_button_pressed() {
// If on settings page, go back to main page
if (current_page_ == Page::SETTINGS) {
// Clean up settings handler
if (settings_ui_handler_) {
settings_ui_handler_->deinit();
settings_ui_handler_.reset();
}
// Reload settings in case they were updated
setting_handler_->load_settings();
// Recreate main UI handler with updated settings
if (!main_ui_handler_) {
main_ui_handler_ = std::make_unique<MainUIHandler>();
main_ui_handler_->init(container_, interaction_handler_, setting_handler_.get());
main_ui_handler_->register_on_settings_button_clicked(on_settings_button_clicked_static, this);
}
// Update UI with configuration status
main_ui_handler_->update_config_prompt(setting_handler_->is_configured());
current_page_ = Page::MAIN;
return true;
}
// Let system handle back (return to app icons)
return false;
}
// ============================================================================
// Private Methods
// ============================================================================
// Settings page with web server and QR code
void IotDisApp::show_settings_page() {
ESP_LOGI(TAG, "Showing settings page");
// Hide main UI handler
if (main_ui_handler_) {
main_ui_handler_->deinit();
main_ui_handler_.reset();
}
// Create settings UI handler
settings_ui_handler_ = std::make_unique<SettingsUIHandler>();
settings_ui_handler_->init(container_, interaction_handler_, setting_handler_.get());
current_page_ = Page::SETTINGS;
}
// ============================================================================
// Static Callbacks
// ============================================================================
void IotDisApp::on_settings_button_clicked_static(lv_event_t* e) {
IotDisApp* app = static_cast<IotDisApp*>(lv_event_get_user_data(e));
if (app) {
app->show_settings_page();
}
}

61
main/ui/apps/iotdis/app.h Normal file
View File

@@ -0,0 +1,61 @@
#pragma once
#include "ui/apps/app.h"
#include "ui/apps/iotdis/settings/settings_handler.h"
#include "ui/apps/iotdis/ui/main_handler.h"
#include "ui/apps/iotdis/ui/settings_handler.h"
#include "io/nvs_handler.h"
#include <string>
#include <memory>
// Forward declarations
class MainUIHandler;
class SettingsUIHandler;
/**
* @brief IotDis (Discord Integration) App
*
* Manages Discord voice state monitoring and control via UDP bridge.
* Features:
* - Real-time voice state monitoring (muted/unmuted)
* - Manual mute/unmute control
* - Settings for bridge IP/port configuration
* - Connection error detection and notification
* - NVS storage for persistent settings
*/
class IotDisApp : public UIApp {
public:
IotDisApp();
~IotDisApp() override;
esp_err_t init(lv_obj_t* container, InteractionHandler* interaction_handler) override;
esp_err_t deinit(void) override;
std::string get_name(void) const override;
bool on_back_button_pressed(void) override;
private:
// UI handlers
std::unique_ptr<MainUIHandler> main_ui_handler_;
std::unique_ptr<SettingsUIHandler> settings_ui_handler_;
// Current page tracking
enum class Page {
MAIN,
SETTINGS
};
Page current_page_;
// Settings handler (shared across handlers)
std::unique_ptr<SettingHandler> setting_handler_;
// Interaction handler (not owned)
InteractionHandler* interaction_handler_;
static constexpr const char* NVS_NAMESPACE = "discord_app";
// Private methods
void show_settings_page();
// UI callback forwarders
static void on_settings_button_clicked_static(lv_event_t* e);
};

View File

@@ -0,0 +1,223 @@
#include "ui/apps/iotdis/bridge/bridge.h"
#include "esp_err.h"
#include "esp_log.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/semphr.h"
#define TAG "IotDisBridge"
#define MUTE_COMMAND "MUTE"
#define STATUS_COMMAND "STATUS"
#define MUTED_RESPONSE "MUTED"
#define UNMUTED_RESPONSE "UNMUTED"
IotDisBridge::~IotDisBridge() {
stop_polling_task();
}
void IotDisBridge::start_polling_task() {
if (poll_task_handle_) {
ESP_LOGW(TAG, "Polling task already running");
return;
}
udp_client_.init(setting_handler_->get_local_port());
udp_client_.configure(
setting_handler_->get_remote_ip(),
setting_handler_->get_remote_port()
);
stop_polling_ = false;
xTaskCreate(poll_task_, "discord_poll", 4096, this, 5, &poll_task_handle_);
}
void IotDisBridge::stop_polling_task() {
if (!poll_task_handle_) {
if (udp_client_.is_configured()) {
udp_client_.close();
}
return;
}
ESP_LOGI(TAG, "Stopping polling task");
stop_polling_ = true;
// Wait for task to finish (max 2 seconds)
int wait_count = 0;
while (poll_task_handle_ && wait_count < 20) {
vTaskDelay(pdMS_TO_TICKS(100));
wait_count++;
}
if (poll_task_handle_) {
ESP_LOGW(TAG, "Force deleting polling task");
vTaskDelete(poll_task_handle_);
poll_task_handle_ = nullptr;
}
if (udp_client_.is_configured()) {
udp_client_.close();
}
on_status_update_callback_ = nullptr;
status_event_user_data_ = nullptr;
consecutive_failures_ = 0;
}
esp_err_t IotDisBridge::send_mute_command() {
if (!setting_handler_->is_configured()) {
ESP_LOGW(TAG, "Cannot send command: not configured");
return ESP_FAIL;
}
ESP_LOGI(TAG, "Sending MUTE command");
esp_err_t err = udp_client_.send_command(MUTE_COMMAND);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send MUTE command");
return err;
}
return ESP_OK;
}
bool IotDisBridge::test_connection(const std::string& ip, uint16_t port, uint16_t local_port) {
ESP_LOGI(TAG, "Testing connection to %s:%u (local port: %u)", ip.c_str(), port, local_port);
// Create temporary UDP client for testing
UDPClient test_client;
esp_err_t err = test_client.init(local_port);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to initialize test UDP client");
return false;
}
err = test_client.configure(ip, port);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to configure test UDP client");
return false;
}
err = test_client.send_command(STATUS_COMMAND);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send STATUS command");
return false;
}
ESP_LOGI(TAG, "STATUS command sent, waiting for response (timeout: %dms)", RESPONSE_TIMEOUT_MS);
std::string response;
err = test_client.receive_response(response, RESPONSE_TIMEOUT_MS);
if (err == ESP_OK) {
ESP_LOGI(TAG, "Received response: %s", response.c_str());
bool valid = (response == MUTED_RESPONSE || response == UNMUTED_RESPONSE);
if (!valid) {
ESP_LOGW(TAG, "Unexpected response (expected MUTED or UNMUTED)");
}
test_client.close();
return valid;
} else if (err == ESP_ERR_TIMEOUT) {
ESP_LOGW(TAG, "Timeout waiting for response");
} else {
ESP_LOGE(TAG, "Error receiving response: %d", err);
}
test_client.close();
return false;
}
//
// private methods
//
void IotDisBridge::poll_task_(void* param) {
IotDisBridge* bridge = static_cast<IotDisBridge*>(param);
ESP_LOGI(TAG, "Polling task started");
while (!bridge->stop_polling_) {
bridge->poll_status_();
// Yield to allow other tasks to run
taskYIELD();
}
ESP_LOGI(TAG, "Polling task stopped");
bridge->poll_task_handle_ = nullptr;
vTaskDelete(nullptr);
}
void IotDisBridge::poll_status_() {
if (!setting_handler_->is_configured()) {
// Don't poll if not configured
return;
}
// Continuously listen for messages (blocking with timeout)
// Use longer timeout if in error state
int listen_timeout = (consecutive_failures_ >= MAX_FAILURES_BEFORE_ERROR)
? ERROR_POLL_INTERVAL_MS
: POLL_INTERVAL_MS;
ESP_LOGI(TAG, "Listening for messages (timeout: %dms)", listen_timeout);
std::string message;
esp_err_t err = udp_client_.receive_response(message, listen_timeout);
if (err == ESP_OK && !message.empty()) {
// Received a message (either push update or status response)
ESP_LOGI(TAG, "Received message: %s", message.c_str());
StatusUpdateEventData event_data {
.state = StatusUpdateEventData::VoiceState::UNKNOWN
};
if (message == MUTED_RESPONSE) {
event_data.state = StatusUpdateEventData::VoiceState::MUTED;
} else if (message == UNMUTED_RESPONSE) {
event_data.state = StatusUpdateEventData::VoiceState::UNMUTED;
}
// Reset failure counter on successful message
if (event_data.state != StatusUpdateEventData::VoiceState::UNKNOWN) {
consecutive_failures_ = 0;
ESP_LOGI(TAG, "Invoking status update callback with state: %d", event_data.state);
if (on_status_update_callback_) {
on_status_update_callback_(event_data, status_event_user_data_);
}
} else {
ESP_LOGW(TAG, "Received unknown message: %s", message.c_str());
}
} else if (err == ESP_ERR_TIMEOUT) {
// Timeout - send STATUS command to verify connection is still alive
ESP_LOGI(TAG, "Listen timeout, sending STATUS command to verify connection");
err = udp_client_.send_command(STATUS_COMMAND);
if (err != ESP_OK) {
consecutive_failures_++;
ESP_LOGW(TAG, "Failed to send STATUS command. Consecutive failures: %d",
consecutive_failures_);
if (consecutive_failures_ >= MAX_FAILURES_BEFORE_ERROR) {
if (on_status_update_callback_) {
on_status_update_callback_(
StatusUpdateEventData { .state = StatusUpdateEventData::VoiceState::ERROR },
status_event_user_data_
);
}
}
}
// The response to STATUS command will be received in the next iteration
} else {
// Error receiving
consecutive_failures_++;
ESP_LOGW(TAG, "Error receiving message: %d (failures: %d)", err, consecutive_failures_);
if (consecutive_failures_ >= MAX_FAILURES_BEFORE_ERROR) {
if (on_status_update_callback_) {
on_status_update_callback_(
StatusUpdateEventData { .state = StatusUpdateEventData::VoiceState::ERROR },
status_event_user_data_
);
}
}
}
}

View File

@@ -0,0 +1,67 @@
#pragma once
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "ui/apps/iotdis/settings/settings_handler.h"
#include <string>
#include <cstdint>
#include <memory>
#include "esp_err.h"
#include "network/udp_client.h"
struct StatusUpdateEventData {
enum class VoiceState {
UNKNOWN,
MUTED,
UNMUTED,
ERROR
} state;
};
using StatusEventCallback = void(*)(StatusUpdateEventData, void*);
class IotDisBridge {
public:
IotDisBridge(
SettingHandler* setting_handler
) : setting_handler_(setting_handler) { }
~IotDisBridge();
void start_polling_task();
void stop_polling_task();
esp_err_t send_mute_command();
bool test_connection(const std::string& ip, uint16_t port) {
return test_connection(ip, port, setting_handler_->get_local_port());
}
bool test_connection(const std::string& ip, uint16_t port, uint16_t local_port);
void register_on_status_update_callback(
StatusEventCallback callback,
void* status_event_user_data
) {
on_status_update_callback_ = callback;
status_event_user_data_ = status_event_user_data;
}
private:
static constexpr int POLL_INTERVAL_MS = 10000;
static constexpr int ERROR_POLL_INTERVAL_MS = 20000;
static constexpr int RESPONSE_TIMEOUT_MS = 1000;
static constexpr int MAX_FAILURES_BEFORE_ERROR = 3;
void poll_status_();
// Polling task
static void poll_task_(void* param);
TaskHandle_t poll_task_handle_ = nullptr;
bool stop_polling_ = false;
int consecutive_failures_ = 0;
SettingHandler* setting_handler_ = nullptr;
UDPClient udp_client_;
StatusEventCallback on_status_update_callback_ = nullptr;
void* status_event_user_data_ = nullptr;
};

View File

@@ -0,0 +1,11 @@
#include "ui/apps/iotdis/descriptor.h"
IotDisDescriptor::IotDisDescriptor()
: AppDescriptor("IotDis", std::make_unique<IotDisApp>()) { }
void IotDisDescriptor::draw_icon(lv_obj_t* parent) {
// Draw Discord icon (call/phone symbol)
lv_obj_t* icon = lv_label_create(parent);
lv_label_set_text(icon, LV_SYMBOL_CALL);
lv_obj_center(icon);
}

View File

@@ -0,0 +1,12 @@
#pragma once
#include "ui/apps/app.h"
#include "ui/apps/iotdis/app.h"
class IotDisDescriptor : public AppDescriptor {
public:
IotDisDescriptor();
~IotDisDescriptor() override = default;
void draw_icon(lv_obj_t* parent) override;
};

View File

@@ -0,0 +1,52 @@
#include "ui/apps/iotdis/settings/settings_handler.h"
#include "esp_log.h"
#define TAG "SettingHandler"
void SettingHandler::load_settings() {
remote_ip_ = storage_->get(NVS_KEY_IP);
std::string port_str = storage_->get(NVS_KEY_PORT);
std::string local_port_str = storage_->get(NVS_KEY_LOCAL_PORT);
if (!remote_ip_.empty() && !port_str.empty()) {
remote_port_ = static_cast<uint16_t>(atoi(port_str.c_str()));
// Load local port, default to DEFAULT_LOCAL_PORT if not configured
if (!local_port_str.empty()) {
local_port_ = static_cast<uint16_t>(atoi(local_port_str.c_str()));
} else {
local_port_ = DEFAULT_LOCAL_PORT;
}
ESP_LOGI(TAG, "Loaded settings: %s:%u (local port: %u)", remote_ip_.c_str(), remote_port_, local_port_);
} else {
local_port_ = DEFAULT_LOCAL_PORT;
ESP_LOGI(TAG, "No settings found, user setup required");
}
}
void SettingHandler::save_settings(const std::string& ip, uint16_t port, uint16_t local_port) {
if (ip.empty() || port == 0 || local_port == 0) {
ESP_LOGW(TAG, "Cannot save: invalid settings");
return;
}
// Save to NVS
storage_->put(NVS_KEY_IP, ip);
char port_str[8];
snprintf(port_str, sizeof(port_str), "%u", port);
storage_->put(NVS_KEY_PORT, port_str);
char local_port_str[8];
snprintf(local_port_str, sizeof(local_port_str), "%u", local_port);
storage_->put(NVS_KEY_LOCAL_PORT, local_port_str);
// Update local config
remote_ip_ = ip;
remote_port_ = port;
local_port_ = local_port;
ESP_LOGI(TAG, "Settings saved: %s:%u (local port: %u)", remote_ip_.c_str(), remote_port_, local_port_);
}

View File

@@ -0,0 +1,45 @@
#pragma once
#include "freertos/FreeRTOS.h"
#include <string>
#include <memory>
#include "io/nvs_handler.h"
class SettingHandler {
public:
SettingHandler(std::unique_ptr<NVSStorageHandler> storage) :
remote_ip_(""),
remote_port_(0),
local_port_(0),
storage_(std::move(storage)) { }
~SettingHandler() = default;
esp_err_t init(const EventGroupHandle_t& system_event_group) {
storage_->init(system_event_group);
return ESP_OK;
}
void load_settings();
void save_settings(const std::string& ip, uint16_t port) {
save_settings(ip, port, local_port_);
}
void save_settings(const std::string& ip, uint16_t port, uint16_t local_port);
bool is_configured() const { return !remote_ip_.empty() && remote_port_ != 0 && local_port_ != 0; }
std::string get_remote_ip() const { return remote_ip_; }
uint16_t get_remote_port() const { return remote_port_; }
uint16_t get_local_port() const { return local_port_; }
private:
static constexpr uint16_t DEFAULT_LOCAL_PORT = 4212;
static constexpr const char* NVS_KEY_IP = "bridge_ip";
static constexpr const char* NVS_KEY_PORT = "bridge_port";
static constexpr const char* NVS_KEY_LOCAL_PORT = "local_port";
std::string remote_ip_;
uint16_t remote_port_;
uint16_t local_port_;
std::unique_ptr<NVSStorageHandler> storage_;
};

View File

@@ -0,0 +1,209 @@
#include "ui/apps/iotdis/ui/main.h"
#include "ui/apps/iotdis/app.h"
#include "ui/interaction_handler.h"
#include "ui/widgets/button.h"
#include "esp_log.h"
#include "esp_lvgl_port.h"
#define LVGL_LOCK_TIMEOUT 4000 // milliseconds
static const char* TAG = "MainUI";
MainUI::~MainUI() {
deinit();
}
esp_err_t MainUI::init(lv_obj_t* parent, InteractionHandler* interaction_handler) {
container_ = parent;
create_ui_(parent);
return ESP_OK;
}
esp_err_t MainUI::deinit(void) {
// LVGL will clean up children automatically when parent is deleted
error_notification_ = nullptr;
status_icon_label_ = nullptr;
status_text_label_ = nullptr;
mute_button_ = nullptr;
settings_button_ = nullptr;
config_prompt_ = nullptr;
container_ = nullptr;
return ESP_OK;
}
void MainUI::create_ui_(lv_obj_t* parent) {
if (!parent) {
ESP_LOGE(TAG, "Parent LVGL object is null");
return;
}
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_LOCK_TIMEOUT))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock for UI creation");
return;
}
// Set up main page with flex column layout
lv_obj_set_flex_flow(parent, LV_FLEX_FLOW_COLUMN);
lv_obj_set_flex_align(parent, LV_FLEX_ALIGN_SPACE_BETWEEN, LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_CENTER);
lv_obj_set_style_pad_all(parent, 10, 0);
// === Top Section: Error Notification ===
error_notification_ = lv_obj_create(parent);
lv_obj_set_width(error_notification_, LV_PCT(90));
lv_obj_set_height(error_notification_, LV_SIZE_CONTENT);
lv_obj_set_style_bg_color(error_notification_, lv_color_white(), 0);
lv_obj_set_style_bg_opa(error_notification_, LV_OPA_COVER, 0);
lv_obj_set_style_border_color(error_notification_, lv_color_black(), 0);
lv_obj_set_style_border_width(error_notification_, 2, 0);
lv_obj_set_style_pad_all(error_notification_, 10, 0);
lv_obj_set_style_radius(error_notification_, 8, 0);
lv_obj_add_flag(error_notification_, LV_OBJ_FLAG_HIDDEN);
lv_obj_set_flex_flow(error_notification_, LV_FLEX_FLOW_ROW);
lv_obj_set_flex_align(error_notification_, LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_CENTER);
lv_obj_t* error_label = lv_label_create(error_notification_);
lv_label_set_text(error_label, LV_SYMBOL_WARNING " Connection Lost");
lv_obj_set_style_text_color(error_label, lv_color_black(), 0);
// === Center Section: Main Content ===
lv_obj_t* center_container = lv_obj_create(parent);
lv_obj_set_size(center_container, LV_PCT(100), LV_SIZE_CONTENT);
lv_obj_set_style_bg_opa(center_container, LV_OPA_TRANSP, 0);
lv_obj_set_style_border_width(center_container, 0, 0);
lv_obj_set_style_pad_all(center_container, 0, 0);
lv_obj_set_flex_flow(center_container, LV_FLEX_FLOW_COLUMN);
lv_obj_set_flex_align(center_container, LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_CENTER);
lv_obj_set_style_pad_row(center_container, 15, 0);
lv_obj_set_flex_grow(center_container, 1);
// Status icon (large, centered)
status_icon_label_ = lv_label_create(center_container);
lv_label_set_text(status_icon_label_, LV_SYMBOL_MUTE);
// Status text
status_text_label_ = lv_label_create(center_container);
lv_label_set_text(status_text_label_, "Unknown Status");
// Mute button
mute_button_ = button_create(center_container);
lv_obj_set_size(mute_button_, 200, 60);
lv_obj_t* mute_label = lv_label_create(mute_button_);
lv_label_set_text(mute_label, "MUTE");
lv_obj_center(mute_label);
lv_obj_set_style_text_color(mute_label, lv_color_black(), 0);
// === Bottom Section: Settings and Config Prompt ===
lv_obj_t* bottom_container = lv_obj_create(parent);
lv_obj_set_size(bottom_container, LV_PCT(100), LV_SIZE_CONTENT);
lv_obj_set_style_bg_opa(bottom_container, LV_OPA_TRANSP, 0);
lv_obj_set_style_border_width(bottom_container, 0, 0);
lv_obj_set_style_pad_all(bottom_container, 0, 0);
lv_obj_set_flex_flow(bottom_container, LV_FLEX_FLOW_ROW);
lv_obj_set_flex_align(bottom_container, LV_FLEX_ALIGN_SPACE_BETWEEN, LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_CENTER);
// Config prompt (left side)
config_prompt_ = lv_label_create(bottom_container);
lv_label_set_text(config_prompt_, "Tap " LV_SYMBOL_SETTINGS " to configure");
lv_obj_set_style_text_color(config_prompt_, lv_color_black(), 0);
// Settings button (right side)
settings_button_ = button_create(bottom_container);
lv_obj_set_size(settings_button_, 60, 60);
lv_obj_t* settings_icon = lv_label_create(settings_button_);
lv_label_set_text(settings_icon, LV_SYMBOL_SETTINGS);
lv_obj_center(settings_icon);
lv_obj_set_style_text_color(settings_icon, lv_color_black(), 0);
ESP_LOGI(TAG, "Main UI created");
lvgl_port_unlock();
}
esp_err_t MainUI::register_on_settings_button_clicked(lv_event_cb_t cb, void* user_data) {
if (!settings_button_) {
return ESP_ERR_INVALID_STATE;
}
lv_obj_add_event_cb(settings_button_, cb, LV_EVENT_CLICKED, user_data);
return ESP_OK;
}
esp_err_t MainUI::register_on_mute_button_clicked(lv_event_cb_t cb, void* user_data) {
if (!mute_button_) {
return ESP_ERR_INVALID_STATE;
}
lv_obj_add_event_cb(mute_button_, cb, LV_EVENT_CLICKED, user_data);
return ESP_OK;
}
bool MainUI::update_status(VoiceState state) {
if (!status_icon_label_ || !status_text_label_) {
return false;
}
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_LOCK_TIMEOUT))) {
ESP_LOGW(TAG, "Failed to acquire LVGL lock for status update");
return false;
}
switch (state) {
case VoiceState::MUTED:
lv_label_set_text(status_icon_label_, LV_SYMBOL_MUTE);
lv_label_set_text(status_text_label_, "Muted");
lv_obj_set_style_text_color(status_icon_label_, lv_color_black(), 0);
break;
case VoiceState::UNMUTED:
lv_label_set_text(status_icon_label_, LV_SYMBOL_VOLUME_MAX);
lv_label_set_text(status_text_label_, "Unmuted");
lv_obj_set_style_text_color(status_icon_label_, lv_color_black(), 0);
break;
case VoiceState::ERROR:
lv_label_set_text(status_icon_label_, LV_SYMBOL_WARNING);
lv_label_set_text(status_text_label_, "Connection Error");
lv_obj_set_style_text_color(status_icon_label_, lv_color_black(), 0);
break;
case VoiceState::UNKNOWN:
default:
lv_label_set_text(status_icon_label_, LV_SYMBOL_BLUETOOTH);
lv_label_set_text(status_text_label_, "Unknown Status");
lv_obj_set_style_text_color(status_icon_label_, lv_color_black(), 0);
break;
}
lvgl_port_unlock();
return true;
}
void MainUI::show_error_notification(bool show) {
if (!error_notification_) {
return;
}
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_LOCK_TIMEOUT))) {
ESP_LOGW(TAG, "Failed to acquire LVGL lock for error notification update");
return;
}
if (show) {
lv_obj_clear_flag(error_notification_, LV_OBJ_FLAG_HIDDEN);
} else {
lv_obj_add_flag(error_notification_, LV_OBJ_FLAG_HIDDEN);
}
lvgl_port_unlock();
}
void MainUI::update_config_prompt(bool configured) {
if (!config_prompt_) {
return;
}
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_LOCK_TIMEOUT))) {
ESP_LOGW(TAG, "Failed to acquire LVGL lock for config prompt update");
return;
}
if (configured) {
lv_obj_add_flag(config_prompt_, LV_OBJ_FLAG_HIDDEN);
} else {
lv_obj_clear_flag(config_prompt_, LV_OBJ_FLAG_HIDDEN);
}
lvgl_port_unlock();
}

View File

@@ -0,0 +1,85 @@
#pragma once
#include "lvgl.h"
#include "esp_err.h"
#include <string>
#include "ui/events.h"
#include "ui/apps/iotdis/bridge/bridge.h"
#include "ui/interaction_handler.h"
// Voice state enumeration
enum class VoiceState {
UNKNOWN,
MUTED,
UNMUTED,
ERROR
};
// Forward declarations
class InteractionHandler;
/**
* @brief Main UI for Discord app
*
* Displays:
* - Current voice state (muted/unmuted/error/unknown)
* - Large status icon
* - Status text
* - Mute toggle button
* - Error notification banner (when connection lost)
* - Settings button
* - Configuration prompt (if not configured)
*/
class MainUI {
public:
MainUI() = default;
~MainUI();
esp_err_t init(lv_obj_t* parent, InteractionHandler* interaction_handler);
esp_err_t deinit(void);
/**
* @brief Register callback for settings button clicks
* @param cb Callback function
* @param user_data User data to pass to callback
*/
esp_err_t register_on_settings_button_clicked(lv_event_cb_t cb, void* user_data);
/**
* @brief Register callback for mute button clicks
* @param cb Callback function
* @param user_data User data to pass to callback
*/
esp_err_t register_on_mute_button_clicked(lv_event_cb_t cb, void* user_data);
/**
* @brief Update status display with current voice state
* @param state Current voice state
*/
bool update_status(VoiceState state);
/**
* @brief Show or hide error notification banner
* @param show true to show, false to hide
*/
void show_error_notification(bool show);
/**
* @brief Update configuration prompt visibility
* @param configured true if settings are configured
*/
void update_config_prompt(bool configured);
private:
void create_ui_(lv_obj_t* parent);
lv_obj_t* container_ = nullptr;
// UI elements
lv_obj_t* error_notification_ = nullptr;
lv_obj_t* status_icon_label_ = nullptr;
lv_obj_t* status_text_label_ = nullptr;
lv_obj_t* mute_button_ = nullptr;
lv_obj_t* settings_button_ = nullptr;
lv_obj_t* config_prompt_ = nullptr;
};

View File

@@ -0,0 +1,199 @@
#include "ui/apps/iotdis/ui/main_handler.h"
#include "esp_log.h"
static const char* TAG = "MainUIHandler";
MainUIHandler::MainUIHandler() {
state_mutex_ = xSemaphoreCreateMutex();
}
MainUIHandler::~MainUIHandler() {
deinit();
if (state_mutex_) {
vSemaphoreDelete(state_mutex_);
state_mutex_ = nullptr;
}
}
esp_err_t MainUIHandler::init(lv_obj_t* parent, InteractionHandler* interaction_handler, SettingHandler* setting_handler) {
ESP_LOGI(TAG, "Initializing Main UI Handler");
setting_handler_ = setting_handler;
// Create unique bridge instance for this handler
bridge_ = std::make_unique<IotDisBridge>(setting_handler_);
// Register status update callback
bridge_->register_on_status_update_callback(on_status_update_static_, this);
// Create main UI
main_ui_ = std::make_unique<MainUI>();
main_ui_->init(parent, interaction_handler);
// Register mute button callback
main_ui_->register_on_mute_button_clicked(on_mute_button_clicked_static_, this);
// Update UI with current configuration
main_ui_->update_config_prompt(setting_handler_->is_configured());
update_ui_();
// Start polling task
bridge_->start_polling_task();
return ESP_OK;
}
esp_err_t MainUIHandler::deinit(void) {
ESP_LOGI(TAG, "Deinitializing Main UI Handler");
// Stop polling
if (bridge_) {
bridge_->stop_polling_task();
bridge_.reset();
}
// Clean up UI
if (main_ui_) {
main_ui_->deinit();
main_ui_.reset();
}
return ESP_OK;
}
esp_err_t MainUIHandler::register_on_settings_button_clicked(lv_event_cb_t cb, void* user_data) {
on_settings_callback_ = cb;
settings_callback_user_data_ = user_data;
if (main_ui_) {
main_ui_->register_on_settings_button_clicked(cb, user_data);
} else {
ESP_LOGE(TAG, "Main UI not initialized");
return ESP_ERR_INVALID_STATE;
}
return ESP_OK;
}
void MainUIHandler::update_config_prompt(bool is_configured) {
if (main_ui_) {
main_ui_->update_config_prompt(is_configured);
} else {
ESP_LOGE(TAG, "Main UI not initialized");
}
}
void MainUIHandler::update_status() {
update_ui_();
}
// ============================================================================
// Private Methods
// ============================================================================
void MainUIHandler::send_mute_command_() {
if (!setting_handler_->is_configured()) {
ESP_LOGW(TAG, "Cannot send command: not configured");
return;
}
ESP_LOGI(TAG, "Sending MUTE command");
esp_err_t err = bridge_->send_mute_command();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to send MUTE command");
}
}
void MainUIHandler::on_status_update_(StatusUpdateEventData data) {
ESP_LOGI(TAG, "on_status_update_ called with state: %d, current_state_: %d", data.state, current_state_);
// Update state in thread-safe manner
bool update_ui = false;
if (state_mutex_ && xSemaphoreTake(state_mutex_, pdMS_TO_TICKS(100)) == pdTRUE) {
if (data.state != current_state_) {
update_ui = true;
}
xSemaphoreGive(state_mutex_);
ESP_LOGI(TAG, "State updated in mutex");
}
// Update UI
if (!update_ui) {
ESP_LOGI(TAG, "State unchanged, skipping UI update");
return;
}
ESP_LOGI(TAG, "Calling update_ui_()");
update_ui_(&data.state);
ESP_LOGI(TAG, "on_status_update_ complete");
}
void MainUIHandler::update_ui_(StatusUpdateEventData::VoiceState* state_ptr) {
ESP_LOGI(TAG, "update_ui_ called");
if (main_ui_) {
StatusUpdateEventData::VoiceState state;
if (state_mutex_ && xSemaphoreTake(state_mutex_, pdMS_TO_TICKS(100)) == pdTRUE) {
state = state_ptr ? *state_ptr : current_state_;
xSemaphoreGive(state_mutex_);
} else {
state = StatusUpdateEventData::VoiceState::UNKNOWN;
}
ESP_LOGI(TAG, "Converting state: %d", state);
// Convert to MainUI VoiceState
VoiceState ui_state;
switch (state) {
case StatusUpdateEventData::VoiceState::MUTED:
ui_state = VoiceState::MUTED;
break;
case StatusUpdateEventData::VoiceState::UNMUTED:
ui_state = VoiceState::UNMUTED;
break;
case StatusUpdateEventData::VoiceState::ERROR:
ui_state = VoiceState::ERROR;
break;
default:
ui_state = VoiceState::UNKNOWN;
break;
}
ESP_LOGI(TAG, "Calling main_ui_->update_status() with ui_state: %d", ui_state);
// Lock LVGL before calling UI functions from another task
bool success = main_ui_->update_status(ui_state);
if (!success) {
ESP_LOGW(TAG, "main_ui_->update_status() failed");
} else {
// Update current state only on successful UI update
current_state_ = state;
}
ESP_LOGI(TAG, "main_ui_->update_status() returned");
}
ESP_LOGI(TAG, "update_ui_ complete");
}
// ============================================================================
// Static Callbacks
// ============================================================================
void MainUIHandler::on_mute_button_clicked_static_(lv_event_t* e) {
MainUIHandler* handler = static_cast<MainUIHandler*>(lv_event_get_user_data(e));
if (handler) {
handler->on_mute_button_clicked_();
}
}
void MainUIHandler::on_mute_button_clicked_() {
send_mute_command_();
}
void MainUIHandler::on_status_update_static_(StatusUpdateEventData data, void* user_data) {
MainUIHandler* handler = static_cast<MainUIHandler*>(user_data);
if (handler) {
handler->on_status_update_(data);
}
}

View File

@@ -0,0 +1,51 @@
#pragma once
#include "ui/apps/iotdis/ui/main.h"
#include "ui/interaction_handler.h"
#include "ui/apps/iotdis/bridge/bridge.h"
#include "ui/apps/iotdis/settings/settings_handler.h"
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "esp_err.h"
#include <memory>
/**
* @brief Main UI Handler for Discord App
*
* Manages the MainUI instance and interaction with the InteractionHandler.
* Each handler instance has its own IotDisBridge to prevent conflicts.
*/
class MainUIHandler {
public:
MainUIHandler();
~MainUIHandler();
esp_err_t init(lv_obj_t* parent, InteractionHandler* interaction_handler, SettingHandler* setting_handler);
esp_err_t deinit(void);
esp_err_t register_on_settings_button_clicked(lv_event_cb_t cb, void* user_data);
void update_config_prompt(bool is_configured);
void update_status();
private:
static void on_mute_button_clicked_static_(lv_event_t* e);
static void on_status_update_static_(StatusUpdateEventData data, void* user_data);
void on_mute_button_clicked_();
void on_status_update_(StatusUpdateEventData data);
void send_mute_command_();
void update_ui_(StatusUpdateEventData::VoiceState* state = nullptr);
std::unique_ptr<MainUI> main_ui_ = nullptr;
std::unique_ptr<IotDisBridge> bridge_ = nullptr;
SettingHandler* setting_handler_ = nullptr; // Not owned
// Voice state tracking
StatusUpdateEventData::VoiceState current_state_ = StatusUpdateEventData::VoiceState::UNKNOWN;
SemaphoreHandle_t state_mutex_ = nullptr;
// Callback for settings button
lv_event_cb_t on_settings_callback_ = nullptr;
void* settings_callback_user_data_ = nullptr;
};

View File

@@ -0,0 +1,74 @@
#include "ui/apps/iotdis/ui/settings.h"
#include "ui/interaction_handler.h"
#include "esp_log.h"
#include <cstring>
static const char* TAG = "SettingsUI";
SettingsUI::~SettingsUI() {
deinit();
}
esp_err_t SettingsUI::init(lv_obj_t* parent, InteractionHandler* interaction_handler) {
container_ = parent;
create_ui_(parent, interaction_handler);
return ESP_OK;
}
esp_err_t SettingsUI::deinit(void) {
// LVGL will clean up children automatically when parent is deleted
qr_code_ = nullptr;
status_label_ = nullptr;
container_ = nullptr;
return ESP_OK;
}
void SettingsUI::create_ui_(lv_obj_t* parent, InteractionHandler* interaction_handler) {
// Title
lv_obj_t* title = lv_label_create(parent);
lv_label_set_text(title, "Scan to Configure");
lv_obj_align(title, LV_ALIGN_TOP_MID, 0, 20);
lv_obj_set_style_text_font(title, &lv_font_montserrat_14, 0);
// Instruction text
lv_obj_t* instruction = lv_label_create(parent);
lv_label_set_text(instruction, "Scan this QR code with your mobile\ndevice to configure settings");
lv_obj_align(instruction, LV_ALIGN_TOP_MID, 0, 60);
lv_obj_set_style_text_align(instruction, LV_TEXT_ALIGN_CENTER, 0);
// QR code (centered)
qr_code_ = lv_qrcode_create(parent);
lv_qrcode_set_size(qr_code_, 250);
lv_qrcode_set_dark_color(qr_code_, lv_color_black());
lv_qrcode_set_light_color(qr_code_, lv_color_white());
lv_obj_align(qr_code_, LV_ALIGN_CENTER, 0, 0);
// Status label below QR code
status_label_ = lv_label_create(parent);
lv_label_set_text(status_label_, "Initializing...");
lv_obj_align(status_label_, LV_ALIGN_BOTTOM_MID, 0, -40);
lv_obj_set_style_text_align(status_label_, LV_TEXT_ALIGN_CENTER, 0);
ESP_LOGI(TAG, "Settings UI created with QR code display");
}
void SettingsUI::set_config_url(const std::string& url) {
if (!qr_code_ || url.empty()) {
ESP_LOGW(TAG, "Cannot set config URL: qr_code=%p, url=%s", qr_code_, url.c_str());
return;
}
lv_result_t result = lv_qrcode_update(qr_code_, url.c_str(), url.length());
if (result != LV_RESULT_OK) {
ESP_LOGE(TAG, "Failed to update QR code");
set_status_message("Error: Failed to generate QR code");
} else {
ESP_LOGI(TAG, "QR code updated with URL: %s", url.c_str());
}
}
void SettingsUI::set_status_message(const std::string& message) {
if (status_label_) {
lv_label_set_text(status_label_, message.c_str());
}
}

View File

@@ -0,0 +1,41 @@
#pragma once
#include "lvgl.h"
#include "esp_err.h"
#include <string>
// Forward declaration
class InteractionHandler;
/**
* @brief Settings UI for Discord app
*
* Displays a QR code that links to a web-based configuration interface
*/
class SettingsUI {
public:
SettingsUI() = default;
~SettingsUI();
esp_err_t init(lv_obj_t* parent, InteractionHandler* interaction_handler);
esp_err_t deinit(void);
/**
* @brief Set the configuration URL to display in QR code
* @param url Full URL including IP, port, and auth key
*/
void set_config_url(const std::string& url);
/**
* @brief Update status message below QR code
* @param message Status message to display
*/
void set_status_message(const std::string& message);
private:
void create_ui_(lv_obj_t* parent, InteractionHandler* interaction_handler);
lv_obj_t* container_ = nullptr;
lv_obj_t* qr_code_ = nullptr;
lv_obj_t* status_label_ = nullptr;
};

View File

@@ -0,0 +1,90 @@
#include "ui/apps/iotdis/ui/settings_handler.h"
#include "network/network.h"
#include "esp_log.h"
#include <sstream>
#include <iomanip>
static const char* TAG = "SettingsUIHandler";
SettingsUIHandler::SettingsUIHandler() { }
SettingsUIHandler::~SettingsUIHandler() {
deinit();
}
esp_err_t SettingsUIHandler::init(lv_obj_t* parent, InteractionHandler* interaction_handler, SettingHandler* setting_handler) {
ESP_LOGI(TAG, "Initializing Settings UI Handler");
setting_handler_ = setting_handler;
// Create unique bridge instance for this handler
bridge_ = std::make_unique<IotDisBridge>(setting_handler_);
// Create web handler with unique bridge
web_handler_ = std::make_unique<WebHandler>(setting_handler_, bridge_.get());
// Create settings UI
settings_ui_ = std::make_unique<SettingsUI>();
settings_ui_->init(parent, interaction_handler);
// Start web server and setup
setup_web_server_();
return ESP_OK;
}
esp_err_t SettingsUIHandler::deinit(void) {
ESP_LOGI(TAG, "Deinitializing Settings UI Handler");
// Stop web server
if (web_handler_) {
web_handler_->stop_web_server();
web_handler_.reset();
}
// Stop bridge
if (bridge_) {
bridge_->stop_polling_task();
bridge_.reset();
}
// Clean up UI
if (settings_ui_) {
settings_ui_->deinit();
settings_ui_.reset();
}
return ESP_OK;
}
// ============================================================================
// Private Methods
// ============================================================================
void SettingsUIHandler::setup_web_server_() {
// Start web server
web_handler_->start_web_server();
if (web_handler_->is_running()) {
std::string device_ip = web_handler_->get_device_ip();
uint16_t port = web_handler_->get_port();
if (!device_ip.empty()) {
std::string url = web_handler_->get_url();
settings_ui_->set_config_url(url);
std::ostringstream status;
status << "Server running on " << device_ip << ":" << port;
settings_ui_->set_status_message(status.str());
ESP_LOGI(TAG, "QR code URL: %s", url.c_str());
} else {
settings_ui_->set_status_message("Error: No IP address");
ESP_LOGE(TAG, "Failed to get device IP address");
}
} else {
settings_ui_->set_status_message("Error: Failed to start server");
ESP_LOGE(TAG, "Web server failed to start");
}
}

View File

@@ -0,0 +1,33 @@
#pragma once
#include "ui/apps/iotdis/ui/settings.h"
#include "ui/interaction_handler.h"
#include "ui/apps/iotdis/bridge/bridge.h"
#include "ui/apps/iotdis/settings/settings_handler.h"
#include "ui/apps/iotdis/web/web_handlers.h"
#include "esp_err.h"
#include <memory>
/**
* @brief Settings UI Handler for Discord App
*
* Manages the SettingsUI instance, web server, and interaction with the InteractionHandler.
* Each handler instance has its own IotDisBridge to prevent conflicts.
*/
class SettingsUIHandler {
public:
SettingsUIHandler();
~SettingsUIHandler();
esp_err_t init(lv_obj_t* parent, InteractionHandler* interaction_handler, SettingHandler* setting_handler);
esp_err_t deinit(void);
private:
void setup_web_server_();
std::unique_ptr<SettingsUI> settings_ui_ = nullptr;
std::unique_ptr<IotDisBridge> bridge_ = nullptr;
std::unique_ptr<WebHandler> web_handler_ = nullptr;
SettingHandler* setting_handler_ = nullptr; // Not owned
};

View File

@@ -0,0 +1,362 @@
#include "web_handlers.h"
#include "../app.h"
#include "esp_log.h"
#include "network/network.h"
#include "common/system_context.h"
#include "esp_random.h"
#include <sstream>
#include <iomanip>
static const char* TAG = "DiscordWebHandler";
WebHandler::~WebHandler() {
stop_web_server();
}
esp_err_t WebHandler::start_web_server() {
if (web_server_ && web_server_->is_running()) {
ESP_LOGI(TAG, "Web server already running");
return ESP_OK;
}
auth_key_ = generate_auth_key_();
uint16_t port = web_server_->start(
auth_key_,
8080
);
if (port == 0) {
ESP_LOGE(TAG, "Failed to start web server");
return ESP_FAIL;
}
esp_err_t ret = register_web_endpoints_();
if (ret != ESP_OK) {
ESP_LOGE(TAG, "Failed to register web endpoints");
web_server_->stop();
return ret;
}
ESP_LOGI(TAG, "Web server started");
return ESP_OK;
}
esp_err_t WebHandler::stop_web_server() {
if (web_server_) {
web_server_->stop();
ESP_LOGI(TAG, "Web server stopped");
}
auth_key_.clear();
return ESP_OK;
}
std::string WebHandler::get_url() const {
if (web_server_ && web_server_->is_running()) {
NetworkHandler* network_handler = SystemContext::instance().get_network_handler();
if (!network_handler) {
ESP_LOGE(TAG, "Network handler not available in system context");
return "";
}
WifiHandler& wifi_handler = network_handler->get_wifi_handler();
std::string device_ip = wifi_handler.get_current_ip();
if (device_ip.empty()) {
ESP_LOGW(TAG, "Device not connected to WiFi");
return "";
}
uint16_t port = web_server_->get_port();
std::ostringstream url;
url << "http://" << device_ip << ":" << port << "/?auth=" << auth_key_;
return url.str();
}
return "";
}
std::string WebHandler::get_device_ip() const {
if (web_server_ && web_server_->is_running()) {
NetworkHandler* network_handler = SystemContext::instance().get_network_handler();
if (!network_handler) {
ESP_LOGE(TAG, "Network handler not available in system context");
return "";
}
WifiHandler& wifi_handler = network_handler->get_wifi_handler();
return wifi_handler.get_current_ip();
}
return "";
}
uint16_t WebHandler::get_port() const {
if (web_server_ && web_server_->is_running()) {
return web_server_->get_port();
}
return 0;
}
//
//
//
std::string WebHandler::generate_auth_key_() {
// Generate 128-bit random key using ESP32 hardware RNG
uint32_t rand_values[4];
for (int i = 0; i < 4; i++) {
rand_values[i] = esp_random();
}
// Convert to hex string
std::ostringstream oss;
oss << std::hex << std::setfill('0');
for (int i = 0; i < 4; i++) {
oss << std::setw(8) << rand_values[i];
}
return oss.str();
}
esp_err_t WebHandler::register_web_endpoints_() {
if (!web_server_ || !web_server_->is_running()) {
return ESP_FAIL;
}
// GET / - Serve settings page
httpd_uri_t settings_page_uri = {
.uri = "/",
.method = HTTP_GET,
.handler = settings_page_handler_,
.user_ctx = this
};
web_server_->register_uri_handler(&settings_page_uri);
// POST /save - Save settings
httpd_uri_t save_settings_uri = {
.uri = "/save",
.method = HTTP_POST,
.handler = save_settings_handler_,
.user_ctx = this
};
web_server_->register_uri_handler(&save_settings_uri);
// POST /test - Test connection
httpd_uri_t test_connection_uri = {
.uri = "/test",
.method = HTTP_POST,
.handler = test_connection_handler_,
.user_ctx = this
};
web_server_->register_uri_handler(&test_connection_uri);
return ESP_OK;
}
esp_err_t WebHandler::settings_page_handler_(httpd_req_t* req) {
WebHandler* self = static_cast<WebHandler*>(req->user_ctx);
// Validate auth
size_t query_len = httpd_req_get_url_query_len(req);
if (query_len == 0) {
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Unauthorized");
return ESP_FAIL;
}
char* query = new char[query_len + 1];
if (httpd_req_get_url_query_str(req, query, query_len + 1) != ESP_OK) {
delete[] query;
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Bad Request");
return ESP_FAIL;
}
if (!self->web_server_->validate_auth(query)) {
delete[] query;
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Unauthorized");
return ESP_FAIL;
}
delete[] query;
// Get current settings (access private members via friend)
std::string current_ip = self->setting_handler_->get_remote_ip();
uint16_t current_port = self->setting_handler_->get_remote_port();
uint16_t current_local_port = self->setting_handler_->get_local_port();
// Build HTML page
std::ostringstream html;
html << "<!DOCTYPE html><html><head>"
<< "<meta name='viewport' content='width=device-width, initial-scale=1'>"
<< "<title>Discord Bridge Settings</title>"
<< "<style>"
<< "body{font-family:Arial,sans-serif;max-width:600px;margin:50px auto;padding:20px;}"
<< "h1{color:#333;}"
<< "label{display:block;margin-top:15px;font-weight:bold;}"
<< "input{width:100%;padding:10px;margin-top:5px;box-sizing:border-box;font-size:16px;}"
<< "button{width:100%;padding:12px;margin-top:20px;font-size:16px;cursor:pointer;}"
<< ".btn-primary{background:#4CAF50;color:white;border:none;}"
<< ".btn-secondary{background:#008CBA;color:white;border:none;}"
<< "#result{margin-top:20px;padding:10px;border-radius:5px;display:none;}"
<< ".success{background:#d4edda;color:#155724;border:1px solid #c3e6cb;}"
<< ".error{background:#f8d7da;color:#721c24;border:1px solid #f5c6cb;}"
<< "</style></head><body>"
<< "<h1>Discord Bridge Settings</h1>"
<< "<form id='settingsForm'>"
<< "<label for='ip'>Bridge IP Address:</label>"
<< "<input type='text' id='ip' name='ip' placeholder='e.g., 192.168.1.100' value='" << current_ip << "' required>"
<< "<label for='port'>Bridge Port:</label>"
<< "<input type='number' id='port' name='port' placeholder='e.g., 4211' value='" << current_port << "' required min='1' max='65535'>"
<< "<label for='localPort'>ESP32 Local Port:</label>"
<< "<input type='number' id='localPort' name='localPort' placeholder='e.g., 4212' value='" << current_local_port << "' required min='1' max='65535'>"
<< "<button type='button' class='btn-secondary' onclick='testConnection()'>Test Connection</button>"
<< "<button type='submit' class='btn-primary'>Save Settings</button>"
<< "</form>"
<< "<div id='result'></div>"
<< "<script>"
<< "const form=document.getElementById('settingsForm');"
<< "const result=document.getElementById('result');"
<< "function showResult(msg,isSuccess){"
<< "result.textContent=msg;"
<< "result.className=isSuccess?'success':'error';"
<< "result.style.display='block';"
<< "}"
<< "function testConnection(){"
<< "const ip=document.getElementById('ip').value;"
<< "const port=document.getElementById('port').value;"
<< "const localPort=document.getElementById('localPort').value;"
<< "if(!ip||!port||!localPort){showResult('Please fill all fields',false);return;}"
<< "showResult('Testing connection...',false);"
<< "fetch('/test',{method:'POST',headers:{'Content-Type':'application/x-www-form-urlencoded'},"
<< "body:'ip='+encodeURIComponent(ip)+'&port='+encodeURIComponent(port)+'&localPort='+encodeURIComponent(localPort)})"
<< ".then(r=>r.json()).then(data=>showResult(data.message,data.success))"
<< ".catch(()=>showResult('Request failed',false));"
<< "}"
<< "form.addEventListener('submit',function(e){"
<< "e.preventDefault();"
<< "const ip=document.getElementById('ip').value;"
<< "const port=document.getElementById('port').value;"
<< "const localPort=document.getElementById('localPort').value;"
<< "if(!ip||!port||!localPort){showResult('Please fill all fields',false);return;}"
<< "fetch('/save',{method:'POST',headers:{'Content-Type':'application/x-www-form-urlencoded'},"
<< "body:'ip='+encodeURIComponent(ip)+'&port='+encodeURIComponent(port)+'&localPort='+encodeURIComponent(localPort)})"
<< ".then(r=>r.json()).then(data=>{showResult(data.message,data.success);"
<< "if(data.success)setTimeout(()=>result.style.display='none',3000);})"
<< ".catch(()=>showResult('Request failed',false));"
<< "});"
<< "</script></body></html>";
std::string html_str = html.str();
httpd_resp_set_type(req, "text/html");
httpd_resp_send(req, html_str.c_str(), html_str.length());
return ESP_OK;
}
esp_err_t WebHandler::save_settings_handler_(httpd_req_t* req) {
WebHandler* self = static_cast<WebHandler*>(req->user_ctx);
// Read POST data
char* buf = new char[req->content_len + 1];
int ret = httpd_req_recv(req, buf, req->content_len);
if (ret <= 0) {
delete[] buf;
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Failed to read request");
return ESP_FAIL;
}
buf[ret] = '\0';
// Parse form data
char ip[64] = { 0 };
char port_str[8] = { 0 };
char local_port_str[8] = { 0 };
httpd_query_key_value(buf, "ip", ip, sizeof(ip));
httpd_query_key_value(buf, "port", port_str, sizeof(port_str));
httpd_query_key_value(buf, "localPort", local_port_str, sizeof(local_port_str));
delete[] buf;
if (strlen(ip) == 0 || strlen(port_str) == 0 || strlen(local_port_str) == 0) {
const char* resp = "{\"success\":false,\"message\":\"Missing fields\"}";
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, resp, strlen(resp));
return ESP_OK;
}
uint16_t port = static_cast<uint16_t>(atoi(port_str));
uint16_t local_port = static_cast<uint16_t>(atoi(local_port_str));
if (port == 0 || local_port == 0) {
const char* resp = "{\"success\":false,\"message\":\"Invalid port\"}";
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, resp, strlen(resp));
return ESP_OK;
}
// Save settings
if (self && self->setting_handler_) {
self->setting_handler_->save_settings(std::string(ip), port, local_port);
}
const char* resp = "{\"success\":true,\"message\":\"Settings saved successfully\"}";
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, resp, strlen(resp));
ESP_LOGI(TAG, "Settings saved via web interface: %s:%u (local port: %u)", ip, port, local_port);
return ESP_OK;
}
esp_err_t WebHandler::test_connection_handler_(httpd_req_t* req) {
WebHandler* self = static_cast<WebHandler*>(req->user_ctx);
IotDisBridge* bridge = self ? self->bridge_ : nullptr;
// Read POST data
char* buf = new char[req->content_len + 1];
int ret = httpd_req_recv(req, buf, req->content_len);
if (ret <= 0) {
delete[] buf;
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Failed to read request");
return ESP_FAIL;
}
buf[ret] = '\0';
// Parse form data
char ip[64] = { 0 };
char port_str[8] = { 0 };
char local_port_str[8] = { 0 };
httpd_query_key_value(buf, "ip", ip, sizeof(ip));
httpd_query_key_value(buf, "port", port_str, sizeof(port_str));
httpd_query_key_value(buf, "localPort", local_port_str, sizeof(local_port_str));
delete[] buf;
if (strlen(ip) == 0 || strlen(port_str) == 0 || strlen(local_port_str) == 0) {
const char* resp = "{\"success\":false,\"message\":\"Missing fields\"}";
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, resp, strlen(resp));
return ESP_OK;
}
uint16_t port = static_cast<uint16_t>(atoi(port_str));
uint16_t local_port = static_cast<uint16_t>(atoi(local_port_str));
if (port == 0 || local_port == 0) {
const char* resp = "{\"success\":false,\"message\":\"Invalid port\"}";
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, resp, strlen(resp));
return ESP_OK;
}
// Test connection
bool success = false;
if (bridge) {
success = bridge->test_connection(std::string(ip), port, local_port);
} else {
ESP_LOGE(TAG, "IotDisBridge pointer is null, cannot test connection");
}
const char* resp = success
? "{\"success\":true,\"message\":\"Connection successful!\"}"
: "{\"success\":false,\"message\":\"No response from bridge\"}";
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, resp, strlen(resp));
ESP_LOGI(TAG, "Connection test via web interface: %s:%u (local port: %u) - %s", ip, port, local_port, success ? "SUCCESS" : "FAILED");
return ESP_OK;
}

View File

@@ -0,0 +1,81 @@
#pragma once
#include "esp_http_server.h"
#include <string>
#include "network/web_server_handler.h"
#include "ui/apps/iotdis/settings/settings_handler.h"
#include "ui/apps/iotdis/bridge/bridge.h"
/**
* @brief HTTP request handlers for Discord Bridge settings web interface
*
* These handlers serve the web configuration page and process
* settings updates and connection tests.
*/
class WebHandler {
public:
WebHandler(
SettingHandler* setting_handler,
IotDisBridge* bridge
) :
web_server_(std::make_unique<WebServerHandler>())
, setting_handler_(setting_handler)
, bridge_(bridge) { }
~WebHandler();
esp_err_t start_web_server();
esp_err_t stop_web_server();
std::string get_url() const;
std::string get_device_ip() const;
uint16_t get_port() const;
bool is_running() const {
return web_server_ && web_server_->is_running();
}
private:
std::string generate_auth_key_();
esp_err_t register_web_endpoints_();
/**
* @brief Serve the main settings configuration page
*
* Validates authentication and serves an HTML form with current settings.
* Requires auth query parameter matching the session key.
*
* @param req HTTP request object
* @return ESP_OK on success
*/
static esp_err_t settings_page_handler_(httpd_req_t* req);
/**
* @brief Save bridge connection settings
*
* Parses POST data containing ip, port, and localPort fields.
* Validates and persists settings to NVS storage.
*
* @param req HTTP request object
* @return ESP_OK on success
*/
static esp_err_t save_settings_handler_(httpd_req_t* req);
/**
* @brief Test connection to Discord bridge
*
* Creates temporary UDP client to test connectivity with provided settings.
* Returns JSON response indicating success or failure.
*
* @param req HTTP request object
* @return ESP_OK on success
*/
static esp_err_t test_connection_handler_(httpd_req_t* req);
std::unique_ptr<WebServerHandler> web_server_;
SettingHandler* setting_handler_ = nullptr; ///< Pointer to settings handler (not owned)
std::string auth_key_;
IotDisBridge* bridge_ = nullptr; ///< Pointer to IotDisBridge (not owned)
};

11
main/ui/apps/registry.cpp Normal file
View File

@@ -0,0 +1,11 @@
#include "ui/apps/registry.h"
#include "ui/apps/iotdis/descriptor.h"
#include "ui/apps/travel/descriptor.h"
esp_err_t AppRegistry::init(void) {
register_app(std::make_unique<IotDisDescriptor>());
register_app(std::make_unique<TravelDescriptor>());
return ESP_OK;
}

59
main/ui/apps/registry.h Normal file
View File

@@ -0,0 +1,59 @@
#pragma once
#include "ui/apps/app.h"
#include <map>
#include <string>
#include "esp_log.h"
#include <memory>
class AppRegistry {
public:
static AppRegistry& instance() {
static AppRegistry registry;
return registry;
}
/**
* @brief Initialize the app registry with built-in apps
*
*/
esp_err_t init(void);
void register_app(std::unique_ptr<AppDescriptor> app_descriptor) {
if (app_descriptors_.find(app_descriptor->get_name()) != app_descriptors_.end()) {
// App already registered
ESP_LOGW("AppRegistry", "App '%s' is already registered", app_descriptor->get_name().c_str());
return;
}
app_descriptors_.emplace(app_descriptor->get_name(), std::move(app_descriptor));
}
size_t size() const {
return app_descriptors_.size();
}
// iterators to access registered apps
auto begin() { return app_descriptors_.begin(); }
auto begin() const { return app_descriptors_.begin(); }
auto end() { return app_descriptors_.end(); }
auto end() const { return app_descriptors_.end(); }
// [] operator to get app by name
AppDescriptor* operator[](const std::string& name) {
auto it = app_descriptors_.find(name);
if (it != app_descriptors_.end()) {
return it->second.get();
}
return nullptr;
}
private:
std::map<std::string, std::unique_ptr<AppDescriptor>> app_descriptors_ = {};
AppRegistry() = default;
// Disable copy and move semantics
AppRegistry(const AppRegistry&) = delete;
AppRegistry& operator=(const AppRegistry&) = delete;
AppRegistry(AppRegistry&&) = delete;
AppRegistry& operator=(AppRegistry&&) = delete;
};

View File

@@ -0,0 +1,11 @@
# Explicit list of travel app sources
list(APPEND SRCS
"${CMAKE_CURRENT_LIST_DIR}/web/web_handlers.cpp"
"${CMAKE_CURRENT_LIST_DIR}/descriptor.cpp"
"${CMAKE_CURRENT_LIST_DIR}/settings/settings_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/app.cpp"
"${CMAKE_CURRENT_LIST_DIR}/ui/settings_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/ui/settings.cpp"
"${CMAKE_CURRENT_LIST_DIR}/ui/main_handler.cpp"
"${CMAKE_CURRENT_LIST_DIR}/ui/main.cpp"
)

131
main/ui/apps/travel/app.cpp Normal file
View File

@@ -0,0 +1,131 @@
#include "ui/apps/travel/app.h"
#include "ui/apps/travel/ui/main_handler.h"
#include "ui/apps/travel/ui/settings_handler.h"
#include "common/system_context.h"
#include "esp_log.h"
static const char* TAG = "TravelApp";
TravelApp::TravelApp()
: main_ui_handler_(nullptr)
, settings_ui_handler_(nullptr)
, current_page_(Page::MAIN)
, setting_handler_(nullptr)
, network_handler_(nullptr)
, interaction_handler_(nullptr) {
setting_handler_ = std::make_unique<travel::SettingHandler>(
std::make_unique<NVSStorageHandler>(TravelApp::NVS_NAMESPACE)
);
}
TravelApp::~TravelApp() { }
esp_err_t TravelApp::init(lv_obj_t* container, InteractionHandler* interaction_handler) {
ESP_LOGI(TAG, "Initializing Travel app");
container_ = container;
interaction_handler_ = interaction_handler;
// Initialize storage
setting_handler_->init(nullptr);
// Load saved settings
setting_handler_->load_settings();
// Get network handler from system context
network_handler_ = SystemContext::instance().get_network_handler();
// Create main UI handler
main_ui_handler_ = std::make_unique<travel::MainUIHandler>();
main_ui_handler_->init(container, interaction_handler_, setting_handler_.get(), network_handler_);
// Register settings button callback
main_ui_handler_->register_on_settings_button_clicked(on_settings_button_clicked_static, this);
current_page_ = Page::MAIN;
return ESP_OK;
}
esp_err_t TravelApp::deinit() {
ESP_LOGI(TAG, "Deinitializing Travel app");
// Clean up UI handlers
if (settings_ui_handler_) {
settings_ui_handler_->deinit();
settings_ui_handler_.reset();
}
if (main_ui_handler_) {
main_ui_handler_->deinit();
main_ui_handler_.reset();
}
return ESP_OK;
}
std::string TravelApp::get_name() const {
return "Travel";
}
bool TravelApp::on_back_button_pressed() {
// If on settings page, go back to main page
if (current_page_ == Page::SETTINGS) {
// Clean up settings handler
if (settings_ui_handler_) {
settings_ui_handler_->deinit();
settings_ui_handler_.reset();
}
// Reload settings in case they were updated
setting_handler_->load_settings();
// Recreate main UI handler with updated settings
if (!main_ui_handler_) {
main_ui_handler_ = std::make_unique<travel::MainUIHandler>();
main_ui_handler_->init(container_, interaction_handler_, setting_handler_.get(), network_handler_);
main_ui_handler_->register_on_settings_button_clicked(on_settings_button_clicked_static, this);
}
current_page_ = Page::MAIN;
return true;
}
// Let system handle back (return to app icons)
return false;
}
void TravelApp::set_network_handler(NetworkHandler* network_handler) {
network_handler_ = network_handler;
}
// ============================================================================
// Private Methods
// ============================================================================
void TravelApp::show_settings_page() {
ESP_LOGI(TAG, "Showing settings page");
// Hide main UI handler
if (main_ui_handler_) {
main_ui_handler_->deinit();
main_ui_handler_.reset();
}
// Create settings UI handler
settings_ui_handler_ = std::make_unique<travel::SettingsUIHandler>();
settings_ui_handler_->init(container_, interaction_handler_, setting_handler_.get(), network_handler_);
current_page_ = Page::SETTINGS;
}
// ============================================================================
// Static Callbacks
// ============================================================================
void TravelApp::on_settings_button_clicked_static(void* user_data) {
TravelApp* app = static_cast<TravelApp*>(user_data);
if (app) {
app->show_settings_page();
}
}

72
main/ui/apps/travel/app.h Normal file
View File

@@ -0,0 +1,72 @@
#pragma once
#include "ui/apps/app.h"
#include "ui/apps/travel/settings/settings_handler.h"
#include "ui/apps/travel/ui/main_handler.h"
#include "ui/apps/travel/ui/settings_handler.h"
#include "io/nvs_handler.h"
#include "network/network.h"
#include <string>
#include <memory>
// Forward declarations
namespace travel {
class MainUIHandler;
class SettingsUIHandler;
class SettingHandler;
}
/**
* @brief Travel App - MTR Station Arrival Time Display
*
* Displays estimated arrival times for configured MTR routes.
* Features:
* - Support for all MTR lines from assets
* - Save up to 5 (station, destination) route pairs
* - Poll every 30 seconds (configurable 10-120s)
* - Traditional Chinese by default
* - E-ink optimized (no animations, static layout)
* - Web-based configuration via QR code
*/
class TravelApp : public UIApp {
public:
TravelApp();
~TravelApp() override;
esp_err_t init(lv_obj_t* container, InteractionHandler* interaction_handler) override;
esp_err_t deinit(void) override;
std::string get_name(void) const override;
bool on_back_button_pressed(void) override;
// Set network handler for API calls
void set_network_handler(NetworkHandler* network_handler);
private:
// UI handlers
std::unique_ptr<travel::MainUIHandler> main_ui_handler_;
std::unique_ptr<travel::SettingsUIHandler> settings_ui_handler_;
// Current page tracking
enum class Page {
MAIN,
SETTINGS
};
Page current_page_;
// Settings handler (shared across handlers)
std::unique_ptr<travel::SettingHandler> setting_handler_;
// Network handler (not owned, set externally)
NetworkHandler* network_handler_;
// Interaction handler (not owned)
InteractionHandler* interaction_handler_;
static constexpr const char* NVS_NAMESPACE = "travel_app";
// Private methods
void show_settings_page();
// UI callback forwarders
static void on_settings_button_clicked_static(void* user_data);
};

View File

@@ -0,0 +1,12 @@
#include "ui/apps/travel/descriptor.h"
#include "ui/apps/travel/app.h"
TravelDescriptor::TravelDescriptor()
: AppDescriptor("Travel", std::make_unique<TravelApp>()) { }
void TravelDescriptor::draw_icon(lv_obj_t* parent) {
// Draw train icon using LVGL symbol
lv_obj_t* icon = lv_label_create(parent);
lv_label_set_text(icon, LV_SYMBOL_DRIVE); // Using drive symbol as train
lv_obj_center(icon);
}

View File

@@ -0,0 +1,14 @@
#pragma once
#include "ui/apps/app.h"
// Forward declaration
class TravelApp;
class TravelDescriptor : public AppDescriptor {
public:
TravelDescriptor();
~TravelDescriptor() override = default;
void draw_icon(lv_obj_t* parent) override;
};

View File

@@ -0,0 +1,171 @@
#include "ui/apps/travel/settings/settings_handler.h"
#include "cJSON.h"
#include "esp_log.h"
static const char* TAG = "TravelSettings";
namespace travel {
SettingHandler::SettingHandler(std::unique_ptr<NVSStorageHandler> storage)
: routes_()
, polling_interval_sec_(DEFAULT_POLLING_INTERVAL)
, storage_(std::move(storage)) {
}
esp_err_t SettingHandler::init(const EventGroupHandle_t& system_event_group) {
storage_->init(system_event_group);
return ESP_OK;
}
void SettingHandler::load_settings() {
// Load polling interval
std::string poll_str = storage_->get(NVS_KEY_POLLING);
if (!poll_str.empty()) {
polling_interval_sec_ = std::stoul(poll_str);
if (polling_interval_sec_ < MIN_POLLING_INTERVAL ||
polling_interval_sec_ > MAX_POLLING_INTERVAL) {
polling_interval_sec_ = DEFAULT_POLLING_INTERVAL;
}
}
// Load routes - clear existing settings as per new format
routes_.clear();
std::string routes_json = storage_->get(NVS_KEY_ROUTES);
if (!routes_json.empty()) {
routes_from_json(routes_json);
}
ESP_LOGI(TAG, "Loaded %d routes, polling interval: %d seconds",
static_cast<int>(routes_.size()), static_cast<int>(polling_interval_sec_));
}
void SettingHandler::save_settings() {
// Save polling interval
storage_->put(NVS_KEY_POLLING, std::to_string(polling_interval_sec_));
// Save routes
std::string routes_json = routes_to_json();
storage_->put(NVS_KEY_ROUTES, routes_json);
ESP_LOGI(TAG, "Saved %d routes, polling interval: %d seconds",
static_cast<int>(routes_.size()), static_cast<int>(polling_interval_sec_));
}
void SettingHandler::add_route(const RoutePair& route) {
if (routes_.size() >= MAX_ROUTES) {
ESP_LOGW(TAG, "Maximum number of routes reached (%d)", static_cast<int>(MAX_ROUTES));
return;
}
// Check for duplicates
for (const auto& existing : routes_) {
if (existing == route) {
ESP_LOGW(TAG, "Route already exists");
return;
}
}
routes_.push_back(route);
ESP_LOGI(TAG, "Added route: %s -> %s", route.station_name.c_str(), route.direction_name.c_str());
}
void SettingHandler::remove_route(size_t index) {
if (index < routes_.size()) {
ESP_LOGI(TAG, "Removing route at index %d", static_cast<int>(index));
routes_.erase(routes_.begin() + index);
}
}
void SettingHandler::clear_routes() {
routes_.clear();
ESP_LOGI(TAG, "Cleared all routes");
}
void SettingHandler::set_polling_interval(uint32_t seconds) {
if (seconds < MIN_POLLING_INTERVAL) {
seconds = MIN_POLLING_INTERVAL;
} else if (seconds > MAX_POLLING_INTERVAL) {
seconds = MAX_POLLING_INTERVAL;
}
polling_interval_sec_ = seconds;
ESP_LOGI(TAG, "Set polling interval to %d seconds", static_cast<int>(seconds));
}
std::string SettingHandler::routes_to_json() const {
cJSON* root = cJSON_CreateArray();
for (const auto& route : routes_) {
cJSON* route_obj = cJSON_CreateObject();
cJSON_AddStringToObject(route_obj, "line_code", route.line_code.c_str());
cJSON_AddStringToObject(route_obj, "line_name", route.line_name.c_str());
cJSON_AddStringToObject(route_obj, "line_color", route.line_color.c_str());
cJSON_AddStringToObject(route_obj, "station_code", route.station_code.c_str());
cJSON_AddStringToObject(route_obj, "station_name", route.station_name.c_str());
cJSON_AddStringToObject(route_obj, "direction", route.direction.c_str());
cJSON_AddStringToObject(route_obj, "direction_name", route.direction_name.c_str());
cJSON_AddItemToArray(root, route_obj);
}
char* json_str = cJSON_PrintUnformatted(root);
std::string result(json_str ? json_str : "[]");
if (json_str) {
free(json_str);
}
cJSON_Delete(root);
return result;
}
void SettingHandler::routes_from_json(const std::string& json) {
routes_.clear();
cJSON* root = cJSON_Parse(json.c_str());
if (!root || !cJSON_IsArray(root)) {
ESP_LOGE(TAG, "Failed to parse routes JSON");
if (root) {
cJSON_Delete(root);
}
return;
}
int array_size = cJSON_GetArraySize(root);
for (int i = 0; i < array_size && i < static_cast<int>(MAX_ROUTES); i++) {
cJSON* route_obj = cJSON_GetArrayItem(root, i);
if (!route_obj || !cJSON_IsObject(route_obj)) {
continue;
}
RoutePair route;
cJSON* item;
item = cJSON_GetObjectItem(route_obj, "line_code");
if (item && cJSON_IsString(item)) route.line_code = item->valuestring;
item = cJSON_GetObjectItem(route_obj, "line_name");
if (item && cJSON_IsString(item)) route.line_name = item->valuestring;
item = cJSON_GetObjectItem(route_obj, "line_color");
if (item && cJSON_IsString(item)) route.line_color = item->valuestring;
item = cJSON_GetObjectItem(route_obj, "station_code");
if (item && cJSON_IsString(item)) route.station_code = item->valuestring;
item = cJSON_GetObjectItem(route_obj, "station_name");
if (item && cJSON_IsString(item)) route.station_name = item->valuestring;
item = cJSON_GetObjectItem(route_obj, "direction");
if (item && cJSON_IsString(item)) route.direction = item->valuestring;
item = cJSON_GetObjectItem(route_obj, "direction_name");
if (item && cJSON_IsString(item)) route.direction_name = item->valuestring;
if (!route.line_code.empty() && !route.station_code.empty() && !route.direction.empty()) {
routes_.push_back(route);
}
}
cJSON_Delete(root);
ESP_LOGI(TAG, "Loaded %d routes from JSON", static_cast<int>(routes_.size()));
}
} // namespace travel

View File

@@ -0,0 +1,58 @@
#pragma once
#include "freertos/FreeRTOS.h"
#include <string>
#include <vector>
#include <memory>
#include "io/nvs_handler.h"
#include "ui/apps/travel/types.h"
namespace travel {
/**
* @brief Settings handler for Travel app
*
* Manages NVS persistence of route pairs and polling interval.
*/
class SettingHandler {
public:
explicit SettingHandler(std::unique_ptr<NVSStorageHandler> storage);
~SettingHandler() = default;
esp_err_t init(const EventGroupHandle_t& system_event_group);
void load_settings();
void save_settings();
bool is_configured() const { return !routes_.empty(); }
// Route management
void add_route(const RoutePair& route);
void remove_route(size_t index);
void clear_routes();
const std::vector<RoutePair>& get_routes() const { return routes_; }
size_t get_route_count() const { return routes_.size(); }
// Polling interval (seconds)
uint32_t get_polling_interval() const { return polling_interval_sec_; }
void set_polling_interval(uint32_t seconds);
static constexpr size_t MAX_ROUTES = 5;
static constexpr uint32_t DEFAULT_POLLING_INTERVAL = 30;
static constexpr uint32_t MIN_POLLING_INTERVAL = 10;
static constexpr uint32_t MAX_POLLING_INTERVAL = 120;
private:
static constexpr const char* NVS_KEY_ROUTES = "routes";
static constexpr const char* NVS_KEY_POLLING = "poll_interval";
std::vector<RoutePair> routes_;
uint32_t polling_interval_sec_ = DEFAULT_POLLING_INTERVAL;
std::unique_ptr<NVSStorageHandler> storage_;
// JSON serialization helpers
std::string routes_to_json() const;
void routes_from_json(const std::string& json);
};
} // namespace travel

View File

@@ -0,0 +1,47 @@
#pragma once
#include <string>
#include <vector>
namespace travel {
/**
* @brief Structure representing a monitored route (station -> direction pair)
*/
struct RoutePair {
std::string line_code; // Line code (e.g., "ISL", "TWL")
std::string line_name; // Line name in Traditional Chinese (e.g., "港島綫")
std::string line_color; // Hex color code (e.g., "#007DC5")
std::string station_code; // Station code (e.g., "CEN")
std::string station_name; // Station name in TC (e.g., "中環")
std::string direction; // Direction terminal code (e.g., "CHW" for "柴灣方向")
std::string direction_name; // Direction name in TC (e.g., "柴灣方向")
bool operator==(const RoutePair& other) const {
return line_code == other.line_code &&
station_code == other.station_code &&
direction == other.direction;
}
};
/**
* @brief Structure representing a single arrival display entry
*/
struct ArrivalDisplay {
std::string arrival_time; // Formatted arrival time (e.g., "2分鐘")
std::string arrival_time_full; // Full time (e.g., "14:32") if available
std::string direction; // Direction terminal name (e.g., "柴灣方向")
std::string platform; // Platform number if available
};
/**
* @brief Structure representing all arrival data for a route
*/
struct RouteArrivalData {
RoutePair route;
std::vector<ArrivalDisplay> arrivals; // List of upcoming trains in direction
bool is_valid = false;
std::string error_message;
};
} // namespace travel

View File

@@ -0,0 +1,321 @@
#include "ui/apps/travel/ui/main.h"
#include "display/lvgl_handler.h"
#include "font/noto_sans_tc_14.c"
#include "esp_log.h"
static const char* TAG = "TravelMainUI";
#define LVGL_PORT_LOCK_TIMEOUT_MS 6000
namespace travel {
MainUI::MainUI() = default;
MainUI::~MainUI() {
deinit();
}
esp_err_t MainUI::init(lv_obj_t* parent) {
if (!parent) {
ESP_LOGE(TAG, "Parent is null");
return ESP_ERR_INVALID_ARG;
}
parent_ = parent;
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_PORT_LOCK_TIMEOUT_MS))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return ESP_ERR_TIMEOUT;
}
// Create main container
container_ = lv_obj_create(parent_);
lv_obj_set_size(container_, LV_PCT(100), LV_PCT(100));
lv_obj_set_flex_flow(container_, LV_FLEX_FLOW_COLUMN);
lv_obj_set_flex_align(container_, LV_FLEX_ALIGN_START, LV_FLEX_ALIGN_START, LV_FLEX_ALIGN_START);
lv_obj_set_style_pad_all(container_, 5, 0);
lv_obj_set_style_bg_opa(container_, LV_OPA_TRANSP, 0);
lv_obj_set_style_border_width(container_, 0, 0);
// Disable animations and scrolling for e-ink
lv_obj_set_style_anim_time(container_, 0, 0);
lv_obj_clear_flag(container_, LV_OBJ_FLAG_SCROLLABLE);
create_header_();
create_route_displays_();
// Message label for errors/empty state
msg_label_ = lv_label_create(container_);
lv_obj_set_width(msg_label_, LV_PCT(100));
lv_label_set_text(msg_label_, "");
lv_obj_set_style_text_font(msg_label_, &noto_sans_tc_14, 0);
lv_obj_add_flag(msg_label_, LV_OBJ_FLAG_HIDDEN);
// Refresh time label at bottom
refresh_time_label_ = lv_label_create(container_);
lv_obj_set_width(refresh_time_label_, LV_PCT(100));
lv_label_set_text(refresh_time_label_, "");
lv_obj_set_style_text_font(refresh_time_label_, &noto_sans_tc_14, 0);
lv_obj_set_style_text_color(refresh_time_label_, lv_color_black(), 0);
lvgl_port_unlock();
return ESP_OK;
}
esp_err_t MainUI::deinit() {
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_PORT_LOCK_TIMEOUT_MS))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return ESP_ERR_TIMEOUT;
}
if (container_) {
lv_obj_del(container_);
container_ = nullptr;
}
// Reset all pointers
header_label_ = nullptr;
settings_btn_ = nullptr;
refresh_time_label_ = nullptr;
msg_label_ = nullptr;
for (auto& display : route_displays_) {
display.container = nullptr;
display.header = nullptr;
for (int i = 0; i < MAX_ARRIVALS_PER_ROUTE; i++) {
display.arrival_labels[i] = nullptr;
}
}
lvgl_port_unlock();
parent_ = nullptr;
return ESP_OK;
}
void MainUI::create_header_() {
// Header container
lv_obj_t* header = lv_obj_create(container_);
lv_obj_set_size(header, LV_PCT(100), 35);
lv_obj_set_flex_flow(header, LV_FLEX_FLOW_ROW);
lv_obj_set_flex_align(header, LV_FLEX_ALIGN_SPACE_BETWEEN, LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_CENTER);
lv_obj_set_style_pad_hor(header, 5, 0);
lv_obj_set_style_bg_opa(header, LV_OPA_TRANSP, 0);
lv_obj_set_style_border_width(header, 0, 0);
lv_obj_set_style_border_width(header, 1, 0);
lv_obj_set_style_border_side(header, LV_BORDER_SIDE_BOTTOM, 0);
lv_obj_set_style_border_color(header, lv_color_black(), 0);
lv_obj_set_style_anim_time(header, 0, 0);
lv_obj_clear_flag(header, LV_OBJ_FLAG_SCROLLABLE);
// Title label
header_label_ = lv_label_create(header);
lv_label_set_text(header_label_, "MTR到站時間");
lv_obj_set_style_text_font(header_label_, &noto_sans_tc_14, 0);
// Settings button
settings_btn_ = lv_btn_create(header);
lv_obj_set_size(settings_btn_, 30, 30);
lv_obj_t* btn_label = lv_label_create(settings_btn_);
lv_label_set_text(btn_label, LV_SYMBOL_SETTINGS);
lv_obj_center(btn_label);
lv_obj_set_style_anim_time(settings_btn_, 0, 0);
}
void MainUI::create_route_displays_() {
for (int i = 0; i < MAX_DISPLAY_ROUTES; i++) {
RouteDisplay& display = route_displays_[i];
// Container for each route
display.container = lv_obj_create(container_);
lv_obj_set_size(display.container, LV_PCT(100), LV_SIZE_CONTENT);
lv_obj_set_flex_flow(display.container, LV_FLEX_FLOW_COLUMN);
lv_obj_set_style_pad_all(display.container, 3, 0);
lv_obj_set_style_bg_opa(display.container, LV_OPA_TRANSP, 0);
lv_obj_set_style_border_width(display.container, 0, 0);
lv_obj_set_style_border_width(display.container, 1, 0);
lv_obj_set_style_border_side(display.container, LV_BORDER_SIDE_BOTTOM, 0);
lv_obj_set_style_border_color(display.container, lv_color_black(), 0);
lv_obj_set_style_anim_time(display.container, 0, 0);
lv_obj_clear_flag(display.container, LV_OBJ_FLAG_SCROLLABLE);
lv_obj_add_flag(display.container, LV_OBJ_FLAG_HIDDEN); // Hidden by default
// Route header (station -> destination with line color)
display.header = lv_label_create(display.container);
lv_obj_set_width(display.header, LV_PCT(100));
lv_label_set_text(display.header, "");
lv_obj_set_style_text_font(display.header, &noto_sans_tc_14, 0);
// Arrival labels (up to 3 per route)
for (int j = 0; j < MAX_ARRIVALS_PER_ROUTE; j++) {
display.arrival_labels[j] = lv_label_create(display.container);
lv_obj_set_width(display.arrival_labels[j], LV_PCT(100));
lv_label_set_text(display.arrival_labels[j], "");
lv_obj_set_style_text_font(display.arrival_labels[j], &noto_sans_tc_14, 0);
lv_obj_set_style_pad_left(display.arrival_labels[j], 10, 0);
}
}
}
void MainUI::update_arrivals(const std::vector<RouteArrivalData>& arrival_data) {
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_PORT_LOCK_TIMEOUT_MS))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return;
}
// Hide message label only if it's currently visible
if (!lv_obj_has_flag(msg_label_, LV_OBJ_FLAG_HIDDEN)) {
lv_obj_add_flag(msg_label_, LV_OBJ_FLAG_HIDDEN);
}
// Update each route display
for (int i = 0; i < MAX_DISPLAY_ROUTES; i++) {
if (i < static_cast<int>(arrival_data.size())) {
update_route_display_(route_displays_[i], arrival_data[i]);
} else {
// Hide unused route displays if currently visible
if (route_displays_[i].cached_visible) {
lv_obj_add_flag(route_displays_[i].container, LV_OBJ_FLAG_HIDDEN);
route_displays_[i].cached_visible = false;
}
}
}
lvgl_port_unlock();
}
void MainUI::update_route_display_(RouteDisplay& display, const RouteArrivalData& data) {
// Show container if hidden
if (!display.cached_visible) {
lv_obj_clear_flag(display.container, LV_OBJ_FLAG_HIDDEN);
display.cached_visible = true;
}
// Update header text (station -> direction)
std::string header_text = data.route.station_name + " -> " + data.route.direction_name;
if (header_text != display.cached_header_text) {
lv_label_set_text(display.header, header_text.c_str());
display.cached_header_text = header_text;
}
// Update line color only if changed
if (data.route.line_color != display.cached_line_color) {
if (!data.route.line_color.empty()) {
lv_color_t line_color = hex_to_lv_color_(data.route.line_color);
lv_obj_set_style_text_color(display.header, line_color, 0);
}
display.cached_line_color = data.route.line_color;
}
// Update arrival labels - only if text changed
for (int i = 0; i < MAX_ARRIVALS_PER_ROUTE; i++) {
std::string arrival_text = "";
bool should_show = (i < static_cast<int>(data.arrivals.size()));
if (should_show) {
const auto& arrival = data.arrivals[i];
arrival_text = " " + arrival.arrival_time;
if (!arrival.arrival_time_full.empty()) {
arrival_text += " (" + arrival.arrival_time_full + ")";
}
arrival_text += " " + arrival.direction;
}
if (arrival_text != display.cached_arrival_texts[i]) {
lv_label_set_text(display.arrival_labels[i], arrival_text.c_str());
display.cached_arrival_texts[i] = arrival_text;
}
// Handle visibility only if changed
if (should_show != display.cached_arrival_visible[i]) {
if (should_show) {
lv_obj_clear_flag(display.arrival_labels[i], LV_OBJ_FLAG_HIDDEN);
} else {
lv_obj_add_flag(display.arrival_labels[i], LV_OBJ_FLAG_HIDDEN);
}
display.cached_arrival_visible[i] = should_show;
}
}
// Show error if any
if (!data.is_valid && !data.error_message.empty()) {
std::string error_text = " 錯誤: " + data.error_message;
if (error_text != display.cached_arrival_texts[0]) {
lv_label_set_text(display.arrival_labels[0], error_text.c_str());
display.cached_arrival_texts[0] = error_text;
}
if (!display.cached_arrival_visible[0]) {
lv_obj_clear_flag(display.arrival_labels[0], LV_OBJ_FLAG_HIDDEN);
display.cached_arrival_visible[0] = true;
}
}
}
void MainUI::update_last_refresh_time(const std::string& time_str) {
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_PORT_LOCK_TIMEOUT_MS))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return;
}
std::string full_text = "更新: " + time_str;
if (full_text != cached_refresh_time_text) {
lv_label_set_text(refresh_time_label_, full_text.c_str());
cached_refresh_time_text = full_text;
}
lvgl_port_unlock();
}
void MainUI::show_no_routes_message() {
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_PORT_LOCK_TIMEOUT_MS))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return;
}
// Hide all route displays
for (auto& display : route_displays_) {
lv_obj_add_flag(display.container, LV_OBJ_FLAG_HIDDEN);
}
// Show message
lv_label_set_text(msg_label_, "請按右上角設定按鈕添加路線");
lv_obj_clear_flag(msg_label_, LV_OBJ_FLAG_HIDDEN);
lvgl_port_unlock();
}
void MainUI::show_error_message(const std::string& message) {
if (!lvgl_port_lock(pdMS_TO_TICKS(LVGL_PORT_LOCK_TIMEOUT_MS))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return;
}
// Hide all route displays
for (auto& display : route_displays_) {
lv_obj_add_flag(display.container, LV_OBJ_FLAG_HIDDEN);
}
// Show error message
lv_label_set_text(msg_label_, ("錯誤: " + message).c_str());
lv_obj_clear_flag(msg_label_, LV_OBJ_FLAG_HIDDEN);
lvgl_port_unlock();
}
void MainUI::register_settings_button_callback(lv_event_cb_t cb, void* user_data) {
if (settings_btn_) {
lv_obj_add_event_cb(settings_btn_, cb, LV_EVENT_CLICKED, user_data);
}
}
lv_color_t MainUI::hex_to_lv_color_(const std::string& hex_color) {
if (hex_color.length() < 7 || hex_color[0] != '#') {
return lv_color_black();
}
unsigned int r = std::stoi(hex_color.substr(1, 2), nullptr, 16);
unsigned int g = std::stoi(hex_color.substr(3, 2), nullptr, 16);
unsigned int b = std::stoi(hex_color.substr(5, 2), nullptr, 16);
return lv_color_make(r, g, b);
}
} // namespace travel

View File

@@ -0,0 +1,67 @@
#pragma once
#include "lvgl.h"
#include "esp_err.h"
#include "ui/apps/travel/types.h"
#include <vector>
#include <memory>
namespace travel {
/**
* @brief Main UI for Travel app - displays train arrivals
*
* E-ink optimized: no animations, static layout, no scrolling
*/
class MainUI {
public:
MainUI();
~MainUI();
esp_err_t init(lv_obj_t* parent);
esp_err_t deinit();
// Update display with arrival data
void update_arrivals(const std::vector<RouteArrivalData>& arrival_data);
void update_last_refresh_time(const std::string& time_str);
void show_no_routes_message();
void show_error_message(const std::string& message);
// Register settings button callback
void register_settings_button_callback(lv_event_cb_t cb, void* user_data);
private:
lv_obj_t* parent_ = nullptr;
lv_obj_t* container_ = nullptr;
lv_obj_t* header_label_ = nullptr;
lv_obj_t* settings_btn_ = nullptr;
lv_obj_t* refresh_time_label_ = nullptr;
lv_obj_t* msg_label_ = nullptr;
std::string cached_refresh_time_text;
// Route display containers (up to MAX_ROUTES)
struct RouteDisplay {
lv_obj_t* container = nullptr;
lv_obj_t* header = nullptr;
lv_obj_t* arrival_labels[3] = {nullptr, nullptr, nullptr}; // Show up to 3 arrivals per route
// Cached values for change detection
std::string cached_header_text;
std::string cached_line_color;
std::string cached_arrival_texts[3];
bool cached_arrival_visible[3] = {false, false, false};
bool cached_visible = false;
};
RouteDisplay route_displays_[5];
static constexpr int MAX_DISPLAY_ROUTES = 5;
static constexpr int MAX_ARRIVALS_PER_ROUTE = 3;
void create_header_();
void create_route_displays_();
void clear_route_display_(RouteDisplay& display);
void update_route_display_(RouteDisplay& display, const RouteArrivalData& data);
lv_color_t hex_to_lv_color_(const std::string& hex_color);
};
} // namespace travel

View File

@@ -0,0 +1,479 @@
#include "ui/apps/travel/ui/main_handler.h"
#include "display/lvgl_handler.h"
#include "external/mtr/line_info.h"
#include "esp_log.h"
#include <ctime>
#include <iomanip>
#include <sstream>
#include <algorithm>
#include <cctype>
static const char* TAG = "TravelMainHandler";
namespace travel {
// Helper functions shared by formatting routines
namespace {
// Parse an ISO 8601-like timestamp into epoch seconds (UTC).
// Supports formats like: 2024-01-15T14:30:00+08:00, 2026-02-03 23:08:22, or ...Z
bool parse_iso_to_epoch(const std::string& s, time_t& out_epoch) {
auto trim_copy = [](const std::string& in) {
size_t a = 0;
size_t b = in.size();
while (a < b && std::isspace((unsigned char)in[a])) ++a;
while (b > a && std::isspace((unsigned char)in[b - 1])) --b;
return in.substr(a, b - a);
};
std::string s_trim = trim_copy(s);
// Accept either 'T' or space (also lowercase 't') as date/time separator
size_t t_pos = s_trim.find_first_of("Tt ");
if (t_pos == std::string::npos) return false;
std::string date = trim_copy(s_trim.substr(0, t_pos));
std::string tzpart;
std::string timepart = trim_copy(s_trim.substr(t_pos + 1));
// Extract timezone (Z or +HH:MM or +HHMM or +HH)
size_t zpos = timepart.find_first_of("Zz");
if (zpos != std::string::npos) {
tzpart = "Z";
timepart = trim_copy(timepart.substr(0, zpos));
} else {
// Find first '+' or '-' AFTER the numeric time portion
size_t plus = std::string::npos;
for (size_t i = 0; i < timepart.size(); ++i) {
if (timepart[i] == '+' || timepart[i] == '-') { plus = i; break; }
}
if (plus != std::string::npos) {
tzpart = trim_copy(timepart.substr(plus));
timepart = trim_copy(timepart.substr(0, plus));
}
}
int year = 0, month = 0, day = 0;
if (sscanf(date.c_str(), "%d-%d-%d", &year, &month, &day) != 3) {
// Try alternative separators like '/'
if (sscanf(date.c_str(), "%d/%d/%d", &year, &month, &day) != 3) return false;
}
int hour = 0, min = 0, sec = 0;
// Remove fractional seconds if present (e.g., 10:34:52.123)
size_t dot = timepart.find('.');
if (dot != std::string::npos) timepart = timepart.substr(0, dot);
int time_parsed = sscanf(timepart.c_str(), "%d:%d:%d", &hour, &min, &sec);
if (time_parsed < 2) {
// Try hour only or hour:minute
if (sscanf(timepart.c_str(), "%d:%d", &hour, &min) == 2) {
sec = 0;
} else {
return false;
}
}
int parsed_offset_seconds = 0; // seconds east of UTC
bool has_tz = false;
if (!tzpart.empty()) {
has_tz = true;
if (tzpart == "Z" || tzpart == "z") {
parsed_offset_seconds = 0;
} else {
char sign = tzpart[0];
int oh = 0, om = 0;
std::string tznum = tzpart.substr(1);
// Accept +HH:MM, +HHMM, or +HH
if (sscanf(tznum.c_str(), "%d:%d", &oh, &om) == 2) {
parsed_offset_seconds = oh * 3600 + om * 60;
} else if (sscanf(tznum.c_str(), "%d", &oh) == 1) {
// If tz like 0800, interpret as HHMM when length>=3
if (tznum.size() >= 3 && tznum.find(':') == std::string::npos && tznum.size() <= 4) {
if (tznum.size() == 4) {
int hh = 0, mm = 0;
if (sscanf(tznum.c_str(), "%2d%2d", &hh, &mm) == 2) {
oh = hh; om = mm;
}
}
parsed_offset_seconds = oh * 3600 + om * 60;
} else {
parsed_offset_seconds = oh * 3600;
}
}
if (sign == '-') parsed_offset_seconds = -parsed_offset_seconds;
}
}
std::tm tm = {};
tm.tm_year = year - 1900;
tm.tm_mon = month - 1;
tm.tm_mday = day;
tm.tm_hour = hour;
tm.tm_min = min;
tm.tm_sec = sec;
tm.tm_isdst = -1;
time_t now = time(nullptr);
std::tm local_tm = *std::localtime(&now);
std::tm gm_tm = *std::gmtime(&now);
time_t local_epoch = mktime(&local_tm);
time_t gm_epoch = mktime(&gm_tm);
int local_offset = static_cast<int>(difftime(local_epoch, gm_epoch));
time_t epoch_assuming_local = mktime(&tm);
if (epoch_assuming_local == (time_t)-1) return false;
if (!has_tz) {
// No timezone provided: assume local time
out_epoch = epoch_assuming_local;
} else {
// Adjust when parsed time had a specific timezone
out_epoch = epoch_assuming_local + (local_offset - parsed_offset_seconds);
}
return true;
}
std::string format_epoch_HHMM(time_t epoch) {
std::tm at = *std::localtime(&epoch);
char buf[6];
strftime(buf, sizeof(buf), "%H:%M", &at);
return std::string(buf);
}
}
MainUIHandler::MainUIHandler()
: main_ui_(std::make_unique<MainUI>())
, mtr_handler_(std::make_unique<MTRNextTrainHandler>()) {
refresh_mutex_ = xSemaphoreCreateMutex();
}
MainUIHandler::~MainUIHandler() {
deinit();
if (refresh_mutex_) {
vSemaphoreDelete(refresh_mutex_);
}
}
esp_err_t MainUIHandler::init(
lv_obj_t* parent,
InteractionHandler* interaction_handler,
SettingHandler* setting_handler,
NetworkHandler* network_handler
) {
ESP_LOGI(TAG, "Initializing main UI handler");
setting_handler_ = setting_handler;
network_handler_ = network_handler;
// Initialize UI
esp_err_t err = main_ui_->init(parent);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to init main UI");
return err;
}
// Register settings button callback
main_ui_->register_settings_button_callback(on_settings_button_clicked_static_, this);
// Check if configured
if (!setting_handler_->is_configured()) {
main_ui_->show_no_routes_message();
return ESP_OK;
}
// Start polling task
polling_running_ = true;
BaseType_t task_created = xTaskCreate(
polling_task_,
"travel_poll",
8192,
this,
5,
&polling_task_handle_
);
if (task_created != pdPASS) {
ESP_LOGE(TAG, "Failed to create polling task");
polling_running_ = false;
return ESP_ERR_NO_MEM;
}
// Do initial refresh
fetch_and_update_arrivals_();
return ESP_OK;
}
esp_err_t MainUIHandler::deinit() {
ESP_LOGI(TAG, "Deinitializing main UI handler");
// Stop polling task
if (polling_task_handle_) {
polling_running_ = false;
// Wait for task to finish
vTaskDelay(pdMS_TO_TICKS(100));
polling_task_handle_ = nullptr;
}
// Deinit UI
if (main_ui_) {
main_ui_->deinit();
}
return ESP_OK;
}
void MainUIHandler::register_on_settings_button_clicked(SettingsButtonCallback cb, void* user_data) {
on_settings_callback_ = cb;
settings_callback_user_data_ = user_data;
}
void MainUIHandler::force_refresh() {
if (xSemaphoreTake(refresh_mutex_, pdMS_TO_TICKS(1000)) == pdTRUE) {
fetch_and_update_arrivals_();
xSemaphoreGive(refresh_mutex_);
}
}
void MainUIHandler::polling_task_(void* param) {
MainUIHandler* handler = static_cast<MainUIHandler*>(param);
while (handler->polling_running_) {
uint32_t interval_ms = handler->setting_handler_->get_polling_interval() * 1000;
if (xSemaphoreTake(handler->refresh_mutex_, pdMS_TO_TICKS(1000)) == pdTRUE) {
handler->fetch_and_update_arrivals_();
xSemaphoreGive(handler->refresh_mutex_);
}
// Delay until next poll
vTaskDelay(pdMS_TO_TICKS(interval_ms));
}
vTaskDelete(nullptr);
}
void MainUIHandler::fetch_and_update_arrivals_() {
if (!network_handler_ || !setting_handler_) {
return;
}
const auto& routes = setting_handler_->get_routes();
if (routes.empty()) {
main_ui_->show_no_routes_message();
return;
}
std::vector<RouteArrivalData> arrival_data;
for (const auto& route : routes) {
RouteArrivalData data;
data.route = route;
// Fetch arrival info from MTR API
std::string line_code = route.line_code;
std::string station_code = route.station_code;
StationArrivalInfo* arrival_info = nullptr;
MtrArrivalErrorCode error = mtr_handler_->get_next_arrival_info(
network_handler_,
line_code,
station_code,
arrival_info,
Language::TC // Traditional Chinese
);
if (error == MtrArrivalErrorCode::NONE && arrival_info) {
// Determine which direction (UP or DOWN) to filter based on terminal station
const auto* up_arrivals = arrival_info->up_arrivals();
const auto* down_arrivals = arrival_info->down_arrivals();
// Get all lines to find station positions
std::vector<LineInfo> lines = mtr_handler_->get_lines();
// Find current line and determine direction
bool filter_up = false;
bool filter_down = false;
for (const auto& line : lines) {
if (std::string(line.code()) == line_code) {
const auto* stations = line.stations();
if (stations) {
// Find index of current station and terminal station
size_t current_idx = SIZE_MAX;
size_t terminal_idx = SIZE_MAX;
for (size_t i = 0; i < stations->size(); i++) {
if (std::string(stations->at(i).code()) == station_code) {
current_idx = i;
}
if (std::string(stations->at(i).code()) == route.direction) {
terminal_idx = i;
}
}
// Determine direction: if terminal is at higher index, it's DOWN
if (current_idx != SIZE_MAX && terminal_idx != SIZE_MAX) {
if (terminal_idx > current_idx) {
filter_down = true;
} else {
filter_up = true;
}
}
}
break;
}
}
// Filter arrivals based on direction
auto process_arrivals = [&](const std::vector<ArrivalInfo>* arrivals) {
if (!arrivals) return;
for (const auto& arrival : *arrivals) {
ArrivalDisplay display;
display.arrival_time = format_arrival_time_(arrival.arrival_time());
display.arrival_time_full = format_arrival_time_full_(arrival.arrival_time());
display.direction = route.direction_name;
data.arrivals.push_back(display);
}
};
if (filter_up) {
process_arrivals(up_arrivals);
}
if (filter_down) {
process_arrivals(down_arrivals);
}
data.is_valid = true;
// Clean up
delete arrival_info;
} else {
data.is_valid = false;
switch (error) {
case MtrArrivalErrorCode::LINE_NOT_FOUND:
data.error_message = "路線不存在";
break;
case MtrArrivalErrorCode::STATION_NOT_FOUND:
data.error_message = "車站不存在";
break;
case MtrArrivalErrorCode::NO_ARRIVAL_INFO:
data.error_message = "無到站資料";
break;
default:
data.error_message = "無法連接";
break;
}
}
arrival_data.push_back(data);
}
// Update UI only if data changed
if (has_arrival_data_changed_(arrival_data)) {
main_ui_->update_arrivals(arrival_data);
cached_arrival_data_ = arrival_data;
}
main_ui_->update_last_refresh_time(get_current_time_string_());
}
std::string MainUIHandler::format_arrival_time_(const std::string& api_time) {
// Keep fallback for numeric minute strings (e.g., "0", "6", "15")
if (!api_time.empty() && std::all_of(api_time.begin(), api_time.end(), [](char c) { return std::isdigit((unsigned char)c); })) {
return api_time + "分鐘";
}
time_t arrival_epoch = 0;
if (parse_iso_to_epoch(api_time, arrival_epoch)) {
time_t now = time(nullptr);
double diff_seconds = difftime(arrival_epoch, now);
if (diff_seconds < 0) diff_seconds = 0; // already arrived -> show 0
int minutes = static_cast<int>((diff_seconds + 59) / 60); // round up
if (minutes < 60) {
return std::to_string(minutes) + "分鐘";
}
}
// Only relative minutes are returned from this function.
ESP_LOGW(TAG, "Unable to parse arrival time for relative format: %s", api_time.c_str());
return std::string();
}
std::string MainUIHandler::format_arrival_time_full_(const std::string& api_time) {
// Returns absolute time for display (e.g., "14:32")
// Returns empty string for relative times
if (api_time.length() <= 2) {
ESP_LOGW(TAG, "Arrival time appears to be relative, no full time available: %s", api_time.c_str());
return "";
}
time_t arrival_epoch = 0;
if (parse_iso_to_epoch(api_time, arrival_epoch)) {
return format_epoch_HHMM(arrival_epoch);
}
// fallback: extract HH:MM
size_t t_pos = api_time.find('T');
if (t_pos != std::string::npos && api_time.length() > t_pos + 5) {
return api_time.substr(t_pos + 1, 5);
}
ESP_LOGW(TAG, "Unable to parse arrival time for full format: %s", api_time.c_str());
return std::string();
}
std::string MainUIHandler::get_current_time_string_() {
time_t now = time(nullptr);
std::tm tm = *std::localtime(&now);
char buffer[32];
// Return absolute local date and time: YYYY-MM-DD HH:MM
strftime(buffer, sizeof(buffer), "%Y-%m-%d %H:%M", &tm);
return std::string(buffer);
}
bool MainUIHandler::has_arrival_data_changed_(const std::vector<RouteArrivalData>& new_data) {
if (new_data.size() != cached_arrival_data_.size()) {
return true;
}
for (size_t i = 0; i < new_data.size(); i++) {
const auto& new_route = new_data[i];
const auto& cached_route = cached_arrival_data_[i];
if (new_route.route.station_code != cached_route.route.station_code ||
new_route.route.direction != cached_route.route.direction ||
new_route.is_valid != cached_route.is_valid ||
new_route.error_message != cached_route.error_message) {
return true;
}
if (new_route.arrivals.size() != cached_route.arrivals.size()) {
return true;
}
for (size_t j = 0; j < new_route.arrivals.size(); j++) {
if (new_route.arrivals[j].arrival_time != cached_route.arrivals[j].arrival_time ||
new_route.arrivals[j].arrival_time_full != cached_route.arrivals[j].arrival_time_full) {
return true;
}
}
}
return false;
}
void MainUIHandler::on_settings_button_clicked_static_(lv_event_t* e) {
MainUIHandler* handler = static_cast<MainUIHandler*>(lv_event_get_user_data(e));
if (handler) {
handler->on_settings_button_clicked_();
}
}
void MainUIHandler::on_settings_button_clicked_() {
if (on_settings_callback_) {
on_settings_callback_(settings_callback_user_data_);
}
}
} // namespace travel

View File

@@ -0,0 +1,74 @@
#pragma once
#include "ui/apps/travel/ui/main.h"
#include "ui/apps/travel/settings/settings_handler.h"
#include "ui/interaction_handler.h"
#include "external/mtr/arrival.h"
#include "external/mtr/mtr.h"
#include "network/network.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/semphr.h"
#include "esp_err.h"
#include <memory>
#include <vector>
#include <atomic>
namespace travel {
/**
* @brief Main UI Handler for Travel app
*
* Manages the MainUI instance, polling task, and MTR API interactions.
* Runs a background task to periodically fetch arrival data.
*/
class MainUIHandler {
public:
// Callback type for settings button
using SettingsButtonCallback = void (*)(void* user_data);
MainUIHandler();
~MainUIHandler();
esp_err_t init(
lv_obj_t* parent,
InteractionHandler* interaction_handler,
SettingHandler* setting_handler,
NetworkHandler* network_handler
);
esp_err_t deinit();
void register_on_settings_button_clicked(SettingsButtonCallback cb, void* user_data);
void force_refresh();
private:
static void polling_task_(void* param);
static void on_settings_button_clicked_static_(lv_event_t* e);
void on_settings_button_clicked_();
void fetch_and_update_arrivals_();
bool has_arrival_data_changed_(const std::vector<RouteArrivalData>& new_data);
std::string format_arrival_time_(const std::string& api_time);
std::string format_arrival_time_full_(const std::string& api_time);
std::string get_current_time_string_();
std::unique_ptr<MainUI> main_ui_;
SettingHandler* setting_handler_ = nullptr;
NetworkHandler* network_handler_ = nullptr;
std::unique_ptr<MTRNextTrainHandler> mtr_handler_;
// Polling task
TaskHandle_t polling_task_handle_ = nullptr;
std::atomic<bool> polling_running_{false};
SemaphoreHandle_t refresh_mutex_ = nullptr;
// Callback for settings button
SettingsButtonCallback on_settings_callback_ = nullptr;
void* settings_callback_user_data_ = nullptr;
std::vector<RouteArrivalData> cached_arrival_data_;
static constexpr uint32_t LVGL_LOCK_TIMEOUT_MS = 4000;
};
} // namespace travel

View File

@@ -0,0 +1,151 @@
#include "ui/apps/travel/ui/settings.h"
#include "display/lvgl_handler.h"
#include "font/noto_sans_tc_14.c"
#include "esp_log.h"
static const char* TAG = "TravelSettingsUI";
namespace travel {
SettingsUI::SettingsUI() = default;
SettingsUI::~SettingsUI() {
deinit();
}
esp_err_t SettingsUI::init(lv_obj_t* parent) {
if (!parent) {
ESP_LOGE(TAG, "Parent is null");
return ESP_ERR_INVALID_ARG;
}
parent_ = parent;
if (!lvgl_port_lock(pdMS_TO_TICKS(1000))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return ESP_ERR_TIMEOUT;
}
// Create main container
container_ = lv_obj_create(parent_);
lv_obj_set_size(container_, LV_PCT(100), LV_PCT(100));
lv_obj_set_flex_flow(container_, LV_FLEX_FLOW_COLUMN);
lv_obj_set_flex_align(container_, LV_FLEX_ALIGN_START, LV_FLEX_ALIGN_CENTER, LV_FLEX_ALIGN_CENTER);
lv_obj_set_style_pad_all(container_, 10, 0);
lv_obj_set_style_bg_opa(container_, LV_OPA_TRANSP, 0);
lv_obj_set_style_border_width(container_, 0, 0);
// Disable animations and scrolling for e-ink
lv_obj_set_style_anim_time(container_, 0, 0);
lv_obj_clear_flag(container_, LV_OBJ_FLAG_SCROLLABLE);
// Title
title_label_ = lv_label_create(container_);
lv_label_set_text(title_label_, "設定路線");
lv_obj_set_style_text_font(title_label_, &noto_sans_tc_14, 0);
lv_obj_set_style_pad_bottom(title_label_, 10, 0);
// QR Code container
lv_obj_t* qr_container = lv_obj_create(container_);
lv_obj_set_size(qr_container, QR_CODE_SIZE + 10, QR_CODE_SIZE + 10);
lv_obj_set_style_bg_color(qr_container, lv_color_white(), 0);
lv_obj_set_style_border_width(qr_container, 2, 0);
lv_obj_set_style_border_color(qr_container, lv_color_black(), 0);
lv_obj_set_style_anim_time(qr_container, 0, 0);
lv_obj_clear_flag(qr_container, LV_OBJ_FLAG_SCROLLABLE);
// QR Code
qr_code_ = lv_qrcode_create(qr_container);
lv_qrcode_set_size(qr_code_, QR_CODE_SIZE);
lv_qrcode_set_dark_color(qr_code_, lv_color_black());
lv_qrcode_set_light_color(qr_code_, lv_color_white());
lv_obj_center(qr_code_);
// URL label
url_label_ = lv_label_create(container_);
lv_obj_set_width(url_label_, LV_PCT(100));
lv_label_set_text(url_label_, "");
lv_obj_set_style_text_font(url_label_, &noto_sans_tc_14, 0);
lv_label_set_long_mode(url_label_, LV_LABEL_LONG_WRAP);
lv_obj_set_style_text_align(url_label_, LV_TEXT_ALIGN_CENTER, 0);
lv_obj_set_style_pad_top(url_label_, 10, 0);
// Status message
status_label_ = lv_label_create(container_);
lv_obj_set_width(status_label_, LV_PCT(100));
lv_label_set_text(status_label_, "正在啟動伺服器...");
lv_obj_set_style_text_font(status_label_, &noto_sans_tc_14, 0);
lv_label_set_long_mode(status_label_, LV_LABEL_LONG_WRAP);
lv_obj_set_style_text_align(status_label_, LV_TEXT_ALIGN_CENTER, 0);
lv_obj_set_style_pad_top(status_label_, 15, 0);
// Instructions
instruction_label_ = lv_label_create(container_);
lv_obj_set_width(instruction_label_, LV_PCT(100));
lv_label_set_text(instruction_label_,
"請使用手機掃描QR碼或瀏覽器開啟網址\n"
"以設定MTR路線");
lv_obj_set_style_text_font(instruction_label_, &noto_sans_tc_14, 0);
lv_label_set_long_mode(instruction_label_, LV_LABEL_LONG_WRAP);
lv_obj_set_style_text_align(instruction_label_, LV_TEXT_ALIGN_CENTER, 0);
lv_obj_set_style_text_color(instruction_label_, lv_color_hex(0x606060), 0);
lv_obj_set_style_pad_top(instruction_label_, 15, 0);
lvgl_port_unlock();
return ESP_OK;
}
esp_err_t SettingsUI::deinit() {
if (!lvgl_port_lock(pdMS_TO_TICKS(1000))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return ESP_ERR_TIMEOUT;
}
if (container_) {
lv_obj_del(container_);
container_ = nullptr;
}
title_label_ = nullptr;
qr_code_ = nullptr;
url_label_ = nullptr;
status_label_ = nullptr;
instruction_label_ = nullptr;
lvgl_port_unlock();
parent_ = nullptr;
return ESP_OK;
}
void SettingsUI::update_qr_code(const std::string& url) {
if (!lvgl_port_lock(pdMS_TO_TICKS(1000))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return;
}
if (qr_code_) {
lv_qrcode_update(qr_code_, url.c_str(), url.length());
}
if (url_label_) {
lv_label_set_text(url_label_, url.c_str());
}
lvgl_port_unlock();
}
void SettingsUI::update_status_message(const std::string& message) {
if (!lvgl_port_lock(pdMS_TO_TICKS(1000))) {
ESP_LOGE(TAG, "Failed to acquire LVGL lock");
return;
}
if (status_label_) {
lv_label_set_text(status_label_, message.c_str());
}
lvgl_port_unlock();
}
} // namespace travel

View File

@@ -0,0 +1,38 @@
#pragma once
#include "lvgl.h"
#include "esp_err.h"
#include <string>
namespace travel {
/**
* @brief Settings UI for Travel app
*
* Displays QR code for web configuration.
* E-ink optimized: no animations, static layout.
*/
class SettingsUI {
public:
SettingsUI();
~SettingsUI();
esp_err_t init(lv_obj_t* parent);
esp_err_t deinit();
void update_qr_code(const std::string& url);
void update_status_message(const std::string& message);
private:
lv_obj_t* parent_ = nullptr;
lv_obj_t* container_ = nullptr;
lv_obj_t* title_label_ = nullptr;
lv_obj_t* qr_code_ = nullptr;
lv_obj_t* url_label_ = nullptr;
lv_obj_t* status_label_ = nullptr;
lv_obj_t* instruction_label_ = nullptr;
static constexpr int QR_CODE_SIZE = 160;
};
} // namespace travel

View File

@@ -0,0 +1,85 @@
#include "ui/apps/travel/ui/settings_handler.h"
#include "display/lvgl_handler.h"
#include "esp_log.h"
static const char* TAG = "TravelSettingsHandler";
namespace travel {
SettingsUIHandler::SettingsUIHandler()
: settings_ui_(std::make_unique<SettingsUI>())
, web_handler_(nullptr) {
}
SettingsUIHandler::~SettingsUIHandler() {
deinit();
}
esp_err_t SettingsUIHandler::init(
lv_obj_t* parent,
InteractionHandler* interaction_handler,
SettingHandler* setting_handler,
NetworkHandler* network_handler
) {
ESP_LOGI(TAG, "Initializing settings UI handler");
setting_handler_ = setting_handler;
network_handler_ = network_handler;
// Initialize UI
esp_err_t err = settings_ui_->init(parent);
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to init settings UI");
return err;
}
// Start web server
start_web_server_();
return ESP_OK;
}
esp_err_t SettingsUIHandler::deinit() {
ESP_LOGI(TAG, "Deinitializing settings UI handler");
// Stop web server
if (web_handler_) {
web_handler_->stop_web_server();
web_handler_.reset();
}
// Deinit UI
if (settings_ui_) {
settings_ui_->deinit();
}
return ESP_OK;
}
void SettingsUIHandler::start_web_server_() {
if (!setting_handler_ || !network_handler_) {
ESP_LOGE(TAG, "Cannot start web server - missing handlers");
settings_ui_->update_status_message("設定錯誤");
return;
}
// Create web handler
web_handler_ = std::make_unique<WebHandler>(setting_handler_, network_handler_);
// Start server
esp_err_t err = web_handler_->start_web_server();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to start web server: %s", esp_err_to_name(err));
settings_ui_->update_status_message("無法啟動伺服器");
return;
}
// Update QR code with URL
std::string url = web_handler_->get_url();
settings_ui_->update_qr_code(url);
settings_ui_->update_status_message("伺服器運行中");
ESP_LOGI(TAG, "Web server started at %s", url.c_str());
}
} // namespace travel

View File

@@ -0,0 +1,40 @@
#pragma once
#include "ui/apps/travel/ui/settings.h"
#include "ui/apps/travel/settings/settings_handler.h"
#include "ui/apps/travel/web/web_handlers.h"
#include "ui/interaction_handler.h"
#include "network/network.h"
#include "esp_err.h"
#include <memory>
namespace travel {
/**
* @brief Settings UI Handler for Travel app
*
* Manages the SettingsUI instance, web server, and settings persistence.
*/
class SettingsUIHandler {
public:
SettingsUIHandler();
~SettingsUIHandler();
esp_err_t init(
lv_obj_t* parent,
InteractionHandler* interaction_handler,
SettingHandler* setting_handler,
NetworkHandler* network_handler
);
esp_err_t deinit();
private:
void start_web_server_();
std::unique_ptr<SettingsUI> settings_ui_;
std::unique_ptr<WebHandler> web_handler_;
SettingHandler* setting_handler_ = nullptr;
NetworkHandler* network_handler_ = nullptr;
};
} // namespace travel

View File

@@ -0,0 +1,729 @@
#include "ui/apps/travel/web/web_handlers.h"
#include "esp_log.h"
#include "cJSON.h"
#include <cstring>
#include <sstream>
#include <iomanip>
static const char* TAG = "TravelWebHandler";
namespace travel {
WebHandler::WebHandler(
SettingHandler* setting_handler,
NetworkHandler* network_handler
)
: web_server_(std::make_unique<WebServerHandler>())
, setting_handler_(setting_handler)
, network_handler_(network_handler)
, mtr_handler_(std::make_unique<MTRNextTrainHandler>())
, auth_key_(generate_auth_key_()) {
}
WebHandler::~WebHandler() {
stop_web_server();
}
std::string WebHandler::generate_auth_key_() {
// Generate a random 16-character hex key
std::stringstream ss;
for (int i = 0; i < 8; i++) {
ss << std::hex << std::setw(2) << std::setfill('0') << (esp_random() & 0xFF);
}
return ss.str();
}
esp_err_t WebHandler::start_web_server() {
uint16_t port = web_server_->start(auth_key_, WEB_SERVER_PORT);
if (port == 0) {
ESP_LOGE(TAG, "Failed to start web server");
return ESP_FAIL;
}
esp_err_t err = register_web_endpoints_();
if (err != ESP_OK) {
ESP_LOGE(TAG, "Failed to register endpoints: %s", esp_err_to_name(err));
web_server_->stop();
return err;
}
ESP_LOGI(TAG, "Web server started on port %d", port);
return ESP_OK;
}
esp_err_t WebHandler::stop_web_server() {
if (web_server_) {
web_server_->stop();
}
return ESP_OK;
}
std::string WebHandler::get_url() const {
std::string ip = get_device_ip();
if (ip.empty()) {
return "";
}
return "http://" + ip + ":" + std::to_string(WEB_SERVER_PORT) + "/?auth=" + auth_key_;
}
std::string WebHandler::get_device_ip() const {
if (!network_handler_) {
return "";
}
return network_handler_->get_wifi_handler().get_current_ip();
}
uint16_t WebHandler::get_port() const {
return WEB_SERVER_PORT;
}
esp_err_t WebHandler::register_web_endpoints_() {
// Main settings page
httpd_uri_t settings_uri = {
.uri = "/",
.method = HTTP_GET,
.handler = settings_page_handler_,
.user_ctx = this
};
ESP_ERROR_CHECK(web_server_->register_uri_handler(&settings_uri));
// Get MTR lines
httpd_uri_t lines_uri = {
.uri = "/api/lines",
.method = HTTP_GET,
.handler = get_lines_handler_,
.user_ctx = this
};
ESP_ERROR_CHECK(web_server_->register_uri_handler(&lines_uri));
// Get saved routes
httpd_uri_t routes_uri = {
.uri = "/api/routes",
.method = HTTP_GET,
.handler = get_routes_handler_,
.user_ctx = this
};
ESP_ERROR_CHECK(web_server_->register_uri_handler(&routes_uri));
// Add route
httpd_uri_t add_route_uri = {
.uri = "/api/routes",
.method = HTTP_POST,
.handler = add_route_handler_,
.user_ctx = this
};
ESP_ERROR_CHECK(web_server_->register_uri_handler(&add_route_uri));
// Remove route
httpd_uri_t remove_route_uri = {
.uri = "/api/routes",
.method = HTTP_DELETE,
.handler = remove_route_handler_,
.user_ctx = this
};
ESP_ERROR_CHECK(web_server_->register_uri_handler(&remove_route_uri));
// Save settings (polling interval)
httpd_uri_t save_uri = {
.uri = "/api/settings",
.method = HTTP_POST,
.handler = save_settings_handler_,
.user_ctx = this
};
ESP_ERROR_CHECK(web_server_->register_uri_handler(&save_uri));
return ESP_OK;
}
esp_err_t WebHandler::settings_page_handler_(httpd_req_t* req) {
WebHandler* handler = static_cast<WebHandler*>(req->user_ctx);
// Check auth
char auth_param[33] = {0};
if (httpd_req_get_url_query_str(req, auth_param, sizeof(auth_param)) == ESP_OK) {
char auth_value[33] = {0};
if (httpd_query_key_value(auth_param, "auth", auth_value, sizeof(auth_value)) == ESP_OK) {
if (handler->auth_key_ != auth_value) {
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Unauthorized");
return ESP_FAIL;
}
} else {
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Missing auth");
return ESP_FAIL;
}
} else {
httpd_resp_send_err(req, HTTPD_401_UNAUTHORIZED, "Missing auth");
return ESP_FAIL;
}
// HTML page with inline CSS and JavaScript
const char* html = R"html(
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>MTR Travel Settings</title>
<style>
* { box-sizing: border-box; margin: 0; padding: 0; }
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
background: #f5f5f5;
padding: 20px;
max-width: 600px;
margin: 0 auto;
}
h1 { font-size: 24px; margin-bottom: 20px; color: #333; }
h2 { font-size: 18px; margin: 20px 0 10px; color: #555; }
.card {
background: white;
border-radius: 8px;
padding: 15px;
margin-bottom: 15px;
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
}
.form-group { margin-bottom: 15px; }
label { display: block; margin-bottom: 5px; font-weight: 500; color: #555; }
select, input[type="number"] {
width: 100%;
padding: 10px;
border: 1px solid #ddd;
border-radius: 4px;
font-size: 16px;
}
button {
background: #007DC5;
color: white;
border: none;
padding: 12px 20px;
border-radius: 4px;
font-size: 16px;
cursor: pointer;
width: 100%;
}
button:hover { background: #005a8c; }
button.secondary {
background: #6c757d;
}
button.danger {
background: #dc3545;
}
.route-item {
display: flex;
justify-content: space-between;
align-items: center;
padding: 10px;
background: #f8f9fa;
border-radius: 4px;
margin-bottom: 8px;
}
.route-info { flex: 1; }
.route-line {
display: inline-block;
padding: 2px 8px;
border-radius: 3px;
color: white;
font-size: 12px;
margin-right: 5px;
}
.status { margin-top: 10px; padding: 10px; border-radius: 4px; }
.status.success { background: #d4edda; color: #155724; }
.status.error { background: #f8d7da; color: #721c24; }
.slider-container {
display: flex;
align-items: center;
gap: 10px;
}
input[type="range"] { flex: 1; }
.value-display { min-width: 60px; text-align: right; }
</style>
</head>
<body>
<h1>MTR Travel </h1>
<div class="card">
<h2></h2>
<div class="form-group">
<label></label>
<select id="line_select" onchange="updateStations()">
<option value=""></option>
</select>
</div>
<div class="form-group">
<label></label>
<select id="station_select">
<option value=""></option>
</select>
</div>
<div class="form-group">
<label></label>
<select id="direction_select">
<option value=""></option>
</select>
</div>
<button onclick="addRoute()"></button>
</div>
<div class="card">
<h2></h2>
<div id="routes_list"></div>
</div>
<div class="card">
<h2></h2>
<div class="form-group">
<label></label>
<div class="slider-container">
<input type="range" id="interval_slider" min="10" max="120" value="30" step="5"
oninput="updateIntervalDisplay()">
<span class="value-display"><span id="interval_value">30</span> 秒</span>
</div>
</div>
<button onclick="saveSettings()"></button>
</div>
<div id="status"></div>
<script>
let linesData = [];
let routesData = [];
// Load initial data
async function init() {
await loadLines();
await loadRoutes();
updateIntervalDisplay();
}
async function loadLines() {
try {
const response = await fetch('/api/lines');
linesData = await response.json();
const select = document.getElementById('line_select');
select.innerHTML = '<option value=""></option>';
linesData.forEach(line => {
const option = document.createElement('option');
option.value = line.code;
option.textContent = line.name;
select.appendChild(option);
});
} catch (err) {
showStatus('', 'error');
}
}
async function loadRoutes() {
try {
const response = await fetch('/api/routes');
const data = await response.json();
routesData = data.routes || [];
document.getElementById('interval_slider').value = data.polling_interval || 30;
renderRoutes();
} catch (err) {
showStatus('', 'error');
}
}
function updateStations() {
const lineCode = document.getElementById('line_select').value;
const stationSelect = document.getElementById('station_select');
const directionSelect = document.getElementById('direction_select');
if (!lineCode) {
stationSelect.innerHTML = '<option value=""></option>';
directionSelect.innerHTML = '<option value=""></option>';
return;
}
const line = linesData.find(l => l.code === lineCode);
if (!line) return;
const stationsHtml = line.stations.map(s =>
`<option value="${s.code}">${s.name}</option>`
).join('');
stationSelect.innerHTML = '<option value=""></option>' + stationsHtml;
const stations = line.stations;
if (stations.length >= 2) {
const firstStation = stations[0];
const lastStation = stations[stations.length - 1];
const directionsHtml =
`<option value="${firstStation.code}">${firstStation.name}</option>` +
`<option value="${lastStation.code}">${lastStation.name}</option>`;
directionSelect.innerHTML = '<option value=""></option>' + directionsHtml;
} else {
directionSelect.innerHTML = '<option value=""></option>';
}
}
function renderRoutes() {
const container = document.getElementById('routes_list');
if (routesData.length === 0) {
container.innerHTML = '<p style="color: #666;"></p>';
return;
}
container.innerHTML = routesData.map((route, index) => `
<div class="route-item">
<div class="route-info">
<span class="route-line" style="background: ${route.line_color}">${route.line_name}</span>
${route.station_name} ${route.direction_name}
</div>
<button class="danger" style="width: auto; padding: 5px 10px;"
onclick="removeRoute(${index})"></button>
</div>
`).join('');
}
async function addRoute() {
const lineCode = document.getElementById('line_select').value;
const stationCode = document.getElementById('station_select').value;
const directionCode = document.getElementById('direction_select').value;
if (!lineCode || !stationCode || !directionCode) {
showStatus('', 'error');
return;
}
if (stationCode === directionCode) {
showStatus('', 'error');
return;
}
const line = linesData.find(l => l.code === lineCode);
const station = line.stations.find(s => s.code === stationCode);
const direction = line.stations.find(s => s.code === directionCode);
const route = {
line_code: lineCode,
line_name: line.name,
line_color: line.color,
station_code: stationCode,
station_name: station.name,
direction: directionCode,
direction_name: direction.name + ''
};
try {
const response = await fetch('/api/routes', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(route)
});
if (response.ok) {
showStatus('', 'success');
await loadRoutes();
} else {
const err = await response.text();
showStatus(': ' + err, 'error');
}
} catch (err) {
showStatus('', 'error');
}
}
async function removeRoute(index) {
try {
const response = await fetch('/api/routes', {
method: 'DELETE',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ index: index })
});
if (response.ok) {
showStatus('', 'success');
await loadRoutes();
} else {
showStatus('', 'error');
}
} catch (err) {
showStatus('', 'error');
}
}
function updateIntervalDisplay() {
const value = document.getElementById('interval_slider').value;
document.getElementById('interval_value').textContent = value;
}
async function saveSettings() {
const interval = parseInt(document.getElementById('interval_slider').value);
try {
const response = await fetch('/api/settings', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ polling_interval: interval })
});
if (response.ok) {
showStatus('', 'success');
} else {
showStatus('', 'error');
}
} catch (err) {
showStatus('', 'error');
}
}
function showStatus(message, type) {
const statusDiv = document.getElementById('status');
statusDiv.className = 'status ' + type;
statusDiv.textContent = message;
setTimeout(() => {
statusDiv.className = '';
statusDiv.textContent = '';
}, 3000);
}
init();
</script>
</body>
</html>
)html";
httpd_resp_set_type(req, "text/html");
httpd_resp_send(req, html, strlen(html));
return ESP_OK;
}
esp_err_t WebHandler::get_lines_handler_(httpd_req_t* req) {
WebHandler* handler = static_cast<WebHandler*>(req->user_ctx);
// Get all lines from MTR handler
std::vector<LineInfo> lines = handler->mtr_handler_->get_lines();
cJSON* root = cJSON_CreateArray();
for (const auto& line : lines) {
cJSON* line_obj = cJSON_CreateObject();
cJSON_AddStringToObject(line_obj, "code", line.code());
cJSON_AddStringToObject(line_obj, "name", line.name());
cJSON_AddStringToObject(line_obj, "color", line.color());
// Add stations
cJSON* stations_arr = cJSON_CreateArray();
const auto* stations = line.stations();
if (stations) {
for (const auto& station : *stations) {
cJSON* station_obj = cJSON_CreateObject();
cJSON_AddStringToObject(station_obj, "code", station.code());
cJSON_AddStringToObject(station_obj, "name", station.name());
cJSON_AddItemToArray(stations_arr, station_obj);
}
}
cJSON_AddItemToObject(line_obj, "stations", stations_arr);
cJSON_AddItemToArray(root, line_obj);
}
char* json_str = cJSON_PrintUnformatted(root);
cJSON_Delete(root);
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, json_str ? json_str : "[]", json_str ? strlen(json_str) : 2);
if (json_str) {
free(json_str);
}
return ESP_OK;
}
esp_err_t WebHandler::get_routes_handler_(httpd_req_t* req) {
WebHandler* handler = static_cast<WebHandler*>(req->user_ctx);
cJSON* root = cJSON_CreateObject();
// Add routes
cJSON* routes_arr = cJSON_CreateArray();
const auto& routes = handler->setting_handler_->get_routes();
for (const auto& route : routes) {
cJSON* route_obj = cJSON_CreateObject();
cJSON_AddStringToObject(route_obj, "line_code", route.line_code.c_str());
cJSON_AddStringToObject(route_obj, "line_name", route.line_name.c_str());
cJSON_AddStringToObject(route_obj, "line_color", route.line_color.c_str());
cJSON_AddStringToObject(route_obj, "station_code", route.station_code.c_str());
cJSON_AddStringToObject(route_obj, "station_name", route.station_name.c_str());
cJSON_AddStringToObject(route_obj, "direction", route.direction.c_str());
cJSON_AddStringToObject(route_obj, "direction_name", route.direction_name.c_str());
cJSON_AddItemToArray(routes_arr, route_obj);
}
cJSON_AddItemToObject(root, "routes", routes_arr);
// Add polling interval
cJSON_AddNumberToObject(root, "polling_interval", handler->setting_handler_->get_polling_interval());
char* json_str = cJSON_PrintUnformatted(root);
cJSON_Delete(root);
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, json_str ? json_str : "{}", json_str ? strlen(json_str) : 2);
if (json_str) {
free(json_str);
}
return ESP_OK;
}
esp_err_t WebHandler::add_route_handler_(httpd_req_t* req) {
WebHandler* handler = static_cast<WebHandler*>(req->user_ctx);
// Read request body
char buf[512];
int received = 0;
int remaining = req->content_len;
std::string body;
while (remaining > 0) {
received = httpd_req_recv(req, buf, std::min(remaining, (int)sizeof(buf) - 1));
if (received <= 0) {
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Failed to read request");
return ESP_FAIL;
}
buf[received] = '\0';
body += buf;
remaining -= received;
}
// Parse JSON
cJSON* root = cJSON_Parse(body.c_str());
if (!root) {
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Invalid JSON");
return ESP_FAIL;
}
RoutePair route;
cJSON* item;
item = cJSON_GetObjectItem(root, "line_code");
if (item && cJSON_IsString(item)) route.line_code = item->valuestring;
item = cJSON_GetObjectItem(root, "line_name");
if (item && cJSON_IsString(item)) route.line_name = item->valuestring;
item = cJSON_GetObjectItem(root, "line_color");
if (item && cJSON_IsString(item)) route.line_color = item->valuestring;
item = cJSON_GetObjectItem(root, "station_code");
if (item && cJSON_IsString(item)) route.station_code = item->valuestring;
item = cJSON_GetObjectItem(root, "station_name");
if (item && cJSON_IsString(item)) route.station_name = item->valuestring;
item = cJSON_GetObjectItem(root, "direction");
if (item && cJSON_IsString(item)) route.direction = item->valuestring;
item = cJSON_GetObjectItem(root, "direction_name");
if (item && cJSON_IsString(item)) route.direction_name = item->valuestring;
cJSON_Delete(root);
if (route.line_code.empty() || route.station_code.empty() || route.direction.empty()) {
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Missing required fields");
return ESP_FAIL;
}
// Add route
handler->setting_handler_->add_route(route);
handler->setting_handler_->save_settings();
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, "{\"success\":true}", 16);
return ESP_OK;
}
esp_err_t WebHandler::remove_route_handler_(httpd_req_t* req) {
WebHandler* handler = static_cast<WebHandler*>(req->user_ctx);
// Read request body
char buf[128];
int received = 0;
int remaining = req->content_len;
std::string body;
while (remaining > 0) {
received = httpd_req_recv(req, buf, std::min(remaining, (int)sizeof(buf) - 1));
if (received <= 0) {
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Failed to read request");
return ESP_FAIL;
}
buf[received] = '\0';
body += buf;
remaining -= received;
}
// Parse JSON
cJSON* root = cJSON_Parse(body.c_str());
if (!root) {
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Invalid JSON");
return ESP_FAIL;
}
cJSON* index_item = cJSON_GetObjectItem(root, "index");
if (!index_item || !cJSON_IsNumber(index_item)) {
cJSON_Delete(root);
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Missing index");
return ESP_FAIL;
}
int index = index_item->valueint;
cJSON_Delete(root);
handler->setting_handler_->remove_route(index);
handler->setting_handler_->save_settings();
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, "{\"success\":true}", 16);
return ESP_OK;
}
esp_err_t WebHandler::save_settings_handler_(httpd_req_t* req) {
WebHandler* handler = static_cast<WebHandler*>(req->user_ctx);
// Read request body
char buf[256];
int received = 0;
int remaining = req->content_len;
std::string body;
while (remaining > 0) {
received = httpd_req_recv(req, buf, std::min(remaining, (int)sizeof(buf) - 1));
if (received <= 0) {
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Failed to read request");
return ESP_FAIL;
}
buf[received] = '\0';
body += buf;
remaining -= received;
}
// Parse JSON
cJSON* root = cJSON_Parse(body.c_str());
if (!root) {
httpd_resp_send_err(req, HTTPD_400_BAD_REQUEST, "Invalid JSON");
return ESP_FAIL;
}
cJSON* interval_item = cJSON_GetObjectItem(root, "polling_interval");
if (interval_item && cJSON_IsNumber(interval_item)) {
uint32_t interval = interval_item->valueint;
handler->setting_handler_->set_polling_interval(interval);
}
cJSON_Delete(root);
handler->setting_handler_->save_settings();
httpd_resp_set_type(req, "application/json");
httpd_resp_send(req, "{\"success\":true}", 16);
return ESP_OK;
}
} // namespace travel

View File

@@ -0,0 +1,58 @@
#pragma once
#include "esp_http_server.h"
#include <string>
#include <memory>
#include "network/web_server_handler.h"
#include "ui/apps/travel/settings/settings_handler.h"
#include "external/mtr/mtr.h"
#include "network/network.h"
namespace travel {
/**
* @brief HTTP request handlers for Travel app settings web interface
*
* These handlers serve the web configuration page for MTR routes.
*/
class WebHandler {
public:
WebHandler(
SettingHandler* setting_handler,
NetworkHandler* network_handler
);
~WebHandler();
esp_err_t start_web_server();
esp_err_t stop_web_server();
std::string get_url() const;
std::string get_device_ip() const;
uint16_t get_port() const;
bool is_running() const {
return web_server_ && web_server_->is_running();
}
private:
std::string generate_auth_key_();
esp_err_t register_web_endpoints_();
// HTTP handlers
static esp_err_t settings_page_handler_(httpd_req_t* req);
static esp_err_t get_lines_handler_(httpd_req_t* req);
static esp_err_t get_routes_handler_(httpd_req_t* req);
static esp_err_t add_route_handler_(httpd_req_t* req);
static esp_err_t remove_route_handler_(httpd_req_t* req);
static esp_err_t save_settings_handler_(httpd_req_t* req);
std::unique_ptr<WebServerHandler> web_server_;
SettingHandler* setting_handler_ = nullptr;
NetworkHandler* network_handler_ = nullptr;
std::unique_ptr<MTRNextTrainHandler> mtr_handler_;
std::string auth_key_;
static constexpr uint16_t WEB_SERVER_PORT = 8081;
};
} // namespace travel

4
main/ui/events.cpp Normal file
View File

@@ -0,0 +1,4 @@
#include "events.h"
// Define the event base
ESP_EVENT_DEFINE_BASE(UI_EVENT_BASE);

15
main/ui/events.h Normal file
View File

@@ -0,0 +1,15 @@
#pragma once
#include "esp_event.h"
#include "lvgl.h"
ESP_EVENT_DECLARE_BASE(UI_EVENT_BASE);
struct KeyboardEventData {
lv_obj_t* textarea; ///< The textarea that triggered the keyboard event, nullptr if not applicable or for hide event
};
enum EventId {
UI_EVENT_KEYBOARD_SHOWN = 1, ///< Event ID for keyboard shown event
UI_EVENT_KEYBOARD_HIDDEN = 2 ///< Event ID for keyboard hidden event
};

Some files were not shown because too many files have changed in this diff Show More