Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @AFetisa
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Bug report
description: Something doesn't work as described
labels: [bug]
body:
- type: dropdown
id: device
attributes:
label: Device
options: [Cardputer ADV, Cardputer (original), Other]
validations: { required: true }
- type: input
id: version
attributes:
label: PocketWUI version
description: Shown in Settings → Device, or the release you installed.
placeholder: "2.1.0"
validations: { required: true }
- type: dropdown
id: install
attributes:
label: Installed with
options: [M5Launcher, M5Burner, Flashed full image (0x0)]
validations: { required: true }
- type: dropdown
id: connection
attributes:
label: Connected via
options: [Home Wi-Fi, Phone hotspot, Cardputer's own Wi-Fi, USB cable]
validations: { required: true }
- type: input
id: client
attributes:
label: Browser / OS
placeholder: "Safari on iOS 19, Chrome on Windows 11…"
- type: textarea
id: what
attributes:
label: What happened, and what did you expect?
description: Steps to reproduce help most. Screenshots or a photo of the Cardputer screen are welcome.
validations: { required: true }
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Question or idea to discuss
url: https://github.com/AFetisa/pocket-wui/discussions
about: Ask how to do something, or float an idea before it becomes a request.
- name: Security problem
url: https://github.com/AFetisa/pocket-wui/security/advisories/new
about: Report privately. Please don't open a public issue.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Feature request
description: Suggest something PocketWUI should do
labels: [enhancement]
body:
- type: textarea
id: problem
attributes:
label: What are you trying to do?
description: The problem or use case, not just the solution.
validations: { required: true }
- type: textarea
id: idea
attributes:
label: How would you like it to work?
- type: checkboxes
id: pr
attributes:
label: Contributing
options:
- label: I'd like to build this myself (wait for a 👍 on this issue before opening a PR)
5 changes: 5 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Closes #

**What and why:**

**Tested on:** <!-- device + how (hardware, simulator, host tests) -->
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ src/web_assets.h
test/hostsim/build/
test/hostsim/pocketwui-sim
dist/
/build/
__pycache__/
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## Unreleased
## 2.1.0

**New**
- Join Wi‑Fi from the Cardputer itself: press `w` on the main screen, pick a
Expand Down
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing

Thanks for helping. PocketWUI is maintained by one person, so everything goes through review.

- **Bugs:** [open a bug report](https://github.com/AFetisa/pocket-wui/issues/new?template=bug_report.yml). Device, version and connection mode matter most.
- **Features:** [open a feature request](https://github.com/AFetisa/pocket-wui/issues/new?template=feature_request.yml) first. Wait for a 👍 before writing code, so your work isn't wasted on something that won't be merged.
- **Questions:** use [Discussions](https://github.com/AFetisa/pocket-wui/discussions).
- **Security:** report [privately](SECURITY.md), not in an issue.

## Pull requests

1. Fork, branch from `main`, keep the change focused on one issue.
2. Run the tests: `make -C test host` and `make -C test sim` (see [docs/DEVELOPING.md](docs/DEVELOPING.md)).
3. Say in the PR what you tested on: real hardware, the simulator, or host tests only.
4. CI must pass, and the maintainer reviews and merges. By contributing you agree your code is released under the [MIT licence](LICENSE).
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Browse, preview, upload and download files on your M5Stack Cardputer / Cardputer
<img src="docs/screenshots/phone-dark.png" alt="PocketWUI on a phone, dark mode" width="170">
</p>

> **Status:** 2.0 passes every automated test (host, simulator, browser) but hasn't run on real hardware yet. Tried it? [Open an issue](../../issues) either way.
> **Status:** runs on the Cardputer ADV via M5Launcher. The original Cardputer should work but is untested; [reports welcome](../../issues/new/choose).

## Features

Expand Down Expand Up @@ -43,5 +43,6 @@ Forgot it? Hold the side button for 5 s to reset the password and Wi‑Fi (your
- **[Guide](docs/GUIDE.md)**: ways to connect, tips, M5Launcher, troubleshooting, privacy, test status
- **[Developing](docs/DEVELOPING.md)**: build, PC simulator, tests, HTTP/WebDAV API
- **[Changelog](CHANGELOG.md)**
- **[Contributing](CONTRIBUTING.md)**: bugs, feature requests, pull requests

Built on [M5Unified / M5GFX](https://github.com/m5stack/M5Unified), [EspUsbDevice](https://github.com/tanakamasayuki/EspUsbDevice) and [pioarduino](https://github.com/pioarduino/platform-espressif32). Works with [M5Launcher](https://github.com/bmorcelli/Launcher). [MIT licence](LICENSE).
7 changes: 7 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Security

Please report vulnerabilities privately through
[GitHub's private reporting](https://github.com/AFetisa/pocket-wui/security/advisories/new), not in a public issue.
You'll get a reply within a week.

Only the latest release is supported. PocketWUI uses plain HTTP by design and is meant for networks you trust (see [the guide](docs/GUIDE.md#privacy-and-safety)).
Binary file removed build/PocketWUI-full-flash.bin
Binary file not shown.
Binary file removed build/PocketWUI.bin
Binary file not shown.
8 changes: 4 additions & 4 deletions docs/GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,14 @@ page waits until it finishes.

## Status

**Version 2.0.** Here's what has and hasn't been verified:
**Version 2.1.** Here's what has and hasn't been verified:

- ✅ Builds cleanly for the ESP32-S3 (CI on every push).
- ✅ The real server code (files, uploads, downloads, ZIP, search, trash,
copy, WebDAV, settings) is compiled for a PC and passes 59 API checks and 30
browser checks in Chromium.
- ✅ The ZIP writer is checked with Python's `zipfile`, including archives
over 4 GB.
- ⚠️ **Not yet run on a real Cardputer:** Wi‑Fi behaviour, the USB network
adapter and drive, the screen, battery reading, *Back to Launcher* and
self-update. 2.0 needs its first real-world test.
- ✅ Runs on a real Cardputer ADV, installed through M5Launcher.
- ⚠️ The original (non-ADV) Cardputer is untested. If you have one,
please [report how it goes](https://github.com/AFetisa/pocket-wui/issues/new/choose).
2 changes: 1 addition & 1 deletion src/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// ---------------------------------------------------------------------------

#define WUI_NAME "PocketWUI"
#define WUI_FW_VERSION "2.0.0"
#define WUI_FW_VERSION "2.1.0"

#define WUI_HOSTNAME "cardputer" // -> http://cardputer.local (changeable in Settings)
#define WUI_AP_PREFIX "PocketWUI-" // fallback access point: PocketWUI-<4 hex digits>
Expand Down
Loading