Document running the Python listener on a second PC

Open
#264 0 comments 0 reactions 1 assignee View on GitHub

Maintainers usually reply within 3 days

@Omanhene20 is already working on this.

Since Nov 6, 2026.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
70/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Read the root README section “Sending to iMotions and Python at the same time” and the relevant guidance in inference/README.md. Then follow the proposed two-PC setup on the lab PCs, checking the listener bind address, Windows Firewall access, and the IPv4 address entered in the relay. Done means the root README has a “Two PCs” subsection, inference/README.md points to it, and the first test's findings are recorded.

Written by the indexing model from the issue text.

Description

area:docs area:ml area:relay documentation needs-triage

Problem

In the lab, X-Plane and the relay run on one PC and the ML pipeline runs on another. Every example in the READMEs uses 127.0.0.1:5001, and nobody has run the mirror between two PCs yet. Three things are needed that the docs do not mention:

  • live_groups and data_logger bind to 127.0.0.1 by default (--host), so a relay on another PC cannot reach them. Start them with --host 0.0.0.0, or with the ML PC's LAN address.
  • Windows Firewall on the ML PC blocks inbound TCP 5001 until a rule allows it, for example New-NetFirewallRule -DisplayName "PilotDataSync 5001" -Direction Inbound -Protocol TCP -LocalPort 5001 -Action Allow (admin).
  • The relay's mirror box needs the ML PC's IPv4 address (ipconfig), not 127.0.0.1.

Proposal

  • A "Two PCs" subsection under "Sending to iMotions and Python at the same time" in the root README, with a pointer from inference/README.md.
  • A first real test on the lab PCs, noting anything else that came up.
  • #258 can automate the firewall rule and print the address. This issue covers the docs and the first test.
Dominant language
Python
Stars
4
Forks
9
Avg merge
4d 17h
Merged PRs (30d)
7

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from oss-slu/PilotDataSynchronization

All issues in oss-slu/PilotDataSynchronization

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.