Skip to content

Commit ffd57e3

Browse files
committed
docs: remove lab-mode references and picotool build vendoring
Lab-mode is gone from the bridge (bc12331) and the firmware (af7c430). Public docs catch up: - README.md: drop the "Remote Sessions (Optional)" section - wiki/Lab-Mode.md: delete - wiki/_Sidebar.md: drop the "Lab Mode" entry - wiki/Home.md: drop the "Lab Mode" bullet from the page index - build.ps1: drop the picotool.exe fetch+vendor block. picotool shipped with the release ZIP only because lab-mode's remote force_bootsel relied on it; with that path gone, builds no longer download or stage picotool. The remote-Parsec-player wording in wiki/Home.md is preserved -- that's the core product description, separate from lab-mode.
1 parent af7c430 commit ffd57e3

5 files changed

Lines changed: 0 additions & 216 deletions

File tree

README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -58,28 +58,6 @@ Useful commands:
5858
.\couchlink.exe bundle
5959
```
6060

61-
## Remote Sessions (Optional)
62-
63-
If you want someone you trust to look at the bridge remotely without sending them files back and forth, open a debug tunnel:
64-
65-
```powershell
66-
.\couchlink.exe tunnel start
67-
```
68-
69-
The bridge mints a session on `couchlink.whyknot.dev` and prints a one-line view URL. Share that URL only with someone you trust -- it lets them run a small allowlisted set of commands against this bridge:
70-
71-
- `couchlink` subcommands (doctor / bundle / configure-wifi / flash / logs / test)
72-
- `cmake` and `ninja` for firmware rebuilds
73-
- `dir` / `ls` / `type` / `cat` for log inspection
74-
75-
There is no general shell. File reads are limited to a fixed set of log / config files with passwords and tokens redacted. Every command the other person runs and every line of output is mirrored to your own bridge console, so you can watch what they are doing in real time.
76-
77-
To revoke access, restart the bridge (or run `.\couchlink.exe tunnel disable`). The URL goes dead immediately. Sessions also auto-expire after 24 hours of bridge idle.
78-
79-
The other person's setup is just a PowerShell one-liner; full instructions for them are at <https://couchlink.whyknot.dev/USAGE.md>.
80-
81-
See the wiki's [Remote Sessions](https://github.com/RealWhyKnot/ParsecCouchLink/wiki/Remote-Sessions) page for the full safety model and the operator-side flow.
82-
8361
## Reporting bugs
8462

8563
If something went wrong, the fastest path is:

build.ps1

Lines changed: 0 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -84,43 +84,6 @@ if (-not (Test-Path -LiteralPath $FirmwarePicow)) {
8484
Copy-Item -LiteralPath $FirmwarePico2w -Destination (Join-Path $StageDir "couchlink-pico2w.uf2") -Force
8585
Copy-Item -LiteralPath $FirmwarePicow -Destination (Join-Path $StageDir "couchlink-picow.uf2") -Force
8686

87-
# picotool ships alongside the bridge so lab-mode's `force_bootsel`
88-
# fallback can drop a wedged Pico into BOOTSEL drive mode without a
89-
# physical button press. We vendor the official pre-built binary from
90-
# raspberrypi/pico-sdk-tools and cache it under tools/picotool/ so
91-
# subsequent builds don't re-download.
92-
$PicotoolVersion = "2.2.0-3"
93-
$PicotoolAssetName = "picotool-2.2.0-a4-x64-win.zip"
94-
$PicotoolUrl = "https://github.com/raspberrypi/pico-sdk-tools/releases/download/v$PicotoolVersion/$PicotoolAssetName"
95-
$PicotoolCacheDir = Join-Path $RepoRoot "tools\picotool"
96-
$PicotoolExe = Join-Path $PicotoolCacheDir "picotool.exe"
97-
if (-not (Test-Path -LiteralPath $PicotoolExe)) {
98-
Write-Host ""
99-
Write-Host "Fetching picotool $PicotoolVersion from raspberrypi/pico-sdk-tools..." -ForegroundColor Cyan
100-
New-Item -ItemType Directory -Force -Path $PicotoolCacheDir | Out-Null
101-
$PicotoolZip = Join-Path $PicotoolCacheDir $PicotoolAssetName
102-
try {
103-
# TLS 1.2 + UseBasicParsing for Windows PowerShell 5.1.
104-
[Net.ServicePointManager]::SecurityProtocol = `
105-
[Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12
106-
Invoke-WebRequest -Uri $PicotoolUrl -OutFile $PicotoolZip -UseBasicParsing
107-
} catch {
108-
throw "Failed to download picotool from $PicotoolUrl : $_"
109-
}
110-
Expand-Archive -LiteralPath $PicotoolZip -DestinationPath $PicotoolCacheDir -Force
111-
Remove-Item -LiteralPath $PicotoolZip -Force
112-
if (-not (Test-Path -LiteralPath $PicotoolExe)) {
113-
# Some sdk-tools releases nest picotool.exe inside a versioned
114-
# subfolder; find it and lift it up.
115-
$found = Get-ChildItem -LiteralPath $PicotoolCacheDir -Recurse -File -Filter picotool.exe | Select-Object -First 1
116-
if ($null -eq $found) {
117-
throw "picotool.exe not found in extracted archive at $PicotoolCacheDir"
118-
}
119-
Copy-Item -LiteralPath $found.FullName -Destination $PicotoolExe -Force
120-
}
121-
}
122-
Copy-Item -LiteralPath $PicotoolExe -Destination (Join-Path $StageDir "picotool.exe") -Force
123-
12487
$ScriptFiles = @(
12588
"setup.ps1",
12689
"doctor.ps1",

wiki/Home.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ Console player 2
2626
- [[Quick Start]] - install from a release zip and run the setup script.
2727
- [[Setup and Flashing]] - what the script does and how to recover a Pico.
2828
- [[Troubleshooting]] - what to run when setup or discovery fails.
29-
- [[Lab Mode]] - opt-in remote-flash session for collaborative testing.
3029
- [[Reporting-Bugs]] - how to make a bundle and what to include in an issue.
3130
- [[Build]] - build the release zip from source.
3231
- [[Protocol]] - short runtime and setup protocol reference.

wiki/Lab-Mode.md

Lines changed: 0 additions & 155 deletions
This file was deleted.

wiki/_Sidebar.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
- [Quick Start](Quick-Start)
33
- [Setup and Flashing](Setup-and-Flashing)
44
- [Troubleshooting](Troubleshooting)
5-
- [Lab Mode](Lab-Mode)
65
- [Build](Build)
76
- [Protocol](Protocol)
87
- [Changelog](Changelog)

0 commit comments

Comments
 (0)