From 1ac5f8c3baac9f8bdfb6bf2260fecd8a782a101b Mon Sep 17 00:00:00 2001 From: sh4un <97253929+sh4un-dot-com@users.noreply.github.com> Date: Wed, 4 Feb 2026 11:17:53 -0500 Subject: [PATCH] UPdate README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 354b9f8..abcfad0 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,13 @@ This bridge enables interoperability, allowing messages, sensor data (with appro ### Configure Copy `examples/config.ini.example` to `config.ini` and edit it. -- **For MeshCore (Binary):** - Set `EXTERNAL_TRANSPORT = serial` and `SERIAL_PROTOCOL = raw_serial`. +- **For MeshCore (Companion USB):** + Set `EXTERNAL_TRANSPORT = serial` and `SERIAL_PROTOCOL = companion_radio`. + + Optional companion settings in `config.ini`: + - `COMPANION_HANDSHAKE_ENABLED = True` (send initial device query/app start) + - `COMPANION_CONTACTS_POLL_S = 0` (poll contacts/adverts; 0 disables) + - `COMPANION_DEBUG = False` (enable raw byte logging) - **For MQTT:** Set `EXTERNAL_TRANSPORT = mqtt` and configure broker details. Optionally enable TLS/SSL for secure connections.