remotivelabs-cli 0.0.36__tar.gz → 0.0.38__tar.gz

{remotivelabs_cli-0.0.36 → remotivelabs_cli-0.0.38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: remotivelabs-cli
-Version: 0.0.36
+Version: 0.0.38
 Summary: CLI for operating RemotiveCloud and RemotiveBroker
 Author: Johan Rask
 Author-email: johan.rask@remotivelabs.com

{remotivelabs_cli-0.0.36 → remotivelabs_cli-0.0.38}/cli/broker/lib/broker.py

@@ -14,6 +14,7 @@ from threading import Thread
 from typing import Any, Callable, Dict, Iterable, List, Sequence, Union
 
 import grpc
+import remotivelabs.broker.generated.sync.network_api_pb2 as network_api
 import remotivelabs.broker.generated.sync.traffic_api_pb2 as traffic_api
 import remotivelabs.broker.sync as br
 import remotivelabs.broker.sync.helper as br_helper
@@ -220,6 +221,13 @@ class Broker:
                     self.play(recording_and_namespace)
             callback(offset_length, total_length, get_mode(mode))
 
+    def listen_on_frame_distribution(self, namespace: str, callback: Callable[[Dict[str, Any]], None]) -> None:
+        config = network_api.FramesDistributionConfig(namespace=br.common_pb2.NameSpace(name=namespace))
+        frame_distribution_stream = self.network_stub.SubscribeToFramesDistribution(config)
+        for frame in frame_distribution_stream:
+            f = MessageToDict(frame, including_default_value_fields=True, preserving_proto_field_name=True)
+            callback(f)
+
     def pause(self, namespace: str, path: str, silent: bool = False) -> br.traffic_api_pb2.PlaybackInfos:
         playback_list = [
             {

{remotivelabs_cli-0.0.36 → remotivelabs_cli-0.0.38}/cli/broker/signals.py

@@ -4,6 +4,7 @@ import json
 import numbers
 import os
 import signal as os_signal
+from datetime import datetime
 from pathlib import Path
 from typing import Any, Dict, Iterable, List, TypedDict, Union
 
@@ -64,7 +65,7 @@ def read_scripted_code_file(file_path: Path) -> bytes:
 def subscribe(  # noqa: C901
     url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option(None, help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
-    signal: List[str] = typer.Option(None, help="Signal names to subscribe to, mandatory when not using script"),
+    signal: List[str] = typer.Option([], help="Signal names to subscribe to, mandatory when not using script"),
     script: Path = typer.Option(
         None,
         exists=True,
@@ -96,7 +97,7 @@ def subscribe(  # noqa: C901
 
     if script is None:
         if len(signal) == 0:
-            ErrorPrinter.print_generic_error("You must use include at least one signal and one namespace or use script when subscribing")
+            ErrorPrinter.print_generic_error("You must use --signal or use --script when subscribing")
             exit(1)
 
     if script is not None:
@@ -194,3 +195,29 @@ def namespaces(
         print(json.dumps(namespaces_json))
     except grpc.RpcError as rpc_error:
         ErrorPrinter.print_grpc_error(rpc_error)
+
+
+@app.command()
+def frame_distribution(
+    url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
+    api_key: str = typer.Option(None, help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
+    namespace: str = typer.Option(..., help="Namespace"),
+) -> None:
+    """
+    Use this command to get frames currently available on the specified namespace.
+    """
+    try:
+        broker = Broker(url, api_key)
+
+        def on_data(data: Dict[str, Any]) -> None:
+            timestamp: str = datetime.now().strftime("%H:%M:%S")
+            distribution = data["countsByFrameId"]
+            if len(distribution) == 0:
+                ErrorPrinter.print_hint(f"{timestamp} - No frames available")
+            else:
+                for d in distribution:
+                    ErrorPrinter.print_generic_message(f"{timestamp}: {d}")
+
+        broker.listen_on_frame_distribution(namespace, on_data)
+    except grpc.RpcError as rpc_error:
+        ErrorPrinter.print_grpc_error(rpc_error)

{remotivelabs_cli-0.0.36 → remotivelabs_cli-0.0.38}/cli/connect/connect.py

@@ -27,10 +27,13 @@ def protopie(  # pylint: disable=R0913
         resolve_path=True,
         help="Configuration file with signal subscriptions and mapping if needed",
     ),
-    signal: List[str] = typer.Option(None, help="Signal names to subscribe to, mandatory when not using script"),
+    signal: List[str] = typer.Option([], help="Signal names to subscribe to, mandatory when not using script"),
     signal_name_expression: str = typer.Option(
         None, help='[Experimental] Python expression to rename signal names, i.e \'lower().replace(".","_")\''
     ),
+    changed_values_only: bool = typer.Option(
+        True, help="Only receive signal when its value is changed to minimize amount of data received"
+    ),
     broker_url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
     api_key: str = typer.Option(None, help="Cloud Broker API-KEY", envvar="REMOTIVE_BROKER_API_KEY"),
     pp_connect_host: str = typer.Option("http://localhost:9981", help="ProtoPie Connect URL"),
@@ -111,4 +114,5 @@ def protopie(  # pylint: disable=R0913
         expression=signal_name_expression,
         config=config,
         signals=signals_to_subscribe_to,
+        on_change_only=changed_values_only,
     )

{remotivelabs_cli-0.0.36 → remotivelabs_cli-0.0.38}/cli/connect/protopie/protopie.py

@@ -85,6 +85,7 @@ def _connect_to_broker(
     config: Union[Path, None] = None,
     signals_to_subscribe_to: Union[List[SubscribableSignal], None] = None,
     expression: str = "",
+    on_change_only: bool = False,
 ) -> None:  # noqa: C901
     signals, namespaces, sub = get_signals_and_namespaces(config, signals_to_subscribe_to)
 
@@ -107,10 +108,12 @@ def _connect_to_broker(
                 signal_name = get_signal_name(expression, s.name())
                 io.emit("ppMessage", {"messageId": signal_name, "value": str(s.value())})
 
-    grpc_connect(on_signals, signals_to_subscribe_to)
+    grpc_connect(on_signals, signals_to_subscribe_to, on_change_only)
 
 
-def grpc_connect(on_signals: Any, signals_to_subscribe_to: Union[List[SignalIdentifier], None] = None) -> None:
+def grpc_connect(
+    on_signals: Any, signals_to_subscribe_to: Union[List[SignalIdentifier], None] = None, on_change_only: bool = False
+) -> None:
     try:
         pretty_print("Connecting and subscribing to broker...")
         subscription = None
@@ -121,7 +124,7 @@ def grpc_connect(on_signals: Any, signals_to_subscribe_to: Union[List[SignalIden
         if signals_to_subscribe_to is None:
             print("No sigs")
             return
-        subscription = client.subscribe(signals_to_subscribe_to=signals_to_subscribe_to, changed_values_only=False)
+        subscription = client.subscribe(signals_to_subscribe_to=signals_to_subscribe_to, changed_values_only=on_change_only)
         pretty_print("Subscription to broker completed")
         pretty_print("Waiting for signals...")
 
@@ -158,6 +161,7 @@ def do_connect(
     config: Union[Path, None],
     signals: List[SubscribableSignal],
     expression: Union[str, None],
+    on_change_only: bool = False,
 ) -> None:
     global broker
     global x_api_key
@@ -180,7 +184,7 @@ def do_connect(
         while is_connected is None:
             time.sleep(1)
         # if expression is not None:
-        _connect_to_broker(signals_to_subscribe_to=signals, config=config, expression=expression)
+        _connect_to_broker(signals_to_subscribe_to=signals, config=config, expression=expression, on_change_only=on_change_only)
     except SocketIoConnectionError as e:
         err_console.print(":boom: [bold red]Failed to connect to ProtoPie Connect[/bold red]")
         err_console.print(e)

{remotivelabs_cli-0.0.36 → remotivelabs_cli-0.0.38}/cli/errors.py

@@ -7,6 +7,8 @@ from rich.console import Console
 err_console = Console(stderr=True)
 
 
+# This should be renamed to Printer since print_generic_message is not an error message.
+# Then we can also add more things here
 class ErrorPrinter:
     @staticmethod
     def print_grpc_error(error: grpc.RpcError) -> None:

{remotivelabs_cli-0.0.36 → remotivelabs_cli-0.0.38}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "remotivelabs-cli"
-version = "0.0.36"
+version = "0.0.38"
 description = "CLI for operating RemotiveCloud and RemotiveBroker"
 authors = ["Johan Rask <johan.rask@remotivelabs.com>"]
 readme = "README.md"