initial commit

Author: jozala

.gitignore

@@ -0,0 +1,7 @@
+.pio
+.pioenvs
+.piolibdeps
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

.travis.yml

@@ -0,0 +1,67 @@
+# Continuous Integration (CI) is the practice, in software
+# engineering, of merging all developer working copies with a shared mainline
+# several times a day < https://docs.platformio.org/page/ci/index.html >
+#
+# Documentation:
+#
+# * Travis CI Embedded Builds with PlatformIO
+#   < https://docs.travis-ci.com/user/integration/platformio/ >
+#
+# * PlatformIO integration with Travis CI
+#   < https://docs.platformio.org/page/ci/travis.html >
+#
+# * User Guide for `platformio ci` command
+#   < https://docs.platformio.org/page/userguide/cmd_ci.html >
+#
+#
+# Please choose one of the following templates (proposed below) and uncomment
+# it (remove "# " before each line) or use own configuration according to the
+# Travis CI documentation (see above).
+#
+
+
+#
+# Template #1: General project. Test it using existing `platformio.ini`.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio run
+
+
+#
+# Template #2: The project is intended to be used as a library with examples.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# env:
+#     - PLATFORMIO_CI_SRC=path/to/test/file.c
+#     - PLATFORMIO_CI_SRC=examples/file.ino
+#     - PLATFORMIO_CI_SRC=path/to/test/directory
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+	// See http://go.microsoft.com/fwlink/?LinkId=827846
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		"platformio.platformio-ide"
+	]
+}

README.md

@@ -0,0 +1,49 @@
+ESP32_W5500_MQTT
+================
+
+Simple example of using Arduino Ethernet library with ESP32 and W5500 to subscribe and publish to MQTT broker.
+
+IMPORTANT: 
+**It has been created to present intermittent connection problems which seems to occur on W5500, but not on WiFi connection.**
+
+## Physical connection between ESP32 and W5500
+
+* GPIO23 <--> MOSI
+* GPIO19 <--> MISO
+* GPIO18 <--> SCLK
+* GPIO5  <--> SCS
+* GPIO11 <--> RESET
+
+It is possible to change pins used for chip-select and reset in 
+`include/MasterConfig.h` file.
+
+
+## Configuration
+
+Fixed IP address of the device (`ETHERNET_IP`) and MQTT hostname (`MQTT_HOSTNAME`) should most probably be changed in `include/MasterConfig.h` to fit your setup.
+Changing other configurations in `MasterConfig.h` is optional.
+
+
+## Running the test
+
+It has been prepared as PlatformIO project. All dependencies will be automatically downloaded if run with PlatformIO.
+
+Script for publishing messages (so ESP32 has something to read) has been prepared with Bash and Docker. That means it Docker is required for it and it is simple to run on Linux. It may also work with Windows Subsystem for Linux but it has not been tested.
+
+1. Load and run project on ESP32
+2. Start script `scripts/mqtt_pub_test.sh [MQTT_HOST]`
+3. Observe serial output from ESP32
+
+### Expected results:
+- `Sending uptime message to MQTT: mydevice/uptime <- 15` is visible on serial output periodically,
+- `Message arrived [mydevice/listen] 2019-06-20T14:25:11` is visible on serial output periodically
+- above should happen indefinitely (until network is available).
+
+
+### Actual results:
+
+- ESP32 gets disconnected from network after some time (time periods differs significantly - from few minutes to couple of hours).
+
+- Log `ERROR: mqttClient has been disconnected. Reconnecting...` is visible on serial output.
+
+Log `Sending uptime message to MQTT` might still be visible on ESP32 serial output, but message with uptime is not send to MQTT broker at that time. This can be observed by subscribing to MQTT broker on `mydevice/uptime` topic. Subscribing to the topic can be easily achieved with `scripts/mosquitto_sub.sh -h [MQTT_HOST] -t "mydevice/uptime"` (requires Bash and Docker).

include/MasterConfig.h

@@ -0,0 +1,10 @@
+#define ETHERNET_MAC            "BA:E5:E3:B1:44:DD" // Ethernet MAC address (have to be unique between devices in the same network)
+#define ETHERNET_IP             "10.0.88.244"       // IP address of RoomHub when on Ethernet connection
+
+#define ETHERNET_RESET_PIN      11      // ESP32 pin where reset pin from W5500 is connected
+#define ETHERNET_CS_PIN         5       // ESP32 pin where CS pin from W5500 is connected
+
+#define MQTT_HOSTNAME           "10.0.88.100"
+#define MQTT_PORT               1883
+
+#define MQTT_PUBLISH_INTERVAL_MS   5000

include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

lib/README

@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html

platformio.ini

@@ -0,0 +1,20 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:esp32doit-devkit-v1]
+platform = espressif32
+board = esp32doit-devkit-v1
+framework = arduino
+lib_deps = 
+	Ethernet
+    PubSubClient
+upload_port = /dev/ttyUSB0
+
+monitor_speed = 115200

scripts/mosquitto_pub.sh

@@ -0,0 +1,3 @@
+#/bin/bash
+
+docker run --name mosquitto_pub -it --rm --net=host eclipse-mosquitto mosquitto_pub $@

scripts/mosquitto_sub.sh

@@ -0,0 +1,15 @@
+#/bin/bash
+
+trap_ctrlc ()
+{
+    # perform cleanup here
+    echo "\n\n"
+    echo "Removing docker container"
+    docker kill mosquitto_sub
+    echo "Cleanup done"
+}
+
+trap "trap_ctrlc" 2
+
+docker run -d --name mosquitto_sub --rm --net=host  eclipse-mosquitto mosquitto_sub $@
+docker logs -f mosquitto_sub

scripts/mqtt_pub_test.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+
+MQTT_HOST=$1
+
+while true; do 
+    currentDate=`date '+%Y-%m-%dT%H:%M:%S'`;
+    $SCRIPT_DIR/mosquitto_pub.sh -h $MQTT_HOST -t "mydevice/listen" -m "$currentDate" -r; 
+    echo "mydevice/listen <- $currentDate"; 
+    sleep 5;
+done