Repository: MaJerle/lwesp Branch: develop Commit: c43d53524841 Files: 463 Total size: 10.1 MB Directory structure: gitextract_jufxey39/ ├── .clang-format ├── .gitattributes ├── .github/ │ ├── FUNDING.yml │ └── workflows/ │ └── release.yml ├── .gitignore ├── .gitmodules ├── .readthedocs.yaml ├── .vscode/ │ ├── c_cpp_properties.json │ ├── extensions.json │ ├── launch.json │ ├── settings.json │ └── tasks.json ├── AUTHORS ├── CHANGELOG.md ├── CMakeLists.txt ├── CMakePresets.json ├── LICENSE ├── README.md ├── TODO.md ├── certificates/ │ ├── client_ca_00.crt │ ├── client_ca_generated_atpki.hex │ ├── client_cert_00.crt │ ├── client_cert_generated_atpki.hex │ ├── client_key_00.key │ └── client_key_generated_atpki.HEX ├── cmake/ │ ├── i686-w64-mingw32-gcc.cmake │ └── x86_64-w64-mingw32-gcc.cmake ├── dev/ │ ├── lwesp_dev.sln │ ├── lwesp_dev.vcxproj │ ├── lwesp_dev.vcxproj.filters │ ├── lwesp_opts.h │ ├── lwmem_opts.h │ └── main.c ├── docs/ │ ├── Makefile │ ├── api-reference/ │ │ ├── apps/ │ │ │ ├── cayenne_api.rst │ │ │ ├── http_server.rst │ │ │ ├── index.rst │ │ │ ├── mqtt_client.rst │ │ │ ├── mqtt_client_api.rst │ │ │ └── netconn.rst │ │ ├── cli/ │ │ │ ├── cli_input.rst │ │ │ ├── cli_opt.rst │ │ │ └── index.rst │ │ ├── index.rst │ │ ├── lwesp/ │ │ │ ├── ap.rst │ │ │ ├── ble.rst │ │ │ ├── bt.rst │ │ │ ├── buff.rst │ │ │ ├── conn.rst │ │ │ ├── debug.rst │ │ │ ├── dhcp.rst │ │ │ ├── dns.rst │ │ │ ├── evt.rst │ │ │ ├── flash.rst │ │ │ ├── hostname.rst │ │ │ ├── index.rst │ │ │ ├── input.rst │ │ │ ├── mdns.rst │ │ │ ├── mem.rst │ │ │ ├── pbuf.rst │ │ │ ├── ping.rst │ │ │ ├── server.rst │ │ │ ├── smart.rst │ │ │ ├── sntp.rst │ │ │ ├── sta.rst │ │ │ ├── timeout.rst │ │ │ ├── types.rst │ │ │ ├── unicode.rst │ │ │ ├── utils.rst │ │ │ ├── webserver.rst │ │ │ └── wps.rst │ │ ├── opt.rst │ │ └── port/ │ │ ├── index.rst │ │ ├── ll.rst │ │ └── sys.rst │ ├── authors/ │ │ └── index.rst │ ├── changelog/ │ │ └── index.rst │ ├── conf.py │ ├── doxyfile.doxy │ ├── examples/ │ │ └── index.rst │ ├── examples_src/ │ │ ├── command_blocking.c │ │ ├── command_nonblocking.c │ │ ├── command_nonblocking_bad.c │ │ ├── config.h │ │ ├── conn_write.c │ │ ├── debug.c │ │ ├── debug_opts.h │ │ ├── evt.c │ │ ├── mem.c │ │ ├── pbuf_cat.c │ │ ├── pbuf_chain.c │ │ ├── pbuf_extract.c │ │ ├── sntp_custom_server.c │ │ └── sta.c │ ├── firmware-update/ │ │ └── index.rst │ ├── get-started/ │ │ └── index.rst │ ├── index.rst │ ├── make.bat │ ├── requirements.txt │ ├── static/ │ │ ├── css/ │ │ │ ├── common.css │ │ │ └── custom.css │ │ ├── dark-light/ │ │ │ ├── common-dark-light.css │ │ │ ├── dark-mode-toggle.mjs │ │ │ ├── dark.css │ │ │ └── light.css │ │ └── images/ │ │ ├── example_app_arch.xml │ │ ├── logo.drawio │ │ ├── memory_manager_structure.xml │ │ ├── memory_manager_structure_freeing.xml │ │ ├── netconn_client.xml │ │ ├── netconn_server_1thread.xml │ │ ├── netconn_server_concurrency.xml │ │ ├── pbuf_block_diagram.xml │ │ ├── pbuf_block_diagram_after_free.xml │ │ ├── pbuf_cat_vs_chain_1.xml │ │ ├── pbuf_cat_vs_chain_2.xml │ │ ├── pbuf_cat_vs_chain_3.xml │ │ ├── system_structure.xml │ │ └── thread_communication.xml │ └── user-manual/ │ ├── architecture.rst │ ├── blocking-nonblocking.rst │ ├── events-cb-fn.rst │ ├── index.rst │ ├── inter-thread-comm.rst │ ├── overview.rst │ ├── porting-guide.rst │ └── ssl-support.rst ├── examples/ │ ├── README.md │ ├── lib/ │ │ ├── FreeRTOS/ │ │ │ ├── CMSIS_RTOS/ │ │ │ │ ├── cmsis_os.c │ │ │ │ ├── cmsis_os.h │ │ │ │ ├── cpu_utils.c │ │ │ │ └── cpu_utils.h │ │ │ ├── CMSIS_RTOS_V2/ │ │ │ │ ├── cmsis_os.h │ │ │ │ ├── cmsis_os2.c │ │ │ │ └── cmsis_os2.h │ │ │ ├── croutine.c │ │ │ ├── event_groups.c │ │ │ ├── include/ │ │ │ │ ├── FreeRTOS.h │ │ │ │ ├── FreeRTOSConfig_template.h │ │ │ │ ├── StackMacros.h │ │ │ │ ├── croutine.h │ │ │ │ ├── deprecated_definitions.h │ │ │ │ ├── event_groups.h │ │ │ │ ├── list.h │ │ │ │ ├── message_buffer.h │ │ │ │ ├── mpu_prototypes.h │ │ │ │ ├── mpu_wrappers.h │ │ │ │ ├── portable.h │ │ │ │ ├── projdefs.h │ │ │ │ ├── queue.h │ │ │ │ ├── semphr.h │ │ │ │ ├── stack_macros.h │ │ │ │ ├── stdint.readme │ │ │ │ ├── stream_buffer.h │ │ │ │ ├── task.h │ │ │ │ └── timers.h │ │ │ ├── list.c │ │ │ ├── portable/ │ │ │ │ ├── Common/ │ │ │ │ │ └── mpu_wrappers.c │ │ │ │ ├── GCC/ │ │ │ │ │ └── ARM_CM4F/ │ │ │ │ │ ├── port.c │ │ │ │ │ └── portmacro.h │ │ │ │ └── MemMang/ │ │ │ │ ├── ReadMe.url │ │ │ │ ├── heap_1.c │ │ │ │ ├── heap_2.c │ │ │ │ ├── heap_3.c │ │ │ │ ├── heap_4.c │ │ │ │ └── heap_5.c │ │ │ ├── queue.c │ │ │ ├── stream_buffer.c │ │ │ ├── tasks.c │ │ │ └── timers.c │ │ └── st/ │ │ ├── CMSIS/ │ │ │ ├── Device/ │ │ │ │ └── ST/ │ │ │ │ ├── STM32F4xx/ │ │ │ │ │ └── Include/ │ │ │ │ │ ├── stm32f429xx.h │ │ │ │ │ ├── stm32f4xx.h │ │ │ │ │ └── system_stm32f4xx.h │ │ │ │ └── STM32L4xx/ │ │ │ │ └── Include/ │ │ │ │ ├── stm32l496xx.h │ │ │ │ ├── stm32l4xx.h │ │ │ │ └── system_stm32l4xx.h │ │ │ └── Include/ │ │ │ ├── arm_common_tables.h │ │ │ ├── arm_const_structs.h │ │ │ ├── arm_math.h │ │ │ ├── cmsis_armcc.h │ │ │ ├── cmsis_armcc_V6.h │ │ │ ├── cmsis_armclang.h │ │ │ ├── cmsis_compiler.h │ │ │ ├── cmsis_gcc.h │ │ │ ├── cmsis_iccarm.h │ │ │ ├── cmsis_version.h │ │ │ ├── core_armv8mbl.h │ │ │ ├── core_armv8mml.h │ │ │ ├── core_cm0.h │ │ │ ├── core_cm0plus.h │ │ │ ├── core_cm1.h │ │ │ ├── core_cm23.h │ │ │ ├── core_cm3.h │ │ │ ├── core_cm33.h │ │ │ ├── core_cm4.h │ │ │ ├── core_cm7.h │ │ │ ├── core_cmFunc.h │ │ │ ├── core_cmInstr.h │ │ │ ├── core_cmSimd.h │ │ │ ├── core_sc000.h │ │ │ ├── core_sc300.h │ │ │ ├── mpu_armv7.h │ │ │ ├── mpu_armv8.h │ │ │ └── tz_context.h │ │ ├── STM32F4xx_HAL_Driver/ │ │ │ ├── Inc/ │ │ │ │ ├── stm32f4xx_ll_bus.h │ │ │ │ ├── stm32f4xx_ll_cortex.h │ │ │ │ ├── stm32f4xx_ll_dma.h │ │ │ │ ├── stm32f4xx_ll_exti.h │ │ │ │ ├── stm32f4xx_ll_gpio.h │ │ │ │ ├── stm32f4xx_ll_pwr.h │ │ │ │ ├── stm32f4xx_ll_rcc.h │ │ │ │ ├── stm32f4xx_ll_system.h │ │ │ │ ├── stm32f4xx_ll_usart.h │ │ │ │ └── stm32f4xx_ll_utils.h │ │ │ └── Src/ │ │ │ ├── stm32f4xx_ll_dma.c │ │ │ ├── stm32f4xx_ll_exti.c │ │ │ ├── stm32f4xx_ll_gpio.c │ │ │ ├── stm32f4xx_ll_pwr.c │ │ │ ├── stm32f4xx_ll_rcc.c │ │ │ ├── stm32f4xx_ll_usart.c │ │ │ └── stm32f4xx_ll_utils.c │ │ └── STM32L4xx_HAL_Driver/ │ │ ├── Inc/ │ │ │ ├── stm32l4xx_ll_adc.h │ │ │ ├── stm32l4xx_ll_bus.h │ │ │ ├── stm32l4xx_ll_cortex.h │ │ │ ├── stm32l4xx_ll_dma.h │ │ │ ├── stm32l4xx_ll_dmamux.h │ │ │ ├── stm32l4xx_ll_exti.h │ │ │ ├── stm32l4xx_ll_gpio.h │ │ │ ├── stm32l4xx_ll_lpuart.h │ │ │ ├── stm32l4xx_ll_pwr.h │ │ │ ├── stm32l4xx_ll_rcc.h │ │ │ ├── stm32l4xx_ll_system.h │ │ │ ├── stm32l4xx_ll_usart.h │ │ │ └── stm32l4xx_ll_utils.h │ │ └── Src/ │ │ ├── stm32l4xx_ll_dma.c │ │ ├── stm32l4xx_ll_exti.c │ │ ├── stm32l4xx_ll_gpio.c │ │ ├── stm32l4xx_ll_lpuart.c │ │ ├── stm32l4xx_ll_pwr.c │ │ ├── stm32l4xx_ll_rcc.c │ │ ├── stm32l4xx_ll_usart.c │ │ └── stm32l4xx_ll_utils.c │ ├── posix/ │ │ ├── README.md │ │ └── sntp_rtos/ │ │ ├── CMakeLists.txt │ │ ├── README.md │ │ ├── lwesp_opts.h │ │ └── main.c │ ├── stm32/ │ │ ├── mqtt_client_api_rtos_stm32f429zi_nucleo/ │ │ │ ├── .vscode/ │ │ │ │ ├── c_cpp_properties.json │ │ │ │ ├── extensions.json │ │ │ │ ├── launch.json │ │ │ │ └── tasks.json │ │ │ ├── CMakeLists.txt │ │ │ ├── CMakePresets.json │ │ │ ├── STM32CubeIDE/ │ │ │ │ ├── .cproject │ │ │ │ ├── .project │ │ │ │ ├── Debug_STM32F429ZI_FLASH.ld │ │ │ │ └── startup/ │ │ │ │ └── startup_stm32f429xx.s │ │ │ ├── cmake/ │ │ │ │ └── gcc-arm-none-eabi.cmake │ │ │ ├── inc/ │ │ │ │ ├── FreeRTOSConfig.h │ │ │ │ ├── lwesp_opts.h │ │ │ │ ├── main.h │ │ │ │ ├── stm32_assert.h │ │ │ │ ├── stm32f4xx_hal_conf.h │ │ │ │ └── stm32f4xx_it.h │ │ │ └── src/ │ │ │ ├── main.c │ │ │ ├── stm32f4xx_it.c │ │ │ ├── syscalls.c │ │ │ └── system_stm32f4xx.c │ │ └── netconn_client_rtos_stm32l496g_discovery/ │ │ ├── .vscode/ │ │ │ ├── c_cpp_properties.json │ │ │ ├── extensions.json │ │ │ ├── launch.json │ │ │ └── tasks.json │ │ ├── CMakeLists.txt │ │ ├── CMakePresets.json │ │ ├── STM32CubeIDE/ │ │ │ ├── .cproject │ │ │ ├── .project │ │ │ ├── Debug_STM32L496AG_FLASH.ld │ │ │ └── startup/ │ │ │ └── startup_stm32l496xx.s │ │ ├── cmake/ │ │ │ └── gcc-arm-none-eabi.cmake │ │ ├── inc/ │ │ │ ├── FreeRTOSConfig.h │ │ │ ├── lwesp_opts.h │ │ │ ├── main.h │ │ │ ├── stm32_assert.h │ │ │ ├── stm32l4xx_hal_conf.h │ │ │ └── stm32l4xx_it.h │ │ └── src/ │ │ ├── main.c │ │ ├── stm32l4xx_it.c │ │ ├── syscalls.c │ │ └── system_stm32l4xx.c │ └── win32/ │ ├── .vscode/ │ │ ├── c_cpp_properties.json │ │ ├── extensions.json │ │ ├── launch.json │ │ ├── settings.json │ │ └── tasks.json │ ├── CMakeLists.txt │ ├── CMakePresets.json │ ├── README.md │ ├── access_point_rtos/ │ │ ├── lwesp_opts.h │ │ └── main.c │ ├── build_all_examples.py │ ├── client_rtos/ │ │ ├── lwesp_opts.h │ │ └── main.c │ ├── dns_rtos/ │ │ ├── lwesp_opts.h │ │ └── main.c │ ├── mqtt_client_api_rtos/ │ │ ├── lwesp_opts.h │ │ └── main.c │ ├── mqtt_client_rtos/ │ │ ├── lwesp_opts.h │ │ └── main.c │ ├── netconn_client_rtos/ │ │ ├── lwesp_opts.h │ │ └── main.c │ ├── netconn_server_rtos/ │ │ ├── lwesp_opts.h │ │ └── main.c │ ├── server_rtos/ │ │ ├── lwesp_opts.h │ │ └── main.c │ └── sntp_rtos/ │ ├── lwesp_opts.h │ └── main.c ├── library.json ├── lwesp/ │ ├── CMakeLists.txt │ ├── library.cmake │ └── src/ │ ├── api/ │ │ └── lwesp_netconn.c │ ├── apps/ │ │ ├── http_server/ │ │ │ ├── lwesp_http_server.c │ │ │ ├── lwesp_http_server_fs.c │ │ │ ├── lwesp_http_server_fs_fat.c │ │ │ └── lwesp_http_server_fs_win32.c │ │ └── mqtt/ │ │ ├── lwesp_mqtt_client.c │ │ ├── lwesp_mqtt_client_api.c │ │ └── lwesp_mqtt_client_evt.c │ ├── cli/ │ │ ├── cli.c │ │ └── cli_input.c │ ├── include/ │ │ ├── cli/ │ │ │ ├── cli.h │ │ │ ├── cli_input.h │ │ │ └── cli_opt.h │ │ ├── lwesp/ │ │ │ ├── apps/ │ │ │ │ ├── lwesp_apps.h │ │ │ │ ├── lwesp_http_server.h │ │ │ │ ├── lwesp_http_server_fs.h │ │ │ │ ├── lwesp_mqtt_client.h │ │ │ │ ├── lwesp_mqtt_client_api.h │ │ │ │ └── lwesp_mqtt_client_evt.h │ │ │ ├── lwesp.h │ │ │ ├── lwesp_ap.h │ │ │ ├── lwesp_ble.h │ │ │ ├── lwesp_bt.h │ │ │ ├── lwesp_buff.h │ │ │ ├── lwesp_cli.h │ │ │ ├── lwesp_conn.h │ │ │ ├── lwesp_debug.h │ │ │ ├── lwesp_debug_types.h │ │ │ ├── lwesp_dhcp.h │ │ │ ├── lwesp_dns.h │ │ │ ├── lwesp_evt.h │ │ │ ├── lwesp_flash.h │ │ │ ├── lwesp_flash_partitions.h │ │ │ ├── lwesp_hostname.h │ │ │ ├── lwesp_includes.h │ │ │ ├── lwesp_input.h │ │ │ ├── lwesp_int.h │ │ │ ├── lwesp_mdns.h │ │ │ ├── lwesp_mem.h │ │ │ ├── lwesp_netconn.h │ │ │ ├── lwesp_opt.h │ │ │ ├── lwesp_opts_template.h │ │ │ ├── lwesp_parser.h │ │ │ ├── lwesp_pbuf.h │ │ │ ├── lwesp_ping.h │ │ │ ├── lwesp_private.h │ │ │ ├── lwesp_server.h │ │ │ ├── lwesp_smart.h │ │ │ ├── lwesp_sntp.h │ │ │ ├── lwesp_sta.h │ │ │ ├── lwesp_threads.h │ │ │ ├── lwesp_timeout.h │ │ │ ├── lwesp_types.h │ │ │ ├── lwesp_unicode.h │ │ │ ├── lwesp_utils.h │ │ │ ├── lwesp_webserver.h │ │ │ └── lwesp_wps.h │ │ └── system/ │ │ ├── lwesp_ll.h │ │ ├── lwesp_sys.h │ │ └── port/ │ │ ├── cmsis_os/ │ │ │ └── lwesp_sys_port.h │ │ ├── freertos/ │ │ │ └── lwesp_sys_port.h │ │ ├── posix/ │ │ │ └── lwesp_sys_port.h │ │ ├── threadx/ │ │ │ └── lwesp_sys_port.h │ │ └── win32/ │ │ └── lwesp_sys_port.h │ ├── lwesp/ │ │ ├── lwesp.c │ │ ├── lwesp_ap.c │ │ ├── lwesp_ble.c │ │ ├── lwesp_bt.c │ │ ├── lwesp_buff.c │ │ ├── lwesp_cli.c │ │ ├── lwesp_conn.c │ │ ├── lwesp_debug.c │ │ ├── lwesp_dhcp.c │ │ ├── lwesp_dns.c │ │ ├── lwesp_evt.c │ │ ├── lwesp_flash.c │ │ ├── lwesp_hostname.c │ │ ├── lwesp_input.c │ │ ├── lwesp_int.c │ │ ├── lwesp_mdns.c │ │ ├── lwesp_mem.c │ │ ├── lwesp_parser.c │ │ ├── lwesp_pbuf.c │ │ ├── lwesp_ping.c │ │ ├── lwesp_server.c │ │ ├── lwesp_smart.c │ │ ├── lwesp_sntp.c │ │ ├── lwesp_sta.c │ │ ├── lwesp_threads.c │ │ ├── lwesp_timeout.c │ │ ├── lwesp_unicode.c │ │ ├── lwesp_utils.c │ │ ├── lwesp_webserver.c │ │ └── lwesp_wps.c │ └── system/ │ ├── lwesp_ll_posix.c │ ├── lwesp_ll_stm32.c │ ├── lwesp_ll_stm32_threadx.c │ ├── lwesp_ll_stm32f429zi_nucleo.c │ ├── lwesp_ll_stm32f723e_discovery.c │ ├── lwesp_ll_stm32f769i_discovery.c │ ├── lwesp_ll_stm32h735g_dk_threadx.c │ ├── lwesp_ll_stm32l432kc_nucleo.c │ ├── lwesp_ll_stm32l496g_discovery.c │ ├── lwesp_ll_stm32l4s5_discovery.c │ ├── lwesp_ll_win32.c │ ├── lwesp_mem_lwmem.c │ ├── lwesp_mem_posix.c │ ├── lwesp_mem_threadx.c │ ├── lwesp_sys_cmsis_os.c │ ├── lwesp_sys_freertos.c │ ├── lwesp_sys_posix.c │ ├── lwesp_sys_threadx.c │ └── lwesp_sys_win32.c ├── snippets/ │ ├── CMakeLists.txt │ ├── client.c │ ├── dns.c │ ├── examples_common_lwesp_callback_func.c │ ├── http_server.c │ ├── include/ │ │ ├── client.h │ │ ├── dns.h │ │ ├── examples_common_lwesp_callback_func.h │ │ ├── http_server.h │ │ ├── mqtt_client.h │ │ ├── mqtt_client_api.h │ │ ├── netconn_client.h │ │ ├── netconn_server.h │ │ ├── netconn_server_1thread.h │ │ ├── sntp.h │ │ ├── station_manager.h │ │ ├── telnet_server.h │ │ └── utils.h │ ├── mqtt_client.c │ ├── mqtt_client_api.c │ ├── mqtt_client_api_ha.c │ ├── netconn_client.c │ ├── netconn_client_ssl.c │ ├── netconn_server.c │ ├── netconn_server_1thread.c │ ├── sntp.c │ ├── station_manager.c │ ├── telnet_server.c │ └── utils.c └── www/ ├── css/ │ └── style.css └── index.shtml ================================================ FILE CONTENTS ================================================ ================================================ FILE: .clang-format ================================================ # Language part removed. With clang-format >=20.1, the C and Cpp are separately handled, # so either there is no language at all, or we need to create 2 formats for C and Cpp, separately --- # Language: Cpp # BasedOnStyle: LLVM AccessModifierOffset: -2 AlignAfterOpenBracket: Align AlignArrayOfStructures: None AlignConsecutiveMacros: Enabled: true AcrossEmptyLines: true AcrossComments: true AlignConsecutiveAssignments: None AlignConsecutiveBitFields: Enabled: true AcrossEmptyLines: true AcrossComments: true AlignConsecutiveDeclarations: None AlignEscapedNewlines: Right AlignOperands: Align SortIncludes: true InsertBraces: true # Control statements must have curly brackets AlignTrailingComments: true AllowAllArgumentsOnNextLine: true AllowAllParametersOfDeclarationOnNextLine: true AllowShortEnumsOnASingleLine: true AllowShortBlocksOnASingleLine: Empty AllowShortCaseLabelsOnASingleLine: true AllowShortFunctionsOnASingleLine: All AllowShortLambdasOnASingleLine: All AllowShortIfStatementsOnASingleLine: Never AllowShortLoopsOnASingleLine: false AlwaysBreakAfterDefinitionReturnType: None AlwaysBreakAfterReturnType: AllDefinitions AlwaysBreakBeforeMultilineStrings: false AlwaysBreakTemplateDeclarations: Yes AttributeMacros: - __capability BinPackArguments: true BinPackParameters: true BraceWrapping: AfterCaseLabel: false AfterClass: false AfterControlStatement: Never AfterEnum: false AfterFunction: false AfterNamespace: false AfterObjCDeclaration: false AfterStruct: false AfterUnion: false AfterExternBlock: false BeforeCatch: false BeforeElse: false BeforeLambdaBody: false BeforeWhile: false IndentBraces: false SplitEmptyFunction: true SplitEmptyRecord: true SplitEmptyNamespace: true BreakBeforeBinaryOperators: NonAssignment BreakBeforeConceptDeclarations: true BreakBeforeBraces: Attach BreakBeforeInheritanceComma: false BreakInheritanceList: BeforeColon BreakBeforeTernaryOperators: true BreakConstructorInitializersBeforeComma: false BreakConstructorInitializers: BeforeColon BreakAfterJavaFieldAnnotations: false BreakStringLiterals: true ColumnLimit: 120 CommentPragmas: "^ IWYU pragma:" QualifierAlignment: Leave CompactNamespaces: false ConstructorInitializerIndentWidth: 4 ContinuationIndentWidth: 4 Cpp11BracedListStyle: true DeriveLineEnding: true DerivePointerAlignment: false DisableFormat: false EmptyLineAfterAccessModifier: Never EmptyLineBeforeAccessModifier: LogicalBlock ExperimentalAutoDetectBinPacking: false PackConstructorInitializers: BinPack BasedOnStyle: "" ConstructorInitializerAllOnOneLineOrOnePerLine: false AllowAllConstructorInitializersOnNextLine: true FixNamespaceComments: true ForEachMacros: - foreach - Q_FOREACH - BOOST_FOREACH IfMacros: - KJ_IF_MAYBE IncludeBlocks: Preserve IncludeCategories: - Regex: "^<(.*)>" Priority: 0 - Regex: '^"(.*)"' Priority: 1 - Regex: "(.*)" Priority: 2 IncludeIsMainRegex: "(Test)?$" IncludeIsMainSourceRegex: "" IndentAccessModifiers: false IndentCaseLabels: true IndentCaseBlocks: false IndentGotoLabels: true IndentPPDirectives: None IndentExternBlock: AfterExternBlock IndentRequires: true IndentWidth: 4 IndentWrappedFunctionNames: false InsertTrailingCommas: None JavaScriptQuotes: Leave JavaScriptWrapImports: true KeepEmptyLinesAtTheStartOfBlocks: true LambdaBodyIndentation: Signature MacroBlockBegin: "" MacroBlockEnd: "" MaxEmptyLinesToKeep: 1 NamespaceIndentation: None ObjCBinPackProtocolList: Auto ObjCBlockIndentWidth: 2 ObjCBreakBeforeNestedBlockParam: true ObjCSpaceAfterProperty: false ObjCSpaceBeforeProtocolList: true PenaltyBreakAssignment: 2 PenaltyBreakBeforeFirstCallParameter: 19 PenaltyBreakComment: 300 PenaltyBreakFirstLessLess: 120 PenaltyBreakOpenParenthesis: 0 PenaltyBreakString: 1000 PenaltyBreakTemplateDeclaration: 10 PenaltyExcessCharacter: 1000000 PenaltyReturnTypeOnItsOwnLine: 60 PenaltyIndentedWhitespace: 0 PointerAlignment: Left PPIndentWidth: -1 ReferenceAlignment: Pointer ReflowComments: false RemoveBracesLLVM: false SeparateDefinitionBlocks: Always ShortNamespaceLines: 1 SortJavaStaticImport: Before SortUsingDeclarations: true SpaceAfterCStyleCast: false SpaceAfterLogicalNot: false SpaceAfterTemplateKeyword: true SpaceBeforeAssignmentOperators: true SpaceBeforeCaseColon: false SpaceBeforeParens: ControlStatements SpaceBeforeParensOptions: AfterControlStatements: true AfterForeachMacros: true AfterFunctionDefinitionName: false AfterFunctionDeclarationName: false AfterIfMacros: true AfterOverloadedOperator: false BeforeNonEmptyParentheses: false SpaceAroundPointerQualifiers: Default SpaceBeforeRangeBasedForLoopColon: true SpaceInEmptyBlock: false SpaceInEmptyParentheses: false SpacesBeforeTrailingComments: 1 SpacesInAngles: Never SpacesInConditionalStatement: false SpacesInContainerLiterals: true SpacesInCStyleCastParentheses: false SpacesInLineCommentPrefix: Minimum: 1 Maximum: -1 SpacesInParentheses: false SpacesInSquareBrackets: false SpaceBeforeSquareBrackets: false BitFieldColonSpacing: Both Standard: Latest StatementAttributeLikeMacros: - Q_EMIT StatementMacros: - Q_UNUSED - QT_REQUIRE_VERSION TabWidth: 8 UseCRLF: false UseTab: Never WhitespaceSensitiveMacros: - STRINGIZE - PP_STRINGIZE - BOOST_PP_STRINGIZE - NS_SWIFT_NAME - CF_SWIFT_NAME SpaceBeforeCpp11BracedList: false SpaceBeforeCtorInitializerColon: true SpaceBeforeInheritanceColon: true --- ================================================ FILE: .gitattributes ================================================ # Auto detect text files and perform LF normalization * text=auto # Custom for Visual Studio *.cs diff=csharp # Standard to msysgit *.doc diff=astextplain *.DOC diff=astextplain *.docx diff=astextplain *.DOCX diff=astextplain *.dot diff=astextplain *.DOT diff=astextplain *.pdf diff=astextplain *.PDF diff=astextplain *.rtf diff=astextplain *.RTF diff=astextplain ================================================ FILE: .github/FUNDING.yml ================================================ # These are supported funding model platforms custom: ['paypal.me/tilz0R'] ================================================ FILE: .github/workflows/release.yml ================================================ name: Release workflow on: push: # Sequence of patterns matched against refs/tags tags: - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 jobs: # Create the release from the tag create-release: name: Create Release runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v2 - name: Create Release id: create_release uses: actions/create-release@v1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: tag_name: ${{ github.ref }} release_name: Release ${{ github.ref }} body: | See the [CHANGELOG](CHANGELOG.md) draft: false prerelease: false # Publish package to PlatformIO publish-platformio: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 - name: Set up Python uses: actions/setup-python@v5 with: python-version: "3.x" - name: Install PlatformIO run: pip install platformio - name: Publish to PlatformIO env: PLATFORMIO_AUTH_TOKEN: ${{ secrets.PLATFORMIO_AUTH_TOKEN }} run: pio pkg publish --type library --non-interactive ================================================ FILE: .gitignore ================================================ #Build Keil files *.rar *.o *.d *.crf *.htm *.dep *.map *.bak *.axf *.lnp *.lst *.ini *.scvd *.iex *.sct *.MajerleT *.tjuln *.tilen *.dbgconf *.uvguix *.uvoptx *.__i *.i *.txt !docs/*.txt !CMakeLists.txt RTE/ *debug # IAR Settings **/settings/*.crun **/settings/*.dbgdt **/settings/*.cspy **/settings/*.cspy.* **/settings/*.xcl **/settings/*.dni **/settings/*.wsdt **/settings/*.wspos # IAR Debug Exe **/Exe/*.sim # IAR Debug Obj **/Obj/*.pbd **/Obj/*.pbd.* **/Obj/*.pbi **/Obj/*.pbi.* *.TMP /docs_src/x_Doxyfile.doxy .DS_Store ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. ## ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore # User-specific files *.suo *.user *.userosscache *.sln.docstates # User-specific files (MonoDevelop/Xamarin Studio) *.userprefs # Build results [Dd]ebug/ [Dd]ebugPublic/ [Rr]elease/ [Rr]eleases/ [Dd]ebug*/ x64/ x86/ bld/ [Bb]in/ [Oo]bj/ [Ll]og/ _build/ build/ __build__/ # Visual Studio 2015/2017 cache/options directory .vs/ # Uncomment if you have tasks that create the project's static files in wwwroot #wwwroot/ # Visual Studio 2017 auto generated files Generated\ Files/ # MSTest test Results [Tt]est[Rr]esult*/ [Bb]uild[Ll]og.* # NUNIT *.VisualState.xml TestResult.xml # Build Results of an ATL Project [Dd]ebugPS/ [Rr]eleasePS/ dlldata.c # Benchmark Results BenchmarkDotNet.Artifacts/ # .NET Core project.lock.json project.fragment.lock.json artifacts/ **/Properties/launchSettings.json # StyleCop StyleCopReport.xml # Files built by Visual Studio *_i.c *_p.c *_i.h *.ilk *.meta *.obj *.pch *.pdb *.pgc *.pgd *.rsp *.sbr *.tlb *.tli *.tlh *.tmp *.tmp_proj *.log *.vspscc *.vssscc .builds *.pidb *.svclog *.scc *.out *.sim # Chutzpah Test files _Chutzpah* # Visual C++ cache files ipch/ *.aps *.ncb *.opendb *.opensdf *.sdf *.cachefile *.VC.db *.VC.VC.opendb # Visual Studio profiler *.psess *.vsp *.vspx *.sap # Visual Studio Trace Files *.e2e # TFS 2012 Local Workspace $tf/ # Guidance Automation Toolkit *.gpState # ReSharper is a .NET coding add-in _ReSharper*/ *.[Rr]e[Ss]harper *.DotSettings.user # JustCode is a .NET coding add-in .JustCode # TeamCity is a build add-in _TeamCity* # DotCover is a Code Coverage Tool *.dotCover # AxoCover is a Code Coverage Tool .axoCover/* !.axoCover/settings.json # Visual Studio code coverage results *.coverage *.coveragexml # NCrunch _NCrunch_* .*crunch*.local.xml nCrunchTemp_* # MightyMoose *.mm.* AutoTest.Net/ # Web workbench (sass) .sass-cache/ # Installshield output folder [Ee]xpress/ # DocProject is a documentation generator add-in DocProject/buildhelp/ DocProject/Help/*.HxT DocProject/Help/*.HxC DocProject/Help/*.hhc DocProject/Help/*.hhk DocProject/Help/*.hhp DocProject/Help/Html2 DocProject/Help/html # Click-Once directory publish/ # Publish Web Output *.[Pp]ublish.xml *.azurePubxml # Note: Comment the next line if you want to checkin your web deploy settings, # but database connection strings (with potential passwords) will be unencrypted *.pubxml *.publishproj # Microsoft Azure Web App publish settings. Comment the next line if you want to # checkin your Azure Web App publish settings, but sensitive information contained # in these scripts will be unencrypted PublishScripts/ # NuGet Packages *.nupkg # The packages folder can be ignored because of Package Restore **/[Pp]ackages/* # except build/, which is used as an MSBuild target. !**/[Pp]ackages/build/ # Uncomment if necessary however generally it will be regenerated when needed #!**/[Pp]ackages/repositories.config # NuGet v3's project.json files produces more ignorable files *.nuget.props *.nuget.targets # Microsoft Azure Build Output csx/ *.build.csdef # Microsoft Azure Emulator ecf/ rcf/ # Windows Store app package directories and files AppPackages/ BundleArtifacts/ Package.StoreAssociation.xml _pkginfo.txt *.appx # Visual Studio cache files # files ending in .cache can be ignored *.[Cc]ache # but keep track of directories ending in .cache !*.[Cc]ache/ # Others ClientBin/ ~$* *~ *.dbmdl *.dbproj.schemaview *.jfm *.pfx *.publishsettings orleans.codegen.cs # Including strong name files can present a security risk # (https://github.com/github/gitignore/pull/2483#issue-259490424) #*.snk # Since there are multiple workflows, uncomment next line to ignore bower_components # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) #bower_components/ # RIA/Silverlight projects Generated_Code/ # Backup & report files from converting an old project file # to a newer Visual Studio version. Backup files are not needed, # because we have git ;-) _UpgradeReport_Files/ Backup*/ UpgradeLog*.XML UpgradeLog*.htm # SQL Server files *.mdf *.ldf *.ndf # Business Intelligence projects *.rdl.data *.bim.layout *.bim_*.settings # Microsoft Fakes FakesAssemblies/ # GhostDoc plugin setting file *.GhostDoc.xml # Node.js Tools for Visual Studio .ntvs_analysis.dat node_modules/ # TypeScript v1 declaration files typings/ # Visual Studio 6 build log *.plg # Visual Studio 6 workspace options file *.opt # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) *.vbw # Visual Studio LightSwitch build output **/*.HTMLClient/GeneratedArtifacts **/*.DesktopClient/GeneratedArtifacts **/*.DesktopClient/ModelManifest.xml **/*.Server/GeneratedArtifacts **/*.Server/ModelManifest.xml _Pvt_Extensions # Paket dependency manager .paket/paket.exe paket-files/ # FAKE - F# Make .fake/ # JetBrains Rider .idea/ *.sln.iml # CodeRush .cr/ # Python Tools for Visual Studio (PTVS) __pycache__/ *.pyc # Cake - Uncomment if you are using it # tools/** # !tools/packages.config # Tabs Studio *.tss # Telerik's JustMock configuration file *.jmconfig # BizTalk build output *.btp.cs *.btm.cs *.odx.cs *.xsd.cs # OpenCover UI analysis results OpenCover/ # Azure Stream Analytics local run output ASALocalRun/ # MSBuild Binary and Structured Log *.binlog log_file.txt .metadata/ .mxproject .settings/ project.ioc mx.scratch *.tilen majerle # Altium Project outputs* History/ *.SchDocPreview *.$$$Preview # VSCode projects project_vscode_compiled.exe ================================================ FILE: .gitmodules ================================================ ================================================ FILE: .readthedocs.yaml ================================================ version: 2 build: os: ubuntu-22.04 tools: python: "3.11" # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py # Python configuration python: install: - requirements: docs/requirements.txt formats: - pdf - epub ================================================ FILE: .vscode/c_cpp_properties.json ================================================ { "version": 4, "configurations": [ { /* * Full configuration is provided by CMake plugin for vscode, * that shall be installed by user */ "name": "Win32", "intelliSenseMode": "${default}", "configurationProvider": "ms-vscode.cmake-tools" } ] } ================================================ FILE: .vscode/extensions.json ================================================ { "recommendations": [ "ms-vscode.cpptools", "ms-vscode.cmake-tools", "twxs.cmake", ] } ================================================ FILE: .vscode/launch.json ================================================ { "version": "0.2.0", "configurations": [ { /* GDB must in be in the PATH environment */ "name": "(Windows) Launch", "type": "cppdbg", "request": "launch", "program": "${command:cmake.launchTargetPath}", "args": [], "stopAtEntry": false, "cwd": "${fileDirname}", "environment": [] } ] } ================================================ FILE: .vscode/settings.json ================================================ { "files.associations": { "*.lcdjson": "json", "lwevt_types.h": "c", "lwevt_type.h": "c", "lwevt.h": "c", "string.h": "c", "lwevt_opt.h": "c", "cli.h": "c", "windows.h": "c", "lwesp_private.h": "c", "lwesp_ll.h": "c", "lwesp.h": "c", "lwesp_includes.h": "c", "lwesp_pbuf.h": "c", "lwesp_opt.h": "c", "LWESP_TYPES.h": "c", "lwesp_opts.h": "c", "lwesp_buff.h": "c", "lwesp_debug.h": "c", "lwesp_utils.h": "c", "stdlib.h": "c", "lwesp_unicode.h": "c", "lwesp_ping.h": "c", "lwesp_threads.h": "c", "lwesp_int.h": "c", "lwesp_sta.h": "c", "lwesp_mqtt_client_api.h": "c", "lwesp_cayenne.h": "c", "lwesp_http_server.h": "c", "lwesp_apps.h": "c", "lwesp_mqtt_client.h": "c", "lwesp_mqtt_client_evt.h": "c", "lwesp_parser.h": "c", "lwesp_debug_types.h": "c", "lwesp_conn.h": "c", "lwesp_flash.h": "c", "lwesp_mem.h": "c", "http_server.h": "c", "cayenne.h": "c", "examples_common_lwesp_callback_func.h": "c", "*.hex": "c", "lwesp_netconn.h": "c", "netconn_client.h": "c", "lwesp_sntp.h": "c", "utils.h": "c", "lwesp_flash_partitions.h": "c", "math.h": "c" }, "esbonio.sphinx.confDir": "" } ================================================ FILE: .vscode/tasks.json ================================================ { "version": "2.0.0", "tasks": [ { "type": "cppbuild", "label": "Build project", "command": "cmake", "args": ["--build", "${command:cmake.buildDirectory}", "-j", "8"], "options": { "cwd": "${workspaceFolder}" }, "problemMatcher": ["$gcc"], "group": { "kind": "build", "isDefault": true } }, { "type": "shell", "label": "Re-build project", "command": "cmake", "args": ["--build", "${command:cmake.buildDirectory}", "--clean-first", "-v", "-j", "8"], "options": { "cwd": "${workspaceFolder}" }, "problemMatcher": ["$gcc"], }, { "type": "shell", "label": "Clean project", "command": "cmake", "args": ["--build", "${command:cmake.buildDirectory}", "--target", "clean"], "options": { "cwd": "${workspaceFolder}" }, "problemMatcher": [] }, { "type": "shell", "label": "Run application", "command": "${command:cmake.launchTargetPath}", "args": [], "problemMatcher": [], }, { "label": "Docs: Install python plugins from requirements.txt file", "type": "shell", "command": "python -m pip install -r requirements.txt", "options": { "cwd": "${workspaceFolder}/docs" }, "problemMatcher": [] }, { "label": "Docs: Generate html", "type": "shell", "command": ".\\make html", "options": { "cwd": "${workspaceFolder}/docs" }, "problemMatcher": [] }, { "label": "Docs: Clean build directory", "type": "shell", "command": ".\\make clean", "options": { "cwd": "${workspaceFolder}/docs" }, "problemMatcher": [] }, { "label": "Build all WIN32 examples", "type": "shell", "command": "python", "args": [ "build_all_examples.py" ], "options": { "cwd": "${workspaceFolder}/examples/win32" }, "problemMatcher": [] } ] } ================================================ FILE: AUTHORS ================================================ Tilen Majerle Adrian Carpenter Miha Cesnik Evgeny Ermakov Michal Převrátil Evgeny Ermakov <> Tom van der Geer Tilen Majerle turmary Bert niedong neo TakashiKusachi imi415 lisekt84 ================================================ FILE: CHANGELOG.md ================================================ # Changelog ## Develop - Change license year to 2022 - MQTT: Improve module implementation - MQTT: Add optional SSL connection type - MQTT: Add cayenne async demo, publish-mode only through ring buffer - MQTT CAYENNE: Completely reworked with asynchronous MQTT instead. Improves performance to transmit more data in one shot - MQTT client: Add poll periodic event for event callback - Port: Improve ThreadX port - CONN: Enable manual TCP receive by default, to improve system stability - Timeout: module returns ERRMEM if no memory to allocate block - Add esp_at_binaries from Espressif, used for library verification (official AT firmware) - Add optional `AT+CMD?` command at reset/restore process, for debug purpose for the moment, only - Add function to get ESP device used for AT command communication - Fix `lwesp_get_min_at_fw_version` to return min AT version for detected ESP device - SNTP: Improve module comments, change timezone variable to `int16_t` - SNTP: Implement global callback when command is to obtain current time - SNTP: Add synchronization interval config, available with ESP AT `2.3.0` or later (ESP32-C3 only for the moment) - SNTP: Add option for readin current SNTP configuration - SNTP: Add option to automatically read SNTP data on `+TIME_UPDATED` event (requires ESP-AT v3.x or newer) - ERR: Add option to get response to `ERR CODE:` message if command doesn't exist and put it to result of command execution - Fix min at version for ESP32 to `2.2.0` - Add `LWESP ` prefix for debug messages - Update code style with astyle - Add `.clang-format` draft - remove astyle support - SSL: Added experimental support - FS: Added support for erase and write operation - Code improvement: Change multiple local variables to single structure - Date&Time `lwesp_datetime_t` and use generic `struct tm` instead - CONN: Add validation counter to ensure netconn object matches connection object and that there was no connection close/re-open in between - Minimum supported AT version is now `v3.2.0 (ESP32, ESP32-C3)` to support new MFG write operations - Added support for `ESP32-C2` and `ESP32-C6` AT commands - SYSFLASH: Split System flash and Manufacturing data to separate commands, following new breaking changes for ESP-AT firmware - WPS: Break API compatibility to configure the feature, by adding minimum security level parameter in the `lwesp_wps_set_config` function - Rework library CMake with removed INTERFACE type ## 1.1.2-dev - Add POSIX-compliant low-level driver (thanks to community to implement it) - Prohibit transmission of too long UDP packets (default), can be disabled with configuration option - Split CMakeLists.txt files between library and executable - Move `esp_set_server` function to separate file `lwesp_server.c` - Use `AT+GMR` command just after reset/restore to determine ESP device being connected on AT port - Minimum required AT binaries are now `2.3.0` for `ESP32/ESP32C3` and `2.2.1` for `ESP8266` - Connection status is acquired with `AT+CIPSTATE` or `AT+CIPSTATUS`, depends on Espressif connected device - Add optional full fields for access point scan with `LWESP_CFG_ACCESS_POINT_STRUCT_FULL_FIELDS` config option - Add optional keep-alive periodic timeout to system event callback functions. Can be used to act as generic timeout event - Improve station manager snippet with asynchronous mode ## v1.1.1-dev - Update to support library.json for Platform.IO ## v1.1.0-dev - Add support for SDK v2.2 - Extend number of information received on AP scan - Add option for `WPA3` and `WPA2_WPA3_PSK` authentication modes - Add bgn and wps readings - Add support for IPv6 - Add option to disconnect all stations from Soft-AP - TODO: Add DNS for IPv6 support (Optional) - TODO: Add support for WIFI GOT IP to parse IPv6 - Update CMSIS OS driver to support FreeRTOS aware kernel ## v1.0.0 - First stable release - Works with *esp-at* version `v2.1.0` - Implements all basic functionality for ESP8266 and ESP32 - Added operating system-based sequential API - Other bug fixes and docs updates ## v0.6.1 - Fixed inadequate MQTT RX data handling causing possible overflow of memory - Added support for zero-copy MQTT RX data ## v0.6.0 - Added support for ESP32 & ESP8266 - Official support for ESP32 AT firmware v1.2 & ESP8266 AT firmware v2.0 - Added examples to main repository - Preparation for BLE support in ESP32 - Removed AT commands with `_CUR` and `_DEF` suffixes - Renamed some event names, such as `ESP_EVT_CONN_CLOSE` instead of `ESP_EVT_CONN_CLOSED` - Added DHCP/static IP support - Added CMSIS-OS v2 support - Added LwMEM port for dynamic memory allocation - Other bug fixes ## v0.5.0 - Remove `_t` for every struct/enum name - Fully use ESP_MEMCPY instead of memcpy - When connection is in closing mode, stop sending any new data and return with error - Remove `_data` part from event helper function for connection receive - Implement semaphores in internal threads - Add driver for NUCLEO-F429 - Implement timeout callback for major events when device does not reply in given time - Add callback function support to every API function which directly interacts with device - Replace all files to CRLF ending - Replace `ESP_EVT_RESET` to `ESP_EVT_RESET_DETECTED` - Replace `ESP_EVT_RESET_FINISH` to ESP_EVT_RESET` - Replace all header files guards with ESP_HDR_ prefix - Add espERRBLOCKING return when function is called in blocking mode when not allowed - Other bug fixes to stabilize AT communication ## v0.4.0 - Add sizeof for every memory allocation - Function typedefs suffix has been renamed to `_fn` instead of `_t` - Merge events for connection data send and data send error - Send callback if sending data is not successful in any case (timeout, ERROR, etc) - Add functions for IP/port retrieval on connections - Remove goto statements and use deep if statements - Fix MQTT problems with username and password - Make consistent variable types across library ## v1.3.0 - Rename all cb annotations with evt, replacing callbacks with events, - Replace built-in memcpy and memset functions with `ESP_MEMCPY` and `ESP_MEMSET` to allow users to do custom implementation - Added example for Server RTOS - Added API to unchain first pbuf in pbuf chain - Implemented first prototype for manual TCP receive functionality. ## v0.2.0 - Fixed netconn issue with wrong data type for OS semaphore - Added support for asynchronous reset - Added support for tickless sleep for modern RTOS systems ## v0.1.0 - Initial release ================================================ FILE: CMakeLists.txt ================================================ cmake_minimum_required(VERSION 3.22) # Setup project project(LwLibPROJECT) if(NOT PROJECT_IS_TOP_LEVEL) add_subdirectory(lwesp) else() add_executable(${PROJECT_NAME}) target_sources(${PROJECT_NAME} PRIVATE ${CMAKE_CURRENT_LIST_DIR}/dev/main.c # Development additional files ${CMAKE_CURRENT_LIST_DIR}/lwesp/src/system/lwesp_mem_lwmem.c ${CMAKE_CURRENT_LIST_DIR}/../lwmem/lwmem/src/lwmem/lwmem.c ${CMAKE_CURRENT_LIST_DIR}/../lwmem/lwmem/src/system/lwmem_sys_win32.c # Http server file system ${CMAKE_CURRENT_LIST_DIR}/lwesp/src/apps/http_server/lwesp_http_server_fs_win32.c # Port specific ${CMAKE_CURRENT_LIST_DIR}/lwesp/src/system/lwesp_ll_win32.c ) target_include_directories(${PROJECT_NAME} PUBLIC ${CMAKE_CURRENT_LIST_DIR} ${CMAKE_CURRENT_LIST_DIR}/dev ${CMAKE_CURRENT_LIST_DIR}/../lwmem/lwmem/src/include ) # Add subdir with lwesp and link to the project set(LWESP_OPTS_FILE ${CMAKE_CURRENT_LIST_DIR}/dev/lwesp_opts.h) set(LWESP_SYS_PORT "win32") add_subdirectory(lwesp) target_link_libraries(${PROJECT_NAME} PUBLIC lwesp_api) target_link_libraries(${PROJECT_NAME} PUBLIC lwesp_apps) target_link_libraries(${PROJECT_NAME} PUBLIC lwesp) add_subdirectory(snippets) target_link_libraries(${PROJECT_NAME} PUBLIC lwesp_snippets) # Add compile options to the library, which will propagate options to executable through public link target_compile_definitions(lwesp PUBLIC WIN32 _DEBUG CONSOLE LWESP_DEV) target_compile_options(lwesp PUBLIC -Wall -Wextra -Wpedantic) endif() ================================================ FILE: CMakePresets.json ================================================ { "version": 3, "configurePresets": [ { "name": "default", "hidden": true, "generator": "Ninja", "binaryDir": "${sourceDir}/build/${presetName}", "cacheVariables": { "CMAKE_EXPORT_COMPILE_COMMANDS": "ON" } }, { "name": "Win32-Debug", "inherits": "default", "toolchainFile": "${sourceDir}/cmake/i686-w64-mingw32-gcc.cmake", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug" } }, { "name": "Win64-Debug", "inherits": "default", "toolchainFile": "${sourceDir}/cmake/x86_64-w64-mingw32-gcc.cmake", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug" } } ], "buildPresets": [ { "name": "Win32-Debug", "configurePreset": "Win32-Debug" }, { "name": "Win64-Debug", "configurePreset": "Win64-Debug" } ] } ================================================ FILE: LICENSE ================================================ MIT License Copyright (c) 2025 Tilen MAJERLE Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: README.md ================================================ # Lightweight ESP-AT parser LwESP is lightweight ESP AT commands parser library to communicate with ESP8266 or ESP32 Wi-Fi modules using AT commands. Module is written in C99 and is system platform agnostic. Its main targets are embedded system devices like ARM Cortex-M, AVR, PIC and others, but can easily work under `Windows`, `Linux` or `MAC` environments too. Espressif module runs official [AT Commands (esp-at)](https://github.com/espressif/esp-at) software and communicates with host device via UART or SPI communication protocol. Follow documentation for more information on implementation and details.

