Added "--shutdown-timeout" option to PIO Home Server

HISTORY.rst

@@ -29,6 +29,7 @@ PlatformIO Core 4.0
 * Extend project environment configuration in "platformio.ini" with other sections using a new `extends <http://docs.platformio.org/page/projectconf/section_env_advanced.html#extends>`__ option (`issue #2953 <https://github.com/platformio/platformio-core/issues/2953>`_)
 * Generate ``.ccls`` LSP file for `Emacs <https://docs.platformio.org/page/ide/emacs.html>`__ cross references, hierarchies, completion and semantic highlighting
 * Added ``--no-ansi`` flag for `PIO Core <http://docs.platformio.org/page/userguide/index.html>`__ to disable ANSI control characters
+* Added ``--shutdown-timeout`` option to `PIO Home Server <http://docs.platformio.org/page/userguide/cmd_home.html>`__
 * Fixed an issue with project generator for `CLion IDE <http://docs.platformio.org/page/ide/clion.html>`__ when 2 environments were used (`issue #2824 <https://github.com/platformio/platformio-core/issues/2824>`_)
 * Fixed default PIO Unified Debugger configuration for `J-Link probe <http://docs.platformio.org/page/plus/debug-tools/jlink.html>`__
 * Fixed an issue when configuration file options partly ignored when using custom ``--project-conf`` (`issue #3034 <https://github.com/platformio/platformio-core/issues/3034>`_)

platformio/commands/home/command.py

@@ -35,7 +35,16 @@ from platformio.managers.core import get_core_package_dir, inject_contrib_pysite
     ),
 )
 @click.option("--no-open", is_flag=True)
-def cli(port, host, no_open):
+@click.option(
+    "--shutdown-timeout",
+    default=0,
+    type=int,
+    help=(
+        "Automatically shutdown server on timeout (in seconds) when no clients "
+        "are connected. Default is 0 which means never auto shutdown"
+    ),
+)
+def cli(port, host, no_open, shutdown_timeout):
     # pylint: disable=import-error, import-outside-toplevel
 
     # import contrib modules
@@ -53,7 +62,7 @@ def cli(port, host, no_open):
     from platformio.commands.home.rpc.server import JSONRPCServerFactory
     from platformio.commands.home.web import WebRoot
 
-    factory = JSONRPCServerFactory()
+    factory = JSONRPCServerFactory(shutdown_timeout)
     factory.addHandler(AppRPC(), namespace="app")
     factory.addHandler(IDERPC(), namespace="ide")
     factory.addHandler(MiscRPC(), namespace="misc")

platformio/commands/home/rpc/server.py

@@ -76,23 +76,25 @@ class JSONRPCServerProtocol(WebSocketServerProtocol):
 
 class JSONRPCServerFactory(WebSocketServerFactory):
 
-    SHUTDOWN_TIMEOUT = 3600  # in seconds
-
     protocol = JSONRPCServerProtocol
     connection_nums = 0
     shutdown_timer = 0
 
-    def __init__(self):
+    def __init__(self, shutdown_timeout=0):
         super(JSONRPCServerFactory, self).__init__()
+        self.shutdown_timeout = shutdown_timeout
         self.dispatcher = jsonrpc.Dispatcher()
 
     def shutdownByTimeout(self):
+        if self.shutdown_timeout < 1:
+            return
+
         def _auto_shutdown_server():
             click.echo("Automatically shutdown server on timeout")
             reactor.stop()
 
         self.shutdown_timer = reactor.callLater(
-            self.SHUTDOWN_TIMEOUT, _auto_shutdown_server
+            self.shutdown_timeout, _auto_shutdown_server
         )
 
     def addHandler(self, handler, namespace):