Skip to content

Commit 1dbbdea

Browse files
committed
Deployed 56cd9a4 to 0.7.0 with MkDocs 1.6.1 and mike 1.1.2
1 parent bdd3e6b commit 1dbbdea

6 files changed

Lines changed: 165 additions & 124 deletions

File tree

0.7.0/commands/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5455,7 +5455,7 @@ <h3 id="screenshot"><code>screenshot</code><a class="headerlink" href="#screensh
54555455
<p>Saves a picture of the current screen to the flash filesystem. You can retrieve it via http://&lt;ip-address&gt;/screenshot.bmp.
54565456
This can be handy for bug reporting or documentation.</p>
54575457
<p>The previous screenshot is overwritten.</p>
5458-
<p>On the <strong>Mac desktop build</strong>, the screenshot is saved as <code>screenshot.bmp</code> in the working directory. You can optionally pass a custom file path as a parameter. Press <strong>F12</strong> in the simulator window as a shortcut.</p>
5458+
<p>On the <strong>desktop builds</strong> (Mac, Linux, and headless), the screenshot is saved as <code>screenshot.bmp</code> in the working directory. You can optionally pass a custom file path as a parameter. Press <strong>F12</strong> in the simulator window as a shortcut (windowed builds only).</p>
54595459
<h3 id="service"><code>service</code><a class="headerlink" href="#service" title="Permanent link">~</a></h3>
54605460
<p>Start or stop some of the processes running on the plate.</p>
54615461
<p>Currently supported parameters:</p>

0.7.0/commands/system/index.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5226,10 +5226,14 @@ <h2 id="screenshot"><code>screenshot</code><a class="headerlink" href="#screensh
52265226
<p>Saves a picture of the current screen to the flash filesystem. You can retrieve it via http://&lt;ip-address&gt;/screenshot.bmp.
52275227
This can be handy for bug reporting or documentation.</p>
52285228
<p>The previous screenshot is overwritten.</p>
5229-
<p>On the <strong>Mac desktop build</strong>, the screenshot is saved as <code>screenshot.bmp</code> in the working directory. You can optionally pass a custom file path as a parameter.</p>
5229+
<p>On the <strong>desktop builds</strong> (Mac, Linux, and headless), the screenshot is saved as <code>screenshot.bmp</code> in the working directory. You can optionally pass a custom file path as a parameter.</p>
52305230
<div class="admonition tip">
52315231
<p class="admonition-title">Tip</p>
5232-
<p>Press <strong>F12</strong> in the simulator window to take a screenshot without using MQTT.</p>
5232+
<p>Press <strong>F12</strong> in the simulator window to take a screenshot without using MQTT (windowed builds only).</p>
5233+
</div>
5234+
<div class="admonition note">
5235+
<p class="admonition-title">Headless build</p>
5236+
<p>The <code>linux_headless</code> build supports screenshots via MQTT without any display server or SDL2 dependency. This makes it suitable for CI/CD pipelines, Docker containers, and headless servers.</p>
52335237
</div>
52345238
<h2 id="service"><code>service</code><a class="headerlink" href="#service" title="Permanent link">~</a></h2>
52355239
<p>Start or stop some of the processes running on the plate.</p>

0.7.0/firmware/compiling/local/index.html

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3196,6 +3196,17 @@
31963196
</span>
31973197
</a>
31983198

3199+
</li>
3200+
3201+
<li class="md-nav__item">
3202+
<a href="#headless-linux-build" class="md-nav__link">
3203+
<span class="md-ellipsis">
3204+
3205+
Headless Linux build
3206+
3207+
</span>
3208+
</a>
3209+
31993210
</li>
32003211

32013212
<li class="md-nav__item">
@@ -5108,6 +5119,17 @@
51085119
</span>
51095120
</a>
51105121

5122+
</li>
5123+
5124+
<li class="md-nav__item">
5125+
<a href="#headless-linux-build" class="md-nav__link">
5126+
<span class="md-ellipsis">
5127+
5128+
Headless Linux build
5129+
5130+
</span>
5131+
</a>
5132+
51115133
</li>
51125134

51135135
<li class="md-nav__item">
@@ -5232,10 +5254,25 @@ <h3 id="mcu-environments">MCU Environments<a class="headerlink" href="#mcu-envir
52325254
<p><img alt="Build All" src="../images/build_all.png" /></p>
52335255
<p>You can now run "Build" or "Build All" in PlatformIO to compile (all) the firmware.</p>
52345256
<h3 id="native-linux-build">Native Linux build<a class="headerlink" href="#native-linux-build" title="Permanent link">~</a></h3>
5235-
<p>For native linux_sdl builds, you also need:
5257+
<p>For native <code>linux_sdl</code> builds (with GUI window), you also need:
52365258
<div class="highlight"><pre><span></span><code>sudo apt update
52375259
sudo apt install build-essential libsdl2-dev
52385260
</code></pre></div></p>
5261+
<h3 id="headless-linux-build">Headless Linux build<a class="headerlink" href="#headless-linux-build" title="Permanent link">~</a></h3>
5262+
<p>The <code>linux_headless</code> build runs without any display server or SDL2 dependency. It uses a null display driver with an in-memory framebuffer, making it ideal for CI/CD pipelines, Docker containers, and headless servers. Screenshots are captured via MQTT.</p>
5263+
<p>No extra system packages are needed beyond a C++ compiler:
5264+
<div class="highlight"><pre><span></span><code>sudo apt update
5265+
sudo apt install build-essential
5266+
</code></pre></div></p>
5267+
<p>Uncomment <code>user_setups/linux/*.ini</code> in your <code>platformio_override.ini</code>, then:
5268+
<div class="highlight"><pre><span></span><code>pio run -e linux_headless
5269+
</code></pre></div></p>
5270+
<p>Run the headless binary:
5271+
<div class="highlight"><pre><span></span><code>./program -c /path/to/config
5272+
</code></pre></div></p>
5273+
<p>Take a screenshot via MQTT:
5274+
<div class="highlight"><pre><span></span><code>mosquitto_pub -t &quot;hasp/&lt;plate&gt;/command/screenshot&quot; -m &quot;/path/to/screenshot.bmp&quot;
5275+
</code></pre></div></p>
52395276
<h3 id="native-macos-build">Native MacOS build<a class="headerlink" href="#native-macos-build" title="Permanent link">~</a></h3>
52405277
<p>For native darwin_sdl builds, you also need <a href="https://brew.sh">Homebrew</a>:</p>
52415278
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>brew<span class="w"> </span>install<span class="w"> </span>gcc<span class="w"> </span>sdl2

0.7.0/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)