Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch rpc console to use CancellableReader instead of a pure read callback #31267

Merged
merged 7 commits into from
Jan 8, 2024
Merged

Switch rpc console to use CancellableReader instead of a pure read callback #31267

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
12f6dfb
Use a cancellable reader for socket communication
andreilitvin Jan 5, 2024
a2b0cea
Remove the auto-reconnect, simpler code
andreilitvin Jan 5, 2024
0f64f2c
Restyle
andreilitvin Jan 5, 2024
a56b583
Ensure we can close the reader
andreilitvin Jan 5, 2024
6820aed
Restyle
andreilitvin Jan 5, 2024
fede628
Merge branch 'master' into use_cancellable_reader
andy31415 Jan 8, 2024
1d889c6
Remove unused import
andy31415 Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 9 additions & 30 deletions examples/common/pigweed/rpc_console/py/chip_rpc/console.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@
import argparse
import logging
import re
import socket
import sys
import threading
from collections import namedtuple
Expand All @@ -50,10 +49,10 @@
import pw_cli.log
from chip_rpc.plugins.device_toolbar import DeviceToolbar
from chip_rpc.plugins.helper_scripts import HelperScripts
from pw_console import PwConsoleEmbed
from pw_console import PwConsoleEmbed, socket_client
from pw_console.__main__ import create_temp_log_file
from pw_console.pyserial_wrapper import SerialWithLogging
from pw_hdlc.rpc import HdlcRpcClient, default_channels
from pw_hdlc.rpc import HdlcRpcClient, SelectableReader, SerialReader, default_channels
from pw_rpc import callback_client
from pw_rpc.console_tools.console import ClientInfo, flattened_rpc_completions
from pw_tokenizer import tokens
Expand Down Expand Up @@ -219,28 +218,8 @@ def _start_ipython_hdlc_terminal(client: HdlcRpcClient) -> None:
interactive_console.setup_python_logging()
# Don't send device logs to the root logger.
_DEVICE_LOG.propagate = False
interactive_console.embed()


class SocketClientImpl:
def __init__(self, config: str):
self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
socket_server = ''
socket_port = 0

if config == 'default':
socket_server = SOCKET_SERVER
socket_port = SOCKET_PORT
else:
socket_server, socket_port_str = config.split(':')
socket_port = int(socket_port_str)
self.socket.connect((socket_server, socket_port))

def write(self, data: bytes):
self.socket.sendall(data)

def read(self, num_bytes: int = PW_RPC_MAX_PACKET_SIZE):
return self.socket.recv(num_bytes)
with client:
interactive_console.embed()


def write_to_output(data: bytes,
Expand Down Expand Up @@ -329,12 +308,12 @@ def console(device: str, baudrate: int,

if socket_addr is None:
serial_device = serial_impl(device, baudrate, timeout=0.1)
def read(): return serial_device.read(8192)
reader = SerialReader(serial_device, 8192)
write = serial_device.write
else:
try:
socket_device = SocketClientImpl(socket_addr)
read = socket_device.read
socket_device = socket_client.SocketClient(socket_addr)
reader = SelectableReader(socket_device)
write = socket_device.write
except ValueError:
_LOG.exception('Failed to initialize socket at %s', socket_addr)
Expand All @@ -351,14 +330,14 @@ def read(): return serial_device.read(8192)
if raw_serial:
threading.Thread(target=_read_raw_serial,
daemon=True,
args=(read,
args=(reader,
lambda data: write_to_output(
data, output, detokenizer),
)).start()
_start_ipython_raw_terminal()
else:
_start_ipython_hdlc_terminal(
HdlcRpcClient(read, PROTOS, default_channels(write),
HdlcRpcClient(reader, PROTOS, default_channels(write),
lambda data: write_to_output(
data, output, detokenizer),
client_impl=callback_client_impl)
Expand Down
Loading