+
diff --git a/docs/CNAME b/docs/CNAME
new file mode 100644
index 0000000..92bf677
--- /dev/null
+++ b/docs/CNAME
@@ -0,0 +1 @@
+picoquake.plab.si
\ No newline at end of file
diff --git a/docs/assets/IMG_1788.jpeg b/docs/assets/IMG_1788.jpeg
deleted file mode 100644
index eb8aa9b..0000000
Binary files a/docs/assets/IMG_1788.jpeg and /dev/null differ
diff --git a/docs/assets/plot_example_fft.png b/docs/assets/plot_example_fft.png
index 522fb0f..1efc85d 100644
Binary files a/docs/assets/plot_example_fft.png and b/docs/assets/plot_example_fft.png differ
diff --git a/docs/assets/plot_example_psd.jpg b/docs/assets/plot_example_psd.jpg
index 7588be7..a84830e 100644
Binary files a/docs/assets/plot_example_psd.jpg and b/docs/assets/plot_example_psd.jpg differ
diff --git a/docs/assets/plot_example_ts.jpg b/docs/assets/plot_example_ts.jpg
index 45ca651..d4bc708 100644
Binary files a/docs/assets/plot_example_ts.jpg and b/docs/assets/plot_example_ts.jpg differ
diff --git a/docs/assets/pq_1.jpeg b/docs/assets/pq_1.jpeg
new file mode 100644
index 0000000..94826fd
Binary files /dev/null and b/docs/assets/pq_1.jpeg differ
diff --git a/docs/assets/IMG_1791.jpeg b/docs/assets/pq_coin.jpeg
similarity index 100%
rename from docs/assets/IMG_1791.jpeg
rename to docs/assets/pq_coin.jpeg
diff --git a/docs/assets/IMG_1795.jpeg b/docs/assets/pq_inthebox.jpeg
similarity index 100%
rename from docs/assets/IMG_1795.jpeg
rename to docs/assets/pq_inthebox.jpeg
diff --git a/docs/assets/IMG_1800.jpeg b/docs/assets/pq_pole_mnt.jpeg
similarity index 100%
rename from docs/assets/IMG_1800.jpeg
rename to docs/assets/pq_pole_mnt.jpeg
diff --git a/docs/assets/IMG_1801.jpeg b/docs/assets/pq_pole_mnt_2.jpeg
similarity index 100%
rename from docs/assets/IMG_1801.jpeg
rename to docs/assets/pq_pole_mnt_2.jpeg
diff --git a/docs/assets/signal_diagram.svg b/docs/assets/signal_diagram.svg
new file mode 100644
index 0000000..a6488af
--- /dev/null
+++ b/docs/assets/signal_diagram.svg
@@ -0,0 +1,547 @@
+
+
+
diff --git a/docs/assets/terminal_screenshot.png b/docs/assets/terminal_screenshot.png
new file mode 100644
index 0000000..67aced1
Binary files /dev/null and b/docs/assets/terminal_screenshot.png differ
diff --git a/docs/assets/vscode_screenshot.png b/docs/assets/vscode_screenshot.png
new file mode 100644
index 0000000..2ca6848
Binary files /dev/null and b/docs/assets/vscode_screenshot.png differ
diff --git a/docs/examples/bldc.md b/docs/examples/bldc.md
index f785adf..64acea7 100644
--- a/docs/examples/bldc.md
+++ b/docs/examples/bldc.md
@@ -4,7 +4,7 @@ Brushless DC motors are a popular choice due to their longevity, efficiency and
The two main control algorithms for BLDCs are the basic 6-step trapezoidal BLDC commutation (tldr: turning windings on and off in the correct sequence) and sinusoidal FOC control (tldr: continuous sinusoidal phase currents instead of discrete steps). We wondered how the choice of the control method impacts the vibration produced by the motor.
-We carried out a simple comparison test by attaching PicoQuake to a small brushless outrunner motor being controlled by a VESC speed controller. In VESC configuration software, commutation method can be selected.
+We carried out a simple comparison test by attaching *PicoQuake* to a small brushless outrunner motor being controlled by a VESC speed controller. In VESC configuration software, commutation method can be selected.
@@ -12,4 +12,4 @@ A one second recording was captured. Looking at the acceleration plots and RMS v
-As showcased in this example, PicoQuake can be used in BLDC drive applications to optimize for smooth and low noise operation, which can be particularly important in small electric mobility product such as electric bikes, scooters, etc.
+As showcased in this example, *PicoQuake* can be used in BLDC drive applications to optimize for smooth and low noise operation, which can be particularly important in small electric mobility product such as electric bikes, scooters, etc.
diff --git a/docs/examples/trackpad.md b/docs/examples/trackpad.md
index e98a338..4e40f05 100644
--- a/docs/examples/trackpad.md
+++ b/docs/examples/trackpad.md
@@ -1,8 +1,8 @@
# Trackpad Click
-PicoQuake can be used to evaluate and optimize all the clicky things - such as the click of a trackpad on a laptop.
+*PicoQuake* can be used to evaluate and optimize all the clicky things - such as the click of a trackpad on a laptop.
-Let’s take a look at how a click of a traditional trackpad looks like. This one has a pivot point at the top and a tactile button under it at the bottom. PicoQuake was simply pressed lightly against the trackpad while clicking it. A recording was taken at the full 4 kHz sample rate. Trackpad’s direction of travel is aligned with the Z axis of PicoQuake.
+Let’s take a look at how a click of a traditional trackpad looks like. This one has a pivot point at the top and a tactile button under it at the bottom. *PicoQuake* was simply pressed lightly against the trackpad while clicking it. A recording was taken at the full 4 kHz sample rate. Trackpad’s direction of travel is aligned with the Z axis of *PicoQuake*.
@@ -14,6 +14,6 @@ More modern trackpads (such as in Apple MacBooks) work very differently however.
-Comparing the two with PicoQuake, we can see that the acceleration pattern is very similar regarding amplitude and duration. Which checks out, because the Magic Trackpad’s click feels very much like a physical tactile button click.
+Comparing the two with *PicoQuake*, we can see that the acceleration pattern is very similar regarding amplitude and duration. Which checks out, because the Magic Trackpad’s click feels very much like a physical tactile button click.
-There is one important difference though - it vibrates in a different axis! Most of the movement is detected in the Y axis (front-back), not Z (up-down). It would appear that human fingers can’t detect the direction of such short bursts of vibration very well, allowing engineers to pick a actuation direction was easiest to implement. This is confirmed by looking inside a MacBook. The magnetic actuator is clearly visible and indeed moves the trackpad in the front-back direction.
+There is one important difference though - it vibrates in a different axis! Most of the movement is detected in the Y axis (front-back), not Z (up-down). It would appear that human fingers can’t detect the direction of such short bursts of vibration very well. Therefore engineers picked the actuation direction that was the easiest to implement. This is confirmed by looking inside the MacBook. The magnetic actuator is clearly visible and indeed moves the trackpad in the front-back direction.
diff --git a/docs/getting_started.md b/docs/getting_started.md
new file mode 100644
index 0000000..c580c6b
--- /dev/null
+++ b/docs/getting_started.md
@@ -0,0 +1,95 @@
+# Getting Started
+
+## Requirements
+
+A computer with:
+
+- *Windows*, *Linux* or *macOS*
+- [*Python*](https://www.python.org/downloads/){:target="_blank"} *3.9* or higher
+- [*pip*](https://pip.pypa.io/en/stable/installation/){:target="_blank"}
+
+## Install
+
+### Basic installation
+
+Run command:
+
+```bash
+pip install picoquake
+```
+
+The recommended way to install if you don't need plotting capabilities. Only supports saving CSV data.
+
+### Plotting capabilities
+
+Run command:
+
+```bash
+pip install 'picoquake[plot]'
+```
+
+Enables creating diagrams in time and frequency domain. Additional dependencies will be installed:
+
+- *NumPy*
+- *SciPy*
+- *Matplotlib*
+
+### Test Installation
+
+Run command:
+
+```bash
+picoquake --version
+```
+
+The above command should print the installed version of the package.
+If you see an error, try the alternative:
+
+```bash
+python -m picoquake --version
+```
+
+!!! note
+ `python -m` prefix is needed if the python scripts directory is not in the system PATH. It depends on your OS and the way *Python* was installed. Check the official *Python* documentation for more information.
+
+## Connect
+
+ Connect *PicoQuake* to your computer. The green LED will light up.
+
+ Run command:
+
+```bash
+picoquake --list
+```
+
+It will print a list of connected devices:
+
+```
+PicoQuake C6E3: /dev/cu.usbmodem1101
+...
+```
+
+!!! info "No devices"
+ If you don't see any devices, check the connection and try again. You can also try another USB port.
+
+!!! note "Short ID"
+ All further commands require a `Short ID` of the device. It's printed on the device label, or can be read by the `--list` command.
+
+## Test
+
+
+
+Run command:
+
+```bash
+picoquake display c6e3
+```
+
+Orange LED will light up, and realtime data will be displayed in the terminal. Try to move the device to see the changes.
+
+
+## What's next?
+
+See [Usage](usage.md) for detailed instructions.
+
+Run `picoquake --help` to see all available commands.
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index 7124da5..c6fb4b6 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,49 +1,4 @@
-# PicoQuake: USB Vibration Sensor
-
-**Overview:**
-
-*PicoQuake* is a MEMS accelerometer vibration sensor designed to profile a wide range of vibrations. It can capture everything from very low-frequency movements (tall buildings, bridges), to high-frequency vibrations in the kilohertz range (motors, industrial machinery).
-
-**Key features:**
-
-- **Wide frequency range:** Suitable for both low and high-frequency vibration monitoring.
-- **Accessible:** A cost-effective alternative to traditional industrial vibration sensors, which often require proprietary hardware and software.
-- **Standalone device:** Connects directly to your computer (Linux, Mac, Windows) via USB.
-- **Open-source integration:** Interfaced through an open-source Python driver, providing a command line interface (CLI) and an API for easy integration and customization.
-
-
+title:
+template: home.html
+---
diff --git a/docs/installation.md b/docs/installation.md
deleted file mode 100644
index 2dafcb0..0000000
--- a/docs/installation.md
+++ /dev/null
@@ -1,49 +0,0 @@
-# Installation
-
-## Requirements
-
-- *Windows*, *Linux* or *macOS*
-- [*Python*](https://www.python.org/downloads/){:target="_blank"} *3.9* or higher
-- [*pip*](https://pip.pypa.io/en/stable/installation/){:target="_blank"}
-
-## Basic installation
-
-Run command:
-
-```bash
-pip install picoquake
-```
-
-Recommended way to install if you don't need plotting capabilities. Only supports saving CSV data.
-
-## Plotting capabilities
-
-Run command:
-
-```bash
-pip install 'picoquake[plot]'
-```
-
-Enables creating diagrams in time and frequency domain. Additional dependencies will be installed:
-
-- *NumPy*
-- *SciPy*
-- *Matplotlib*
-
-## Test installation
-
-Run command:
-
-```bash
-picoquake --version
-```
-
-The above command should print the installed version of the package.
-If you see an error, try the alternative:
-
-```bash
-python -m picoquake --version
-```
-
-!!! note
- `python -m` prefix is needed if the python scripts directory is not in the system PATH. It depends on your OS and the way *Python* was installed. Check the official *Python* documentation for more information.
diff --git a/docs/overrides/home.html b/docs/overrides/home.html
new file mode 100644
index 0000000..77b0eb8
--- /dev/null
+++ b/docs/overrides/home.html
@@ -0,0 +1,226 @@
+{% extends "main.html" %}
+{% block tabs %}
+{{ super() }}
+
+
+
++ Measure any vibration. +
+
+
+ + Measure vibrations of a small fan or a tall building. + Using a low-noise MEMS accelerometer, even the smallest vibrations can be detected. +
++ Simply hold it to an object, stick it with a double-sided tape or fix it with a cable tie. +
++ Specs +
+
+ + A cost effective alternative to industrial vibration sensors. +
++ Connects directly to your computer via USB. + No additional power supply required. + Python driver and command line interface (CLI) with minimal dependencies. + Supports Linux, Mac & Windows. +
++ Firmware and Python driver are open-source and available on GitHub. +
++ Repository +
+
+ + Control PicoQuake using the command line interface (CLI). +
++ List available devices, set acquisition parameters and trigger data acquisition. + For advanced acquisitions, a TOML file can be used for configuration. Continuous or interval acquisition is supported. + Data is saved to a CSV file. +
++ Supports basic plotting of time series and power spectral density of the acquired data. +
+ +
+ + Integrate PicoQuake into your project using the Python API. +
++ Read values directly, trigger acquisition based on a threshold, or stream buffered data. +
+ +
+