OVMS3-idf/examples/protocols/mqtt/ws/README.md

# ESP-MQTT MQTT over Websocket

(See the README.md file in the upper level 'examples' directory for more information about examples.)

This example connects to the broker iot.eclipse.org over web sockets as a demonstration subscribes/unsubscribes and send a message on certain topic.

It uses ESP-MQTT library which implements mqtt client to connect to mqtt broker.

## How to use example

### Hardware Required

This example can be executed on any ESP32 board, the only required interface is WiFi and connection to internet.

### Configure the project

* Run `make menuconfig` (or `idf.py menuconfig` if using CMake build system)
* Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../../README.md) for more details.
* When using Make build system, set `Default serial port` under `Serial flasher config`.

### Build and Flash

Build the project and flash it to the board, then run monitor tool to view serial output:

```
make -j4 flash monitor
```

(To exit the serial monitor, type ``Ctrl-]``.)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

## Example Output

```
I (3714) event: sta ip: 192.168.0.139, mask: 255.255.255.0, gw: 192.168.0.2
I (3714) system_api: Base MAC address is not set, read default base MAC address from BLK0 of EFUSE
I (3964) MQTT_CLIENT: Sending MQTT CONNECT message, type: 1, id: 0000
I (4164) MQTTWS_EXAMPLE: MQTT_EVENT_CONNECTED
I (4174) MQTTWS_EXAMPLE: sent publish successful, msg_id=41464
I (4174) MQTTWS_EXAMPLE: sent subscribe successful, msg_id=17886
I (4174) MQTTWS_EXAMPLE: sent subscribe successful, msg_id=42970
I (4184) MQTTWS_EXAMPLE: sent unsubscribe successful, msg_id=50241
I (4314) MQTTWS_EXAMPLE: MQTT_EVENT_PUBLISHED, msg_id=41464
I (4484) MQTTWS_EXAMPLE: MQTT_EVENT_SUBSCRIBED, msg_id=17886
I (4484) MQTTWS_EXAMPLE: sent publish successful, msg_id=0
I (4684) MQTTWS_EXAMPLE: MQTT_EVENT_SUBSCRIBED, msg_id=42970
I (4684) MQTTWS_EXAMPLE: sent publish successful, msg_id=0
I (4884) MQTT_CLIENT: deliver_publish, message_length_read=19, message_length=19
I (4884) MQTTWS_EXAMPLE: MQTT_EVENT_DATA
TOPIC=/topic/qos0
DATA=data
I (5194) MQTT_CLIENT: deliver_publish, message_length_read=19, message_length=19
I (5194) MQTTWS_EXAMPLE: MQTT_EVENT_DATA
TOPIC=/topic/qos0
DATA=data
```
MQTT: Integrate esp-mqtt library into idf added docs and tests for mqtt library, small fixes (removed warnings, option for custom outbox, websocket bug fixed for longer transports). refactored to use common tcp_transport component, support for CMake build system. Closes #2108 2018-07-24 14:59:03 +00:00			`# ESP-MQTT MQTT over Websocket`

			`(See the README.md file in the upper level 'examples' directory for more information about examples.)`

			`This example connects to the broker iot.eclipse.org over web sockets as a demonstration subscribes/unsubscribes and send a message on certain topic.`

			`It uses ESP-MQTT library which implements mqtt client to connect to mqtt broker.`

			`## How to use example`

			`### Hardware Required`

			`This example can be executed on any ESP32 board, the only required interface is WiFi and connection to internet.`

			`### Configure the project`

examples/protocols/mqtt: use common network component 2018-11-20 16:42:03 +00:00			* Run `make menuconfig` (or `idf.py menuconfig` if using CMake build system)
			`* Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../../README.md) for more details.`
			* When using Make build system, set `Default serial port` under `Serial flasher config`.
MQTT: Integrate esp-mqtt library into idf added docs and tests for mqtt library, small fixes (removed warnings, option for custom outbox, websocket bug fixed for longer transports). refactored to use common tcp_transport component, support for CMake build system. Closes #2108 2018-07-24 14:59:03 +00:00
			`### Build and Flash`

			`Build the project and flash it to the board, then run monitor tool to view serial output:`

			```
			`make -j4 flash monitor`
			```

			(To exit the serial monitor, type ``Ctrl-]``.)

			`See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.`

			`## Example Output`

			```
			`I (3714) event: sta ip: 192.168.0.139, mask: 255.255.255.0, gw: 192.168.0.2`
			`I (3714) system_api: Base MAC address is not set, read default base MAC address from BLK0 of EFUSE`
			`I (3964) MQTT_CLIENT: Sending MQTT CONNECT message, type: 1, id: 0000`
			`I (4164) MQTTWS_EXAMPLE: MQTT_EVENT_CONNECTED`
			`I (4174) MQTTWS_EXAMPLE: sent publish successful, msg_id=41464`
			`I (4174) MQTTWS_EXAMPLE: sent subscribe successful, msg_id=17886`
			`I (4174) MQTTWS_EXAMPLE: sent subscribe successful, msg_id=42970`
			`I (4184) MQTTWS_EXAMPLE: sent unsubscribe successful, msg_id=50241`
			`I (4314) MQTTWS_EXAMPLE: MQTT_EVENT_PUBLISHED, msg_id=41464`
			`I (4484) MQTTWS_EXAMPLE: MQTT_EVENT_SUBSCRIBED, msg_id=17886`
			`I (4484) MQTTWS_EXAMPLE: sent publish successful, msg_id=0`
			`I (4684) MQTTWS_EXAMPLE: MQTT_EVENT_SUBSCRIBED, msg_id=42970`
			`I (4684) MQTTWS_EXAMPLE: sent publish successful, msg_id=0`
			`I (4884) MQTT_CLIENT: deliver_publish, message_length_read=19, message_length=19`
			`I (4884) MQTTWS_EXAMPLE: MQTT_EVENT_DATA`
			`TOPIC=/topic/qos0`
			`DATA=data`
			`I (5194) MQTT_CLIENT: deliver_publish, message_length_read=19, message_length=19`
			`I (5194) MQTTWS_EXAMPLE: MQTT_EVENT_DATA`
			`TOPIC=/topic/qos0`
			`DATA=data`
			```