Merge pull request #47 from david-cermak/feat/custom_impl

Support for custom WiFi remote implementation

Author: david-cermak

components/esp_wifi_remote/.cz.yaml

@@ -3,6 +3,6 @@ commitizen:
   bump_message: 'bump(wifi_remote): $current_version -> $new_version'
   pre_bump_hooks: python ../../ci/changelog.py esp_wifi_remote
   tag_format: wifi_remote-v$version
-  version: 0.13.0
+  version: 0.14.0
   version_files:
   - idf_component.yml

components/esp_wifi_remote/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [0.14.0](https://github.com/espressif/esp-wifi-remote/commits/wifi_remote-v0.14.0)
+
+### Features
+
+- Add support for custom wifi-remote impl ([9bf662f](https://github.com/espressif/esp-wifi-remote/commit/9bf662f))
+
 ## [0.13.0](https://github.com/espressif/esp-wifi-remote/commits/wifi_remote-v0.13.0)
 
 ### Features

components/esp_wifi_remote/CMakeLists.txt

@@ -9,6 +9,7 @@ endif()
 idf_component_register(INCLUDE_DIRS include
                     SRCS ${src_wifi_is_remote}
                          ${src_wifi_remote_eppp}
+                         dummy_src.c    # Prevents making this component potentially INTERFACE only
                     PRIV_INCLUDE_DIRS eppp
                     REQUIRES esp_event esp_netif
                     PRIV_REQUIRES esp_wifi esp-tls vfs)
@@ -27,8 +28,6 @@ endif()
 
 idf_component_get_property(wifi esp_wifi COMPONENT_LIB)
 
-set(TARGET_INCLUDE_TYPE "INTERFACE")
-set(TARGET_SOURCE_TYPE "INTERFACE")
 if(NOT CONFIG_ESP_WIFI_ENABLED AND NOT CONFIG_ESP_HOST_WIFI_ENABLED)
     set(src_wifi_with_remote ${IDF_VER_DIR}/esp_wifi_with_remote.c)
     if(CONFIG_ESP_WIFI_REMOTE_EAP_ENABLED)
@@ -37,25 +36,21 @@ if(NOT CONFIG_ESP_WIFI_ENABLED AND NOT CONFIG_ESP_HOST_WIFI_ENABLED)
     # We need to build wifi sources with wifi-remote properties, so the injected wifi headers are used
     get_target_property(wifi_sources ${wifi} SOURCES)
     set_target_properties(${wifi} PROPERTIES SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/dummy_src.c")
-    set(TARGET_INCLUDE_TYPE "PUBLIC")
-    set(TARGET_SOURCE_TYPE "PRIVATE")
 endif()
 
-if(CONFIG_ESP_WIFI_REMOTE_LIBRARY_EPPP)
-    set(TARGET_INCLUDE_TYPE "PUBLIC")
-    set(TARGET_SOURCE_TYPE "PRIVATE")
-else()
+# Add weak symbol for the wifi_remote API if we're using esp_hosted implementation
+if(CONFIG_ESP_WIFI_REMOTE_LIBRARY_HOSTED)
     set(src_wifi_remote_weak ${IDF_VER_DIR}/esp_wifi_remote_weak.c)
     if(CONFIG_ESP_WIFI_REMOTE_EAP_ENABLED)
         list(APPEND src_wifi_remote_weak ${IDF_VER_DIR}/esp_eap_client_remote_weak.c)
     endif()
 endif()
 
 
-target_include_directories(${COMPONENT_LIB} ${TARGET_INCLUDE_TYPE} ${IDF_VER_DIR}/include)
-target_sources(${COMPONENT_LIB}             ${TARGET_SOURCE_TYPE}  ${src_wifi_remote_weak}
-                                                                   ${src_wifi_with_remote}
-                                                                   ${wifi_sources})
+target_include_directories(${COMPONENT_LIB} PUBLIC   ${IDF_VER_DIR}/include)
+target_sources(${COMPONENT_LIB}             PRIVATE  ${src_wifi_remote_weak}
+                                                     ${src_wifi_with_remote}
+                                                     ${wifi_sources})
 
 if(NOT CONFIG_ESP_WIFI_ENABLED AND NOT CONFIG_ESP_HOST_WIFI_ENABLED)
     # Update wifi include directories to prepend the injected dir with modified headers supporting SLAVE capability
@@ -67,5 +62,5 @@ endif()
 target_link_libraries(${wifi} PUBLIC ${COMPONENT_LIB})
 
 if(CONFIG_ESP_WIFI_REMOTE_EAP_ENABLED)
-    idf_component_optional_requires(${TARGET_INCLUDE_TYPE} wpa_supplicant)
+    idf_component_optional_requires(PRIVATE wpa_supplicant)
 endif()

components/esp_wifi_remote/Kconfig.rpc.in

@@ -5,13 +5,19 @@ choice ESP_WIFI_REMOTE_LIBRARY
         Select type of WiFi Remote implementation
 
         ESP-HOSTED is the default and most versatile option.
-        It's also possible to use EPPP, which uses PPPoS link between micros and NAPT, so it's slower
-        and less universal.
+        It's possible to use EPPP, which uses PPPoS link between micros and NAPT,
+        so it's slower, but allows for more customization on the slave side.
+        It's also possible to select CUSTOM and provide wifi_remote implementation
+        in any other component or application (needs to set link dependency from wifi-remote
+        to the custom implementation)
 
     config ESP_WIFI_REMOTE_LIBRARY_HOSTED
         bool "ESP-HOSTED"
     config ESP_WIFI_REMOTE_LIBRARY_EPPP
         bool "EPPP"
+    config ESP_WIFI_REMOTE_LIBRARY_CUSTOM
+        bool "CUSTOM"
+
 endchoice
 
     if ESP_WIFI_REMOTE_LIBRARY_EPPP

components/esp_wifi_remote/idf_component.yml

@@ -1,4 +1,4 @@
-version: 0.13.0
+version: 0.14.0
 url: https://github.com/espressif/esp-wifi-remote
 description: Utility wrapper for esp_wifi functionality on remote targets
 dependencies: