esp-rainmaker-cli 1.11.1__tar.gz → 1.12.0__tar.gz

{esp_rainmaker_cli-1.11.1 → esp_rainmaker_cli-1.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: esp-rainmaker-cli
-Version: 1.11.1
+Version: 1.12.0
 Summary: A python utility to perform host based claiming
 Home-page: https://github.com/espressif/esp-rainmaker-cli
 Author: Espressif Systems
@@ -115,6 +115,18 @@ Changelog
 
 All major changes to ESP RainMaker CLI will be documented in this file.
 
+## [1.12.0] - 19-Feb-2026
+### Added
+- Local node cache layer for faster `--local` control operations:
+  - Caches node details, config, POP, and local control capability per profile/user
+  - Disk-based session reuse to skip X25519 handshake on repeated commands
+  - Auto-POP resolution from cache, eliminating need for prior cloud `getparams` call
+  - Empirical capability discovery (probes sec0 first, then sec1, caches result)
+  - Cache disabled by default; enable via `cache enable` or `profile add --cache`
+- New `cache` CLI command group: `enable`, `disable`, `show`, `clear`
+- `--no-cache` flag on `getparams`, `setparams`, `getnodeconfig` for one-shot cache bypass
+- `RM_NODE_CACHE` and `RM_NODE_CACHE_DIR` environment variables for automation control
+
 ## [1.11.1] - 10-Feb-2026
 - Add support for ecdsa in claiming and make it as default, with an option to fall back to the earlier rsa scheme.
 

{esp_rainmaker_cli-1.11.1 → esp_rainmaker_cli-1.12.0}/esp_rainmaker_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: esp-rainmaker-cli
-Version: 1.11.1
+Version: 1.12.0
 Summary: A python utility to perform host based claiming
 Home-page: https://github.com/espressif/esp-rainmaker-cli
 Author: Espressif Systems
@@ -115,6 +115,18 @@ Changelog
 
 All major changes to ESP RainMaker CLI will be documented in this file.
 
+## [1.12.0] - 19-Feb-2026
+### Added
+- Local node cache layer for faster `--local` control operations:
+  - Caches node details, config, POP, and local control capability per profile/user
+  - Disk-based session reuse to skip X25519 handshake on repeated commands
+  - Auto-POP resolution from cache, eliminating need for prior cloud `getparams` call
+  - Empirical capability discovery (probes sec0 first, then sec1, caches result)
+  - Cache disabled by default; enable via `cache enable` or `profile add --cache`
+- New `cache` CLI command group: `enable`, `disable`, `show`, `clear`
+- `--no-cache` flag on `getparams`, `setparams`, `getnodeconfig` for one-shot cache bypass
+- `RM_NODE_CACHE` and `RM_NODE_CACHE_DIR` environment variables for automation control
+
 ## [1.11.1] - 10-Feb-2026
 - Add support for ecdsa in claiming and make it as default, with an option to fall back to the earlier rsa scheme.
 

{esp_rainmaker_cli-1.11.1 → esp_rainmaker_cli-1.12.0}/esp_rainmaker_cli.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ rainmaker/rainmaker.py
 rainmaker/version.py
 rmaker_cmd/__init__.py
 rmaker_cmd/browserlogin.py
+rmaker_cmd/cache.py
 rmaker_cmd/cmd_response.py
 rmaker_cmd/group.py
 rmaker_cmd/node.py
@@ -29,12 +30,14 @@ rmaker_lib/exceptions.py
 rmaker_lib/local_control.py
 rmaker_lib/logger.py
 rmaker_lib/node.py
+rmaker_lib/node_cache.py
 rmaker_lib/profile_manager.py
 rmaker_lib/profile_utils.py
 rmaker_lib/schedule_utils.py
 rmaker_lib/serverconfig.py
 rmaker_lib/service.py
 rmaker_lib/session.py
+rmaker_lib/session_store.py
 rmaker_lib/simple_local_control.py
 rmaker_lib/user.py
 rmaker_tools/__init__.py

{esp_rainmaker_cli-1.11.1 → esp_rainmaker_cli-1.12.0}/rainmaker/rainmaker.py

@@ -16,6 +16,7 @@ from rmaker_cmd.provision import provision
 from rmaker_cmd.test import test
 from rmaker_lib.logger import log
 from rmaker_cmd.group import group_add, group_remove, group_edit, group_list, group_show, group_add_nodes, group_remove_nodes, group_list_nodes
+from rmaker_cmd.cache import cache_manage
 
 # Import the version
 from rainmaker.version import VERSION
@@ -102,6 +103,9 @@ def main():
                                     type=str,
                                     metavar='<description>',
                                     help='Description for the custom profile (optional)')
+    profile_add_parser.add_argument('--cache',
+                                    action='store_true',
+                                    help='Enable node cache for this profile')
     profile_add_parser.set_defaults(func=profile_add)
 
     # profile remove
@@ -112,6 +116,33 @@ def main():
                                        help='Name of the profile to remove')
     profile_remove_parser.set_defaults(func=profile_remove)
 
+    # Cache management commands
+    cache_parser = subparsers.add_parser("cache",
+                                         help="Manage local node cache")
+    cache_subparsers = cache_parser.add_subparsers(dest='cache_command', help='Cache operations')
+
+    cache_enable_parser = cache_subparsers.add_parser('enable', help='Enable node cache for current profile')
+    cache_enable_parser.set_defaults(func=cache_manage)
+
+    cache_disable_parser = cache_subparsers.add_parser('disable', help='Disable node cache for current profile')
+    cache_disable_parser.set_defaults(func=cache_manage)
+
+    cache_show_parser = cache_subparsers.add_parser('show', help='Show cached data')
+    cache_show_parser.add_argument('--node',
+                                   type=str,
+                                   metavar='<nodeid>',
+                                   help='Node ID to show cache for (omit for all)')
+    add_profile_argument(cache_show_parser)
+    cache_show_parser.set_defaults(func=cache_manage)
+
+    cache_clear_parser = cache_subparsers.add_parser('clear', help='Clear cached data')
+    cache_clear_parser.add_argument('--node',
+                                    type=str,
+                                    metavar='<nodeid>',
+                                    help='Node ID to clear cache for (omit for all)')
+    add_profile_argument(cache_clear_parser)
+    cache_clear_parser.set_defaults(func=cache_manage)
+
     signup_parser = subparsers.add_parser("signup",
                                           help="Sign up for ESP RainMaker")
     signup_parser.add_argument('user_name',
@@ -245,8 +276,8 @@ def main():
     getnodeconfig_parser.add_argument('--sec_ver',
                                      type=int,
                                      choices=[0, 1, 2],
-                                     default=1,
-                                     help='Security version for local control')
+                                     default=None,
+                                     help='Security version for local control (default: 1)')
     getnodeconfig_parser.add_argument('--local-raw',
                                      action='store_true',
                                      help='Use local control via raw endpoints (get_config with fragmentation) instead of esp_local_ctrl')
@@ -259,6 +290,13 @@ def main():
     getnodeconfig_parser.add_argument('--proxy-report',
                                      action='store_true',
                                      help='Automatically use current timestamp and POST signed response to proxy API endpoint')
+    getnodeconfig_parser.add_argument('--auto',
+                                     action='store_true',
+                                     help='Try local control first, fall back to cloud if local fails')
+    getnodeconfig_parser.add_argument('--no-cache',
+                                     action='store_true',
+                                     dest='no_cache',
+                                     help='Skip local cache for this invocation')
     add_profile_argument(getnodeconfig_parser)
     getnodeconfig_parser.set_defaults(func=get_node_config)
 
