start with article

Author: FreekPols

.github/workflows/deploy.yml

@@ -0,0 +1,48 @@
+# This file was created automatically with `myst init --gh-pages` 🪄 💚
+# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
+
+name: MyST GitHub Pages Deploy
+on:
+  push:
+    # Runs on pushes targeting the default branch
+    branches: [main]
+env:
+  # `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
+  # E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
+  # If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
+  BASE_URL: /${{ github.event.repository.name }}
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Install MyST
+        run: npm install -g mystmd
+      - name: Build HTML Assets
+        run: myst build --html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './_build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,2 @@
+# MyST build outputs
+_build

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "cSpell.words": [
+        "microcontroller"
+    ]
+}

article.md

@@ -0,0 +1,92 @@
+---
+title: An affordable and adaptable educational escape room
+abstract: some abstract here
+---
+
+# Introduction
+- engaging students difficult
+- gamification, escape rooms
+- solution in education? efforts?
+- challenges: cost, setup time, adaptability
+- here we outline ...
+- use it yourselves, or let your students build one based on this idea: resulting in an entertaining experience and a learning experience in electronics and programming
+
+# Background
+- some info on the educational escape rooms
+
+https://www.instructables.com/id/Escaperoom
+
+# The design
+
+## Outline of the escape room
+- box with buttons and lcd screen
+- puzzles to solve, input codes
+- indication of level of completion
+- hints should be possible, but not by asking teacher
+- timer
+- resistors
+- tea box, size of ...
+
+
+
+## Materials and setup
+
+The entire setup is designed to be affordable and easy to assemble using commonly available components.
+We used a tea box with dimensions of approximately 20 x 15 x 10 cm as the enclosure for the electronics.
+However, any box of similar size can be used - it might be worthwhile to visit the local second-hand store to find a suitable box.
+We disassembled the lid of the box and used a laser cutter to create holes for the buttons, leds, buzzer, and LCD screen (the source file is included in the supplementary files), see figure {numref}`figure {number} <fig_top>`.
+
+````{figure}
+:label: fig_top
+```{figure} top1.*
+:label: fig_top1
+
+Top view of the tea box with holes for buttons, leds, buzzer, and LCD screen.
+```
+```{figure} top2.*
+:label: fig_top2
+
+Top view of the tea box with holes for buttons, leds, buzzer, and LCD screen.
+```
+````
+
+
+
+For this project, we used the Arduino Uno R3 as the main microcontroller.
+It is both affordable, widely available and has enough input and output pins to connect all the necessary components. 
+
+We included four 16 mm panel mount push buttons for user input.
+Using a series circuit with resistors, where each button is connected to a different resistor value, we can read the button presses using a single analog input pin on the Arduino, see {numref}`figure {number} <fig_circuit>`.
+This reduces the number of required pins and simplifies the wiring.
+Moreover, this system allows to easily add more buttons if needed.
+
+```{figure} circuit.*
+:label: fig_circuit
+
+Wiring diagram of the button input circuit using resistors. [circuit](@https://www.circuit-diagram.org/editor/c/5fd81e68c4b84dc39689d8260aeaba49)
+```
+
+Four green leds are required to indicate the progress of the team (though more leds can be added, optionally using a multiplexer to reduce the number of required pins). 
+A red led is used to indicate a wrong code entry, or running out of time.
+A buzzer is used to sound an alarm or, when complete, a victory tune.
+
+In this project we used the internal clock of the Arduino to keep track of time.
+Optionally, a real time clock (RTC) module can be added to keep more accurate time, especially when the device is powered off and on again.
+
+An LCD screen is used to display the timer, hints, and other information to the players.
+We opted for the LCD with integrated I2C module, which reduces the number of required pins to just two (SDA and SCL), and off course power and ground.
+
+Finally, a battery pack and on/off switch are used to power the entire setup, making it portable and easy to set up anywhere.
+
+
+
+
+## Code
+
+
+
+# Implementation
+
+
+
+# Conclusion

circuit.svg

@@ -0,0 +1,17 @@
+# See docs at: https://mystmd.org/guide/frontmatter
+version: 1
+project:
+  id: 8a478874-8f2f-4f8e-9b56-fd21507f0275
+  title: An affordable and adaptable educational escape room
+  # description:
+  keywords: [Escape room; Physics; Education; Instructable; Open Science; Open Hardware]
+  authors: 
+    - name: Freek Pols
+    - name: Koen Caspers
+  github: https://github.com/FreekPols/EscapeTheClassroom
+  # To autogenerate a Table of Contents, run "myst init --write-toc"
+site:
+  template: article-theme
+  # options:
+  #   favicon: favicon.ico
+  #   logo: site_logo.png