Overview

phyphox turns the sensors in a smartphone into physics measuring instruments. What the app does in any given experiment is described entirely by an experiment configuration file — so anyone can write their own experiments, and this documentation exists to describe exactly how.

Also, phyphox features a REST API, which is documented here as well.

You may not need to write XML at all

Experiment configurations can be created visually with the phyphox experiment editor, which assembles them from blocks in the browser and generates a QR code to get the result onto a phone. This site documents the underlying format, which the editor writes for you.

Phyphox file format

• The experiment file format — the XML format that defines every phyphox experiment: data sources, analysis, views, export and metadata.
• Analysis modules — every mathematical operation available in the analysis stage, from add to Fourier transforms.
• Bluetooth Low Energy — reading and writing BLE devices from an experiment.
• Network connections — HTTP and MQTT data sources.

Interfaces and tools

• The remote interface — control a running experiment and stream its data over HTTP.
• The experiment editor — build experiments visually, without writing XML by hand.
• Transferring experiments — getting an experiment onto a phone.

Reference

• Version history — what changed in each release.
• Known inconsistencies — where the implementations currently disagree with each other, and which behavior is correct.

For more information, check out phyphox.org, where you can find our forum, a wiki with some additional info and further resources.