@@ -308,8 +346,8 @@ def main():
     setparams_parser.add_argument('--sec_ver',
                                  type=int,
                                  choices=[0, 1, 2],
-                                 default=1,
-                                 help='Security version for local control')
+                                 default=None,
+                                 help='Security version for local control (default: 1)')
     setparams_parser.add_argument('--local-raw',
                                  action='store_true',
                                  help='Use local control via raw endpoints (get_params/set_params) instead of esp_local_ctrl')
@@ -317,7 +355,13 @@ def main():
                                  type=str,
                                  help='Device name for BLE transport (e.g., PROV_aaf824). Required when using --transport ble')
 
-    # Note: setparams_data_group is mutually exclusive group, so we add profile to the parent
+    setparams_parser.add_argument('--auto',
+                                 action='store_true',
+                                 help='Try local control first, fall back to cloud if local fails')
+    setparams_parser.add_argument('--no-cache',
+                                 action='store_true',
+                                 dest='no_cache',
+                                 help='Skip local cache for this invocation')
     add_profile_argument(setparams_parser)
     setparams_parser.set_defaults(func=set_params)
 
@@ -345,8 +389,8 @@ def main():
     getparams_parser.add_argument('--sec_ver',
                                  type=int,
                                  choices=[0, 1, 2],
-                                 default=1,
-                                 help='Security version for local control')
+                                 default=None,
+                                 help='Security version for local control (default: 1)')
     getparams_parser.add_argument('--local-raw',
                                  action='store_true',
                                  help='Use local control via raw endpoints (get_params/set_params) instead of esp_local_ctrl')
@@ -362,6 +406,13 @@ def main():
     getparams_parser.add_argument('--init',
                                  action='store_true',
                                  help='Use initparams API endpoint instead of params (only with --proxy-report)')
+    getparams_parser.add_argument('--auto',
+                                 action='store_true',
+                                 help='Try local control first, fall back to cloud if local fails')
+    getparams_parser.add_argument('--no-cache',
+                                 action='store_true',
+                                 dest='no_cache',
+                                 help='Skip local cache for this invocation')
     add_profile_argument(getparams_parser)
     getparams_parser.set_defaults(func=get_params)
 

{esp_rainmaker_cli-1.11.1 → esp_rainmaker_cli-1.12.0}/rainmaker/version.py

@@ -5,4 +5,4 @@
 # SPDX-License-Identifier: Apache-2.0
 
 # This file contains the version information for the ESP RainMaker CLI
-VERSION = "1.11.1"
+VERSION = "1.12.0"

esp_rainmaker_cli-1.12.0/rmaker_cmd/cache.py