Read first: Documentation

## Features - Supports latest ESP32, ESP32-C2, ESP32-C3, ESP32-C6 & ESP8266 AT software from Espressif system - Platform independent and very easy to port - Development of library under Win32 platform - Available examples for ARM Cortex-M, Win32 or POSIX (mostly Linux) platforms - Written in C language (C99) - Allows different configurations to optimize user requirements - Supports implementation with operating systems with advanced inter-thread communications - Uses `2` tasks for data handling from user and device - Includes several applications built on top of library - Netconn sequential API for client and server - HTTP server with dynamic files (file system) supported - MQTT client - Embeds other AT features, such as WPS management, custom DNS setup, Hostname for DHCP, Ping feature - User friendly MIT license ## Contribute Fresh contributions are always welcome. Simple instructions to proceed: 1. Fork Github repository 2. Follow [C style & coding rules](https://github.com/MaJerle/c-code-style) already used in the project 3. Create a pull request to develop branch with new features or bug fixes Alternatively you may: 1. Report a bug 2. Ask for a feature request ================================================ FILE: TODO.md ================================================ # TODO list - Implement `AT+CWSTATE` to query Wi-Fi state - Implement `AT+CIPSENDL` and `AT+CIPSENDLCFG` for long data send - Implement `AT+CIPTCPOPT` to configure TCP connection - Implement BLE feature - Implement BT feature - Transfer Cayenne MQTT app to be based on non-blocking API instead - Add DNS for IPv6 support (Optional) - Add `AT+CWJEAP` for WPA2 connections - Implement single callback when station is connected and IP is received (so far STA_GOT_IP may be called several times in a row, when IP v4 and v6 are received) - Implement new type of event instead, that is called only once per connection - Add support for wifi mode `0` that has disabled WIFI IP ================================================ FILE: certificates/client_ca_00.crt ================================================ -----BEGIN CERTIFICATE----- MIIDLTCCAhWgAwIBAgIJAMQZBKBLTB95MA0GCSqGSIb3DQEBBQUAMDcxCzAJBgNV BAYTAlMxMQ8wDQYDVQQKDAZFU1AgUzExFzAVBgNVBAMMDkVTUCBSb290IENBIFMx MB4XDTE5MDYyMTA4MDAyMloXDTI5MDYxODA4MDAyMlowNzELMAkGA1UEBhMCUzEx DzANBgNVBAoMBkVTUCBTMTEXMBUGA1UEAwwORVNQIFJvb3QgQ0EgUzEwggEiMA0G CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCt/chHLK76uZwnGywrmWDFt8ixoH2G KJi3QzEW0MT0GUX1/6bCRKEkvDY6Neze26+a6sJCwbhOLcCGIxiPi2L2QHeCrO2n PxTfl2pGm+Vhe0TzTJhHpBSrdbnk2DQBjg6CzK+3f6ZBSuKACpMfHg5Xovgq/2Uz N3Dz1nZ5N90OlNSNBjFW4i9vIk5LtSh62cEFtdGjwGlXtfm4k30ZxfZF8P9z9FXI m9t6L8+B0UqE2Bysg/pHadmw/D0IOqnyji/gzJ56dLQES/Of1R0LQ9EG7ZZLG3eM 1IsSww+0/Iarm1LqAFfTE3NbYkSajAEXIFEsbHpIw4A36y6A80orIq8bAgMBAAGj PDA6MAwGA1UdEwQFMAMBAf8wCwYDVR0PBAQDAgGmMB0GA1UdDgQWBBQE1Ucuke3Z PAiqLlJFyBWR3nV0ujANBgkqhkiG9w0BAQUFAAOCAQEAMgH0OyIh2kgw4s7Gv1Uo vDKhCCO0GqRYBAzEkXbHSJdl1pYFyp2yNCnPWztF6aDAmM9EzWNOJQlig4xwB1SZ Tgk3ov6tkRicfbwhvIfAvvb/XWfVo1XsL20Bp4euE/tI9JmPGOUzuiQWaxVrlkuc qAg4U3gcHY6nBkanpbY9idPF4lDLYZNkxe3+0mp50NxHmiuM/ShoR8xs0ee4fydV wI52uuiEGtjcivHPr0t8J8N+dXJPKqddszsrelwuCDsYMhpJLR2obTMxJx1aP5Zx jw5BTh1TrdGUDe2JumZ7YDUpkQHnfdR7XTF6XubbeJBjHwWr1A7AzFwmbZDO266s Rw== -----END CERTIFICATE----- ================================================ FILE: certificates/client_ca_generated_atpki.hex ================================================ 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x42, 0x45, 0x47, 0x49, 0x4E, 0x20, 0x43, 0x45, 0x52, 0x54, 0x49, 0x46, 0x49, 0x43, 0x41, 0x54, 0x45, 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x0A, 0x4D, 0x49, 0x49, 0x44, 0x4C, 0x54, 0x43, 0x43, 0x41, 0x68, 0x57, 0x67, 0x41, 0x77, 0x49, 0x42, 0x41, 0x67, 0x49, 0x4A, 0x41, 0x4D, 0x51, 0x5A, 0x42, 0x4B, 0x42, 0x4C, 0x54, 0x42, 0x39, 0x35, 0x4D, 0x41, 0x30, 0x47, 0x43, 0x53, 0x71, 0x47, 0x53, 0x49, 0x62, 0x33, 0x44, 0x51, 0x45, 0x42, 0x42, 0x51, 0x55, 0x41, 0x4D, 0x44, 0x63, 0x78, 0x43, 0x7A, 0x41, 0x4A, 0x42, 0x67, 0x4E, 0x56, 0x0A, 0x42, 0x41, 0x59, 0x54, 0x41, 0x6C, 0x4D, 0x78, 0x4D, 0x51, 0x38, 0x77, 0x44, 0x51, 0x59, 0x44, 0x56, 0x51, 0x51, 0x4B, 0x44, 0x41, 0x5A, 0x46, 0x55, 0x31, 0x41, 0x67, 0x55, 0x7A, 0x45, 0x78, 0x46, 0x7A, 0x41, 0x56, 0x42, 0x67, 0x4E, 0x56, 0x42, 0x41, 0x4D, 0x4D, 0x44, 0x6B, 0x56, 0x54, 0x55, 0x43, 0x42, 0x53, 0x62, 0x32, 0x39, 0x30, 0x49, 0x45, 0x4E, 0x42, 0x49, 0x46, 0x4D, 0x78, 0x0A, 0x4D, 0x42, 0x34, 0x58, 0x44, 0x54, 0x45, 0x35, 0x4D, 0x44, 0x59, 0x79, 0x4D, 0x54, 0x41, 0x34, 0x4D, 0x44, 0x41, 0x79, 0x4D, 0x6C, 0x6F, 0x58, 0x44, 0x54, 0x49, 0x35, 0x4D, 0x44, 0x59, 0x78, 0x4F, 0x44, 0x41, 0x34, 0x4D, 0x44, 0x41, 0x79, 0x4D, 0x6C, 0x6F, 0x77, 0x4E, 0x7A, 0x45, 0x4C, 0x4D, 0x41, 0x6B, 0x47, 0x41, 0x31, 0x55, 0x45, 0x42, 0x68, 0x4D, 0x43, 0x55, 0x7A, 0x45, 0x78, 0x0A, 0x44, 0x7A, 0x41, 0x4E, 0x42, 0x67, 0x4E, 0x56, 0x42, 0x41, 0x6F, 0x4D, 0x42, 0x6B, 0x56, 0x54, 0x55, 0x43, 0x42, 0x54, 0x4D, 0x54, 0x45, 0x58, 0x4D, 0x42, 0x55, 0x47, 0x41, 0x31, 0x55, 0x45, 0x41, 0x77, 0x77, 0x4F, 0x52, 0x56, 0x4E, 0x51, 0x49, 0x46, 0x4A, 0x76, 0x62, 0x33, 0x51, 0x67, 0x51, 0x30, 0x45, 0x67, 0x55, 0x7A, 0x45, 0x77, 0x67, 0x67, 0x45, 0x69, 0x4D, 0x41, 0x30, 0x47, 0x0A, 0x43, 0x53, 0x71, 0x47, 0x53, 0x49, 0x62, 0x33, 0x44, 0x51, 0x45, 0x42, 0x41, 0x51, 0x55, 0x41, 0x41, 0x34, 0x49, 0x42, 0x44, 0x77, 0x41, 0x77, 0x67, 0x67, 0x45, 0x4B, 0x41, 0x6F, 0x49, 0x42, 0x41, 0x51, 0x43, 0x74, 0x2F, 0x63, 0x68, 0x48, 0x4C, 0x4B, 0x37, 0x36, 0x75, 0x5A, 0x77, 0x6E, 0x47, 0x79, 0x77, 0x72, 0x6D, 0x57, 0x44, 0x46, 0x74, 0x38, 0x69, 0x78, 0x6F, 0x48, 0x32, 0x47, 0x0A, 0x4B, 0x4A, 0x69, 0x33, 0x51, 0x7A, 0x45, 0x57, 0x30, 0x4D, 0x54, 0x30, 0x47, 0x55, 0x58, 0x31, 0x2F, 0x36, 0x62, 0x43, 0x52, 0x4B, 0x45, 0x6B, 0x76, 0x44, 0x59, 0x36, 0x4E, 0x65, 0x7A, 0x65, 0x32, 0x36, 0x2B, 0x61, 0x36, 0x73, 0x4A, 0x43, 0x77, 0x62, 0x68, 0x4F, 0x4C, 0x63, 0x43, 0x47, 0x49, 0x78, 0x69, 0x50, 0x69, 0x32, 0x4C, 0x32, 0x51, 0x48, 0x65, 0x43, 0x72, 0x4F, 0x32, 0x6E, 0x0A, 0x50, 0x78, 0x54, 0x66, 0x6C, 0x32, 0x70, 0x47, 0x6D, 0x2B, 0x56, 0x68, 0x65, 0x30, 0x54, 0x7A, 0x54, 0x4A, 0x68, 0x48, 0x70, 0x42, 0x53, 0x72, 0x64, 0x62, 0x6E, 0x6B, 0x32, 0x44, 0x51, 0x42, 0x6A, 0x67, 0x36, 0x43, 0x7A, 0x4B, 0x2B, 0x33, 0x66, 0x36, 0x5A, 0x42, 0x53, 0x75, 0x4B, 0x41, 0x43, 0x70, 0x4D, 0x66, 0x48, 0x67, 0x35, 0x58, 0x6F, 0x76, 0x67, 0x71, 0x2F, 0x32, 0x55, 0x7A, 0x0A, 0x4E, 0x33, 0x44, 0x7A, 0x31, 0x6E, 0x5A, 0x35, 0x4E, 0x39, 0x30, 0x4F, 0x6C, 0x4E, 0x53, 0x4E, 0x42, 0x6A, 0x46, 0x57, 0x34, 0x69, 0x39, 0x76, 0x49, 0x6B, 0x35, 0x4C, 0x74, 0x53, 0x68, 0x36, 0x32, 0x63, 0x45, 0x46, 0x74, 0x64, 0x47, 0x6A, 0x77, 0x47, 0x6C, 0x58, 0x74, 0x66, 0x6D, 0x34, 0x6B, 0x33, 0x30, 0x5A, 0x78, 0x66, 0x5A, 0x46, 0x38, 0x50, 0x39, 0x7A, 0x39, 0x46, 0x58, 0x49, 0x0A, 0x6D, 0x39, 0x74, 0x36, 0x4C, 0x38, 0x2B, 0x42, 0x30, 0x55, 0x71, 0x45, 0x32, 0x42, 0x79, 0x73, 0x67, 0x2F, 0x70, 0x48, 0x61, 0x64, 0x6D, 0x77, 0x2F, 0x44, 0x30, 0x49, 0x4F, 0x71, 0x6E, 0x79, 0x6A, 0x69, 0x2F, 0x67, 0x7A, 0x4A, 0x35, 0x36, 0x64, 0x4C, 0x51, 0x45, 0x53, 0x2F, 0x4F, 0x66, 0x31, 0x52, 0x30, 0x4C, 0x51, 0x39, 0x45, 0x47, 0x37, 0x5A, 0x5A, 0x4C, 0x47, 0x33, 0x65, 0x4D, 0x0A, 0x31, 0x49, 0x73, 0x53, 0x77, 0x77, 0x2B, 0x30, 0x2F, 0x49, 0x61, 0x72, 0x6D, 0x31, 0x4C, 0x71, 0x41, 0x46, 0x66, 0x54, 0x45, 0x33, 0x4E, 0x62, 0x59, 0x6B, 0x53, 0x61, 0x6A, 0x41, 0x45, 0x58, 0x49, 0x46, 0x45, 0x73, 0x62, 0x48, 0x70, 0x49, 0x77, 0x34, 0x41, 0x33, 0x36, 0x79, 0x36, 0x41, 0x38, 0x30, 0x6F, 0x72, 0x49, 0x71, 0x38, 0x62, 0x41, 0x67, 0x4D, 0x42, 0x41, 0x41, 0x47, 0x6A, 0x0A, 0x50, 0x44, 0x41, 0x36, 0x4D, 0x41, 0x77, 0x47, 0x41, 0x31, 0x55, 0x64, 0x45, 0x77, 0x51, 0x46, 0x4D, 0x41, 0x4D, 0x42, 0x41, 0x66, 0x38, 0x77, 0x43, 0x77, 0x59, 0x44, 0x56, 0x52, 0x30, 0x50, 0x42, 0x41, 0x51, 0x44, 0x41, 0x67, 0x47, 0x6D, 0x4D, 0x42, 0x30, 0x47, 0x41, 0x31, 0x55, 0x64, 0x44, 0x67, 0x51, 0x57, 0x42, 0x42, 0x51, 0x45, 0x31, 0x55, 0x63, 0x75, 0x6B, 0x65, 0x33, 0x5A, 0x0A, 0x50, 0x41, 0x69, 0x71, 0x4C, 0x6C, 0x4A, 0x46, 0x79, 0x42, 0x57, 0x52, 0x33, 0x6E, 0x56, 0x30, 0x75, 0x6A, 0x41, 0x4E, 0x42, 0x67, 0x6B, 0x71, 0x68, 0x6B, 0x69, 0x47, 0x39, 0x77, 0x30, 0x42, 0x41, 0x51, 0x55, 0x46, 0x41, 0x41, 0x4F, 0x43, 0x41, 0x51, 0x45, 0x41, 0x4D, 0x67, 0x48, 0x30, 0x4F, 0x79, 0x49, 0x68, 0x32, 0x6B, 0x67, 0x77, 0x34, 0x73, 0x37, 0x47, 0x76, 0x31, 0x55, 0x6F, 0x0A, 0x76, 0x44, 0x4B, 0x68, 0x43, 0x43, 0x4F, 0x30, 0x47, 0x71, 0x52, 0x59, 0x42, 0x41, 0x7A, 0x45, 0x6B, 0x58, 0x62, 0x48, 0x53, 0x4A, 0x64, 0x6C, 0x31, 0x70, 0x59, 0x46, 0x79, 0x70, 0x32, 0x79, 0x4E, 0x43, 0x6E, 0x50, 0x57, 0x7A, 0x74, 0x46, 0x36, 0x61, 0x44, 0x41, 0x6D, 0x4D, 0x39, 0x45, 0x7A, 0x57, 0x4E, 0x4F, 0x4A, 0x51, 0x6C, 0x69, 0x67, 0x34, 0x78, 0x77, 0x42, 0x31, 0x53, 0x5A, 0x0A, 0x54, 0x67, 0x6B, 0x33, 0x6F, 0x76, 0x36, 0x74, 0x6B, 0x52, 0x69, 0x63, 0x66, 0x62, 0x77, 0x68, 0x76, 0x49, 0x66, 0x41, 0x76, 0x76, 0x62, 0x2F, 0x58, 0x57, 0x66, 0x56, 0x6F, 0x31, 0x58, 0x73, 0x4C, 0x32, 0x30, 0x42, 0x70, 0x34, 0x65, 0x75, 0x45, 0x2F, 0x74, 0x49, 0x39, 0x4A, 0x6D, 0x50, 0x47, 0x4F, 0x55, 0x7A, 0x75, 0x69, 0x51, 0x57, 0x61, 0x78, 0x56, 0x72, 0x6C, 0x6B, 0x75, 0x63, 0x0A, 0x71, 0x41, 0x67, 0x34, 0x55, 0x33, 0x67, 0x63, 0x48, 0x59, 0x36, 0x6E, 0x42, 0x6B, 0x61, 0x6E, 0x70, 0x62, 0x59, 0x39, 0x69, 0x64, 0x50, 0x46, 0x34, 0x6C, 0x44, 0x4C, 0x59, 0x5A, 0x4E, 0x6B, 0x78, 0x65, 0x33, 0x2B, 0x30, 0x6D, 0x70, 0x35, 0x30, 0x4E, 0x78, 0x48, 0x6D, 0x69, 0x75, 0x4D, 0x2F, 0x53, 0x68, 0x6F, 0x52, 0x38, 0x78, 0x73, 0x30, 0x65, 0x65, 0x34, 0x66, 0x79, 0x64, 0x56, 0x0A, 0x77, 0x49, 0x35, 0x32, 0x75, 0x75, 0x69, 0x45, 0x47, 0x74, 0x6A, 0x63, 0x69, 0x76, 0x48, 0x50, 0x72, 0x30, 0x74, 0x38, 0x4A, 0x38, 0x4E, 0x2B, 0x64, 0x58, 0x4A, 0x50, 0x4B, 0x71, 0x64, 0x64, 0x73, 0x7A, 0x73, 0x72, 0x65, 0x6C, 0x77, 0x75, 0x43, 0x44, 0x73, 0x59, 0x4D, 0x68, 0x70, 0x4A, 0x4C, 0x52, 0x32, 0x6F, 0x62, 0x54, 0x4D, 0x78, 0x4A, 0x78, 0x31, 0x61, 0x50, 0x35, 0x5A, 0x78, 0x0A, 0x6A, 0x77, 0x35, 0x42, 0x54, 0x68, 0x31, 0x54, 0x72, 0x64, 0x47, 0x55, 0x44, 0x65, 0x32, 0x4A, 0x75, 0x6D, 0x5A, 0x37, 0x59, 0x44, 0x55, 0x70, 0x6B, 0x51, 0x48, 0x6E, 0x66, 0x64, 0x52, 0x37, 0x58, 0x54, 0x46, 0x36, 0x58, 0x75, 0x62, 0x62, 0x65, 0x4A, 0x42, 0x6A, 0x48, 0x77, 0x57, 0x72, 0x31, 0x41, 0x37, 0x41, 0x7A, 0x46, 0x77, 0x6D, 0x62, 0x5A, 0x44, 0x4F, 0x32, 0x36, 0x36, 0x73, 0x0A, 0x52, 0x77, 0x3D, 0x3D, 0x0A, 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x45, 0x4E, 0x44, 0x20, 0x43, 0x45, 0x52, 0x54, 0x49, 0x46, 0x49, 0x43, 0x41, 0x54, 0x45, 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x0A ================================================ FILE: certificates/client_cert_00.crt ================================================ -----BEGIN CERTIFICATE----- MIIDLTCCAhWgAwIBAgIJAN6LrsW0Qt2FMA0GCSqGSIb3DQEBCwUAMDcxCzAJBgNV BAYTAkMxMQ8wDQYDVQQKDAZFU1AgQzExFzAVBgNVBAMMDkVTUCBSb290IENBIEMx MB4XDTE5MDYyMTA4MDAyM1oXDTI5MDYxODA4MDAyM1owNzELMAkGA1UEBhMCQzIx DzANBgNVBAoMBkVTUCBDMjEXMBUGA1UEAwwORVNQIFJvb3QgQ0EgQzIwggEiMA0G CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC02DXgCw0gSDShaHLDlanRppKjIoJ0 JW/+gDkg8j1PCNm5WxkAx3BItBN6hnJwwlQ4DMWCZXe+EDDYz8cKLC5g2TetrpxJ aSQ4JyPqxU5uiym26C+nTL9/d40Nom//3+fDjA0+7bdUkffcKdhZV7MsxKF2dBb9 eKFJeIjc8q0Q0LqKr3xnKOeGN2Xt80oJTv8XIEfko/mfkINr83AhH/WPkSg2kJS/ C2Xyl6Q22ew01vZv0Am5ocl3+ju2Dyv/nbQl2Vru1K9TD+b8fDacmqZco4oeQBvf EhyW7FOhUf2yLgpUdEEGyAMZ9JgoTJih1dnr9CLHkt/XMCn03HOcfpPlAgMBAAGj PDA6MAwGA1UdEwQFMAMBAf8wCwYDVR0PBAQDAgGmMB0GA1UdDgQWBBR+kprR64Cl lQZk6w6hJGlsrerCTTANBgkqhkiG9w0BAQsFAAOCAQEAYfcgIyQsA+lvlIMIz+1z cyhnGuwywEEa0h5pGvWizxfx/EARam5sCXC49i3S788wAqbdg3d8iQp662ybT3O0 WimqJDgr7LFIMq8UIxJHIMdcf7mUmleUJUmbAiFAo1XWb6MoVIUW7aR1+0aKKCIK OcvYlvkenM3P+lLQe/nEvnvyhsc78V4V56FKz/S+ePsgSIurEaDnFe8LSZ5aHESB p9muQdGJYMuR1GnZbINix/4j8Q0S5z2MI+6bWqU9cfk1rFuHqd4tZ6BmLCAFC7fH w6s/PGhr0UHx+NmTmdOvp9Ny2qLO9vvfl5h7wDG/pzcGvbYWHPZSvPeNVQRE13DH Dg== -----END CERTIFICATE----- ================================================ FILE: certificates/client_cert_generated_atpki.hex ================================================ 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x42, 0x45, 0x47, 0x49, 0x4E, 0x20, 0x43, 0x45, 0x52, 0x54, 0x49, 0x46, 0x49, 0x43, 0x41, 0x54, 0x45, 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x0A, 0x4D, 0x49, 0x49, 0x44, 0x4C, 0x54, 0x43, 0x43, 0x41, 0x68, 0x57, 0x67, 0x41, 0x77, 0x49, 0x42, 0x41, 0x67, 0x49, 0x4A, 0x41, 0x4E, 0x36, 0x4C, 0x72, 0x73, 0x57, 0x30, 0x51, 0x74, 0x32, 0x46, 0x4D, 0x41, 0x30, 0x47, 0x43, 0x53, 0x71, 0x47, 0x53, 0x49, 0x62, 0x33, 0x44, 0x51, 0x45, 0x42, 0x43, 0x77, 0x55, 0x41, 0x4D, 0x44, 0x63, 0x78, 0x43, 0x7A, 0x41, 0x4A, 0x42, 0x67, 0x4E, 0x56, 0x0A, 0x42, 0x41, 0x59, 0x54, 0x41, 0x6B, 0x4D, 0x78, 0x4D, 0x51, 0x38, 0x77, 0x44, 0x51, 0x59, 0x44, 0x56, 0x51, 0x51, 0x4B, 0x44, 0x41, 0x5A, 0x46, 0x55, 0x31, 0x41, 0x67, 0x51, 0x7A, 0x45, 0x78, 0x46, 0x7A, 0x41, 0x56, 0x42, 0x67, 0x4E, 0x56, 0x42, 0x41, 0x4D, 0x4D, 0x44, 0x6B, 0x56, 0x54, 0x55, 0x43, 0x42, 0x53, 0x62, 0x32, 0x39, 0x30, 0x49, 0x45, 0x4E, 0x42, 0x49, 0x45, 0x4D, 0x78, 0x0A, 0x4D, 0x42, 0x34, 0x58, 0x44, 0x54, 0x45, 0x35, 0x4D, 0x44, 0x59, 0x79, 0x4D, 0x54, 0x41, 0x34, 0x4D, 0x44, 0x41, 0x79, 0x4D, 0x31, 0x6F, 0x58, 0x44, 0x54, 0x49, 0x35, 0x4D, 0x44, 0x59, 0x78, 0x4F, 0x44, 0x41, 0x34, 0x4D, 0x44, 0x41, 0x79, 0x4D, 0x31, 0x6F, 0x77, 0x4E, 0x7A, 0x45, 0x4C, 0x4D, 0x41, 0x6B, 0x47, 0x41, 0x31, 0x55, 0x45, 0x42, 0x68, 0x4D, 0x43, 0x51, 0x7A, 0x49, 0x78, 0x0A, 0x44, 0x7A, 0x41, 0x4E, 0x42, 0x67, 0x4E, 0x56, 0x42, 0x41, 0x6F, 0x4D, 0x42, 0x6B, 0x56, 0x54, 0x55, 0x43, 0x42, 0x44, 0x4D, 0x6A, 0x45, 0x58, 0x4D, 0x42, 0x55, 0x47, 0x41, 0x31, 0x55, 0x45, 0x41, 0x77, 0x77, 0x4F, 0x52, 0x56, 0x4E, 0x51, 0x49, 0x46, 0x4A, 0x76, 0x62, 0x33, 0x51, 0x67, 0x51, 0x30, 0x45, 0x67, 0x51, 0x7A, 0x49, 0x77, 0x67, 0x67, 0x45, 0x69, 0x4D, 0x41, 0x30, 0x47, 0x0A, 0x43, 0x53, 0x71, 0x47, 0x53, 0x49, 0x62, 0x33, 0x44, 0x51, 0x45, 0x42, 0x41, 0x51, 0x55, 0x41, 0x41, 0x34, 0x49, 0x42, 0x44, 0x77, 0x41, 0x77, 0x67, 0x67, 0x45, 0x4B, 0x41, 0x6F, 0x49, 0x42, 0x41, 0x51, 0x43, 0x30, 0x32, 0x44, 0x58, 0x67, 0x43, 0x77, 0x30, 0x67, 0x53, 0x44, 0x53, 0x68, 0x61, 0x48, 0x4C, 0x44, 0x6C, 0x61, 0x6E, 0x52, 0x70, 0x70, 0x4B, 0x6A, 0x49, 0x6F, 0x4A, 0x30, 0x0A, 0x4A, 0x57, 0x2F, 0x2B, 0x67, 0x44, 0x6B, 0x67, 0x38, 0x6A, 0x31, 0x50, 0x43, 0x4E, 0x6D, 0x35, 0x57, 0x78, 0x6B, 0x41, 0x78, 0x33, 0x42, 0x49, 0x74, 0x42, 0x4E, 0x36, 0x68, 0x6E, 0x4A, 0x77, 0x77, 0x6C, 0x51, 0x34, 0x44, 0x4D, 0x57, 0x43, 0x5A, 0x58, 0x65, 0x2B, 0x45, 0x44, 0x44, 0x59, 0x7A, 0x38, 0x63, 0x4B, 0x4C, 0x43, 0x35, 0x67, 0x32, 0x54, 0x65, 0x74, 0x72, 0x70, 0x78, 0x4A, 0x0A, 0x61, 0x53, 0x51, 0x34, 0x4A, 0x79, 0x50, 0x71, 0x78, 0x55, 0x35, 0x75, 0x69, 0x79, 0x6D, 0x32, 0x36, 0x43, 0x2B, 0x6E, 0x54, 0x4C, 0x39, 0x2F, 0x64, 0x34, 0x30, 0x4E, 0x6F, 0x6D, 0x2F, 0x2F, 0x33, 0x2B, 0x66, 0x44, 0x6A, 0x41, 0x30, 0x2B, 0x37, 0x62, 0x64, 0x55, 0x6B, 0x66, 0x66, 0x63, 0x4B, 0x64, 0x68, 0x5A, 0x56, 0x37, 0x4D, 0x73, 0x78, 0x4B, 0x46, 0x32, 0x64, 0x42, 0x62, 0x39, 0x0A, 0x65, 0x4B, 0x46, 0x4A, 0x65, 0x49, 0x6A, 0x63, 0x38, 0x71, 0x30, 0x51, 0x30, 0x4C, 0x71, 0x4B, 0x72, 0x33, 0x78, 0x6E, 0x4B, 0x4F, 0x65, 0x47, 0x4E, 0x32, 0x58, 0x74, 0x38, 0x30, 0x6F, 0x4A, 0x54, 0x76, 0x38, 0x58, 0x49, 0x45, 0x66, 0x6B, 0x6F, 0x2F, 0x6D, 0x66, 0x6B, 0x49, 0x4E, 0x72, 0x38, 0x33, 0x41, 0x68, 0x48, 0x2F, 0x57, 0x50, 0x6B, 0x53, 0x67, 0x32, 0x6B, 0x4A, 0x53, 0x2F, 0x0A, 0x43, 0x32, 0x58, 0x79, 0x6C, 0x36, 0x51, 0x32, 0x32, 0x65, 0x77, 0x30, 0x31, 0x76, 0x5A, 0x76, 0x30, 0x41, 0x6D, 0x35, 0x6F, 0x63, 0x6C, 0x33, 0x2B, 0x6A, 0x75, 0x32, 0x44, 0x79, 0x76, 0x2F, 0x6E, 0x62, 0x51, 0x6C, 0x32, 0x56, 0x72, 0x75, 0x31, 0x4B, 0x39, 0x54, 0x44, 0x2B, 0x62, 0x38, 0x66, 0x44, 0x61, 0x63, 0x6D, 0x71, 0x5A, 0x63, 0x6F, 0x34, 0x6F, 0x65, 0x51, 0x42, 0x76, 0x66, 0x0A, 0x45, 0x68, 0x79, 0x57, 0x37, 0x46, 0x4F, 0x68, 0x55, 0x66, 0x32, 0x79, 0x4C, 0x67, 0x70, 0x55, 0x64, 0x45, 0x45, 0x47, 0x79, 0x41, 0x4D, 0x5A, 0x39, 0x4A, 0x67, 0x6F, 0x54, 0x4A, 0x69, 0x68, 0x31, 0x64, 0x6E, 0x72, 0x39, 0x43, 0x4C, 0x48, 0x6B, 0x74, 0x2F, 0x58, 0x4D, 0x43, 0x6E, 0x30, 0x33, 0x48, 0x4F, 0x63, 0x66, 0x70, 0x50, 0x6C, 0x41, 0x67, 0x4D, 0x42, 0x41, 0x41, 0x47, 0x6A, 0x0A, 0x50, 0x44, 0x41, 0x36, 0x4D, 0x41, 0x77, 0x47, 0x41, 0x31, 0x55, 0x64, 0x45, 0x77, 0x51, 0x46, 0x4D, 0x41, 0x4D, 0x42, 0x41, 0x66, 0x38, 0x77, 0x43, 0x77, 0x59, 0x44, 0x56, 0x52, 0x30, 0x50, 0x42, 0x41, 0x51, 0x44, 0x41, 0x67, 0x47, 0x6D, 0x4D, 0x42, 0x30, 0x47, 0x41, 0x31, 0x55, 0x64, 0x44, 0x67, 0x51, 0x57, 0x42, 0x42, 0x52, 0x2B, 0x6B, 0x70, 0x72, 0x52, 0x36, 0x34, 0x43, 0x6C, 0x0A, 0x6C, 0x51, 0x5A, 0x6B, 0x36, 0x77, 0x36, 0x68, 0x4A, 0x47, 0x6C, 0x73, 0x72, 0x65, 0x72, 0x43, 0x54, 0x54, 0x41, 0x4E, 0x42, 0x67, 0x6B, 0x71, 0x68, 0x6B, 0x69, 0x47, 0x39, 0x77, 0x30, 0x42, 0x41, 0x51, 0x73, 0x46, 0x41, 0x41, 0x4F, 0x43, 0x41, 0x51, 0x45, 0x41, 0x59, 0x66, 0x63, 0x67, 0x49, 0x79, 0x51, 0x73, 0x41, 0x2B, 0x6C, 0x76, 0x6C, 0x49, 0x4D, 0x49, 0x7A, 0x2B, 0x31, 0x7A, 0x0A, 0x63, 0x79, 0x68, 0x6E, 0x47, 0x75, 0x77, 0x79, 0x77, 0x45, 0x45, 0x61, 0x30, 0x68, 0x35, 0x70, 0x47, 0x76, 0x57, 0x69, 0x7A, 0x78, 0x66, 0x78, 0x2F, 0x45, 0x41, 0x52, 0x61, 0x6D, 0x35, 0x73, 0x43, 0x58, 0x43, 0x34, 0x39, 0x69, 0x33, 0x53, 0x37, 0x38, 0x38, 0x77, 0x41, 0x71, 0x62, 0x64, 0x67, 0x33, 0x64, 0x38, 0x69, 0x51, 0x70, 0x36, 0x36, 0x32, 0x79, 0x62, 0x54, 0x33, 0x4F, 0x30, 0x0A, 0x57, 0x69, 0x6D, 0x71, 0x4A, 0x44, 0x67, 0x72, 0x37, 0x4C, 0x46, 0x49, 0x4D, 0x71, 0x38, 0x55, 0x49, 0x78, 0x4A, 0x48, 0x49, 0x4D, 0x64, 0x63, 0x66, 0x37, 0x6D, 0x55, 0x6D, 0x6C, 0x65, 0x55, 0x4A, 0x55, 0x6D, 0x62, 0x41, 0x69, 0x46, 0x41, 0x6F, 0x31, 0x58, 0x57, 0x62, 0x36, 0x4D, 0x6F, 0x56, 0x49, 0x55, 0x57, 0x37, 0x61, 0x52, 0x31, 0x2B, 0x30, 0x61, 0x4B, 0x4B, 0x43, 0x49, 0x4B, 0x0A, 0x4F, 0x63, 0x76, 0x59, 0x6C, 0x76, 0x6B, 0x65, 0x6E, 0x4D, 0x33, 0x50, 0x2B, 0x6C, 0x4C, 0x51, 0x65, 0x2F, 0x6E, 0x45, 0x76, 0x6E, 0x76, 0x79, 0x68, 0x73, 0x63, 0x37, 0x38, 0x56, 0x34, 0x56, 0x35, 0x36, 0x46, 0x4B, 0x7A, 0x2F, 0x53, 0x2B, 0x65, 0x50, 0x73, 0x67, 0x53, 0x49, 0x75, 0x72, 0x45, 0x61, 0x44, 0x6E, 0x46, 0x65, 0x38, 0x4C, 0x53, 0x5A, 0x35, 0x61, 0x48, 0x45, 0x53, 0x42, 0x0A, 0x70, 0x39, 0x6D, 0x75, 0x51, 0x64, 0x47, 0x4A, 0x59, 0x4D, 0x75, 0x52, 0x31, 0x47, 0x6E, 0x5A, 0x62, 0x49, 0x4E, 0x69, 0x78, 0x2F, 0x34, 0x6A, 0x38, 0x51, 0x30, 0x53, 0x35, 0x7A, 0x32, 0x4D, 0x49, 0x2B, 0x36, 0x62, 0x57, 0x71, 0x55, 0x39, 0x63, 0x66, 0x6B, 0x31, 0x72, 0x46, 0x75, 0x48, 0x71, 0x64, 0x34, 0x74, 0x5A, 0x36, 0x42, 0x6D, 0x4C, 0x43, 0x41, 0x46, 0x43, 0x37, 0x66, 0x48, 0x0A, 0x77, 0x36, 0x73, 0x2F, 0x50, 0x47, 0x68, 0x72, 0x30, 0x55, 0x48, 0x78, 0x2B, 0x4E, 0x6D, 0x54, 0x6D, 0x64, 0x4F, 0x76, 0x70, 0x39, 0x4E, 0x79, 0x32, 0x71, 0x4C, 0x4F, 0x39, 0x76, 0x76, 0x66, 0x6C, 0x35, 0x68, 0x37, 0x77, 0x44, 0x47, 0x2F, 0x70, 0x7A, 0x63, 0x47, 0x76, 0x62, 0x59, 0x57, 0x48, 0x50, 0x5A, 0x53, 0x76, 0x50, 0x65, 0x4E, 0x56, 0x51, 0x52, 0x45, 0x31, 0x33, 0x44, 0x48, 0x0A, 0x44, 0x67, 0x3D, 0x3D, 0x0A, 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x45, 0x4E, 0x44, 0x20, 0x43, 0x45, 0x52, 0x54, 0x49, 0x46, 0x49, 0x43, 0x41, 0x54, 0x45, 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x0A ================================================ FILE: certificates/client_key_00.key ================================================ -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAtNg14AsNIEg0oWhyw5Wp0aaSoyKCdCVv/oA5IPI9TwjZuVsZ AMdwSLQTeoZycMJUOAzFgmV3vhAw2M/HCiwuYNk3ra6cSWkkOCcj6sVObosptugv p0y/f3eNDaJv/9/nw4wNPu23VJH33CnYWVezLMShdnQW/XihSXiI3PKtENC6iq98 Zyjnhjdl7fNKCU7/FyBH5KP5n5CDa/NwIR/1j5EoNpCUvwtl8pekNtnsNNb2b9AJ uaHJd/o7tg8r/520Jdla7tSvUw/m/Hw2nJqmXKOKHkAb3xIcluxToVH9si4KVHRB BsgDGfSYKEyYodXZ6/Qix5Lf1zAp9NxznH6T5QIDAQABAoIBAHPyyCAclc7j3LK8 SBC0jYv40726q4+STUsMpRRFnB9nWkkoalCAjrJemrqNJyS6w8qoDZ58NhjrQpZQ KZqRFy9LNhKqiFPdELbcCYBF/vKLUTSPi7YlVAaC/TIHuu2AfpV23ytAuLGFYTiM r8UgoKWMcMWEyxS62hZELOQUx/el9xjTv3+HWS9804qcrdyqztJRw2M1fton8C3w GPVZ7uwr2aqyuFDLAS17tanTl1E66iczHef+cTK4TjGLIMcNkNHPerAqJ7Le6o1R VQaRJX7pVq5uc3jty84PndWhX/Uyo0t3bsI1x+62L6JA37ML4WSDZtBzWyQPJw0l YJ8U1SUCgYEA7dO84bV51seNO+vqejCGpk69LQj5wCh06iROcjb3knbODQbRQKOM 6g21e++Z4WEfoQWaLZVdPn71cXR+EbOvfacG5tGpDus0ZhxH4IM3HmYb5vfcJ0mU byiPfZQSVxjCsdV2vWsbZbHKl5p0UaAyiyT2pMkl4ngySL1OE2dlm2sCgYEAwqnO oE22l2O/HCBpAmG/7IyOLjhbTuUHlshe8O3KH18/WFbp4Nvf2qv+FZoCRp0W7B+4 2P9Ncusq3M10TsUh3A/5QOineCPsKe22UTzs2WOAP+YT0MORFWmQttnEETn2+3zS sdu6M0K7K/XYtEHcgFM3TT4iP+keYemsYGlpMe8CgYAU0pcVA/iY73vUJUGwVRNU +Evj54dGZcRmw6sCoQFoF3LO/SvRBwDNdUnQghfs/b3xMTZgi1VQpXkD5/kpv5u7 2qXmC7FLlxhNYGiCpbprtPD4dfcWkYCngtudWRuJ+KcDPvdYeko5yyk7wNAyXV5P hHr7zoi8nV15tOljFYh15QKBgQC/sKegg+aCPd87u06s4cU1E1QPf7+qeS539OhJ KGAZdJnUTAITQ3G0zBlw/C+xiY/BBZvpU77Yo2uZ81fNGaK2KaSxnmkLjZRJ1aPr a6twhuMMCW0J7ws3orS22sqQjBwCmnCAZHd/cv8N0xKKrzCLzWZv0fe4J7+be5gb eLH2UQKBgA6DmumbC+aqdSFaYphFFiCEXzrr6o6Iy1d694Ll+Umsx8JnI3TaRuAy cDLbLZ41vKeRqkm0ylLEBwsVa7/ycL29eG5vzI4mSg8XABDZaCbOfpyrJzruGTKg G4NFJpOVnlhhl5qcKsWhkBwvTGao4+j7FFI1SmbvwxtzmhpvDp/e -----END RSA PRIVATE KEY----- ================================================ FILE: certificates/client_key_generated_atpki.HEX ================================================ 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x42, 0x45, 0x47, 0x49, 0x4E, 0x20, 0x52, 0x53, 0x41, 0x20, 0x50, 0x52, 0x49, 0x56, 0x41, 0x54, 0x45, 0x20, 0x4B, 0x45, 0x59, 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x0A, 0x4D, 0x49, 0x49, 0x45, 0x6F, 0x77, 0x49, 0x42, 0x41, 0x41, 0x4B, 0x43, 0x41, 0x51, 0x45, 0x41, 0x74, 0x4E, 0x67, 0x31, 0x34, 0x41, 0x73, 0x4E, 0x49, 0x45, 0x67, 0x30, 0x6F, 0x57, 0x68, 0x79, 0x77, 0x35, 0x57, 0x70, 0x30, 0x61, 0x61, 0x53, 0x6F, 0x79, 0x4B, 0x43, 0x64, 0x43, 0x56, 0x76, 0x2F, 0x6F, 0x41, 0x35, 0x49, 0x50, 0x49, 0x39, 0x54, 0x77, 0x6A, 0x5A, 0x75, 0x56, 0x73, 0x5A, 0x0A, 0x41, 0x4D, 0x64, 0x77, 0x53, 0x4C, 0x51, 0x54, 0x65, 0x6F, 0x5A, 0x79, 0x63, 0x4D, 0x4A, 0x55, 0x4F, 0x41, 0x7A, 0x46, 0x67, 0x6D, 0x56, 0x33, 0x76, 0x68, 0x41, 0x77, 0x32, 0x4D, 0x2F, 0x48, 0x43, 0x69, 0x77, 0x75, 0x59, 0x4E, 0x6B, 0x33, 0x72, 0x61, 0x36, 0x63, 0x53, 0x57, 0x6B, 0x6B, 0x4F, 0x43, 0x63, 0x6A, 0x36, 0x73, 0x56, 0x4F, 0x62, 0x6F, 0x73, 0x70, 0x74, 0x75, 0x67, 0x76, 0x0A, 0x70, 0x30, 0x79, 0x2F, 0x66, 0x33, 0x65, 0x4E, 0x44, 0x61, 0x4A, 0x76, 0x2F, 0x39, 0x2F, 0x6E, 0x77, 0x34, 0x77, 0x4E, 0x50, 0x75, 0x32, 0x33, 0x56, 0x4A, 0x48, 0x33, 0x33, 0x43, 0x6E, 0x59, 0x57, 0x56, 0x65, 0x7A, 0x4C, 0x4D, 0x53, 0x68, 0x64, 0x6E, 0x51, 0x57, 0x2F, 0x58, 0x69, 0x68, 0x53, 0x58, 0x69, 0x49, 0x33, 0x50, 0x4B, 0x74, 0x45, 0x4E, 0x43, 0x36, 0x69, 0x71, 0x39, 0x38, 0x0A, 0x5A, 0x79, 0x6A, 0x6E, 0x68, 0x6A, 0x64, 0x6C, 0x37, 0x66, 0x4E, 0x4B, 0x43, 0x55, 0x37, 0x2F, 0x46, 0x79, 0x42, 0x48, 0x35, 0x4B, 0x50, 0x35, 0x6E, 0x35, 0x43, 0x44, 0x61, 0x2F, 0x4E, 0x77, 0x49, 0x52, 0x2F, 0x31, 0x6A, 0x35, 0x45, 0x6F, 0x4E, 0x70, 0x43, 0x55, 0x76, 0x77, 0x74, 0x6C, 0x38, 0x70, 0x65, 0x6B, 0x4E, 0x74, 0x6E, 0x73, 0x4E, 0x4E, 0x62, 0x32, 0x62, 0x39, 0x41, 0x4A, 0x0A, 0x75, 0x61, 0x48, 0x4A, 0x64, 0x2F, 0x6F, 0x37, 0x74, 0x67, 0x38, 0x72, 0x2F, 0x35, 0x32, 0x30, 0x4A, 0x64, 0x6C, 0x61, 0x37, 0x74, 0x53, 0x76, 0x55, 0x77, 0x2F, 0x6D, 0x2F, 0x48, 0x77, 0x32, 0x6E, 0x4A, 0x71, 0x6D, 0x58, 0x4B, 0x4F, 0x4B, 0x48, 0x6B, 0x41, 0x62, 0x33, 0x78, 0x49, 0x63, 0x6C, 0x75, 0x78, 0x54, 0x6F, 0x56, 0x48, 0x39, 0x73, 0x69, 0x34, 0x4B, 0x56, 0x48, 0x52, 0x42, 0x0A, 0x42, 0x73, 0x67, 0x44, 0x47, 0x66, 0x53, 0x59, 0x4B, 0x45, 0x79, 0x59, 0x6F, 0x64, 0x58, 0x5A, 0x36, 0x2F, 0x51, 0x69, 0x78, 0x35, 0x4C, 0x66, 0x31, 0x7A, 0x41, 0x70, 0x39, 0x4E, 0x78, 0x7A, 0x6E, 0x48, 0x36, 0x54, 0x35, 0x51, 0x49, 0x44, 0x41, 0x51, 0x41, 0x42, 0x41, 0x6F, 0x49, 0x42, 0x41, 0x48, 0x50, 0x79, 0x79, 0x43, 0x41, 0x63, 0x6C, 0x63, 0x37, 0x6A, 0x33, 0x4C, 0x4B, 0x38, 0x0A, 0x53, 0x42, 0x43, 0x30, 0x6A, 0x59, 0x76, 0x34, 0x30, 0x37, 0x32, 0x36, 0x71, 0x34, 0x2B, 0x53, 0x54, 0x55, 0x73, 0x4D, 0x70, 0x52, 0x52, 0x46, 0x6E, 0x42, 0x39, 0x6E, 0x57, 0x6B, 0x6B, 0x6F, 0x61, 0x6C, 0x43, 0x41, 0x6A, 0x72, 0x4A, 0x65, 0x6D, 0x72, 0x71, 0x4E, 0x4A, 0x79, 0x53, 0x36, 0x77, 0x38, 0x71, 0x6F, 0x44, 0x5A, 0x35, 0x38, 0x4E, 0x68, 0x6A, 0x72, 0x51, 0x70, 0x5A, 0x51, 0x0A, 0x4B, 0x5A, 0x71, 0x52, 0x46, 0x79, 0x39, 0x4C, 0x4E, 0x68, 0x4B, 0x71, 0x69, 0x46, 0x50, 0x64, 0x45, 0x4C, 0x62, 0x63, 0x43, 0x59, 0x42, 0x46, 0x2F, 0x76, 0x4B, 0x4C, 0x55, 0x54, 0x53, 0x50, 0x69, 0x37, 0x59, 0x6C, 0x56, 0x41, 0x61, 0x43, 0x2F, 0x54, 0x49, 0x48, 0x75, 0x75, 0x32, 0x41, 0x66, 0x70, 0x56, 0x32, 0x33, 0x79, 0x74, 0x41, 0x75, 0x4C, 0x47, 0x46, 0x59, 0x54, 0x69, 0x4D, 0x0A, 0x72, 0x38, 0x55, 0x67, 0x6F, 0x4B, 0x57, 0x4D, 0x63, 0x4D, 0x57, 0x45, 0x79, 0x78, 0x53, 0x36, 0x32, 0x68, 0x5A, 0x45, 0x4C, 0x4F, 0x51, 0x55, 0x78, 0x2F, 0x65, 0x6C, 0x39, 0x78, 0x6A, 0x54, 0x76, 0x33, 0x2B, 0x48, 0x57, 0x53, 0x39, 0x38, 0x30, 0x34, 0x71, 0x63, 0x72, 0x64, 0x79, 0x71, 0x7A, 0x74, 0x4A, 0x52, 0x77, 0x32, 0x4D, 0x31, 0x66, 0x74, 0x6F, 0x6E, 0x38, 0x43, 0x33, 0x77, 0x0A, 0x47, 0x50, 0x56, 0x5A, 0x37, 0x75, 0x77, 0x72, 0x32, 0x61, 0x71, 0x79, 0x75, 0x46, 0x44, 0x4C, 0x41, 0x53, 0x31, 0x37, 0x74, 0x61, 0x6E, 0x54, 0x6C, 0x31, 0x45, 0x36, 0x36, 0x69, 0x63, 0x7A, 0x48, 0x65, 0x66, 0x2B, 0x63, 0x54, 0x4B, 0x34, 0x54, 0x6A, 0x47, 0x4C, 0x49, 0x4D, 0x63, 0x4E, 0x6B, 0x4E, 0x48, 0x50, 0x65, 0x72, 0x41, 0x71, 0x4A, 0x37, 0x4C, 0x65, 0x36, 0x6F, 0x31, 0x52, 0x0A, 0x56, 0x51, 0x61, 0x52, 0x4A, 0x58, 0x37, 0x70, 0x56, 0x71, 0x35, 0x75, 0x63, 0x33, 0x6A, 0x74, 0x79, 0x38, 0x34, 0x50, 0x6E, 0x64, 0x57, 0x68, 0x58, 0x2F, 0x55, 0x79, 0x6F, 0x30, 0x74, 0x33, 0x62, 0x73, 0x49, 0x31, 0x78, 0x2B, 0x36, 0x32, 0x4C, 0x36, 0x4A, 0x41, 0x33, 0x37, 0x4D, 0x4C, 0x34, 0x57, 0x53, 0x44, 0x5A, 0x74, 0x42, 0x7A, 0x57, 0x79, 0x51, 0x50, 0x4A, 0x77, 0x30, 0x6C, 0x0A, 0x59, 0x4A, 0x38, 0x55, 0x31, 0x53, 0x55, 0x43, 0x67, 0x59, 0x45, 0x41, 0x37, 0x64, 0x4F, 0x38, 0x34, 0x62, 0x56, 0x35, 0x31, 0x73, 0x65, 0x4E, 0x4F, 0x2B, 0x76, 0x71, 0x65, 0x6A, 0x43, 0x47, 0x70, 0x6B, 0x36, 0x39, 0x4C, 0x51, 0x6A, 0x35, 0x77, 0x43, 0x68, 0x30, 0x36, 0x69, 0x52, 0x4F, 0x63, 0x6A, 0x62, 0x33, 0x6B, 0x6E, 0x62, 0x4F, 0x44, 0x51, 0x62, 0x52, 0x51, 0x4B, 0x4F, 0x4D, 0x0A, 0x36, 0x67, 0x32, 0x31, 0x65, 0x2B, 0x2B, 0x5A, 0x34, 0x57, 0x45, 0x66, 0x6F, 0x51, 0x57, 0x61, 0x4C, 0x5A, 0x56, 0x64, 0x50, 0x6E, 0x37, 0x31, 0x63, 0x58, 0x52, 0x2B, 0x45, 0x62, 0x4F, 0x76, 0x66, 0x61, 0x63, 0x47, 0x35, 0x74, 0x47, 0x70, 0x44, 0x75, 0x73, 0x30, 0x5A, 0x68, 0x78, 0x48, 0x34, 0x49, 0x4D, 0x33, 0x48, 0x6D, 0x59, 0x62, 0x35, 0x76, 0x66, 0x63, 0x4A, 0x30, 0x6D, 0x55, 0x0A, 0x62, 0x79, 0x69, 0x50, 0x66, 0x5A, 0x51, 0x53, 0x56, 0x78, 0x6A, 0x43, 0x73, 0x64, 0x56, 0x32, 0x76, 0x57, 0x73, 0x62, 0x5A, 0x62, 0x48, 0x4B, 0x6C, 0x35, 0x70, 0x30, 0x55, 0x61, 0x41, 0x79, 0x69, 0x79, 0x54, 0x32, 0x70, 0x4D, 0x6B, 0x6C, 0x34, 0x6E, 0x67, 0x79, 0x53, 0x4C, 0x31, 0x4F, 0x45, 0x32, 0x64, 0x6C, 0x6D, 0x32, 0x73, 0x43, 0x67, 0x59, 0x45, 0x41, 0x77, 0x71, 0x6E, 0x4F, 0x0A, 0x6F, 0x45, 0x32, 0x32, 0x6C, 0x32, 0x4F, 0x2F, 0x48, 0x43, 0x42, 0x70, 0x41, 0x6D, 0x47, 0x2F, 0x37, 0x49, 0x79, 0x4F, 0x4C, 0x6A, 0x68, 0x62, 0x54, 0x75, 0x55, 0x48, 0x6C, 0x73, 0x68, 0x65, 0x38, 0x4F, 0x33, 0x4B, 0x48, 0x31, 0x38, 0x2F, 0x57, 0x46, 0x62, 0x70, 0x34, 0x4E, 0x76, 0x66, 0x32, 0x71, 0x76, 0x2B, 0x46, 0x5A, 0x6F, 0x43, 0x52, 0x70, 0x30, 0x57, 0x37, 0x42, 0x2B, 0x34, 0x0A, 0x32, 0x50, 0x39, 0x4E, 0x63, 0x75, 0x73, 0x71, 0x33, 0x4D, 0x31, 0x30, 0x54, 0x73, 0x55, 0x68, 0x33, 0x41, 0x2F, 0x35, 0x51, 0x4F, 0x69, 0x6E, 0x65, 0x43, 0x50, 0x73, 0x4B, 0x65, 0x32, 0x32, 0x55, 0x54, 0x7A, 0x73, 0x32, 0x57, 0x4F, 0x41, 0x50, 0x2B, 0x59, 0x54, 0x30, 0x4D, 0x4F, 0x52, 0x46, 0x57, 0x6D, 0x51, 0x74, 0x74, 0x6E, 0x45, 0x45, 0x54, 0x6E, 0x32, 0x2B, 0x33, 0x7A, 0x53, 0x0A, 0x73, 0x64, 0x75, 0x36, 0x4D, 0x30, 0x4B, 0x37, 0x4B, 0x2F, 0x58, 0x59, 0x74, 0x45, 0x48, 0x63, 0x67, 0x46, 0x4D, 0x33, 0x54, 0x54, 0x34, 0x69, 0x50, 0x2B, 0x6B, 0x65, 0x59, 0x65, 0x6D, 0x73, 0x59, 0x47, 0x6C, 0x70, 0x4D, 0x65, 0x38, 0x43, 0x67, 0x59, 0x41, 0x55, 0x30, 0x70, 0x63, 0x56, 0x41, 0x2F, 0x69, 0x59, 0x37, 0x33, 0x76, 0x55, 0x4A, 0x55, 0x47, 0x77, 0x56, 0x52, 0x4E, 0x55, 0x0A, 0x2B, 0x45, 0x76, 0x6A, 0x35, 0x34, 0x64, 0x47, 0x5A, 0x63, 0x52, 0x6D, 0x77, 0x36, 0x73, 0x43, 0x6F, 0x51, 0x46, 0x6F, 0x46, 0x33, 0x4C, 0x4F, 0x2F, 0x53, 0x76, 0x52, 0x42, 0x77, 0x44, 0x4E, 0x64, 0x55, 0x6E, 0x51, 0x67, 0x68, 0x66, 0x73, 0x2F, 0x62, 0x33, 0x78, 0x4D, 0x54, 0x5A, 0x67, 0x69, 0x31, 0x56, 0x51, 0x70, 0x58, 0x6B, 0x44, 0x35, 0x2F, 0x6B, 0x70, 0x76, 0x35, 0x75, 0x37, 0x0A, 0x32, 0x71, 0x58, 0x6D, 0x43, 0x37, 0x46, 0x4C, 0x6C, 0x78, 0x68, 0x4E, 0x59, 0x47, 0x69, 0x43, 0x70, 0x62, 0x70, 0x72, 0x74, 0x50, 0x44, 0x34, 0x64, 0x66, 0x63, 0x57, 0x6B, 0x59, 0x43, 0x6E, 0x67, 0x74, 0x75, 0x64, 0x57, 0x52, 0x75, 0x4A, 0x2B, 0x4B, 0x63, 0x44, 0x50, 0x76, 0x64, 0x59, 0x65, 0x6B, 0x6F, 0x35, 0x79, 0x79, 0x6B, 0x37, 0x77, 0x4E, 0x41, 0x79, 0x58, 0x56, 0x35, 0x50, 0x0A, 0x68, 0x48, 0x72, 0x37, 0x7A, 0x6F, 0x69, 0x38, 0x6E, 0x56, 0x31, 0x35, 0x74, 0x4F, 0x6C, 0x6A, 0x46, 0x59, 0x68, 0x31, 0x35, 0x51, 0x4B, 0x42, 0x67, 0x51, 0x43, 0x2F, 0x73, 0x4B, 0x65, 0x67, 0x67, 0x2B, 0x61, 0x43, 0x50, 0x64, 0x38, 0x37, 0x75, 0x30, 0x36, 0x73, 0x34, 0x63, 0x55, 0x31, 0x45, 0x31, 0x51, 0x50, 0x66, 0x37, 0x2B, 0x71, 0x65, 0x53, 0x35, 0x33, 0x39, 0x4F, 0x68, 0x4A, 0x0A, 0x4B, 0x47, 0x41, 0x5A, 0x64, 0x4A, 0x6E, 0x55, 0x54, 0x41, 0x49, 0x54, 0x51, 0x33, 0x47, 0x30, 0x7A, 0x42, 0x6C, 0x77, 0x2F, 0x43, 0x2B, 0x78, 0x69, 0x59, 0x2F, 0x42, 0x42, 0x5A, 0x76, 0x70, 0x55, 0x37, 0x37, 0x59, 0x6F, 0x32, 0x75, 0x5A, 0x38, 0x31, 0x66, 0x4E, 0x47, 0x61, 0x4B, 0x32, 0x4B, 0x61, 0x53, 0x78, 0x6E, 0x6D, 0x6B, 0x4C, 0x6A, 0x5A, 0x52, 0x4A, 0x31, 0x61, 0x50, 0x72, 0x0A, 0x61, 0x36, 0x74, 0x77, 0x68, 0x75, 0x4D, 0x4D, 0x43, 0x57, 0x30, 0x4A, 0x37, 0x77, 0x73, 0x33, 0x6F, 0x72, 0x53, 0x32, 0x32, 0x73, 0x71, 0x51, 0x6A, 0x42, 0x77, 0x43, 0x6D, 0x6E, 0x43, 0x41, 0x5A, 0x48, 0x64, 0x2F, 0x63, 0x76, 0x38, 0x4E, 0x30, 0x78, 0x4B, 0x4B, 0x72, 0x7A, 0x43, 0x4C, 0x7A, 0x57, 0x5A, 0x76, 0x30, 0x66, 0x65, 0x34, 0x4A, 0x37, 0x2B, 0x62, 0x65, 0x35, 0x67, 0x62, 0x0A, 0x65, 0x4C, 0x48, 0x32, 0x55, 0x51, 0x4B, 0x42, 0x67, 0x41, 0x36, 0x44, 0x6D, 0x75, 0x6D, 0x62, 0x43, 0x2B, 0x61, 0x71, 0x64, 0x53, 0x46, 0x61, 0x59, 0x70, 0x68, 0x46, 0x46, 0x69, 0x43, 0x45, 0x58, 0x7A, 0x72, 0x72, 0x36, 0x6F, 0x36, 0x49, 0x79, 0x31, 0x64, 0x36, 0x39, 0x34, 0x4C, 0x6C, 0x2B, 0x55, 0x6D, 0x73, 0x78, 0x38, 0x4A, 0x6E, 0x49, 0x33, 0x54, 0x61, 0x52, 0x75, 0x41, 0x79, 0x0A, 0x63, 0x44, 0x4C, 0x62, 0x4C, 0x5A, 0x34, 0x31, 0x76, 0x4B, 0x65, 0x52, 0x71, 0x6B, 0x6D, 0x30, 0x79, 0x6C, 0x4C, 0x45, 0x42, 0x77, 0x73, 0x56, 0x61, 0x37, 0x2F, 0x79, 0x63, 0x4C, 0x32, 0x39, 0x65, 0x47, 0x35, 0x76, 0x7A, 0x49, 0x34, 0x6D, 0x53, 0x67, 0x38, 0x58, 0x41, 0x42, 0x44, 0x5A, 0x61, 0x43, 0x62, 0x4F, 0x66, 0x70, 0x79, 0x72, 0x4A, 0x7A, 0x72, 0x75, 0x47, 0x54, 0x4B, 0x67, 0x0A, 0x47, 0x34, 0x4E, 0x46, 0x4A, 0x70, 0x4F, 0x56, 0x6E, 0x6C, 0x68, 0x68, 0x6C, 0x35, 0x71, 0x63, 0x4B, 0x73, 0x57, 0x68, 0x6B, 0x42, 0x77, 0x76, 0x54, 0x47, 0x61, 0x6F, 0x34, 0x2B, 0x6A, 0x37, 0x46, 0x46, 0x49, 0x31, 0x53, 0x6D, 0x62, 0x76, 0x77, 0x78, 0x74, 0x7A, 0x6D, 0x68, 0x70, 0x76, 0x44, 0x70, 0x2F, 0x65, 0x0A, 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x45, 0x4E, 0x44, 0x20, 0x52, 0x53, 0x41, 0x20, 0x50, 0x52, 0x49, 0x56, 0x41, 0x54, 0x45, 0x20, 0x4B, 0x45, 0x59, 0x2D, 0x2D, 0x2D, 0x2D, 0x2D, 0x0A, 0xFF ================================================ FILE: cmake/i686-w64-mingw32-gcc.cmake ================================================ set(CMAKE_SYSTEM_NAME Windows) # Some default GCC settings set(CMAKE_C_COMPILER i686-w64-mingw32-gcc) set(CMAKE_CXX_COMPILER i686-w64-mingw32-g++) set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY) ================================================ FILE: cmake/x86_64-w64-mingw32-gcc.cmake ================================================ set(CMAKE_SYSTEM_NAME Windows) # Some default GCC settings set(CMAKE_C_COMPILER x86_64-w64-mingw32-gcc) set(CMAKE_CXX_COMPILER x86_64-w64-mingw32-g++) set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY) ================================================ FILE: dev/lwesp_dev.sln ================================================  Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 16 VisualStudioVersion = 16.0.28803.452 MinimumVisualStudioVersion = 10.0.40219.1 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "lwesp_dev", "lwesp_dev.vcxproj", "{5D881BA7-6232-4F33-B72F-0BB5DFF2A575}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|x64 = Debug|x64 Debug|x86 = Debug|x86 Release|x64 = Release|x64 Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {5D881BA7-6232-4F33-B72F-0BB5DFF2A575}.Debug|x64.ActiveCfg = Debug|x64 {5D881BA7-6232-4F33-B72F-0BB5DFF2A575}.Debug|x64.Build.0 = Debug|x64 {5D881BA7-6232-4F33-B72F-0BB5DFF2A575}.Debug|x86.ActiveCfg = Debug|Win32 {5D881BA7-6232-4F33-B72F-0BB5DFF2A575}.Debug|x86.Build.0 = Debug|Win32 {5D881BA7-6232-4F33-B72F-0BB5DFF2A575}.Release|x64.ActiveCfg = Release|x64 {5D881BA7-6232-4F33-B72F-0BB5DFF2A575}.Release|x64.Build.0 = Release|x64 {5D881BA7-6232-4F33-B72F-0BB5DFF2A575}.Release|x86.ActiveCfg = Release|Win32 {5D881BA7-6232-4F33-B72F-0BB5DFF2A575}.Release|x86.Build.0 = Release|Win32 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {7915554A-0FB0-4F8A-9B80-404D9FCDBB34} EndGlobalSection EndGlobal ================================================ FILE: dev/lwesp_dev.vcxproj ================================================  Debug Win32 Release Win32 Debug x64 Release x64 15.0 {5D881BA7-6232-4F33-B72F-0BB5DFF2A575} Win32Proj lwesp_dev_os 10.0 Application true v142 Unicode Application false v142 true Unicode Application true v142 Unicode Application false v142 true Unicode true .;..\lwesp\src\include\system\port\win32;..\lwesp\src\include;..\snippets\include;..\..\lwmem\lwmem\src\include;$(IncludePath) true false false NotUsing Level3 Disabled WIN32;_DEBUG;_CONSOLE;_CRT_SECURE_NO_WARNINGS;%(PreprocessorDefinitions) false Console Use Level3 Disabled _DEBUG;_CONSOLE;%(PreprocessorDefinitions) Console Level3 Use MaxSpeed true true WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions) Console true true Level3 Use MaxSpeed true true NDEBUG;_CONSOLE;%(PreprocessorDefinitions) Console true true false ================================================ FILE: dev/lwesp_dev.vcxproj.filters ================================================  {4FC737F1-C7A5-4376-A066-2A32D752A2FF} cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx {2ccedd44-52f3-42de-a09f-0efbb182a9bb} {ed3e52b6-f791-4856-bea8-c539749fbd7b} {f41c49ad-9944-4714-a950-d7747d143061} {95f13059-d7bd-41eb-92a5-fc358f95592d} {a7a2f464-2a72-438b-95c3-287e652c47f0} {f53eba69-7eb3-428c-9053-e398ae95bf8e} {3b90bd2c-2305-40af-9d58-f49b6817bc2e} {89a7c350-8eb5-4eea-9b01-10fbcd6a0e6c} Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files Source Files\LWMEM Source Files\LWMEM Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS Source Files Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CLI Source Files\ESP CLI Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP APPS MQTT Source Files\ESP APPS MQTT Source Files\ESP APPS MQTT Source Files\ESP APPS MQTT Source Files\ESP APPS HTTP SERVER Source Files\ESP APPS HTTP SERVER Source Files\ESP APPS HTTP SERVER Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP CORE Source Files\ESP LL Source Files\ESP API Source Files\ESP LL Source Files\ESP SNIPPETS Source Files\ESP SNIPPETS ================================================ FILE: dev/lwesp_opts.h ================================================ /** * \file lwesp_opts.h * \brief ESP application options */ /* * Copyright (c) 2024 Tilen MAJERLE * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation * files (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * This file is part of LwESP - Lightweight ESP-AT parser library. * * Author: Tilen MAJERLE * Version: v1.1.0-dev */ #ifndef LWESP_HDR_OPTS_H #define LWESP_HDR_OPTS_H /* Rename this file to "lwesp_opts.h" for your application */ /* * Open "include/lwesp/lwesp_opt.h" and * copy & replace here settings you want to change values */ #if !__DOXYGEN__ #define LWESP_CFG_IPV6 1 #define LWESP_CFG_NETCONN 1 #define LWESP_CFG_NETCONN_RECEIVE_QUEUE_LEN 16 #define LWESP_CFG_DBG LWESP_DBG_ON #define LWESP_CFG_DBG_TYPES_ON LWESP_DBG_TYPE_TRACE | LWESP_DBG_TYPE_STATE #define LWESP_CFG_DBG_IPD LWESP_DBG_OFF #define LWESP_CFG_DBG_SERVER LWESP_DBG_OFF #define LWESP_CFG_DBG_MQTT LWESP_DBG_OFF #define LWESP_CFG_DBG_MEM LWESP_DBG_OFF #define LWESP_CFG_DBG_PBUF LWESP_DBG_OFF #define LWESP_CFG_DBG_CONN LWESP_DBG_OFF #define LWESP_CFG_DBG_VAR LWESP_DBG_OFF #define LWESP_CFG_RCV_BUFF_SIZE 0x1000 #define LWESP_CFG_MEM_CUSTOM 1 #define LWESP_CFG_REST_CLIENT 1 #define LWESP_CFG_ESP32 1 #define LWESP_CFG_ESP8266 1 #define LWESP_CFG_ESP32_C2 1 #define LWESP_CFG_ESP32_C3 1 #define LWESP_CFG_ESP32_C6 1 #define LWESP_CFG_CONN_MAX_DATA_LEN 1500 #define LWESP_CFG_INPUT_USE_PROCESS 1 #define LWESP_CFG_AT_ECHO 0 #define LWESP_CFG_USE_API_FUNC_EVT 1 #define LWESP_CFG_MAX_CONNS 5 #define LWESP_CFG_DNS 1 #define LWESP_CFG_SNTP 1 #define LWESP_CFG_SNTP_AUTO_READ_TIME_ON_UPDATE 1 #define LWESP_CFG_HOSTNAME 1 #define LWESP_CFG_WPS 1 #define LWESP_CFG_MDNS 1 #define LWESP_CFG_PING 1 #define LWESP_CFG_FLASH 1 #define LWESP_CFG_MODE_STATION 1 #define LWESP_CFG_RESET_ON_INIT 1 #define LWESP_CFG_RESTORE_ON_INIT 0 #define LWESP_CFG_CONN_MANUAL_TCP_RECEIVE 1 #define LWESP_CFG_ACCESS_POINT_STRUCT_FULL_FIELDS 1 #define LWESP_CFG_LIST_CMD 1 #define LWESP_CFG_MQTT_MAX_REQUESTS 32 #endif /* !__DOXYGEN__ */ #endif /* LWESP_HDR_OPTS_H */ ================================================ FILE: dev/lwmem_opts.h ================================================ /** * \file lwmem_opts.h * \brief LwMEM application options */ /* * Copyright (c) 2024 Tilen MAJERLE * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation * files (the "Software"), to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, * publish, distribute, sublicense, and/or sell copies of the Software, * and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * This file is part of LwMEM - Lightweight dynamic memory manager library. * * Author: Tilen MAJERLE * Version: v1.1.0-dev */ #ifndef LWMEM_HDR_OPTS_H #define LWMEM_HDR_OPTS_H /* Rename this file to "lwmem_opts.h" for your application */ #include "windows.h" /* * Open "include/lwmem/lwmem_opt.h" and * copy & replace here settings you want to change values */ #define LWMEM_CFG_OS 1 #define LWMEM_CFG_OS_MUTEX_HANDLE HANDLE #endif /* LWMEM_HDR_OPTS_H */ ================================================ FILE: dev/main.c ================================================ // lwesp_dev_os.cpp : Defines the entry point for the console application. // #include #include "examples_common_lwesp_callback_func.h" #include "lwesp/apps/lwesp_mqtt_client_api.h" #include "lwesp/lwesp.h" #include "windows.h" #include "http_server.h" #include "lwesp/lwesp_opt.h" #include "lwesp/lwesp_timeout.h" #include "lwmem/lwmem.h" #include "mqtt_client.h" #include "mqtt_client_api.h" #include "netconn_client.h" #include "netconn_server.h" #include "netconn_server_1thread.h" #include "sntp.h" #include "station_manager.h" #include "utils.h" #define safeprintf printf static void main_thread(void* arg); static void input_thread(void* arg); static lwesp_ap_t aps[10]; static size_t aps_count; static lwespr_t lwesp_evt(lwesp_evt_t* evt); static lwesp_sta_info_ap_t connected_ap_info; extern volatile uint8_t lwesp_ll_win32_driver_ignore_data; static uint8_t parse_str(char** str, char** out); static uint8_t parse_num_u64(char** str, uint64_t* out); static uint8_t parse_num(char** str, uint32_t* out); /** * \brief LwMEM memory config */ uint8_t lwmem_region_1[0x4000]; lwmem_region_t lwmem_regions[] = { {lwmem_region_1, sizeof(lwmem_region_1)}, {NULL, 0}, }; /** * \brief Command structure */ typedef struct { uint8_t del; /*!< Delimiter */ const char* cmd; /*!< Command text */ const char* help_params; /*!< Help parameters */ const char* help_text; /*!< Help long text */ } cmd_t; /** * \brief List of test commands */ static const cmd_t cmd_commands[] = { {0, "help", "", "Print help for commands"}, {0, "join", " [ []]", "Join to access point"}, {0, "reconn_set", " ", "Set reconnect config"}, {0, "quit", "", "Quit from access point"}, {1, "IP management", NULL, NULL}, {0, "stagetip", "", "Get station IP address"}, {0, "stasetip", "", "Set station IP address"}, {0, "apgetip", "", "Get Soft Access point IP address"}, {0, "apsetip", "", "Set Soft Access point IP address"}, {0, "setdhcp", "", "Enable or disable DHCP"}, {1, "MAC management", NULL, NULL}, {0, "stagetmac", "", "Get station MAC address"}, {0, "stasetmac", "", "Set station MAC address"}, {0, "apgetmac", "", "Get Soft Access point MAC address"}, {0, "apsetmac", "", "Set Soft Access point MAC address"}, {1, "Access point", NULL, NULL}, {0, "apconfig", " [ ]", "Configure Soft Access point"}, {0, "apliststa", "", "List stations connected to access point"}, {0, "apquitsta", "", "Disconnect station for Soft access point"}, {1, "Hostname", NULL, NULL}, {0, "hnset", "", "Set station hostname"}, {0, "hnget", "", "Get station hostname"}, {1, "Misc", NULL, NULL}, {0, "ping", "", "Ping domain or IP address"}, {1, "Separate threads", NULL, NULL}, {0, "netconn_client", "", "Start netconn client thread"}, {0, "netconn_server", "", "Start netconn server thread"}, {0, "mqtt_client_api", "", "Start mqtt client API thread"}, {0, "ciupdate", "", "Run ciupdate command"}, {0, "dhcpenable", "", "Enable DHCP"}, {0, "dhcpdisable", "", "Disable DHCP"}, {0, "wifidisable", "", "Disable WIFI mode completely"}}; /** * \brief Program entry point */ int main() { safeprintf("App start!\r\n"); /* Setup regions for memory as a start */ if (!lwmem_assignmem(lwmem_regions)) { safeprintf("Could not assign memory for LwMEM!\r\n"); return -1; } /* Create main threads */ CreateThread(0, 0, (LPTHREAD_START_ROUTINE)main_thread, NULL, 0, NULL); CreateThread(0, 0, (LPTHREAD_START_ROUTINE)input_thread, NULL, 0, NULL); /* Do nothing at this point but do not close the program */ while (1) { lwesp_delay(1000); } } /** * \brief Main thread for init purposes */ static void main_thread(void* arg) { char hn[10]; uint32_t ping_time; LWESP_UNUSED(hn); LWESP_UNUSED(arg); LWESP_UNUSED(ping_time); /* Init ESP library */ lwesp_init(lwesp_evt, 1); if (0) { #if LWESP_CFG_ESP32 } else if (lwesp_device_is_device(LWESP_DEVICE_ESP32)) { safeprintf("Device is ESP32\r\n"); #endif /* LWESP_CFG_ESP32 */ #if LWESP_CFG_ESP8266 } else if (lwesp_device_is_device(LWESP_DEVICE_ESP8266)) { safeprintf("Device is ESP8266\r\n"); #endif /* LWESP_CFG_ESP8266 */ #if LWESP_CFG_ESP32_C2 } else if (lwesp_device_is_device(LWESP_DEVICE_ESP32_C2)) { safeprintf("Device is ESP32-C2\r\n"); #endif /* LWESP_CFG_ESP32_C2 */ #if LWESP_CFG_ESP32_C3 } else if (lwesp_device_is_device(LWESP_DEVICE_ESP32_C3)) { safeprintf("Device is ESP32-C3\r\n"); #endif /* LWESP_CFG_ESP32_C3 */ #if LWESP_CFG_ESP32_C6 } else if (lwesp_device_is_device(LWESP_DEVICE_ESP32_C6)) { safeprintf("Device is ESP32-C6\r\n"); #endif /* LWESP_CFG_ESP32_C6 */ } else { safeprintf("Unknown device...\r\n"); } #if 0 uint8_t read_data_buffer[1024]; uint32_t read_data_length; lwesp_mfg_read(LWESP_MFG_NAMESPACE_SERVER_CERT, "server_cert", read_data_buffer, sizeof(read_data_buffer), 0, &read_data_length, NULL, NULL, 1); printf("Len: %u\r\n", (unsigned)read_data_length); lwesp_mfg_read(LWESP_MFG_NAMESPACE_SERVER_CERT, "server_cert", read_data_buffer, 15, 20, &read_data_length, NULL, NULL, 1); printf("Len: %u\r\n", (unsigned)read_data_length); #endif /* Start thread to toggle device present */ //lwesp_sys_thread_create(NULL, "device_present", (lwesp_sys_thread_fn)lwesp_device_present_toggle, NULL, 0, LWESP_SYS_THREAD_PRIO); /* * Try to connect to preferred access point * * Follow function implementation for more info * on how to setup preferred access points for fast connection */ lwesp_sta_autojoin(0, NULL, NULL, 1); /* * Initialize and start asynchronous connection to preferred acces point * * Will immediately return and will not block the application. * All events are done asynchronously */ station_manager_connect_to_access_point_async_init(); /* Different types of snippets to execute */ /* HTTP server application example */ /* SNTP example */ sntp_gettime(); /* Netconn client in separate thread */ //lwesp_sys_thread_create(NULL, "netconn_client", (lwesp_sys_thread_fn)netconn_client_thread, NULL, 0, LWESP_SYS_THREAD_PRIO); /* Netconn client in separate thread */ //lwesp_sys_thread_create(NULL, "netconn_client_ssl", (lwesp_sys_thread_fn)netconn_client_ssl_thread, NULL, 0, LWESP_SYS_THREAD_PRIO); /* Netconn server with multiple threads */ //lwesp_sys_thread_create(NULL, "netconn_server", (lwesp_sys_thread_fn)netconn_server_thread, NULL, 0, LWESP_SYS_THREAD_PRIO); /* Netconn server with single thread */ //lwesp_sys_thread_create(NULL, "netconn_server_single", (lwesp_sys_thread_fn)netconn_server_1thread_thread, NULL, 0, LWESP_SYS_THREAD_PRIO); /* MQTT client with asynchronous events */ //lwesp_sys_thread_create(NULL, "mqtt_client", (lwesp_sys_thread_fn)mqtt_client_thread, NULL, 0, LWESP_SYS_THREAD_PRIO); /* MQTT client with API sequential mode, test application */ //lwesp_sys_thread_create(NULL, "mqtt_client_api", (lwesp_sys_thread_fn)lwesp_mqtt_client_api_thread, NULL, 0, LWESP_SYS_THREAD_PRIO); /* MQTT API client with connectivity to home assistant */ lwesp_sys_thread_create(NULL, "mqtt_client_api_ha", (lwesp_sys_thread_fn)lwesp_mqtt_client_api_ha_thread, NULL, 0, LWESP_SYS_THREAD_PRIO); /* While loop with delay to prevent main thread termination in development environment */ while (1) { lwesp_delay(1000); } } /** * \brief Console input thread */ static void input_thread(void* arg) { char buff[128]; char* str; const cmd_t* cmd; #define IS_LINE(s) (strncmp(buff, (s), sizeof(s) - 1) == 0) LWESP_UNUSED(arg); /* Notify user */ safeprintf("Start by writing commands..\r\n"); /* Very simple input */ while (1) { safeprintf(" > "); memset(buff, 0x00, sizeof(buff)); fgets(buff, sizeof(buff), stdin); /* Analyze input data */ size_t i = 0; for (i = 0; i < LWESP_ARRAYSIZE(cmd_commands); ++i) { if (cmd_commands[i].del) { continue; } if (!strncmp(buff, cmd_commands[i].cmd, strlen(cmd_commands[i].cmd))) { cmd = &cmd_commands[i]; break; } } if (i == LWESP_ARRAYSIZE(cmd_commands)) { safeprintf("[CMD] Unknown input command\r\n"); continue; } safeprintf("cmd name: %s\r\n", cmd->cmd); str = buff + strlen(cmd->cmd); /* Process each command */ if (IS_LINE("join")) { char *ssid, *pass; parse_str(&str, &ssid); parse_str(&str, &pass); lwesp_sta_join(ssid, pass, NULL, NULL, NULL, 1); } else if (IS_LINE("quit")) { lwesp_sta_quit(NULL, NULL, 1); } else if (IS_LINE("reconn_set")) { uint32_t interval, rep_cnt = 0; parse_num(&str, &interval); if (interval > 0) { parse_num(&str, &rep_cnt); } lwesp_sta_reconnect_set_config(interval, rep_cnt, NULL, NULL, 1); } else if (IS_LINE("setip")) { lwesp_ip_t dev_ip; lwesp_ip_set_ip4(&dev_ip, 192, 168, 1, 150); lwesp_sta_setip(&dev_ip, NULL, NULL, NULL, NULL, 1); } else if (IS_LINE("getip")) { lwesp_sta_getip(NULL, NULL, NULL, NULL, NULL, 1); } else if (IS_LINE("dhcpenable")) { lwesp_dhcp_set_config(1, 0, 1, NULL, NULL, 1); } else if (IS_LINE("dhcpdisable")) { lwesp_dhcp_set_config(1, 0, 1, NULL, NULL, 1); } else if (IS_LINE("listap")) { lwesp_sta_list_ap(NULL, aps, LWESP_ARRAYSIZE(aps), &aps_count, NULL, NULL, 1); safeprintf("Detected %d number of access points\r\n", (int)aps_count); } else if (IS_LINE("getapinfo")) { lwesp_sta_info_ap_t ap; lwesp_sta_get_ap_info(&ap, NULL, NULL, 1); } else if (IS_LINE("apenable")) { lwesp_set_wifi_mode(LWESP_MODE_STA_AP, NULL, NULL, 1); lwesp_ap_set_config("ESP8266_SSID", "its private", 13, LWESP_ECN_WPA2_PSK, 5, 0, NULL, NULL, 1); } else if (IS_LINE("apdisable")) { lwesp_set_wifi_mode(LWESP_MODE_STA, NULL, NULL, 1); } else if (IS_LINE("wifidisable")) { lwesp_set_wifi_mode(LWESP_MODE_NONE, NULL, NULL, 1); } else if (IS_LINE("apliststa")) { lwesp_sta_t stas[10]; size_t stat; lwesp_ap_list_sta(stas, LWESP_ARRAYSIZE(stas), &stat, NULL, NULL, 1); safeprintf("Number of stations: %d\r\n", (int)stat); } else if (IS_LINE("ping")) { uint32_t pingtime; char* host; if (parse_str(&str, &host)) { if (lwesp_ping(host, &pingtime, NULL, NULL, 1) == lwespOK) { safeprintf("Ping time: %d\r\n", (int)pingtime); } else { safeprintf("Error with ping to host \"%s\"\r\n", host); } } else { safeprintf("Cannot parse host\r\n"); } } else if (IS_LINE("hnset")) { char* host; if (parse_str(&str, &host)) { lwesp_hostname_set(host, NULL, NULL, 1); } else { safeprintf("Cannot parse host\r\n"); } } else if (IS_LINE("hnget")) { char hn[20]; lwesp_hostname_get(hn, sizeof(hn), NULL, NULL, 1); safeprintf("Hostname: %s\r\n", hn); } else if (IS_LINE("netconn_client")) { lwesp_sys_sem_t sem; lwesp_sys_sem_create(&sem, 0); lwesp_sys_thread_create(NULL, "netconn_client", (lwesp_sys_thread_fn)netconn_client_thread, &sem, 0, LWESP_SYS_THREAD_PRIO); lwesp_sys_sem_wait(&sem, 0); lwesp_sys_sem_delete(&sem); } else if (IS_LINE("netconn_server")) { lwesp_sys_thread_create(NULL, "netconn_server", (lwesp_sys_thread_fn)netconn_server_thread, NULL, 0, LWESP_SYS_THREAD_PRIO); } else if (IS_LINE("mqttthread")) { lwesp_sys_thread_create(NULL, "mqtt_client_api", (lwesp_sys_thread_fn)lwesp_mqtt_client_api_thread, NULL, 0, LWESP_SYS_THREAD_PRIO); } else if (IS_LINE("ignoreon")) { safeprintf("Ignoring data...\r\n"); lwesp_ll_win32_driver_ignore_data = 1; } else if (IS_LINE("ignoreoff")) { safeprintf("Not ignoring data...\r\n"); lwesp_ll_win32_driver_ignore_data = 0; } else if (IS_LINE("ciupdate")) { lwesp_update_sw(NULL, NULL, 1); } else { safeprintf("Unknown input!\r\n"); } } } /** * \brief Global ESP event function callback * \param[in] evt: Event information * \return \ref lwespOK on success, member of \ref lwespr_t otherwise */ static lwespr_t lwesp_evt(lwesp_evt_t* evt) { switch (evt->type) { case LWESP_EVT_INIT_FINISH: { /* Device is not present on init */ //lwesp_device_set_present(0, NULL, NULL, 0); break; } case LWESP_EVT_RESET: { if (lwesp_evt_reset_get_result(evt) == lwespOK) { safeprintf("Reset sequence successful!\r\n"); } else { safeprintf("Reset sequence error!\r\n"); } break; } case LWESP_EVT_RESTORE: { if (lwesp_evt_restore_get_result(evt) == lwespOK) { safeprintf("Restore sequence successful!\r\n"); } else { safeprintf("Restore sequence error!\r\n"); } break; } case LWESP_EVT_AT_VERSION_NOT_SUPPORTED: { lwesp_sw_version_t v_min, v_curr; lwesp_get_min_at_fw_version(&v_min); lwesp_get_current_at_fw_version(&v_curr); safeprintf("Current ESP[8266/32[-C3]] AT version is not supported by the library\r\n"); safeprintf("Minimum required AT version is: %08X\r\n", (unsigned)v_min.version); safeprintf("Current AT version is: %08X\r\n", (unsigned)v_curr.version); break; } case LWESP_EVT_WIFI_GOT_IP: { safeprintf("Wifi got an IP address.\r\n"); if (lwesp_sta_has_ipv6_local()) { safeprintf("Wifi got IPv6 local IP address.\r\n"); } if (lwesp_sta_has_ipv6_global()) { safeprintf("Wifi got IPv6 global IP address.\r\n"); } break; } case LWESP_EVT_WIFI_CONNECTED: { safeprintf("Wifi just connected. Read access point information\r\n"); lwesp_sta_get_ap_info(&connected_ap_info, NULL, NULL, 0); break; } case LWESP_EVT_WIFI_DISCONNECTED: { safeprintf("Wifi just disconnected\r\n"); break; } case LWESP_EVT_STA_INFO_AP: { safeprintf("SSID: %s, ch: %d, rssi: %d\r\n", lwesp_evt_sta_info_ap_get_ssid(evt), (int)lwesp_evt_sta_info_ap_get_channel(evt), (int)lwesp_evt_sta_info_ap_get_rssi(evt)); break; } case LWESP_EVT_WIFI_IP_ACQUIRED: { lwesp_ip_t ip; uint8_t is_dhcp; safeprintf("WIFI IP ACQUIRED!\r\n"); if (lwesp_sta_copy_ip(&ip, NULL, NULL, &is_dhcp) == lwespOK) { utils_print_ip("IP: ", &ip, "\r\n"); } else { safeprintf("Acquired IP is not valid\r\n"); } break; } #if LWESP_CFG_MODE_ACCESS_POINT case LWESP_EVT_AP_CONNECTED_STA: { lwesp_mac_t* mac = lwesp_evt_ap_connected_sta_get_mac(evt); utils_print_mac("New station connected to AP with MAC: ", mac, "\r\n"); break; } case LWESP_EVT_AP_DISCONNECTED_STA: { lwesp_mac_t* mac = lwesp_evt_ap_disconnected_sta_get_mac(evt); utils_print_mac("New station disconnected from AP with MAC: ", mac, "\r\n"); break; } case LWESP_EVT_AP_IP_STA: { lwesp_mac_t* mac = lwesp_evt_ap_ip_sta_get_mac(evt); lwesp_ip_t* ip = lwesp_evt_ap_ip_sta_get_ip(evt); utils_print_ip("Station got IP address (from AP): ", ip, ""); utils_print_mac(" and MAC: ", mac, "\r\n"); break; } #endif /* LWESP_CFG_MODE_ACCESS_POINT */ default: break; } return lwespOK; } /** * \brief Parse string and move pointer after parse * \param[in,out] str: Pointer to pointer to input string * \param[out] out: Output variable to set beg of pointer * \return `1` on success, `0` otherwise */ static uint8_t parse_str(char** str, char** out) { char* s = *str; uint8_t is_quote = 0; *out = NULL; for (; s != NULL && *s != '\0' && *s == ' '; ++s) {} if (s != NULL && *s >= ' ') { if (*s == '"') { is_quote = 1; ++s; } else if (*s == '\0') { return 0; } *out = s; /* Set where we point */ for (; s != NULL && *s >= ' ' && *s != (is_quote ? '"' : ' '); ++s) {} *s = '\0'; *str = s + 1; /* Set new value for str */ return 1; } else { *out = NULL; return 0; } } /** * \brief Parse number in dec, oct, hex or bin format * \param[in,out] str: Pointer to pointer to input string * \param[out] out: Output variable to write value * \return `1` on success, `0` otherwise */ static uint8_t parse_num_u64(char** str, uint64_t* out) { uint64_t r, num = 0; char* s = *str; unsigned char c; *out = 0; for (; s != NULL && *s != '\0' && *s == ' '; ++s) {} if (s != NULL && *s >= '0' && *s <= '9') { /* Check for hex/bin/octal */ if (*s == '0') { ++s; if (*s == 'x' || *s == 'X') { r = 16; ++s; } else if (*s == 'b' || *s == 'B') { r = 2; ++s; } else if (*s <= '7') { r = 8; } else if (*s <= ' ') { return 1; /* Single zero */ } else { return 0; /* Wrong format */ } } else { r = 10; } num = 0; for (c = *s; c > ' '; ++s, c = *s) { if (c > 'a') { c -= 0x20; } c -= '0'; if (c > 17) { c -= 7; if (c <= 9) { return 0; } } if (c >= r) { return 0; } num = num * r + c; } *out = num; *str = s; return 1; } return 0; } /** * \brief Parse number in dec, oct, hex or bin format * \param[in,out] str: Pointer to pointer to input string * \param[out] out: Output variable to write value * \return `1` on success, `0` otherwise */ static uint8_t parse_num(char** str, uint32_t* out) { uint64_t num; uint8_t s; s = parse_num_u64(str, &num); *out = (uint32_t)num; return s; } ================================================ FILE: docs/Makefile ================================================ # Minimal makefile for Sphinx documentation # # You can set these variables from the command line, and also # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = _build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) ================================================ FILE: docs/api-reference/apps/cayenne_api.rst ================================================ .. _api_app_cayenne_api: Cayenne MQTT API ================ .. doxygengroup:: LWESP_APP_CAYENNE_API ================================================ FILE: docs/api-reference/apps/http_server.rst ================================================ .. _api_app_http_server: HTTP Server =========== .. doxygengroup:: LWESP_APP_HTTP_SERVER .. doxygengroup:: LWESP_APP_HTTP_SERVER_FS_FAT ================================================ FILE: docs/api-reference/apps/index.rst ================================================ .. _api_apps: Applications ============ .. toctree:: :maxdepth: 2 :glob: * ================================================ FILE: docs/api-reference/apps/mqtt_client.rst ================================================ .. _api_app_mqtt_client: MQTT Client =========== MQTT client v3.1.1 implementation, based on callback (non-netconn) connection API. .. literalinclude:: ../../../snippets/mqtt_client.c :language: c :linenos: :caption: MQTT application example code .. doxygengroup:: LWESP_APP_MQTT_CLIENT .. doxygengroup:: LWESP_APP_MQTT_CLIENT_EVT ================================================ FILE: docs/api-reference/apps/mqtt_client_api.rst ================================================ .. _api_app_mqtt_client_api: MQTT Client API =============== *MQTT Client API* provides sequential API built on top of :ref:`api_app_mqtt_client`. .. literalinclude:: ../../../snippets/mqtt_client_api.c :language: c :linenos: :caption: MQTT API application example code .. doxygengroup:: LWESP_APP_MQTT_CLIENT_API ================================================ FILE: docs/api-reference/apps/netconn.rst ================================================ .. _api_app_netconn: Netconn API =========== *Netconn API* is addon on top of existing connection module and allows sending and receiving data with sequential API calls, similar to *POSIX socket* API. It can operate in client or server mode and uses operating system features, such as message queues and semaphore to link non-blocking callback API for connections with sequential API for application thread. .. note:: Connection API does not directly allow receiving data with sequential and linear code execution. All is based on connection event system. Netconn adds this functionality as it is implemented on top of regular connection API. .. warning:: Netconn API are designed to be called from application threads ONLY. It is not allowed to call any of *netconn API* functions from within interrupt or callback event functions. Netconn client ^^^^^^^^^^^^^^ .. figure:: ../../static/images/netconn_client.svg :align: center :alt: Netconn API client block diagram Netconn API client block diagram Above block diagram shows basic architecture of netconn client application. There is always one application thread (in green) which calls *netconn API* functions to interact with connection API in synchronous mode. Every netconn connection uses dedicated structure to handle message queue for data received packet buffers. Each time new packet is received (red block, *data received event*), reference to it is written to message queue of netconn structure, while application thread reads new entries from the same queue to get packets. .. literalinclude:: ../../../snippets/netconn_client.c :language: c :linenos: :caption: Netconn client example Netconn server ^^^^^^^^^^^^^^ .. figure:: ../../static/images/netconn_server_1thread.svg :align: center :alt: Netconn API server block diagram Netconn API server block diagram When netconn is configured in server mode, it is possible to accept new clients from remote side. Application creates *netconn server connection*, which can only accept *clients* and cannot send/receive any data. It configures server on dedicated port (selected by application) and listens on it. When new client connects, *server callback function* is called with *new active connection event*. Newly accepted connection is then written to server structure netconn which is later read by application thread. At the same time, *netconn connection* structure (blue) is created to allow standard send/receive operation on active connection. .. note:: Each connected client has its own *netconn connection* structure. When multiple clients connect to server at the same time, multiple entries are written to *connection accept* message queue and are ready to be processed by application thread. From this point, program flow is the same as in case of *netconn client*. This is basic example for netconn thread. It waits for client and processes it in blocking mode. .. warning:: When multiple clients connect at the same time to netconn server, they are processed one-by-one, sequentially. This may introduce delay in response for other clients. Check netconn concurrency option to process multiple clients at the same time .. literalinclude:: ../../../snippets/netconn_server_1thread.c :language: c :linenos: :caption: Netconn server with single processing thread Netconn server concurrency ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: ../../static/images/netconn_server_concurrency.svg :align: center :alt: Netconn API server concurrency block diagram Netconn API server concurrency block diagram When compared to classic netconn server, concurrent netconn server mode allows multiple clients to be processed at the same time. This can drastically improve performance and response time on clients side, especially when many clients are connected to server at the same time. Every time *server application thread* (green block) gets new client to process, it starts a new *processing* thread instead of doing it in accept thread. * Server thread is only dedicated to accept clients and start threads * Multiple processing thread can run in parallel to send/receive data from multiple clients * No delay when multi clients are active at the same time * Higher memory footprint is necessary as there are multiple threads active .. literalinclude:: ../../../snippets/netconn_server.c :language: c :linenos: :caption: Netconn server with multiple processing threads Non-blocking receive ^^^^^^^^^^^^^^^^^^^^ By default, netconn API is written to only work in separate application thread, dedicated for network connection processing. Because of that, by default every function is fully blocking. It will wait until result is ready to be used by application. It is, however, possible to enable timeout feature for receiving data only. When this feature is enabled, :cpp:func:`lwesp_netconn_receive` will block for maximal timeout set with :cpp:func:`lwesp_netconn_set_receive_timeout` function. When enabled, if there is no received data for timeout amount of time, function will return with timeout status and application needs to process it accordingly. .. tip:: :c:macro:`LWESP_CFG_NETCONN_RECEIVE_TIMEOUT` must be set to ``1`` to use this feature. .. doxygengroup:: LWESP_NETCONN ================================================ FILE: docs/api-reference/cli/cli_input.rst ================================================ .. _api_cli_input: CLI Input module ================ .. doxygengroup:: CLI_INPUT ================================================ FILE: docs/api-reference/cli/cli_opt.rst ================================================ .. _api_cli_opt: CLI Configuration ================= .. doxygengroup:: CLI_CONFIG :inner: ================================================ FILE: docs/api-reference/cli/index.rst ================================================ .. _api_cli: Command line interface ====================== .. toctree:: :maxdepth: 2 :glob: * .. doxygengroup:: CLI ================================================ FILE: docs/api-reference/index.rst ================================================ .. _api_reference: API reference ============= List of all the modules: .. toctree:: :maxdepth: 2 lwesp/index opt port/index apps/index cli/index ================================================ FILE: docs/api-reference/lwesp/ap.rst ================================================ .. _api_lwesp_ap: Access point ============ .. doxygengroup:: LWESP_AP ================================================ FILE: docs/api-reference/lwesp/ble.rst ================================================ .. _api_lwesp_ble: Bluetooth Low Energy ==================== .. doxygengroup:: LWESP_BLE ================================================ FILE: docs/api-reference/lwesp/bt.rst ================================================ .. _api_lwesp_bt: Bluetooth Classic ================= .. doxygengroup:: LWESP_BT ================================================ FILE: docs/api-reference/lwesp/buff.rst ================================================ .. _api_lwesp_buff: Ring buffer =========== .. doxygengroup:: LWESP_BUFF ================================================ FILE: docs/api-reference/lwesp/conn.rst ================================================ .. _api_lwesp_conn: Connections =========== Connections are essential feature of WiFi device and middleware. It is developed with strong focus on its performance and since it may interact with huge amount of data, it tries to use zero-copy (when available) feature, to decrease processing time. *ESP AT Firmware* by default supports up to ``5`` connections being active at the same time and supports: * Up to ``5`` TCP connections active at the same time * Up to ``5`` UDP connections active at the same time * Up to ``1`` SSL connection active at a time .. note:: Client or server connections are available. Same API function call are used to send/receive data or close connection. Architecture of the connection API is using callback event functions. This allows maximal optimization in terms of responsiveness on different kind of events. Example below shows *bare minimum* implementation to: * Start a new connection to remote host * Send *HTTP GET* request to remote host * Process received data in event and print number of received bytes .. literalinclude:: ../../../snippets/client.c :language: c :linenos: :caption: Client connection minimum example Sending data ^^^^^^^^^^^^ Receiving data flow is always the same. Whenever new data packet arrives, corresponding event is called to notify application layer. When it comes to sending data, application may decide between ``2`` options (*this is valid only for non-UDP connections*): * Write data to temporary transmit buffer * Execute *send command* for every API function call Temporary transmit buffer ************************* By calling :cpp:func:`lwesp_conn_write` on active connection, temporary buffer is allocated and input data are copied to it. There is always up to ``1`` internal buffer active. When it is full (or if input data length is longer than maximal size), data are immediately send out and are not written to buffer. *ESP AT Firmware* allows (current revision) to transmit up to ``2048`` bytes at a time with single command. When trying to send more than this, application would need to issue multiple *send commands* on *AT commands level*. Write option is used mostly when application needs to write many different small chunks of data. Temporary buffer hence prevents many *send command* instructions as it is faster to send single command with big buffer, than many of them with smaller chunks of bytes. .. literalinclude:: ../../examples_src/conn_write.c :language: c :linenos: :caption: Write data to connection output buffer Transmit packet manually ************************ In some cases it is not possible to use temporary buffers, mostly because of memory constraints. Application can directly start *send data* instructions on *AT* level by using :cpp:func:`lwesp_conn_send` or :cpp:func:`lwesp_conn_sendto` functions. .. doxygengroup:: LWESP_CONN ================================================ FILE: docs/api-reference/lwesp/debug.rst ================================================ .. _api_lwesp_debug: Debug support ============= Middleware has extended debugging capabilities. These consist of different debugging levels and types of debug messages, allowing to track and catch different types of warnings, severe problems or simply output messages program flow messages (trace messages). Module is highly configurable using library configuration methods. Application must enable some options to decide what type of messages and for which modules it would like to output messages. With default configuration, ``printf`` is used as output function. This behavior can be changed with :c:macro:`LWESP_CFG_DBG_OUT` configuration. For successful debugging, application must: * Enable global debugging by setting :c:macro:`LWESP_CFG_DBG` to :c:macro:`LWESP_DBG_ON` * Configure which types of messages to output * Configure debugging level, from all messages to severe only * Enable specific modules to debug, by setting its configuration value to :c:macro:`LWESP_DBG_ON` .. tip:: Check :ref:`api_lwesp_opt` for all modules with debug implementation. An example code with config and latter usage: .. literalinclude:: ../../examples_src/debug_opts.h :language: c :linenos: :caption: Debug configuration setup .. literalinclude:: ../../examples_src/debug.c :language: c :linenos: :caption: Debug usage within middleware .. doxygengroup:: LWESP_DEBUG ================================================ FILE: docs/api-reference/lwesp/dhcp.rst ================================================ .. _api_lwesp_dhcp: Dynamic Host Configuration Protocol =================================== .. doxygengroup:: LWESP_DHCP ================================================ FILE: docs/api-reference/lwesp/dns.rst ================================================ .. _api_lwesp_dns: Domain Name System ================== .. doxygengroup:: LWESP_DNS ================================================ FILE: docs/api-reference/lwesp/evt.rst ================================================ .. _api_lwesp_evt: Event management ================ .. doxygengroup:: LWESP_EVT ================================================ FILE: docs/api-reference/lwesp/flash.rst ================================================ .. _api_flash: System Flash ============ .. doxygengroup:: LWESP_FLASH ================================================ FILE: docs/api-reference/lwesp/hostname.rst ================================================ .. _api_lwesp_hostname: Hostname ======== .. doxygengroup:: LWESP_HOSTNAME ================================================ FILE: docs/api-reference/lwesp/index.rst ================================================ .. _api_lwesp: LwESP ===== .. toctree:: :maxdepth: 2 :glob: * .. doxygengroup:: LWESP ================================================ FILE: docs/api-reference/lwesp/input.rst ================================================ .. _api_lwesp_input: Input module ============ Input module is used to input received data from *ESP* device to *LwESP* middleware part. ``2`` processing options are possible: * Indirect processing with :cpp:func:`lwesp_input` (default mode) * Direct processing with :cpp:func:`lwesp_input_process` .. tip:: Direct or indirect processing mode is select by setting :c:macro:`LWESP_CFG_INPUT_USE_PROCESS` configuration value. Indirect processing ^^^^^^^^^^^^^^^^^^^ With indirect processing mode, every received character from *ESP* physical device is written to intermediate buffer between low-level driver and *processing* thread. Function :cpp:func:`lwesp_input` is used to write data to buffer, which is later processed by *processing* thread. Indirect processing mode allows embedded systems to write received data to buffer from interrupt context (outside threads). As a drawback, its performance is decreased as it involves copying every receive character to intermediate buffer, and may also introduce RAM memory footprint increase. Direct processing ^^^^^^^^^^^^^^^^^ Direct processing is targeting more advanced host controllers, like STM32 or WIN32 implementation use. It is developed with DMA support in mind, allowing low-level drivers to skip intermediate data buffer and process input bytes directly. .. note:: When using this mode, function :cpp:func:`lwesp_input_process` must be used and it may only be called from thread context. Processing of input bytes is done in low-level input thread, started by application. .. tip:: Check :ref:`um_porting_guide` for implementation examples. .. doxygengroup:: LWESP_INPUT ================================================ FILE: docs/api-reference/lwesp/mdns.rst ================================================ .. _api_lwesp_: Multicast DNS ============= .. doxygengroup:: LWESP_MDNS ================================================ FILE: docs/api-reference/lwesp/mem.rst ================================================ .. _api_lwesp_mem: Memory manager ============== .. doxygengroup:: LWESP_MEM ================================================ FILE: docs/api-reference/lwesp/pbuf.rst ================================================ .. _api_lwesp_pbuf: Packet buffer ============= Packet buffer (or *pbuf*) is buffer manager to handle received data from any connection. It is optimized to construct big buffer of smaller chunks of fragmented data as received bytes are not always coming as single packet. Pbuf block diagram ^^^^^^^^^^^^^^^^^^ .. figure:: ../../static/images/pbuf_block_diagram.svg :align: center :alt: Block diagram of pbuf chain Block diagram of pbuf chain Image above shows structure of *pbuf* chain. Each *pbuf* consists of: * Pointer to next *pbuf*, or ``NULL`` when it is last in chain * Length of current packet length * Length of current packet and all next in chain * If *pbuf* is last in chain, total length is the same as current packet length * Reference counter, indicating how many pointers point to current *pbuf* * Actual buffer data Top image shows ``3`` pbufs connected to single chain. There are ``2`` custom pointer variables to point at different *pbuf* structures. Second *pbuf* has reference counter set to ``2``, as ``2`` variables point to it: * *next* of *pbuf 1* is the first one * *User variable 2* is the second one .. table:: Block structure +--------------+-----------+------------+---------------------+-------------------+ | Block number | Next pbuf | Block size | Total size in chain | Reference counter | +==============+===========+============+=====================+===================+ | Block 1 | *Block 2* | ``150`` | ``550`` | ``1`` | +--------------+-----------+------------+---------------------+-------------------+ | Block 2 | *Block 3* | ``130`` | ``400`` | ``2`` | +--------------+-----------+------------+---------------------+-------------------+ | Block 3 | ``NULL`` | ``270`` | ``270`` | ``1`` | +--------------+-----------+------------+---------------------+-------------------+ Reference counter ^^^^^^^^^^^^^^^^^ Reference counter holds number of references (or variables) pointing to this block. It is used to properly handle memory free operation, especially when *pbuf* is used by lib core and application layer. .. note:: If there would be no reference counter information and application would free memory while another part of library still uses its reference, application would invoke *undefined behavior* and system could crash instantly. When application tries to free pbuf chain as on first image, it would normally call :cpp:func:`lwesp_pbuf_free` function. That would: * Decrease reference counter by ``1`` * If reference counter ``== 0``, it removes it from chain list and frees packet buffer memory * If reference counter ``!= 0`` after decrease, it stops free procedure * Go to next pbuf in chain and repeat steps As per first example, result of freeing from *user variable 1* would look similar to image and table below. First block (blue) had reference counter set to ``1`` prior freeing operation. It was successfully removed as *user variable 1* was the only one pointing to it, while second (green) block had reference counter set to ``2``, preventing free operation. .. figure:: ../../static/images/pbuf_block_diagram_after_free.svg :align: center :alt: Block diagram of pbuf chain after free from *user variable 1* Block diagram of pbuf chain after free from *user variable 1* .. table:: Block diagram of pbuf chain after free from *user variable 1* +--------------+-----------+------------+---------------------+-------------------+ | Block number | Next pbuf | Block size | Total size in chain | Reference counter | +==============+===========+============+=====================+===================+ | Block 2 | *Block 3* | ``130`` | ``400`` | ``1`` | +--------------+-----------+------------+---------------------+-------------------+ | Block 3 | ``NULL`` | ``270`` | ``270`` | ``1`` | +--------------+-----------+------------+---------------------+-------------------+ .. note:: *Block 1* has been successfully freed, but since *block 2* had reference counter set to ``2`` before, it was only decreased by ``1`` to a new value ``1`` and free operation stopped instead. *User variable 2* is still using *pbuf* starting at *block 2* and must manually call :cpp:func:`lwesp_pbuf_free` to free it. Concatenating vs chaining ^^^^^^^^^^^^^^^^^^^^^^^^^ This section will explain difference between *concat* and *chain* operations. Both operations link ``2`` pbufs together in a chain of pbufs, difference is that *chain* operation increases *reference counter* to linked pbuf, while *concat* keeps *reference counter* at its current status. .. figure:: ../../static/images/pbuf_cat_vs_chain_1.svg :align: center :alt: Different pbufs, each pointed to by its own variable Different pbufs, each pointed to by its own variable Concat operation **************** Concat operation shall be used when ``2`` pbufs are linked together and reference to *second* is no longer used. .. figure:: ../../static/images/pbuf_cat_vs_chain_2.svg :align: center :alt: Structure after pbuf concat Structure after pbuf concat After concating *2 pbufs* together, reference counter of second is still set to ``1``, however we can see that ``2`` pointers point to *second pbuf*. .. note:: After application calls :cpp:func:`lwesp_pbuf_cat`, it must not use pointer which points to *second pbuf*. This would invoke *undefined behavior* if one pointer tries to free memory while second still points to it. An example code showing proper usage of concat operation: .. literalinclude:: ../../examples_src/pbuf_cat.c :language: c :linenos: :caption: Packet buffer concat example Chain operation *************** Chain operation shall be used when ``2`` pbufs are linked together and reference to *second* is still required. .. figure:: ../../static/images/pbuf_cat_vs_chain_3.svg :align: center :alt: Structure after pbuf chain Structure after pbuf chain After chainin *2 pbufs* together, reference counter of second is increased by ``1``, which allows application to reference second *pbuf* separatelly. .. note:: After application calls :cpp:func:`lwesp_pbuf_chain`, it also has to manually free its reference using :cpp:func:`lwesp_pbuf_free` function. Forgetting to free pbuf invokes memory leak An example code showing proper usage of chain operation: .. literalinclude:: ../../examples_src/pbuf_chain.c :language: c :linenos: :caption: Packet buffer chain example Extract pbuf data ***************** Each *pbuf* holds some amount of data bytes. When multiple *pbufs* are linked together (either chained or concated), blocks of raw data are not linked to contiguous memory block. It is necessary to process block by block manually. An example code showing proper reading of any *pbuf*: .. literalinclude:: ../../examples_src/pbuf_extract.c :language: c :linenos: :caption: Packet buffer data extraction .. doxygengroup:: LWESP_PBUF ================================================ FILE: docs/api-reference/lwesp/ping.rst ================================================ .. _api_lwesp_ping: Ping support ============ .. doxygengroup:: LWESP_PING ================================================ FILE: docs/api-reference/lwesp/server.rst ================================================ .. _api_lwesp_server: Server ====== .. doxygengroup:: LWESP_SERVER ================================================ FILE: docs/api-reference/lwesp/smart.rst ================================================ .. _api_lwesp_smart: Smart config ============ .. doxygengroup:: LWESP_SMART ================================================ FILE: docs/api-reference/lwesp/sntp.rst ================================================ .. _api_lwesp_sntp: Simple Network Time Protocol ============================ ESP has built-in support for *Simple Network Time Protocol (SNTP)*. It is support through middleware API calls for configuring servers and reading actual date and time. .. literalinclude:: ../../../snippets/sntp.c :language: c :linenos: :caption: Minimum SNTP example .. doxygengroup:: LWESP_SNTP ================================================ FILE: docs/api-reference/lwesp/sta.rst ================================================ .. _api_lwesp_sta: Station API =========== Station API is used to work with *ESP* acting in station mode. It allows to join other access point, scan for available access points or simply disconnect from it. An example below is showing how all examples (coming with this library) scan for access point and then try to connect to AP from list of preferred one. .. literalinclude:: ../../../snippets/station_manager.c :language: c :linenos: :caption: Station manager used with all examples .. doxygengroup:: LWESP_STA ================================================ FILE: docs/api-reference/lwesp/timeout.rst ================================================ .. _api_lwesp_timeout: Timeout manager =============== Timeout manager allows application to call specific function at desired time. It is used in middleware (and can be used by application too) to poll active connections. .. note:: Callback function is called from *processing* thread. It is not allowed to call any blocking API function from it. When application registers timeout, it needs to set timeout, callback function and optional user argument. When timeout elapses, ESP middleware will call timeout callback. This feature can be considered as single-shot software timer. .. doxygengroup:: LWESP_TIMEOUT ================================================ FILE: docs/api-reference/lwesp/types.rst ================================================ .. _api_lwesp_types: Structures and enumerations =========================== .. doxygengroup:: LWESP_TYPES ================================================ FILE: docs/api-reference/lwesp/unicode.rst ================================================ .. _api_lwesp_unicode: Unicode ======= Unicode decoder block. It can decode sequence of *UTF-8* characters, between ``1`` and ``4`` bytes long. .. note:: This is simple implementation and does not support string encoding. .. doxygengroup:: LWESP_UNICODE ================================================ FILE: docs/api-reference/lwesp/utils.rst ================================================ .. _api_lwesp_utils: Utilities ========= Utility functions for various cases. These function are used across entire middleware and can also be used by application. .. doxygengroup:: LWESP_UTILS ================================================ FILE: docs/api-reference/lwesp/webserver.rst ================================================ .. _api_lwesp_webserver: Web Server ========== Use ESP-AT's built-in web server feature to help WiFi provisioning and/or Firmware Over-the-Air update. .. note:: Web Server is not enabled in ESP-AT by default. Refer to `ESP-AT User Guide `_ to build a custom image from source. .. doxygengroup:: LWESP_WEBSERVER ================================================ FILE: docs/api-reference/lwesp/wps.rst ================================================ .. _api_lwesp_wps: Wi-Fi Protected Setup ===================== .. doxygengroup:: LWESP_WPS ================================================ FILE: docs/api-reference/opt.rst ================================================ .. _api_lwesp_opt: Configuration ============= This is the default configuration of the middleware. When any of the settings shall be modified, it shall be done in dedicated application config ``lwesp_opts.h`` file. .. note:: Check :ref:`getting_started` for guidelines on how to create and use configuration file. .. doxygengroup:: LWESP_OPT :inner: ================================================ FILE: docs/api-reference/port/index.rst ================================================ .. _api_lwesp_port: Platform specific ================= List of all the modules: .. toctree:: :maxdepth: 2 :glob: * ================================================ FILE: docs/api-reference/port/ll.rst ================================================ .. _api_lwesp_ll: Low-Level functions =================== Low-level module consists of callback-only functions, which are called by middleware and must be implemented by final application. .. tip:: Check :ref:`um_porting_guide` for actual implementation .. doxygengroup:: LWESP_LL ================================================ FILE: docs/api-reference/port/sys.rst ================================================ .. _api_lwesp_sys: System functions ================ System functions are bridge between operating system system calls and middleware system calls. Middleware is tightly coupled with operating system features hence it is important to include OS features directly. It includes support for: * Thread management, to start/stop threads * Mutex management for recursive mutexes * Semaphore management for binary-only semaphores * Message queues for thread-safe data exchange between threads * Core system protection for mutual exclusion to access shared resources .. tip:: Check :ref:`um_porting_guide` for actual implementation guidelines. .. doxygengroup:: LWESP_SYS ================================================ FILE: docs/authors/index.rst ================================================ .. _authors: Authors ======= List of authors and contributors to the library .. literalinclude:: ../../AUTHORS ================================================ FILE: docs/changelog/index.rst ================================================ .. _changelof: Changelog ========= .. literalinclude:: ../../CHANGELOG.md ================================================ FILE: docs/conf.py ================================================ # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('.')) from sphinx.builders.html import StandaloneHTMLBuilder import subprocess, os # Run doxygen first # read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' # if read_the_docs_build: subprocess.call('doxygen doxyfile.doxy', shell=True) # -- Project information ----------------------------------------------------- project = 'LwESP' copyright = '2025, Tilen MAJERLE' author = 'Tilen MAJERLE' # Try to get branch at which this is running # and try to determine which version to display in sphinx # Version is using git tag if on master/main or "latest-develop" if on develop branch version = '' git_branch = '' def cmd_exec_print(t): print("cmd > ", t, "\n", os.popen(t).read().strip(), "\n") # Print demo data here cmd_exec_print('git branch') cmd_exec_print('git describe') cmd_exec_print('git describe --tags') cmd_exec_print('git describe --tags --abbrev=0') cmd_exec_print('git describe --tags --abbrev=1') # Get current branch res = os.popen('git branch').read().strip() for line in res.split("\n"): if line[0] == '*': git_branch = line[1:].strip() # Decision for display version git_branch = git_branch.replace('(HEAD detached at ', '').replace(')', '') if git_branch.find('master') >= 0 or git_branch.find('main') >= 0: #version = os.popen('git describe --tags --abbrev=0').read().strip() version = 'latest-stable' elif git_branch.find('develop-') >= 0 or git_branch.find('develop/') >= 0: version = 'branch-' + git_branch elif git_branch == 'develop' or git_branch == 'origin/develop': version = 'latest-develop' else: version = os.popen('git describe --tags --abbrev=0').read().strip() # For debugging purpose only print("GIT BRANCH: " + git_branch) print("PROJ VERSION: " + version) # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.autosectionlabel', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx_sitemap', 'breathe', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] highlight_language = 'c' # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = 'sphinx_rtd_theme' html_theme_options = { 'canonical_url': '', 'analytics_id': '', # Provided by Google in your dashboard 'display_version': True, 'prev_next_buttons_location': 'bottom', 'style_external_links': False, 'logo_only': False, # Toc options 'collapse_navigation': True, 'sticky_navigation': True, 'navigation_depth': 4, 'includehidden': True, 'titles_only': False } html_logo = 'static/images/logo.svg' github_url = 'https://github.com/MaJerle/esp-at-lib' html_baseurl = 'https://docs.majerle.eu/projects/esp-at-lib/' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['static'] html_css_files = [ 'css/common.css', 'css/custom.css', 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css', ] html_js_files = [ '' ] # Master index file master_doc = 'index' # --- Breathe configuration ----------------------------------------------------- breathe_projects = { "lwesp": "_build/xml/" } breathe_default_project = "lwesp" breathe_default_members = ('members', 'undoc-members') breathe_show_enumvalue_initializer = True ================================================ FILE: docs/doxyfile.doxy ================================================ # Doxyfile 1.9.4 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). # # Note: # # Use doxygen to compare the used configuration file with the template # configuration file: # doxygen -x [configFile] # Use doxygen to compare the used configuration file with the template # configuration file without replacing the environment variables: # doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the configuration # file that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = LwESP # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "Lightweight ESP-AT parser library" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = _build # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format # and will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to # control the number of sub-directories. # The default value is: NO. CREATE_SUBDIRS = NO # Controls the number of sub-directories that will be created when # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every # level increment doubles the number of directories, resulting in 4096 # directories at level 8 which is the default and also the maximum value. The # sub-directories are organized in 2 levels, the first level always has a fixed # numer of 16 directories. # Minimum value: 0, maximum value: 8, default value: 8. # This tag requires that the tag CREATE_SUBDIRS is set to YES. CREATE_SUBDIRS_LEVEL = 8 # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with # English messages), Korean, Korean-en (Korean with English messages), Latvian, # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, # Swedish, Turkish, Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = NO # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be # interpreted by doxygen. # The default value is: NO. JAVADOC_BANNER = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # By default Python docstrings are displayed as preformatted text and doxygen's # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the # doxygen's special commands can be used and the contents of the docstring # documentation blocks is shown as doxygen documentation. # The default value is: YES. PYTHON_DOCSTRING = YES # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:^^" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". Note that you cannot put \n's in the value part of an alias # to insert newlines (in the resulting output). You can put ^^ in the value part # of an alias to insert a newline as if a physical newline was in the original # file. When you need a literal { or } or , in the value part of an alias you # have to escape them by means of a backslash (\), this can lead to conflicts # with the commands \{ and \} for these it is advised to use the version @{ and # @} or use a double escape (\\{ and \\}) ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice # sources only. Doxygen will then generate output that is more tailored for that # language. For instance, namespaces will be presented as modules, types will be # separated into more groups, etc. # The default value is: NO. OPTIMIZE_OUTPUT_SLICE = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the # default for Fortran type files). For instance to make doxygen treat .inc files # as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. When specifying no_extension you should add # * to the FILE_PATTERNS. # # Note see also the list of default file extension mappings. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 5 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = YES # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use # during processing. When set to 0 doxygen will based this on the number of # cores available in the system. You can set it explicitly to a value larger # than 0 to get more control over the balance between CPU load and processing # speed. At this moment only the input processing can be done using multiple # threads. Since this is still an experimental feature the default is set to 1, # which effectively disables parallel processing. Please report any issues you # encounter. Generating dot graphs in parallel is controlled by the # DOT_NUM_THREADS setting. # Minimum value: 0, maximum value: 32, default value: 1. NUM_PROC_THREADS = 1 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual # methods of a class will be included in the documentation. # The default value is: NO. EXTRACT_PRIV_VIRTUAL = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If this flag is set to YES, the name of an unnamed parameter in a declaration # will be determined by the corresponding definition. By default unnamed # parameters remain unnamed in the output. # The default value is: YES. RESOLVE_UNNAMED_PARAMS = YES # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # With the correct setting of option CASE_SENSE_NAMES doxygen will better be # able to match the capabilities of the underlying filesystem. In case the # filesystem is case sensitive (i.e. it supports files in the same directory # whose names only differ in casing), the option must be set to YES to properly # deal with such files in case they appear in the input. For filesystems that # are not case sensitive the option should be set to NO to properly deal with # output files written for symbols that only differ in casing, such as for two # classes, one named CLASS and the other named Class, and to also support # references to files without having to specify the exact matching casing. On # Windows (including Cygwin) and MacOS, users should typically set this option # to NO, whereas on Linux or other Unix flavors it should typically be set to # YES. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = YES # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class # will show which file needs to be included to use the class. # The default value is: YES. SHOW_HEADERFILE = YES # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = NO # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. See also section "Changing the # layout of pages" for information. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as documenting some parameters in # a documented function twice, or documenting parameters that don't exist or # using markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete # function parameter documentation. If set to NO, doxygen will accept that some # parameters have no documentation without warning. # The default value is: YES. WARN_IF_INCOMPLETE_DOC = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong parameter # documentation, but not about the absence of documentation. If EXTRACT_ALL is # set to YES then this flag will automatically be disabled. See also # WARN_IF_INCOMPLETE_DOC # The default value is: NO. WARN_NO_PARAMDOC = YES # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but # at the end of the doxygen process doxygen will return with a non-zero status. # Possible values are: NO, YES and FAIL_ON_WARNINGS. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # See also: WARN_LINE_FORMAT # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # In the $text part of the WARN_FORMAT command it is possible that a reference # to a more specific place is given. To make it easier to jump to this place # (outside of doxygen) the user can define a custom "cut" / "paste" string. # Example: # WARN_LINE_FORMAT = "'vi $file +$line'" # See also: WARN_FORMAT # The default value is: at line $line of file $file. WARN_LINE_FORMAT = "at line $line of file $file" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). In case the file specified cannot be opened for writing the # warning and error messages are written to standard error. When as file - is # specified the warning and error messages are written to standard output # (stdout). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = ../lwesp/ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: # https://www.gnu.org/software/libiconv/) for the list of possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # Note the list of default checked file patterns might differ from the list of # default file extension mappings. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, # *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ *.java \ *.ii \ *.ixx \ *.ipp \ *.i++ \ *.inl \ *.idl \ *.ddl \ *.odl \ *.h \ *.hh \ *.hxx \ *.hpp \ *.h++ \ *.cs \ *.d \ *.php \ *.php4 \ *.php5 \ *.phtml \ *.inc \ *.m \ *.markdown \ *.md \ *.mm \ *.dox \ *.py \ *.f90 \ *.f \ *.for \ *.tcl \ *.vhd \ *.vhdl \ *.ucf \ *.qsf \ *.as \ *.js # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # ANamespace::AClass, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: # http://clang.llvm.org/) for more accurate parsing at the cost of reduced # performance. This can be particularly helpful with template rich C++ code for # which doxygen's built-in parser lacks the necessary type information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS # tag is set to YES then doxygen will add the directory of each input to the # include path. # The default value is: YES. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_ADD_INC_PATHS = YES # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = # If clang assisted parsing is enabled you can provide the clang parser with the # path to the directory containing a file called compile_commands.json. This # file is the compilation database (see: # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the # options used when the source files were built. This is equivalent to # specifying the -p option to a clang tool, such as clang-check. These options # will then be passed to the parser. Any options specified with CLANG_OPTIONS # will be added as well. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse_libclang=ON option for CMake. CLANG_DATABASE_PATH = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a color-wheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use gray-scales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML # page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_MENUS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To # create a documentation set, doxygen will generate a Makefile in the HTML # output directory. Running make will produce the docset in that directory and # running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag determines the URL of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDURL = # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # on Windows. In the beginning of 2021 Microsoft took the original page, with # a.o. the download links, offline the HTML help workshop was already many years # in maintenance mode). You can download the HTML help workshop from the web # archives at Installation executable (see: # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the main .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location (absolute path # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to # run qhelpgenerator on the generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine tune the look of the index (see "Fine-tuning the output"). As an # example, the default style sheet generated by doxygen has an example that # shows how to put an image at the root of the tree instead of the PROJECT_NAME. # Since the tree basically has the same information as the tab index, you could # consider setting DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the # FULL_SIDEBAR option determines if the side bar is limited to only the treeview # area (value NO) or if it should extend to the full height of the window (value # YES). Setting this to YES gives a layout similar to # https://docs.readthedocs.io with more room for contents, but less room for the # project logo, title, and description. If either GENERATE_TREEVIEW or # DISABLE_INDEX is set to NO, this option has no effect. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. FULL_SIDEBAR = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email # addresses. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. OBFUSCATE_EMAILS = YES # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see # https://inkscape.org) to generate formulas as SVG images instead of PNGs for # the HTML output. These images will generally look nicer at scaled resolutions. # Possible values are: png (the default) and svg (looks nicer but requires the # pdf2svg or inkscape tool). # The default value is: png. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FORMULA_FORMAT = png # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. FORMULA_MACROFILE = # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = YES # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. # Note that the different versions of MathJax have different requirements with # regards to the different settings, so it is possible that also other MathJax # settings have to be changed when switching between the different MathJax # versions. # Possible values are: MathJax_2 and MathJax_3. # The default value is: MathJax_2. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_VERSION = MathJax_2 # When MathJax is enabled you can set the default output format to be used for # the MathJax output. For more details about the output format see MathJax # version 2 (see: # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 # (see: # http://docs.mathjax.org/en/latest/web/components/output.html). # Possible values are: HTML-CSS (which is slower, but has the best # compatibility. This is the name for Mathjax version 2, for MathJax version 3 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This # is the name for Mathjax version 3, for MathJax version 2 this will be # translated into HTML-CSS) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. The default value is: # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # for MathJax version 2 (see # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # For example for MathJax version 3 (see # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): # MATHJAX_EXTENSIONS = ams # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /