Skip to content

Commit

Permalink
feat(launchpad): add launchpad support devkit and readme (#64)
Browse files Browse the repository at this point in the history 
* feat(launchpad): add launchpad support devkit and readme

* feat(esp_launchpad): added some enhancement in devkit selection logic and defined developKitsContainer
  • Loading branch information
@lijunru-hub
lijunru-hub authored Jul 22, 2024
1 parent a3db340 commit 34b1cf1
Show file tree
Hide file tree
Showing 4 changed files with 238 additions and 40 deletions.
9 changes: 8 additions & 1 deletion config/config.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,18 @@ config_readme_url = "<APP_CONFIG_README_FILE_URL>"

[YOUR_FIRMWARE_APP_NAME]
# ESP32 Chipsets for which you have a supported Firmware App. Define a property for each supported chipset in the given format.
chipsets = ["ESP32", "ESP32-S2", "ESP32-C3"]
chipsets = ["ESP32", "ESP32-S2", "ESP32-C3", "ESP32-S3"]
# Optional: Set development board for chip model.
developKits.esp32-s3 = ["esp32-s3-box", "esp32-s3-box3"]
# Configure the name of the binary file
image.esp32 = "SINGLE_BIN_FOR_ESP32.bin"
image.esp32-s2 = "SINGLE_BIN_FOR_ESP32-S2.bin"
image.esp32-c3 = "SINGLE_BIN_FOR_ESP32-C3.bin"
# Optinal: Configure the name of the image file for development board. Under this configuration, image.esp32-s3 will become invalid..
image.esp32-s3-box = "SINGLE_BIN_FOR_ESP32-S3-BOX.bin"
image.esp32-s3-box3 = "SINGLE_BIN_FOR_ESP32-S3-BOX3.bin"
# Optional: A brief introduction to this app.
description = "Description of the firmware app"
# Optional: Phone APP URLs if any for Playstores
android_app_url = ""
ios_app_url = ""
Expand Down
27 changes: 20 additions & 7 deletions css/custom.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@

.navbar-nav .nav-item .icon {
opacity: 0.8;
}
}

.navbar-nav .nav-item.active .icon
.navbar-nav .icon:hover {
Expand Down Expand Up @@ -146,7 +146,7 @@ footer {
}

.form .field-container .field select {

padding: 0.5em 3.5em 0.5em 1em;
border: 1px solid var(--bs-gray-600);
border-radius: 5px;
Expand Down Expand Up @@ -177,7 +177,7 @@ footer {
}

.app-button.submit-form-button {

}

.main-page-tab-panel {
Expand Down Expand Up @@ -211,7 +211,7 @@ td img {
}

.xterm .xterm-viewport {
width: initial !important;
width: initial !important;
}

/* About sections css */
Expand Down Expand Up @@ -254,10 +254,23 @@ td img {
display: none;
}

.appdescription-text {
max-width: 25rem;
max-height: 30rem;
word-wrap: break-word;
}

.appinfocontainer {
max-height: 400px;
overflow-y: auto;
margin-top: 3rem;
max-height: 600px;
overflow-y: auto;
margin-top: 3rem;
width: 100%;
}

.appinfo-flash-container {
max-height: 600px;
overflow-y: auto;
margin-top: 3rem;
}

.app-config-info-container {
Expand Down
53 changes: 41 additions & 12 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h4 class="topic" data-target-tab-panel-id="about">
<span>DIY</span>
</button>
</li>

<li class="nav-item">
<button class="nav-link icon-button" id="connectButton">
<img src="assets/icons/connect.png" class="icon" />
Expand All @@ -127,7 +127,7 @@ <h4 class="topic" data-target-tab-panel-id="about">
<span>Disconnect</span>
</button>
</li>

<li class="nav-item" data-role="nav-menu-tab" data-target-tab-panel-id="console">
<button class="nav-link icon-button" id="v-pills-console-tab">
<img src="assets/icons/console.png" class="icon" />
Expand Down Expand Up @@ -200,11 +200,40 @@ <h5 class="pt-4 pb-2 lh-lg"><span id="qtLabel">Choose from some of ESP's pre-bui
</div>
</div>
</div>
<div class="field-container" id ="developKitsContainer" style="display: none">
<label>
ESP Develop Kits
</label>
<div class="field">
<div id="developKits">
<div class="form-check-inline">
<label class="form-check-label" for="radio3">ESP32-S3-DevKits&nbsp;
<input type="radio" checked class="form-check-input" name="developKitsType" id="radio3" value="">
</label>
</div>
<div class="form-check-inline">
<label class="form-check-label" for="radio4">ESP32-S3-DevKits&nbsp;
<input type="radio" class="form-check-input" name="developKitsType" id="radio4" value="">
</label>
</div>
</div>
</div>
</div>
<div class="field-container" id="appDescriptionContainer" style="display: none; align-items: baseline;">
<label>
Application Description
</label>
<span class="appdescription-text" id="appDescription">
</span>
</div>
<div class="field-container">
<div class="field-container" title="Click on 'Connect' button in top Menu" style="display:inline-block" data-toggle="tooltip" id="flashWrapper">
<button class="app-button submit-form-button btn btn-outline-dark" id="flashButton" disabled>Flash</button>
</div>
</div>
<div class="appinfocontainer col-6" id="appInfoContainer" style="display:none;">
<div id="appInfo"></div>
</div>
</div>
<div class="card text-dark bg-light app-config-info-container" id="appConfigInfoContainer" style="display: none;">
<div class="card-header">Application Configuration&colon;</div>
Expand Down Expand Up @@ -239,9 +268,9 @@ <h5 class="pt-4 pb-2 lh-lg"><span id="qtLabel">Choose from some of ESP's pre-bui
<div class="container tabs-section main-page-tab-panel" data-tab-panel-id="diy">
<h5 class="pt-4 pb-2 lh-lg">Choose your own built firmware image from the local storage to flash and use.</h5>
<br>
<input class="btn btn-danger btn-sm" type="button" id="eraseButton" value="Erase Flash" data-toggle="tooltip"
<input class="btn btn-danger btn-sm" type="button" id="eraseButton" value="Erase Flash" data-toggle="tooltip"
data-placement="top" title="Erase firmware on your device"/>

<div class="alert alert-danger alert-dismissible fade-in-down" id="alertDiv" style="display:none; margin-top:10px">
<a href="#" class="close" aria-label="close" onclick="$('.alert').hide()">&times;</a>
<span id="alertmsg"></span>
Expand Down Expand Up @@ -277,11 +306,11 @@ <h5 class="pt-4 pb-2 lh-lg">Choose your own built firmware image from the local
</div>
<!-- DIY tab content - end -->

<!-- Console tab content - start -->
<!-- Console tab content - start -->
<div class="container main-page-tab-panel" data-tab-panel-id="console">
<div class="row" id="consolePageWrapper">
<div class="appinfocontainer col-6" id="appInfoContainer" style="display:none;">
<div id="appInfo"></div>
<div class="appinfo-flash-container col-6" id="appInfoFlashContainer" style="display:none;">
<div id="appInfoFlash"></div>
</div>
<div class="col-12 fade-in-down" id="terminalContainer" style="display:none;">
<div class="button-container text-end mb-sm-3">
Expand All @@ -295,9 +324,9 @@ <h5 class="pt-4 pb-2 lh-lg">Choose your own built firmware image from the local
</div>
</div>
</div>

<!-- Console tab content - end -->

<!-- Settings tab content - start -->
<div class="container main-page-tab-panel" data-tab-panel-id="settings">
<div class="row">
Expand Down Expand Up @@ -347,7 +376,7 @@ <h5 class="pt-4 pb-2 lh-lg">Choose your own built firmware image from the local
</i>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -411,7 +440,7 @@ <h4 class=" mb-4" style="color: #e63f36;"><b>Publish your own firmware apps</b><
this firmware. A sample TOML config file can be viewed <a href="https://espressif.github.io/esp-launchpad/config/config.toml"> here </a> </p>

<p>Rest of the flashing procedure is same easy 4 step process as the Quick Start one above.</p>

<p>Once ready, you can use the following image and add following html code on your website for supporting ESPaunchpad with your configuration.
Edit the query parameter in the href, replacing URL_TO_YOUR_CONFIG_TOML value where your TOML config file is hosted.
</p>
Expand All @@ -432,7 +461,7 @@ <h4 class=" mb-4" style="color: #e63f36;"><b>Publish your own firmware apps</b><
</div>
<!-- About us tab content - end -->
</div>

<!-- Safari & FireFox not supported error message-->
<div id="unsupportedBrowserErr" style="display:none"><p align="center" style="color:red">
This tool is not supported on Safari & Firefox browsers yet! Please try using another browser like Google Chrome.
Expand Down
Loading

0 comments on commit 34b1cf1

Please sign in to comment.