Skip to content

Commit

Permalink
fix(websocket): added dependency checks, sdkconfig.defaults and refin…
Browse files Browse the repository at this point in the history
…ed README.md
  • Loading branch information
suren-gabrielyan-espressif committed Jan 30, 2024
1 parent 5ba7cfa commit 11e21ae
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
28 changes: 27 additions & 1 deletion components/esp_websocket_client/examples/linux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,33 @@
This example demonstrates the ESP websocket client using the `linux` target. It allows for compilation and execution of the example directly within a Linux environment.

## Compilation and Execution
To compile and execute this example on Linux, follow the standard procedures for building and running ESP-IDF projects under the Linux platform.

To compile and execute this example on Linux need to set target `linux`

```
idf.py --preview set-target linux
idf.py build
./websocket.elf
```

## Example Output

```
I (164532) websocket: [APP] Startup..
I (164532) websocket: [APP] Free memory: 4294967295 bytes
I (164532) websocket: [APP] IDF version: v5.3-dev-1353-gb3f7e2c8a4
I (164538) websocket: Connecting to ws://echo.websocket.events...
W (164538) websocket_client: `reconnect_timeout_ms` is not set, or it is less than or equal to zero, using default time out 10000 (milliseconds)
W (164538) websocket_client: `network_timeout_ms` is not set, or it is less than or equal to zero, using default time out 10000 (milliseconds)
I (165103) websocket: WEBSOCKET_EVENT_CONNECTED
I (165539) websocket: Sending hello 0000
I (165627) websocket: WEBSOCKET_EVENT_DATA
I (165627) websocket: Received opcode=1
W (165627) websocket: Received=hello 0000
W (165627) websocket: Total payload length=10, data_len=10, current payload offset=0
I (166539) websocket: Sending fragmented message
```

## Coverage Reporting
For generating a coverage report, it's necessary to enable `CONFIG_GCOV_ENABLED=y` option. Set the following configuration in your project's SDK configuration file (`sdkconfig.ci.coverage`, `sdkconfig.ci.linux` or via `menuconfig`):
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dependencies:
idf: ">5.2"
protocol_examples_common:
path: ${IDF_PATH}/examples/common_components/protocol_examples_common
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
CONFIG_IDF_TARGET="linux"
CONFIG_IDF_TARGET_LINUX=y
CONFIG_ESP_EVENT_POST_FROM_ISR=n
CONFIG_ESP_EVENT_POST_FROM_IRAM_ISR=n
CONFIG_WEBSOCKET_URI="ws://echo.websocket.events"
CONFIG_WEBSOCKET_URI_FROM_STRING=y
CONFIG_WEBSOCKET_URI_FROM_STDIN=n
CONFIG_EXAMPLE_CONNECT_WIFI=n

0 comments on commit 11e21ae

Please sign in to comment.