Skip to content

docs: add settings validation reference#5218

Merged
jamesarich merged 3 commits into
mainfrom
copilot/generate-validation-documentation
May 28, 2026
Merged

docs: add settings validation reference#5218
jamesarich merged 3 commits into
mainfrom
copilot/generate-validation-documentation

Conversation

Copilot AI commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

Comprehensive reference documenting the validation rules enforced on every radio config and module config settings screen, sourced from both protobuf max_size annotations and the UI form layer.

  • Device config screens (User, Device, Position, Power, Network, Display, LoRa, Bluetooth, Security) — per-field type, constraint, and conditional visibility rules
  • Module config screens (MQTT, Serial, Ext Notification, Store & Forward, Range Test, Telemetry, Canned Message, Audio, Remote Hardware, Neighbor Info, Ambient Lighting, Detection Sensor, Paxcounter, Status Message, Traffic Management, TAK) — same treatment
  • Channel config — name byte limit, PSK length constraints (0/16/32 bytes)
  • Interval configurations — all 17 IntervalConfiguration contexts with their exact allowed value sets in seconds
  • UI component validation — documents how each reusable core:ui component (EditTextPreference, DropDownPreference, EditIPv4Preference, EditBase64Preference, BitwisePreference, SliderPreference, etc.) enforces constraints

Example entry:

Field Type Validation Notes
long_name String maxSize: 39 bytes (proto max_size: 40) Required (non-blank)
latitude Double Range: −90.0 to +90.0 Visible only when fixed_position = true
fixed_pin String Exactly 6 digits —

Also notes known discrepancies (e.g. allow_input_source UI enforces 63 bytes while proto specifies max_size: 16).

Copilot AI mentioned this pull request Apr 22, 2026
Merged
@github-actions github-actions Bot added the Stale label May 23, 2026
@jamesarich jamesarich requested a review from Copilot May 23, 2026 11:42
Copilot AI reviewed May 23, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a comprehensive documentation reference for validation rules across radio/device/module/channel configuration screens, including interval presets and reusable core:ui component behavior, with constraints sourced from protobuf max_size annotations and the settings UI form layer.

Changes:

  • Introduces docs/settings-validation.md as a field-by-field validation reference for config screens.
  • Documents IntervalConfiguration allowed value sets and shared constants (e.g., GPIO pin ranges).
  • Summarizes validation/enforcement behavior of reusable core:ui preference components.

Comment thread feature/settings/settings-validation.md
Comment on lines +55 to +58
| Field | Type | Validation | Notes |
|-------|------|------------|-------|
| `long_name` | String | maxSize: 39 bytes (proto max_size: 40) | Required (non-blank) |
| `short_name` | String | maxSize: 4 bytes (proto max_size: 5) | Required (non-blank) |
Comment thread feature/settings/settings-validation.md
| Field | Type | Validation | Notes |
|-------|------|------------|-------|
| `public_key` | Base64 | 32 bytes; read-only | Auto-derived from private key |
| `private_key` | Base64 | 32 bytes | Key generation applies bit masking: `f[0] &= 0xF8`, `f[31] = (f[31] & 0x7F) ǀ 0x40` |
Comment thread feature/settings/settings-validation.md
Comment on lines +432 to +433
Shows a live byte counter when focused.
- **Int mode:** Validates with `toIntOrNull()`; sets error icon on failure.
Comment thread feature/settings/settings-validation.md

### EditIPv4Preference

- Regex validation: `\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}`.
@github-actions github-actions Bot removed the Stale label May 24, 2026
@jamesarich

jamesarich commented May 28, 2026

Copy link
Copy Markdown
Collaborator

@copilot /docs is where the user facing docs are kept - find a better place for this to live

Copilot AI commented May 28, 2026

Copy link
Copy Markdown
Contributor Author

@copilot /docs is where the user facing docs are kept - find a better place for this to live

Moved it out of /docs into the settings feature module at feature/settings/settings-validation.md, and added a pointer in feature/settings/README.md in commit 8752b6b.

Copilot AI requested a review from jamesarich May 28, 2026 17:00
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 28, 2026
@github-actions

github-actions Bot commented May 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

✅ Preview staleness check passed

Preview and screenshot references are up to date.

@github-actions

github-actions Bot commented May 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

✅ Docs staleness check passed

This PR includes updates to docs/en/ alongside the source changes. Thank you!

@jamesarich jamesarich force-pushed the copilot/generate-validation-documentation branch from 8752b6b to 934d512 Compare May 28, 2026 17:25
@jamesarich jamesarich marked this pull request as ready for review May 28, 2026 17:32
@jamesarich jamesarich merged commit a5d176d into main May 28, 2026
18 checks passed
@jamesarich jamesarich deleted the copilot/generate-validation-documentation branch May 28, 2026 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@jamesarich jamesarich Awaiting requested review from jamesarich

Assignees

@garthvh garthvh

Copilot code review Copilot

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jamesarich @garthvh