WLED/usermods/Fix_unreachable_netservices_v2/readme.md
srg74 8caeddde15
Spelling check by @wthomson (#2940)
A lot of spelling corrections. Now repo will sound like educated person :)

Co-authored-by: Bill Thomson <bt@kattt.org>
2022-12-10 16:12:55 +01:00

2.2 KiB

Fix unreachable net services V2

Attention: This usermod compiles only for ESP8266

This usermod-v2 modification performs a ping request to a local IP address every 60 seconds. This ensures WLED net services remain accessible in some problematic WLAN environments.

The modification works with static or DHCP IP address configuration.

Story:

Unfortunately, with many ESP projects where a web server or other network services are running, after some time, the connecton to the web server is lost. The connection can be reestablished with a ping request from the device.

With this modification, in the worst case, the network functions are not available until the next ping request. (60 seconds)

Webinterface

The number of pings and reconnects is displayed on the info page in the web interface. The ping delay can be changed. Changes persist after a reboot.

JSON API

The usermod supports the following state changes:

JSON key Value range Description
PingDelayMs 5000 to 18000000 Deactivdate/activate the sensor

Changes also persist after a reboot.

Installation

  1. Copy the file usermod_Fix_unreachable_netservices.h to the wled00 directory.
  2. Register the usermod by adding #include "usermod_Fix_unreachable_netservices.h" in the top and registerUsermod(new FixUnreachableNetServices()); in the bottom of usermods_list.cpp.

Example usermods_list.cpp:

#include "wled.h"
/*
 * Register your v2 usermods here!
 *   (for v1 usermods using just usermod.cpp, you can ignore this file)
 */

/*
 * Add/uncomment your usermod filename here (and once more below)
 * || || ||
 * \/ \/ \/
 */
//#include "usermod_v2_example.h"
//#include "usermod_temperature.h"
//#include "usermod_v2_empty.h"
#include  "usermod_Fix_unreachable_netservices.h"

void registerUsermods()
{
  /*
   * Add your usermod class name here
   * || || ||
   * \/ \/ \/
   */
  //usermods.add(new MyExampleUsermod());
  //usermods.add(new UsermodTemperature());
  //usermods.add(new UsermodRenameMe());
  usermods.add(new FixUnreachableNetServices());

}

Hopefully I can help someone with that - @gegu