remotivelabs-cli 0.0.1a26__tar.gz → 0.0.13__tar.gz

remotivelabs_cli-0.0.13/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: remotivelabs-cli
+Version: 0.0.13
+Summary: CLI for operating RemotiveCloud and RemotiveBroker
+Author: Johan Rask
+Author-email: johan.rask@remotivelabs.com
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: plotext (>=5.2,<6.0)
+Requires-Dist: pyjwt (>=2.6,<3.0)
+Requires-Dist: python-can (>=4.3.1)
+Requires-Dist: python-socketio (>=4.6.1)
+Requires-Dist: remotivelabs-broker (>=0.1.17)
+Requires-Dist: rich (>=13.7.0,<13.8.0)
+Requires-Dist: trogon (>=0.5.0)
+Requires-Dist: typer (>=0.9.0,<0.10.0)
+Requires-Dist: websocket-client (>=1.6,<2.0)
+Requires-Dist: zeroconf (>=0.127.0,<0.128.0)
+Description-Content-Type: text/markdown
+
+# RemotiveLabs - CLI
+[![PyPI - Version](https://img.shields.io/pypi/v/remotivelabs-cli.svg)](https://pypi.org/project/remotivelabs-cli)
+
+Use this CLI with our cloud and broker as a compliment to code and web tools.
+
+Read more at https://docs.remotivelabs.com/docs/remotive-cli
+
+

remotivelabs_cli-0.0.13/README.md

@@ -0,0 +1,7 @@
+# RemotiveLabs - CLI
+[![PyPI - Version](https://img.shields.io/pypi/v/remotivelabs-cli.svg)](https://pypi.org/project/remotivelabs-cli)
+
+Use this CLI with our cloud and broker as a compliment to code and web tools.
+
+Read more at https://docs.remotivelabs.com/docs/remotive-cli
+

{remotivelabs_cli-0.0.1a26 → remotivelabs_cli-0.0.13}/cli/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2022-present U.N. Owen <void@some.where>
 #
 # SPDX-License-Identifier: MIT
-__version__ = '0.0.1'
+__version__ = "0.0.1"

remotivelabs_cli-0.0.13/cli/broker/brokers.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+import os
+from time import sleep
+
+import typer
+from zeroconf import (
+    IPVersion,
+    ServiceBrowser,
+    ServiceStateChange,
+    Zeroconf,
+)
+
+from . import export, files, playback, record, scripting, signals
+
+app = typer.Typer(rich_markup_mode="rich")
+
+
+@app.callback()
+def main(
+    url: str = typer.Option(None, is_eager=False, help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
+):
+    # This can be used to override the --url per command, lets see if this is a better approach
+    if url is not None:
+        os.environ["REMOTIVE_BROKER_URL"] = url
+    # Do other global stuff, handle other global options here
+    return
+
+
+@app.command(help="Discover brokers on this network")
+def discover():
+    # print("Not implemented")
+
+    zeroconf = Zeroconf(ip_version=IPVersion.V4Only)
+
+    services = ["_remotivebroker._tcp.local."]
+    # services = list(ZeroconfServiceTypes.find(zc=zeroconf))
+
+    print("\nLooking for RemotiveBrokers on your network, press Ctrl-C to exit...\n")
+    ServiceBrowser(zeroconf, services, handlers=[on_service_state_change])
+
+    try:
+        while True:
+            sleep(0.1)
+    except KeyboardInterrupt:
+        pass
+    finally:
+        zeroconf.close()
+
+
+def on_service_state_change(zeroconf: Zeroconf, service_type: str, name: str, state_change: ServiceStateChange) -> None:
+    # print(f"Service {name} state changed: {state_change}")
+
+    if state_change is ServiceStateChange.Removed:
+        print(f"Service {name} was removed")
+
+    if state_change is ServiceStateChange.Updated:
+        print(f"Service {name} was updated")
+
+    if state_change is ServiceStateChange.Added:
+        print(f"[ {name} ]")
+        info = zeroconf.get_service_info(service_type, name)
+        # print("Info from zeroconf.get_service_info: %r" % (info))
+
+        if info:
+            # addresses = ["%s:%d" % (addr, cast(int, info.port)) for addr in info.parsed_scoped_addresses()]
+            for addr in info.parsed_scoped_addresses():
+                print(f"RemotiveBrokerApp: http://{addr}:8080")
+                print(f"RemotiveBroker http://{addr}:50051")
+            # print("  Weight: %d, priority: %d" % (info.weight, info.priority))
+            # print(f"  Server: {info.server}")
+            # if info.properties:
+            #    print("  Properties are:")
+            #    for key, value in info.properties.items():
+            #        print(f"    {key}: {value}")
+            # else:
+            #    print("  No properties")
+        else:
+            print("  No info")
+        print("\n")
+
+
+app.add_typer(playback.app, name="playback", help="Manage playing recordings")
+app.add_typer(record.app, name="record", help="Record data on buses")
+app.add_typer(files.app, name="files", help="Upload/Download configurations and recordings")
+app.add_typer(signals.app, name="signals", help="Find and subscribe to signals")
+app.add_typer(export.app, name="export", help="Export to external formats")
+app.add_typer(scripting.app, name="scripting")
+
+if __name__ == "__main__":
+    app()

remotivelabs_cli-0.0.13/cli/broker/export.py

@@ -0,0 +1,110 @@
+from __future__ import annotations
+
+import os
+import signal as os_signal
+from typing import List
+
+import grpc
+import typer
+
+from cli.errors import ErrorPrinter
+
+from .lib.broker import Broker
+
+app = typer.Typer(
+    rich_markup_mode="rich",
+    help="""
+Export subscribed signals to different formats, currently only InfluxDB line protocol
+but more formats will come soon
+""",
+)
+
+
+@app.command()
+def influxdb(
+    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"),
+    signal: List[str] = typer.Option(..., help="List of signal names to subscribe to"),
+    namespace: str = typer.Option(..., help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
+    on_change_only: bool = typer.Option(default=False, help="Only get signal if value is changed"),
+    output: str = typer.Option(None, help="Write results to file, defaults to stdout"),
+):
+    """
+    Exports subscribed signals to InfluxDB line-protocol, really useful to dump some signals into
+    influxdb for offline analysis and insights.
+
+    This is a sample for exporting and importing to InfluxDB using remotive-cli and influx-cli
+
+    Export:
+    remotive broker export influxdb --url [URL] --output signals.influx --namespace VehicleBus  \\
+        --signal Control.SteeringWheel_Position --signal Control.Accelerator_PedalPosition \\
+        --signal GpsPosition.GPS_Longitude --signal GpsPosition.GPS_Latitude
+
+    Output:
+    Control, SteeringWheel_Position=1.0,Accelerator_PedalPosition=0,Speed=0 1664787032944374000
+    GpsPosition, GPS_Longitude=12.982076,GPS_Latitude=55.618748 1664787032948256000
+
+    Import:
+    influx write --org myorg -b my-bucket -p ns --format=lp  -f signals.influx
+
+
+    """
+
+    if output is not None:
+        f = open(output, "w")
+
+    def exit_on_ctrlc(sig, frame):
+        if output is not None:
+            f.close()
+        os._exit(0)
+
+    def per_frame_influx_line_protocol(x):
+        signals = list(x)
+        if len(signals) == 0:
+            return
+
+        frame_name = signals[0]["name"].split(".")[0]
+        signals_str = ",".join(list(map(lambda s: f'{s["name"].split(".")[1]}={s["value"]}', signals)))
+        influx_lp = f"{frame_name},namespace={namespace} {signals_str} {round(signals[0]['timestamp_us'] * 1000)}"
+        if output is not None:
+            f.write(f"{influx_lp}\n")
+        else:
+            print(f"{influx_lp}")
+
+    # TODO - support for csv
+    # def csv(x):
+    # list = list(x)
+    # print(x)
+    # l = list(x)
+    # print(l)
+    # ll=list(map(lambda s : s, l))
+    # for s in l:
+    # dt = datetime.fromtimestamp(s["timestamp_nanos"] / 1000000)
+    # t=datetime.isoformat(dt)
+    # t=rfc3339.format_millisecond(dt)
+    # rich_rprint(len(l))
+    # lat = (l[0])
+    # lon = l[1]
+    # dt = datetime.fromtimestamp(lat["timestamp_nanos"] / 1000000)
+    # t=datetime.isoformat(dt)
+    # t = rfc3339.format_millisecond(dt)
+    # name = s["name"]
+    # value = s["value"]
+    # if output is not None:
+    #    f.write(f'coord,{lat["value"]},{lon["value"]},{t}\n')
+    # else:
+    #    print(f'coord,{lat["value"]},{lon["value"]},{t}')
+    # if output is not None:
+    #    f.flush()
+    # print(x["timestamp_nanos"])
+    # rich_rprint(json.dumps(list(x)))
+
+    os_signal.signal(os_signal.SIGINT, exit_on_ctrlc)
+
+    # print(namespace)
+    # signals2 = list(map( lambda s: s['signal'], broker.list_signal_names2(namespace)))
+    try:
+        broker = Broker(url, api_key)
+        broker.subscribe(signal, namespace, per_frame_influx_line_protocol, on_change_only)
+    except grpc.RpcError as rpc_error:
+        ErrorPrinter.print_grpc_error(rpc_error)

remotivelabs_cli-0.0.13/cli/broker/files.py

@@ -0,0 +1,119 @@
+from __future__ import annotations
+
+import os
+from typing import List
+
+import grpc
+import typer
+from rich.progress import Progress, SpinnerColumn, TextColumn
+
+from cli.errors import ErrorPrinter
+
+from .lib.broker import Broker
+
+app = typer.Typer(help=help)
+
+
+@app.command()
+def reload_configuration(
+    url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
+    api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
+):
+    try:
+        broker = Broker(url, api_key)
+        broker.reload_config()
+        print("Configuration successfully reloaded")
+    except grpc.RpcError as err:
+        ErrorPrinter.print_grpc_error(err)
+
+
+@app.command()
+def delete(
+    path: List[str] = typer.Argument(..., help="Paths to files on broker to delete"),
+    exit_on_failure: bool = typer.Option(False, help="Exits if there was a problem deleting a file"),
+    url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
+    api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
+):
+    """
+    Deletes the specified files from the broker
+    """
+    try:
+        broker = Broker(url, api_key)
+
+        if len(path) == 0:
+            print("At least one path must be suppled")
+            raise typer.Exit(1)
+
+        broker.delete_files(path, exit_on_failure)
+    except grpc.RpcError as err:
+        ErrorPrinter.print_grpc_error(err)
+
+
+@app.command()
+def download(
+    path: str = typer.Argument(..., help="Path to file on broker to download"),
+    output: str = typer.Option("", help="Optional output file name"),
+    url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
+    api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
+):
+    """
+    Downloads a file from a broker
+    """
+    try:
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(description=f"Downloading {path}...", total=None)
+            broker = Broker(url, api_key)
+            output_file = os.path.basename(path)
+            if output != "":
+                output_file = output
+            if os.path.exists(output_file):
+                print(f"File already exist {output_file}, please use another output file name")
+            else:
+                broker.download(path, output_file)
+                print(f"Successfully saved {output_file}")
+    except grpc.RpcError as err:
+        ErrorPrinter.print_grpc_error(err)
+
+
+@app.command()
+def upload(
+    path: str = typer.Argument(..., help="Path to local file to upload"),
+    output: str = typer.Option("", help="Optional output path on broker"),
+    url: str = typer.Option(..., help="Broker URL", envvar="REMOTIVE_BROKER_URL"),
+    api_key: str = typer.Option("offline", help="Cloud Broker API-KEY or access token", envvar="REMOTIVE_BROKER_API_KEY"),
+):
+    """
+    Uploads a file to a broker - physical or in cloud.
+    """
+    try:
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(description=f"Uploading {path}...", total=None)
+
+            if path == ".":
+                path = "./"  ## Does not work otherwise
+
+            if not os.path.exists(path):
+                print(f"File {path} does not exist")
+                raise typer.Exit(1)
+
+            broker = Broker(url, api_key)
+
+            if os.path.isdir(path):
+                broker.upload_folder(path)
+                print(f"Successfully uploaded {path}")
+            else:
+                output_file = os.path.basename(path)
+                if output != "":
+                    output_file = output
+                broker.upload(path, output_file)
+                print(f"Successfully uploaded {path}")
+    except grpc.RpcError as err:
+        ErrorPrinter.print_grpc_error(err)

{remotivelabs_cli-0.0.1a26 → remotivelabs_cli-0.0.13}/cli/broker/lib/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2022-present remotiveLabs <support@remotivelabs.com>
 #
 # SPDX-License-Identifier: Apache-2.0
-__version__ = '0.0.1'
+__version__ = "0.0.1"