Skip to content

Latest commit

 

History

History
103 lines (58 loc) · 8.18 KB

File metadata and controls

103 lines (58 loc) · 8.18 KB

P2 Generated Documents

PDF documents generated from the P2 Knowledge Base.

License

About These Documents

This documentation is produced differently than traditional technical manuals. These are AI-generated drafts, guided by human expertise — a collaborative approach where AI assists in structuring and writing while humans provide direction, source material curation, and review.

Our process emphasizes source fidelity:

  • Source material is rigorously gathered from official Parallax documentation, datasheets, and authoritative community references
  • Code examples are compiled and validated using pnut_ts wherever possible
  • Content is cross-referenced against the project's structured YAML knowledge base

What this means for community review:

Because these documents are AI-assisted, the issues you may encounter differ from traditionally authored manuals. Watch for:

  • Plausible but incorrect details — Specifications that sound right but aren't (wrong clock cycles, flag behaviors, register addresses)
  • Overgeneralization — Statements presented as universal that have exceptions or edge cases
  • Missing practitioner context — Technically accurate but lacking the practical insight experienced users know
  • Logic errors in examples — Code that compiles but doesn't behave as described
  • Terminology drift — Nearly-correct terms that could mislead

Your expertise is essential. This review process depends on practitioners who know the Propeller 2 to catch what automated validation cannot. If something looks wrong, seems incomplete, or contradicts your experience — report it via the Issues page.

How These Documents Are Built — and Why You Can Trust Them

Two short companion reads go deeper on the questions every reviewer asks:

Why You Can Trust What's in These Manuals — how a fact gets into a manual and how we check it. Jump to: checked against the silicon · we audit our own work · when you report a problem, it ships.

How These Manuals Are Made — and How They Stack Up — the craft, measured honestly against how the best reference manuals in the world are produced. Jump to: the bar we measured against · where we go past a printed book · where we don't match them yet.

Documents in Community Review

Four documents are available now for community technical review. We welcome feedback on accuracy, completeness, and clarity. (PDF links download the file directly.)

Complete PASM2 Instruction Set DocumentationVersion 3.0.0

The definitive reference for P2 assembly language programming. Documents all PASM2 instructions with accurate syntax, encoding tables, behavior descriptions, and practical examples. Organized alphabetically for quick lookup, with comprehensive coverage of directives, special registers, and predefined constants. Includes architectural foundation chapters on execution models, instruction formats, flags, timing, and hardware integration.

June 2026 - Community Review Edition | Changelog

A Human-Centered Approach to Parallel ProcessingVersion 3.0.0

This tutorial follows in the footsteps of deSilva's legendary P1 Assembly Tutorial, bringing the same approachable, hands-on teaching style to the Propeller 2. Starting with a blinking LED and progressing through COG architecture, hub memory, CORDIC math, Smart Pins, and multi-COG coordination, this manual makes PASM2 genuinely enjoyable to learn. Written with the philosophy: "Learn by doing, celebrate progress, have fun!"

June 2026 - Community Review Edition | Changelog

A Guide to the Propeller 2 Streamer — Its Modes and FunctionVersion 1.0.1

An introduction to the P2 streamer — the DMA-like engine that moves data between hub RAM, pins, and DACs — built to make a genuinely tricky part of the chip make sense. Covers every streamer mode (immediate, RDFAST/WRFAST, RGB video, ADC sampling, DDS/Goertzel), NCO timing and frequency calculation, DAC channel routing and pin control, and application patterns for video output, high-speed serial, and signal processing. Includes a complete mode encoding table and a clickable index.

June 2026 - Community Review Edition | Changelog

See What Your Program Is Doing — Nine Display Windows for the Propeller 2Version 1.0.0

The complete guide to the P2's nine DEBUG display windows — TERM, BITMAP, PLOT, LOGIC, SCOPE, SCOPE_XY, FFT, SPECTRO, and MIDI. Documents every window's directives, parameters, ranges, and defaults, with a worked, software-only example in each chapter — thermal heatmap, PID strip-chart, glitch capture, motor run-up, and more — that runs on a bare P2 board with no wiring. Integration chapters cover packed-data high-rate transfer, multiple windows and PASM debugging, host keyboard and mouse input, and live control and status panels. Includes a downloadable example library of 32 compile-clean Spin2 programs.

June 2026 - Community Review Edition | Changelog | Example Library (ZIP)

Also in the Pipeline

Two further manuals are in production and will open for community review as they complete:

P2 Single-Step Debugger Manual

Observe and Control Your Running P2 Codecoming soon

A practical guide to single-stepping P2 code — pausing and resuming a running program, inspecting values and timing, and driving the debugger from the host.

P2 I/O & Smart Pins User Guide

Complete P2 Pin I/O and Smart Pin Referencecoming soon

The complete reference for P2 pin I/O and the Smart Pins — every smart pin mode, its configuration, and usage patterns.

Reporting Issues

Found an error or have feedback? We appreciate your help improving these documents!

Report a Document Defect — Use this when you found an error and know (or can reference) the correct information. Include page number, nearest heading, and source reference.

Provide Document Feedback — Use this for suggestions, unclear content, missing information, or when something seems wrong but you're not sure of the fix.

For issues with AI-generated code or the underlying YAML/JSON knowledge base, see:

Generation

Documents are generated using PDF Forge from markdown sources we've authored.


Built with intention for the P2 community