diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml index 7ce27c3c..db2f64de 100644 --- a/.github/workflows/sphinx.yml +++ b/.github/workflows/sphinx.yml @@ -1,25 +1,42 @@ name: "Sphinx: Render docs" -on: push +on: + push: + branches: + main jobs: build: runs-on: ubuntu-latest - permissions: - contents: write steps: - - uses: actions/checkout@v4 - - name: Build HTML - uses: ammaraskar/sphinx-action@master + - run: lsb_release -a + - run: uname -a + - name: Checkout repository + uses: actions/checkout@master + - name: Setup Python + uses: actions/setup-python@master with: - docs-folder: "." - build-command: "sphinx-build -b html . _build/html" + python-version: '3.10' + - name: Install build dependencies + run: | + sudo apt-get update -y + sudo apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended + - name: Upgrade pip + run: python3 -m pip install --upgrade pip + - name: Install python dependencies + run: pip install -r requirements.txt + - name: Build HTML + run: make html + - name: Build PDF + run: | + make latexpdf + mv _build/latex/*.pdf _build/html - name: Upload artifacts uses: actions/upload-artifact@v4 with: - name: html-docs + name: docs path: _build/html/ - - name: Deploy + - name: Deploy HTML uses: peaceiris/actions-gh-pages@v3 if: github.ref == 'refs/heads/main' with: diff --git a/bioamp-exg-pill.rst b/bioamp-exg-pill.rst new file mode 100644 index 00000000..77ace0a7 --- /dev/null +++ b/bioamp-exg-pill.rst @@ -0,0 +1,13 @@ +:orphan: + +.. _bioamp-exg-pill-datasheet: + +BioAmp EXG Pill +############### + +.. toctree:: + :hidden: + :maxdepth: 2 + :caption: BioAmp + + bioamp/hardware/bioamp-exg-pill/index \ No newline at end of file diff --git a/bioamp/hardware/bioamp-exg-pill/index.rst b/bioamp/hardware/bioamp-exg-pill/index.rst index a4fd6014..6ee6e2ab 100644 --- a/bioamp/hardware/bioamp-exg-pill/index.rst +++ b/bioamp/hardware/bioamp-exg-pill/index.rst @@ -32,7 +32,7 @@ Features & Specifications +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Minimum Input Voltage | 4.5-40 V | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Input Impedance | 10^12 Ω | +| Input Impedance | 10^12 ohm | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Compatible Hardware | Any development board with an ADC (Arduino UNO & Nano, Espressif ESP32, Adafruit QtPy, STM32 Blue Pill, BeagleBone Black, Raspberry Pi Pico, to name just a few) | +-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -170,8 +170,7 @@ be used for a wide variety of interesting biosensing projects, including: - Blink detection (EOG) - Capturing photos with a blink of an eye (EOG) - Controlling LEDs via brain waves (EEG) -- Patient monitoring -and many more examples. +- Patient monitoring and many more examples. Some project ideas ******************* diff --git a/bioamp/hardware/muscle-bioamp-biscute/index.rst b/bioamp/hardware/muscle-bioamp-biscute/index.rst index f527b27e..3c994de8 100644 --- a/bioamp/hardware/muscle-bioamp-biscute/index.rst +++ b/bioamp/hardware/muscle-bioamp-biscute/index.rst @@ -24,7 +24,7 @@ Features & Specifications +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Minimum Input Voltage | 3.3-30 V | +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Input Impedance | 10^11 Ω | +| Input Impedance | 10^11 ohm | +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Fixed Gain | x2420 | +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -53,17 +53,21 @@ Images below shows a quick overview of the hardware design. :margin: 4 4 0 0 :gutter: 2 - .. card:: + .. grid-item:: + + .. card:: - **PCB Front** - ^^^^^ - .. figure:: media/front.* + **PCB Front** + ^^^^^ + .. figure:: media/front.* - .. card:: + .. grid-item:: + + .. card:: - **PCB Back** - ^^^^^ - .. figure:: media/back.* + **PCB Back** + ^^^^^ + .. figure:: media/back.* .. figure:: media/assembled.* :align: center @@ -198,6 +202,6 @@ Some project ideas We have curated a playlist for you which consists some awesome project ideas for you to get started with your next HCI project. -.. youtube:: https://youtube.com/playlist?list=PLtkEloJ7UnkQIoz1HK4IXWujCB8hKdiKU&si=osloTX71TE7AJ3CF - :width: 100% - :align: center +.. .. youtube:: https://youtube.com/playlist?list=PLtkEloJ7UnkQIoz1HK4IXWujCB8hKdiKU&si=osloTX71TE7AJ3CF +.. :width: 100% +.. :align: center diff --git a/bioamp/hardware/muscle-bioamp-candy/index.rst b/bioamp/hardware/muscle-bioamp-candy/index.rst index edae726b..533358af 100644 --- a/bioamp/hardware/muscle-bioamp-candy/index.rst +++ b/bioamp/hardware/muscle-bioamp-candy/index.rst @@ -25,7 +25,7 @@ Features & Specifications +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Minimum Input Voltage | 3.3-30 V | +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Input Impedance | 10^11 Ω | +| Input Impedance | 10^11 ohm | +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Fixed Gain | x2420 | +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -53,17 +53,21 @@ Images below shows a quick overview of the hardware design. :margin: 4 4 0 0 :gutter: 2 - .. card:: + .. grid-item:: + + .. card:: - **PCB Front** - ^^^^^ - .. figure:: media/PCBfront.* + **PCB Front** + ^^^^^ + .. figure:: media/PCBfront.* - .. card:: + .. grid-item:: + + .. card:: - **PCB Back** - ^^^^^ - .. figure:: media/PCBback.* + **PCB Back** + ^^^^^ + .. figure:: media/PCBback.* .. figure:: media/muscle-bioamp-candy-front.* :align: center @@ -98,6 +102,6 @@ Some project ideas We have curated a playlist for you which consists some awesome project ideas for you to get started with your next HCI project. -.. youtube:: https://youtube.com/playlist?list=PLtkEloJ7UnkQIoz1HK4IXWujCB8hKdiKU&si=osloTX71TE7AJ3CF - :width: 100% - :align: center +.. .. youtube:: https://youtube.com/playlist?list=PLtkEloJ7UnkQIoz1HK4IXWujCB8hKdiKU&si=osloTX71TE7AJ3CF +.. :width: 100% +.. :align: center diff --git a/bioamp/hardware/muscle-bioamp-patchy/index.rst b/bioamp/hardware/muscle-bioamp-patchy/index.rst index 634da706..f6e1d8df 100644 --- a/bioamp/hardware/muscle-bioamp-patchy/index.rst +++ b/bioamp/hardware/muscle-bioamp-patchy/index.rst @@ -21,7 +21,7 @@ Features & Specifications +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Minimum Input Voltage | 4.5 V | +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Input Impedance | 10^12 Ω | +| Input Impedance | 10^12 ohm | +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Fixed Gain | x2420 | +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,17 +55,20 @@ Images below shows a quick overview of the hardware design. :margin: 4 4 0 0 :gutter: 2 - .. card:: + .. grid-item:: + + .. card:: - **PCB Front** - ^^^^^ - .. figure:: media/PCB-Front.* + **PCB Front** + ^^^^^ + .. figure:: media/PCB-Front.* - .. card:: + .. grid-item:: + .. card:: - **PCB Back** - ^^^^^ - .. figure:: media/PCB-Back.* + **PCB Back** + ^^^^^ + .. figure:: media/PCB-Back.* .. figure:: media/Muscle-BioAmp-Patchy-Assembled-Front.* :align: center diff --git a/bioamp/hardware/muscle-bioamp-shield/index.rst b/bioamp/hardware/muscle-bioamp-shield/index.rst index 64e5f223..6be334c5 100644 --- a/bioamp/hardware/muscle-bioamp-shield/index.rst +++ b/bioamp/hardware/muscle-bioamp-shield/index.rst @@ -32,7 +32,7 @@ output. On STEMMA digital port you can connect any digital sensor or actuator of +---------------------+---------------------------------------+ | Input Voltage | 5V | +---------------------+---------------------------------------+ -| Input Impedance | 10^11 Ω | +| Input Impedance | 10^11 ohm | +---------------------+---------------------------------------+ | Fixed Gain | x2420 | +---------------------+---------------------------------------+ @@ -60,17 +60,21 @@ Images below shows a quick overview of the hardware design. :margin: 4 4 0 0 :gutter: 2 - .. card:: + .. grid-item:: - **PCB Front** - ^^^^^ - .. figure:: media/Muscle-BioAmp-Shield-Front.* + .. card:: - .. card:: + **PCB Front** + ^^^^^ + .. figure:: media/Muscle-BioAmp-Shield-Front.* - **PCB Back** - ^^^^^ - .. figure:: media/Muscle-BioAmp-Shield-Back.* + .. grid-item:: + + .. card:: + + **PCB Back** + ^^^^^ + .. figure:: media/Muscle-BioAmp-Shield-Back.* .. figure:: media/Muscle-BioAmp-Shield-With-Wires.* :align: center @@ -246,37 +250,45 @@ Using the Sensor The possibilities are endless as you can: -.. grid:: 1 1 2 2 - :margin: 2 2 0 0 - :gutter: 2 +.. .. grid:: 1 1 2 2 +.. :margin: 2 2 0 0 +.. :gutter: 2 - .. card:: - - .. figure:: media/LEDGraph.* +.. .. grid-item:: + +.. .. card:: - ^^^^^ - Visualize the EMG signals using the 6-onboard LEDs. The more you flex, the more LEDs will glow up. +.. .. figure:: media/LEDGraph.* + +.. ^^^^^ +.. Visualize the EMG signals using the 6-onboard LEDs. The more you flex, the more LEDs will glow up. - .. card:: +.. .. grid-item:: - .. figure:: media/servo-control.* +.. .. card:: - ^^^^^ - Directly connect the servo motor via 3-pin angled header pins and control it using muscle signals (EMG). +.. .. figure:: media/servo-control.* - .. card:: +.. ^^^^^ +.. Directly connect the servo motor via 3-pin angled header pins and control it using muscle signals (EMG). - .. figure:: media/listening-muscle-signals.* - - ^^^^^ - Give audio/mic input signals from your mobile phone, laptop, or speakers via BioAmp AUX Cable connected to a 4-pin JST PH 2mm connector. +.. .. grid-item:: + +.. .. card:: + +.. .. figure:: media/listening-muscle-signals.* - .. card:: +.. ^^^^^ +.. Give audio/mic input signals from your mobile phone, laptop, or speakers via BioAmp AUX Cable connected to a 4-pin JST PH 2mm connector. + +.. .. grid-item:: - .. figure:: media/9v-battery.* - - ^^^^^ - Connect a 7V to 9V battery via snap cable. +.. .. card:: + +.. .. figure:: media/9v-battery.* + +.. ^^^^^ +.. Connect a 7V to 9V battery via snap cable. - Record the muscle signals (EMG) either using Gel Electrodes or BioAmp Bands (dry electrode based) via BioAmp Cable connected to a 3-pin JST PH 2mm connector. diff --git a/conf.py b/conf.py index 6c85ea8d..aa1cabc3 100644 --- a/conf.py +++ b/conf.py @@ -118,3 +118,6 @@ "my_vcs_site": "https://github.com/upsidedownlabs/upsidedownlabs.github.io/edit/main", } +latex_documents = [ + ("bioamp-exg-pill", "bioamp-exg-pill.tex", "BioAmp EXG Pill", author, "manual"), +] \ No newline at end of file