palm-client: USB link to the radio via the Visor's HsUd port and a Mac bridge
The Ports screen showed the Neo's Serial Manager drivers, including 'HsUd' (USB, the GENERIC port). The app gets a Serial/USB link switch (USB default); Query radio retries since the bridge needs a moment to attach, and SrmSendWait is gone (it can block over USB with no host). tools/visor_bridge.py (stdlib + libusb via ctypes) finds the GENERIC port from the Visor's connection info and forwards bytes to the radio's serial port, logging each companion frame. Ports shows one line per driver so all of them fit.
This commit is contained in:
1 parent
259c666ad8
commit
8a118e4cac
8 files changed
+276
-34
No files matched your search
@@ -11,6 +11,9 @@ BEGIN
|
||||
LABEL "MeshCore client for the Visor" AUTOID AT (5 20)
|
||||
LABEL "Radio:" AUTOID AT (5 45) FONT 1
|
||||
LABEL "Not connected " ID MainStatusLabel AT (40 45)
|
||||
LABEL "Link:" AUTOID AT (5 65) FONT 1
|
||||
PUSHBUTTON "Serial" ID MainSerialPush AT (40 64 40 12) GROUP MainLinkGroup
|
||||
PUSHBUTTON "USB" ID MainUsbPush AT (PREVRIGHT+1 PREVTOP 40 12) GROUP MainLinkGroup
|
||||
BUTTON "Query radio" ID MainQueryButton AT (20 140 AUTO AUTO)
|
||||
BUTTON "Ports" ID MainPortsButton AT (PREVRIGHT+10 PREVTOP AUTO AUTO)
|
||||
END
|
||||
|
||||
+38
-21
@@ -6,6 +6,7 @@
|
||||
|
||||
#define VM_MIN_ROM_VERSION sysMakeROMVersion(3, 5, 0, sysROMStageRelease, 0)
|
||||
#define VM_QUERY_TIMEOUT (2 * SysTicksPerSecond())
|
||||
#define VM_QUERY_ATTEMPTS 3 /* over USB the host bridge needs a moment to attach after SrmOpen */
|
||||
|
||||
static VmFrameDecoder gDecoder;
|
||||
|
||||
@@ -36,7 +37,7 @@ static void QueryRadio(void)
|
||||
{
|
||||
UInt8 frame[VM_HEADER_LEN + 2];
|
||||
UInt8 rx[32];
|
||||
UInt16 frameLen, n, i;
|
||||
UInt16 frameLen, n, i, attempt;
|
||||
UInt32 deadline;
|
||||
Char msg[32];
|
||||
Err err;
|
||||
@@ -52,25 +53,28 @@ static void QueryRadio(void)
|
||||
frameLen = VmBuildDeviceQuery(frame, sizeof(frame));
|
||||
VmDecoderReset(&gDecoder);
|
||||
|
||||
err = TransportSend(frame, frameLen);
|
||||
if (err != errNone) {
|
||||
StrPrintF(msg, "Send failed (0x%x)", err);
|
||||
SetStatus(msg);
|
||||
TransportClose();
|
||||
return;
|
||||
}
|
||||
for (attempt = 1; attempt <= VM_QUERY_ATTEMPTS; attempt++) {
|
||||
err = TransportSend(frame, frameLen);
|
||||
if (err != errNone) {
|
||||
StrPrintF(msg, "Send failed (0x%x)", err);
|
||||
SetStatus(msg);
|
||||
TransportClose();
|
||||
return;
|
||||
}
|
||||
|
||||
SetStatus("Waiting for reply...");
|
||||
deadline = TimGetTicks() + VM_QUERY_TIMEOUT;
|
||||
while (TimGetTicks() < deadline) {
|
||||
n = TransportRecv(rx, sizeof(rx), deadline - TimGetTicks(), &err);
|
||||
for (i = 0; i < n; i++) {
|
||||
if (VmDecoderFeed(&gDecoder, rx[i])) {
|
||||
StrPrintF(msg, "Reply 0x%x, %u bytes",
|
||||
gDecoder.len ? gDecoder.payload[0] : 0, gDecoder.len);
|
||||
SetStatus(msg);
|
||||
TransportClose();
|
||||
return;
|
||||
StrPrintF(msg, "Waiting for reply (%u)...", attempt);
|
||||
SetStatus(msg);
|
||||
deadline = TimGetTicks() + VM_QUERY_TIMEOUT;
|
||||
while (TimGetTicks() < deadline) {
|
||||
n = TransportRecv(rx, sizeof(rx), deadline - TimGetTicks(), &err);
|
||||
for (i = 0; i < n; i++) {
|
||||
if (VmDecoderFeed(&gDecoder, rx[i])) {
|
||||
StrPrintF(msg, "Reply 0x%x, %u bytes",
|
||||
gDecoder.len ? gDecoder.payload[0] : 0, gDecoder.len);
|
||||
SetStatus(msg);
|
||||
TransportClose();
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -81,10 +85,23 @@ static void QueryRadio(void)
|
||||
static Boolean MainFormHandleEvent(EventType *event)
|
||||
{
|
||||
switch (event->eType) {
|
||||
case frmOpenEvent:
|
||||
FrmDrawForm(FrmGetActiveForm());
|
||||
case frmOpenEvent: {
|
||||
FormType *form = FrmGetActiveForm();
|
||||
UInt16 link = (TransportGetPort() == VM_PORT_USB) ? MainUsbPush : MainSerialPush;
|
||||
|
||||
FrmSetControlGroupSelection(form, MainLinkGroup, link);
|
||||
FrmDrawForm(form);
|
||||
return true;
|
||||
}
|
||||
case ctlSelectEvent:
|
||||
if (event->data.ctlSelect.controlID == MainSerialPush) {
|
||||
TransportSetPort(VM_PORT_SERIAL);
|
||||
return true;
|
||||
}
|
||||
if (event->data.ctlSelect.controlID == MainUsbPush) {
|
||||
TransportSetPort(VM_PORT_USB);
|
||||
return true;
|
||||
}
|
||||
if (event->data.ctlSelect.controlID == MainQueryButton) {
|
||||
QueryRadio();
|
||||
return true;
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
|
||||
#define LINE_H 11
|
||||
#define FIRST_Y 18
|
||||
#define MAX_LINES 11
|
||||
#define MAX_LINES 11 /* header + 10 devices */
|
||||
|
||||
static void DrawLine(UInt16 line, const Char *text)
|
||||
{
|
||||
@@ -32,7 +32,7 @@ static void DrawPorts(void)
|
||||
StrPrintF(buf, "%u serial device(s):", count);
|
||||
DrawLine(line++, buf);
|
||||
|
||||
for (i = 0; i < count && line + 1 < MAX_LINES; i++) {
|
||||
for (i = 0; i < count && line < MAX_LINES; i++) {
|
||||
MemSet(&info, sizeof(info), 0);
|
||||
err = SrmGetDeviceInfo(i, &info);
|
||||
if (err != errNone) {
|
||||
@@ -42,13 +42,10 @@ static void DrawPorts(void)
|
||||
}
|
||||
MemMove(crid, &info.serDevCreator, 4);
|
||||
crid[4] = 0;
|
||||
StrPrintF(buf, "%u '%s' ftr %lx max %lu", i, crid, info.serDevFtrInfo, info.serDevMaxBaudRate);
|
||||
DrawLine(line++, buf);
|
||||
if (info.serDevPortInfoStr) {
|
||||
StrNCopy(buf, " ", sizeof(buf));
|
||||
StrPrintF(buf, "%u %s %lx ", i, crid, info.serDevFtrInfo);
|
||||
if (info.serDevPortInfoStr)
|
||||
StrNCat(buf, info.serDevPortInfoStr, sizeof(buf));
|
||||
DrawLine(line++, buf);
|
||||
}
|
||||
DrawLine(line++, buf);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -5,6 +5,9 @@
|
||||
#define MainStatusLabel 1001
|
||||
#define MainQueryButton 1002
|
||||
#define MainPortsButton 1003
|
||||
#define MainSerialPush 1004
|
||||
#define MainUsbPush 1005
|
||||
#define MainLinkGroup 1
|
||||
|
||||
#define PortsForm 1100
|
||||
#define PortsDoneButton 1101
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/*
|
||||
* Byte-stream link to the companion radio. One implementation per transport:
|
||||
* transport_srm.c Serial Manager (cradle serial port, or an emulator's
|
||||
* serial port bridged to a radio on the host)
|
||||
* transport_srm.c Serial Manager: the cradle serial port, or the Visor's
|
||||
* USB data port bridged to a radio by tools/visor_bridge.py
|
||||
* (later) SB-LoRa Springboard module via the SC16IS740
|
||||
*/
|
||||
#ifndef VM_TRANSPORT_H
|
||||
@@ -9,6 +9,13 @@
|
||||
|
||||
#include <PalmOS.h>
|
||||
|
||||
/* Serial Manager ports (see the Ports screen for what a device has). */
|
||||
#define VM_PORT_SERIAL serPortCradlePort
|
||||
#define VM_PORT_USB 'HsUd' /* Handspring "USB" driver: the Visor's GENERIC USB port */
|
||||
|
||||
void TransportSetPort(UInt32 port); /* takes effect on the next TransportOpen */
|
||||
UInt32 TransportGetPort(void);
|
||||
|
||||
Err TransportOpen(void);
|
||||
void TransportClose(void);
|
||||
Err TransportSend(const UInt8 *buf, UInt16 len);
|
||||
|
||||
@@ -5,6 +5,17 @@
|
||||
|
||||
static UInt16 gPortId;
|
||||
static Boolean gPortOpen = false;
|
||||
static UInt32 gPort = VM_PORT_USB;
|
||||
|
||||
void TransportSetPort(UInt32 port)
|
||||
{
|
||||
gPort = port;
|
||||
}
|
||||
|
||||
UInt32 TransportGetPort(void)
|
||||
{
|
||||
return gPort;
|
||||
}
|
||||
|
||||
Err TransportOpen(void)
|
||||
{
|
||||
@@ -12,7 +23,7 @@ Err TransportOpen(void)
|
||||
|
||||
if (gPortOpen)
|
||||
return errNone;
|
||||
err = SrmOpen(serPortCradlePort, VM_BAUD, &gPortId);
|
||||
err = SrmOpen(gPort, VM_BAUD, &gPortId);
|
||||
if (err == errNone)
|
||||
gPortOpen = true;
|
||||
return err;
|
||||
@@ -32,9 +43,8 @@ Err TransportSend(const UInt8 *buf, UInt16 len)
|
||||
|
||||
if (!gPortOpen)
|
||||
return serErrNotOpen;
|
||||
/* No SrmSendWait: over USB it can block indefinitely if no host is reading. */
|
||||
SrmSend(gPortId, (void *)buf, len, &err);
|
||||
if (err == errNone)
|
||||
err = SrmSendWait(gPortId);
|
||||
return err;
|
||||
}
|
||||
|
||||
|
||||
Binary file not shown.
Executable
+205
@@ -0,0 +1,205 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Bridge the Visor's USB data port to a MeshCore radio's serial port.
|
||||
|
||||
For testing the Palm client before the SB-LoRa boards exist: the app opens the
|
||||
Visor's 'HsUd' Serial Manager driver (the USB GENERIC port) and this forwards
|
||||
bytes between it and the radio, logging each companion frame.
|
||||
|
||||
visor_bridge.py /dev/cu.usbserial-XXXX # radio on a USB-TTL adapter (D6/D7)
|
||||
visor_bridge.py /dev/cu.usbmodemXXXX # radio's own USB companion link
|
||||
|
||||
Then put the Visor in its USB cradle and tap "Query radio" with Link = USB.
|
||||
Needs libusb-1.0 (brew install libusb); everything else is the standard library.
|
||||
"""
|
||||
import argparse
|
||||
import ctypes
|
||||
import ctypes.util
|
||||
import os
|
||||
import select
|
||||
import sys
|
||||
import termios
|
||||
import threading
|
||||
import time
|
||||
|
||||
VISOR_VID, VISOR_PID = 0x082D, 0x0100
|
||||
|
||||
# Visor vendor requests (as used by the Linux visor driver and pilot-link)
|
||||
VISOR_REQ_TYPE_IN = 0xC2 # device-to-host, vendor, endpoint
|
||||
VISOR_GET_CONNECTION_INFORMATION = 0x03
|
||||
VISOR_REQUEST_BYTES_AVAILABLE = 0x01
|
||||
FUNCTIONS = {0: 'GENERIC', 1: 'DEBUGGER', 2: 'HOTSYNC', 3: 'CONSOLE', 4: 'REMOTE_FILE_SYS'}
|
||||
|
||||
LIBUSB_ERROR_TIMEOUT = -7
|
||||
LIBUSB_ERROR_NO_DEVICE = -4
|
||||
|
||||
CODES_TO_RADIO = {1: 'APP_START', 2: 'SEND_TXT_MSG', 3: 'SEND_CHANNEL_TXT_MSG', 4: 'GET_CONTACTS',
|
||||
10: 'SYNC_NEXT_MESSAGE', 22: 'DEVICE_QUERY'}
|
||||
CODES_FROM_RADIO = {0: 'OK', 1: 'ERR', 2: 'CONTACTS_START', 3: 'CONTACT', 4: 'END_OF_CONTACTS',
|
||||
5: 'SELF_INFO', 6: 'SENT', 10: 'NO_MORE_MESSAGES', 13: 'DEVICE_INFO',
|
||||
16: 'CONTACT_MSG_V3', 17: 'CHANNEL_MSG_V3', 0x80: 'PUSH_ADVERT',
|
||||
0x82: 'PUSH_SEND_CONFIRMED', 0x83: 'PUSH_MSG_WAITING'}
|
||||
|
||||
|
||||
def load_libusb():
|
||||
path = ctypes.util.find_library('usb-1.0') or '/opt/homebrew/lib/libusb-1.0.dylib'
|
||||
lib = ctypes.CDLL(path)
|
||||
lib.libusb_init.argtypes = [ctypes.c_void_p]
|
||||
lib.libusb_open_device_with_vid_pid.restype = ctypes.c_void_p
|
||||
lib.libusb_open_device_with_vid_pid.argtypes = [ctypes.c_void_p, ctypes.c_uint16, ctypes.c_uint16]
|
||||
lib.libusb_close.argtypes = [ctypes.c_void_p]
|
||||
lib.libusb_claim_interface.argtypes = [ctypes.c_void_p, ctypes.c_int]
|
||||
lib.libusb_release_interface.argtypes = [ctypes.c_void_p, ctypes.c_int]
|
||||
lib.libusb_control_transfer.argtypes = [ctypes.c_void_p, ctypes.c_uint8, ctypes.c_uint8, ctypes.c_uint16,
|
||||
ctypes.c_uint16, ctypes.c_char_p, ctypes.c_uint16, ctypes.c_uint]
|
||||
lib.libusb_bulk_transfer.argtypes = [ctypes.c_void_p, ctypes.c_uint8, ctypes.c_char_p, ctypes.c_int,
|
||||
ctypes.POINTER(ctypes.c_int), ctypes.c_uint]
|
||||
lib.libusb_error_name.restype = ctypes.c_char_p
|
||||
lib.libusb_error_name.argtypes = [ctypes.c_int]
|
||||
if lib.libusb_init(None) != 0:
|
||||
sys.exit('libusb_init failed')
|
||||
return lib
|
||||
|
||||
|
||||
def open_serial(path):
|
||||
fd = os.open(path, os.O_RDWR | os.O_NOCTTY | os.O_NONBLOCK)
|
||||
attrs = termios.tcgetattr(fd)
|
||||
attrs[0] = attrs[1] = attrs[3] = 0
|
||||
attrs[2] = termios.CS8 | termios.CREAD | termios.CLOCAL
|
||||
attrs[4] = attrs[5] = termios.B115200
|
||||
termios.tcsetattr(fd, termios.TCSANOW, attrs)
|
||||
termios.tcflush(fd, termios.TCIOFLUSH)
|
||||
return fd
|
||||
|
||||
|
||||
class FrameLogger:
|
||||
"""Splits a byte stream into companion frames and prints one line per frame."""
|
||||
|
||||
def __init__(self, label, start, names, quiet):
|
||||
self.label, self.start, self.names, self.quiet = label, start, names, quiet
|
||||
self.buf = bytearray()
|
||||
|
||||
def feed(self, data):
|
||||
if self.quiet:
|
||||
return
|
||||
self.buf += data
|
||||
while True:
|
||||
i = self.buf.find(self.start)
|
||||
if i < 0:
|
||||
self.buf.clear()
|
||||
return
|
||||
del self.buf[:i]
|
||||
if len(self.buf) < 3:
|
||||
return
|
||||
n = self.buf[1] | (self.buf[2] << 8)
|
||||
if len(self.buf) < 3 + n:
|
||||
return
|
||||
body = bytes(self.buf[3:3 + n])
|
||||
del self.buf[:3 + n]
|
||||
code = body[0] if body else None
|
||||
name = self.names.get(code, f'0x{code:02x}' if code is not None else 'empty')
|
||||
shown = body[:24].hex(' ') + (' ...' if n > 24 else '')
|
||||
print(f'{time.strftime("%H:%M:%S")} {self.label} {name:<18} len={n:<3} {shown}', flush=True)
|
||||
|
||||
|
||||
def wait_for_visor(lib):
|
||||
print('Waiting for the Visor (open VisorMesh, Link = USB, tap Query radio)...', flush=True)
|
||||
while True:
|
||||
h = lib.libusb_open_device_with_vid_pid(None, VISOR_VID, VISOR_PID)
|
||||
if h:
|
||||
# macOS can hold a freshly enumerated device for a moment; retry the claim.
|
||||
for _ in range(20):
|
||||
rc = lib.libusb_claim_interface(h, 0)
|
||||
if rc == 0:
|
||||
return h
|
||||
time.sleep(0.1)
|
||||
print(f'claim_interface failed: {lib.libusb_error_name(rc).decode()}', flush=True)
|
||||
lib.libusb_close(h)
|
||||
time.sleep(0.1)
|
||||
|
||||
|
||||
def generic_port(lib, h):
|
||||
"""Asks the Visor which USB port number carries each function; returns the GENERIC one."""
|
||||
buf = ctypes.create_string_buffer(0x12)
|
||||
n = lib.libusb_control_transfer(h, VISOR_REQ_TYPE_IN, VISOR_GET_CONNECTION_INFORMATION, 0, 0, buf, 0x12, 2000)
|
||||
if n < 2:
|
||||
raise RuntimeError(f'GET_CONNECTION_INFORMATION failed: {n}')
|
||||
raw = buf.raw[:n]
|
||||
count = raw[0] | (raw[1] << 8)
|
||||
ports = {}
|
||||
for k in range(count):
|
||||
if 2 + 2 * k + 1 >= n:
|
||||
break
|
||||
func, port = raw[2 + 2 * k], raw[3 + 2 * k]
|
||||
ports[func] = port
|
||||
print(f' port {port}: {FUNCTIONS.get(func, hex(func))}', flush=True)
|
||||
avail = ctypes.create_string_buffer(2)
|
||||
lib.libusb_control_transfer(h, VISOR_REQ_TYPE_IN, VISOR_REQUEST_BYTES_AVAILABLE, 0, 0, avail, 2, 2000)
|
||||
if 0 not in ports:
|
||||
raise RuntimeError('Visor did not offer a GENERIC port (is the app using the HsUd driver?)')
|
||||
return ports[0]
|
||||
|
||||
|
||||
def bridge(lib, h, port, serial_fd, quiet):
|
||||
ep_in, ep_out = 0x80 | port, port
|
||||
to_radio = FrameLogger('visor->radio', b'<', CODES_TO_RADIO, quiet)
|
||||
to_visor = FrameLogger('radio->visor', b'>', CODES_FROM_RADIO, quiet)
|
||||
gone = threading.Event()
|
||||
|
||||
def usb_to_serial():
|
||||
buf = ctypes.create_string_buffer(512)
|
||||
got = ctypes.c_int(0)
|
||||
while not gone.is_set():
|
||||
rc = lib.libusb_bulk_transfer(h, ep_in, buf, len(buf), ctypes.byref(got), 200)
|
||||
if got.value:
|
||||
data = buf.raw[:got.value]
|
||||
os.write(serial_fd, data)
|
||||
to_radio.feed(data)
|
||||
if rc not in (0, LIBUSB_ERROR_TIMEOUT):
|
||||
gone.set()
|
||||
|
||||
t = threading.Thread(target=usb_to_serial, daemon=True)
|
||||
t.start()
|
||||
got = ctypes.c_int(0)
|
||||
while not gone.is_set():
|
||||
r, _, _ = select.select([serial_fd], [], [], 0.2)
|
||||
if not r:
|
||||
continue
|
||||
data = os.read(serial_fd, 512)
|
||||
to_visor.feed(data)
|
||||
rc = lib.libusb_bulk_transfer(h, ep_out, data, len(data), ctypes.byref(got), 2000)
|
||||
if rc != 0:
|
||||
gone.set()
|
||||
t.join(1)
|
||||
|
||||
|
||||
def main():
|
||||
ap = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
|
||||
ap.add_argument('radio', help='serial port of the MeshCore companion radio')
|
||||
ap.add_argument('--quiet', action='store_true', help="don't log frames")
|
||||
args = ap.parse_args()
|
||||
|
||||
lib = load_libusb()
|
||||
serial_fd = open_serial(args.radio)
|
||||
try:
|
||||
while True:
|
||||
h = wait_for_visor(lib)
|
||||
print('Visor connected', flush=True)
|
||||
try:
|
||||
port = generic_port(lib, h)
|
||||
print(f'Bridging Visor USB port {port} <-> {args.radio}', flush=True)
|
||||
bridge(lib, h, port, serial_fd, args.quiet)
|
||||
except RuntimeError as e:
|
||||
print(e, flush=True)
|
||||
finally:
|
||||
lib.libusb_release_interface(h, 0)
|
||||
lib.libusb_close(h)
|
||||
print('Visor disconnected', flush=True)
|
||||
time.sleep(0.5)
|
||||
except KeyboardInterrupt:
|
||||
pass
|
||||
finally:
|
||||
os.close(serial_fd)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Reference in new issue
Block a user