Added documentation for environment setup close #10

README.md

@@ -191,7 +191,7 @@ Replace the address **0x10000** with **0x0** if you want a fresh install.
 
 ## Building the Binaries
 
-see [How to build](docs/README.md)
+see [How to setup environment and build](docs/BUILD.md)
 
 ### DNS
 As soon as the ESP32 STA has learned a DNS IP from its upstream DNS server on first connect, it passes that to newly connected clients.

docs/BUILD.md

@@ -0,0 +1,28 @@
+# How to set up environment and build binary
+
+## Prerequisites
+
+- Install [VisualStudio Code](https://code.visualstudio.com/)
+- Install [PlatformIO IDE for VSCode](https://platformio.org/install/ide?install=vscode)
+- Install [Standard setup toolchain](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#get-started-get-prerequisites) for your platform
+
+
+## Getting started
+
+- Checkout or download sources 
+
+- Open project by selecting the project folder
+
+    ![Start](pio_start.png)
+
+    ![Open](pio_open.png)
+
+    This may take a while, because PlatformIO downloads all the required boards and tools for development.
+
+- make your changes
+
+- you can now compile and/or upload your code
+
+    ![Compile](pio_compile.png)
+
+- The bin-files (bootloader.bin, firmware.bin, partitions.bin) will be in {project folder}/.pio/build/esp32dev

sdkconfig.esp32dev

@@ -196,6 +196,7 @@ CONFIG_BT_CTRL_SLEEP_MODE_EFF=0
 CONFIG_BT_CTRL_SLEEP_CLOCK_EFF=0
 CONFIG_BT_CTRL_HCI_TL_EFF=1
 CONFIG_BT_RESERVE_DRAM=0
+CONFIG_BT_NIMBLE_USE_ESP_TIMER=y
 # end of Bluetooth
 
 #
@@ -327,6 +328,7 @@ CONFIG_ESP32_XTAL_FREQ=40
 # CONFIG_ESP32_DISABLE_BASIC_ROM_CONSOLE is not set
 # CONFIG_ESP32_NO_BLOBS is not set
 # CONFIG_ESP32_COMPATIBLE_PRE_V2_1_BOOTLOADERS is not set
+# CONFIG_ESP32_COMPATIBLE_PRE_V3_1_BOOTLOADERS is not set
 # CONFIG_ESP32_USE_FIXED_STATIC_RAM_SIZE is not set
 CONFIG_ESP32_DPORT_DIS_INTERRUPT_LVL=5
 # end of ESP32-specific
@@ -493,7 +495,12 @@ CONFIG_ESP32_WIFI_TASK_PINNED_TO_CORE_0=y
 # CONFIG_ESP32_WIFI_TASK_PINNED_TO_CORE_1 is not set
 CONFIG_ESP32_WIFI_SOFTAP_BEACON_MAX_LEN=752
 CONFIG_ESP32_WIFI_MGMT_SBUF_NUM=32
-# CONFIG_ESP32_WIFI_DEBUG_LOG_ENABLE is not set
+# CONFIG_WIFI_LOG_DEFAULT_LEVEL_NONE is not set
+# CONFIG_WIFI_LOG_DEFAULT_LEVEL_ERROR is not set
+# CONFIG_WIFI_LOG_DEFAULT_LEVEL_WARN is not set
+CONFIG_WIFI_LOG_DEFAULT_LEVEL_INFO=y
+# CONFIG_WIFI_LOG_DEFAULT_LEVEL_DEBUG is not set
+# CONFIG_WIFI_LOG_DEFAULT_LEVEL_VERBOSE is not set
 CONFIG_ESP32_WIFI_IRAM_OPT=y
 CONFIG_ESP32_WIFI_RX_IRAM_OPT=y
 # CONFIG_ESP32_WIFI_ENABLE_WPA3_SAE is not set
@@ -687,11 +694,13 @@ CONFIG_LWIP_ESP_GRATUITOUS_ARP=y
 CONFIG_LWIP_GARP_TMR_INTERVAL=60
 CONFIG_LWIP_TCPIP_RECVMBOX_SIZE=32
 CONFIG_LWIP_DHCP_DOES_ARP_CHECK=y
+# CONFIG_LWIP_DHCP_DISABLE_CLIENT_ID is not set
 # CONFIG_LWIP_DHCP_RESTORE_LAST_IP is not set
 
 #
 # DHCP server
 #
+CONFIG_LWIP_DHCPS=y
 CONFIG_LWIP_DHCPS_LEASE_UNIT=60
 CONFIG_LWIP_DHCPS_MAX_STATION_NUM=8
 # end of DHCP server
@@ -753,6 +762,7 @@ CONFIG_LWIP_IPV6_ND6_NUM_NEIGHBORS=5
 #
 # ICMP
 #
+CONFIG_LWIP_ICMP=y
 # CONFIG_LWIP_MULTICAST_PING is not set
 # CONFIG_LWIP_BROADCAST_PING is not set
 # end of ICMP
@@ -856,6 +866,8 @@ CONFIG_MBEDTLS_SSL_PROTO_TLS1_2=y
 CONFIG_MBEDTLS_SSL_PROTO_DTLS=y
 CONFIG_MBEDTLS_SSL_ALPN=y
 CONFIG_MBEDTLS_CLIENT_SSL_SESSION_TICKETS=y
+CONFIG_MBEDTLS_X509_CHECK_KEY_USAGE=y
+CONFIG_MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE=y
 CONFIG_MBEDTLS_SERVER_SSL_SESSION_TICKETS=y
 
 #
@@ -871,6 +883,7 @@ CONFIG_MBEDTLS_RC4_DISABLED=y
 # CONFIG_MBEDTLS_XTEA_C is not set
 CONFIG_MBEDTLS_CCM_C=y
 CONFIG_MBEDTLS_GCM_C=y
+# CONFIG_MBEDTLS_NIST_KW_C is not set
 # end of Symmetric Ciphers
 
 # CONFIG_MBEDTLS_RIPEMD160_C is not set
@@ -1048,7 +1061,13 @@ CONFIG_SPIFFS_USE_MTIME=y
 #
 # TCP Transport
 #
+
+#
+# Websocket
+#
+CONFIG_WS_TRANSPORT=y
 CONFIG_WS_BUFFER_SIZE=1024
+# end of Websocket
 # end of TCP Transport
 
 #
@@ -1106,7 +1125,7 @@ CONFIG_WPA_MBEDTLS_CRYPTO=y
 # CONFIG_WPA_WAPI_PSK is not set
 # CONFIG_WPA_DEBUG_PRINT is not set
 # CONFIG_WPA_TESTING_OPTIONS is not set
-# CONFIG_WPA_WPS_WARS is not set
+# CONFIG_WPA_WPS_STRICT is not set
 # CONFIG_WPA_11KV_SUPPORT is not set
 # end of Supplicant
 # end of Component config