@@ -0,0 +1,160 @@
+# SPDX-FileCopyrightText: 2020-2025 Espressif Systems (Shanghai) CO LTD
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import json
+import os
+import time
+import datetime
+from rmaker_lib.logger import log
+
+
+def cache_manage(vars=None):
+    """
+    Manage local node cache: enable, disable, show, clear.
+    """
+    if vars is None:
+        print("No cache command specified. Use: cache {enable|disable|show|clear}")
+        return
+
+    command = vars.get('cache_command')
+    if not command:
+        print("No cache command specified. Use: cache {enable|disable|show|clear}")
+        return
+
+    if command == 'enable':
+        _cache_enable_disable(True)
+    elif command == 'disable':
+        _cache_enable_disable(False)
+    elif command == 'show':
+        _cache_show(vars)
+    elif command == 'clear':
+        _cache_clear(vars)
+
+
+def _cache_enable_disable(enable):
+    """Enable or disable cache for the current profile."""
+    try:
+        from rmaker_lib.configmanager import Config
+        config = Config()
+        profile_name = config.get_current_profile_name()
+        config.profile_manager.set_cache_enabled(profile_name, enable)
+        state = 'enabled' if enable else 'disabled'
+        print(f"Node cache {state} for profile '{profile_name}'.")
+    except Exception as e:
+        print(f"Failed to update cache setting: {e}")
+
+
+def _cache_show(vars):
+    """Show cached data for current user/profile."""
+    try:
+        from rmaker_lib.configmanager import Config
+        from rmaker_lib.node_cache import NodeCache, is_cache_enabled, _get_cache_base_dir
+
+        config = Config(profile_override=vars.get('profile'))
+        profile_name = config.get_current_profile_name()
+        profile_config = config.get_profile_config_for_current()
+
+        if not is_cache_enabled(profile_config):
+            print(f"Node cache is disabled for profile '{profile_name}'.")
+            print("Use 'esp-rainmaker-cli cache enable' to enable it.")
+            return
+
+        try:
+            user_id = config.get_user_id()
+        except Exception:
+            user_id = 'unknown'
+
+        nc = NodeCache(profile_name, user_id, enabled=True)
+        node_filter = vars.get('node')
+
+        if node_filter:
+            nodes = [node_filter]
+        else:
+            nodes = nc.list_cached_nodes()
+
+        if not nodes:
+            print("No cached data found.")
+            return
+
+        print(f"Cache location: {nc.cache_dir}")
+        print(f"Profile: {profile_name}, User: {user_id}")
+        print()
+
+        for nodeid in nodes:
+            summary = nc.get_cache_summary(nodeid)
+            if summary is None:
+                print(f"  {nodeid}: No cached data")
+                continue
+
+            print(f"  Node: {nodeid}")
+            for filename, info in summary.get('files', {}).items():
+                ts = info.get('timestamp')
+                stale = info.get('stale', True)
+                ts_str = datetime.datetime.fromtimestamp(ts).strftime('%Y-%m-%d %H:%M:%S') if ts else 'unknown'
+                status = 'stale' if stale else 'fresh'
+                print(f"    {filename}: {ts_str} ({status})")
+
+            lc_info = nc.get_local_control_info(nodeid)
+            if lc_info:
+                print(f"    Local Control: POP={'yes' if lc_info.get('pop') else 'no'}, "
+                      f"sec_ver={lc_info.get('sec_ver', '?')}")
+
+            cap = nc.get_local_control_capability(nodeid)
+            if cap:
+                if cap.get('supported'):
+                    print(f"    Capability: supported, sec_ver={cap.get('sec_ver', '?')}, "
+                          f"pop_required={cap.get('pop_required', '?')}")
+                else:
+                    print(f"    Capability: not supported")
+
+            from rmaker_lib.session_store import SessionStore
+            ss = SessionStore(nc.cache_dir, enabled=True)
+            if ss.is_session_valid(nodeid):
+                sess = ss.load_session(nodeid)
+                if sess:
+                    last_used = sess.get('last_used_at', 0)
+                    age = time.time() - last_used
+                    print(f"    Session: active ({age:.0f}s ago)")
+            print()
+
+    except Exception as e:
+        print(f"Failed to show cache: {e}")
+        log.debug(f"Cache show error: {e}")
+
+
+def _cache_clear(vars):
+    """Clear cached data."""
+    try:
+        from rmaker_lib.configmanager import Config
+        from rmaker_lib.node_cache import NodeCache, is_cache_enabled
+        from rmaker_lib.session_store import SessionStore
+
+        config = Config(profile_override=vars.get('profile'))
+        profile_name = config.get_current_profile_name()
+        profile_config = config.get_profile_config_for_current()
+
+        if not is_cache_enabled(profile_config):
+            print(f"Node cache is disabled for profile '{profile_name}'.")
+            return
+
+        try:
+            user_id = config.get_user_id()
+        except Exception:
+            user_id = 'unknown'
+
+        nc = NodeCache(profile_name, user_id, enabled=True)
+        ss = SessionStore(nc.cache_dir, enabled=True)
+        node_filter = vars.get('node')
+
+        nc.invalidate(nodeid=node_filter)
+        ss.invalidate_session(nodeid=node_filter)
+
+        if node_filter:
+            print(f"Cleared cache for node '{node_filter}'.")
+        else:
+            print("Cleared all cached data.")
+
+    except Exception as e:
+        print(f"Failed to clear cache: {e}")
+        log.debug(f"Cache clear error: {e}")