Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Show Application Configuration On Quick Start Page #62

Merged
merged 2 commits into from
May 15, 2024

Conversation

RushikeshPatange
Copy link
Contributor

@RushikeshPatange RushikeshPatange commented May 14, 2024

What Does This PR DO ?

This PR adds following feature:

  • This PR enables Markdown display support on the default launchpad on Quick Start page that shows the configuration on which the applications are built.

Screenshot ?

app_config

Test link ?

You can try it out at following URL:

Note: Your config file should be of following format where config_readme_url used to display config on Quick Start page

https://rushikeshpatange.github.io/esp-launchpad/?flashConfigURL=<YOUR_CONFIG_FILE_URL>

Supported TOML File Template ?

esp_toml_version = 1.0

# This should be a publicly accessible URL of the file server where your firmware binaries are available for download
firmware_images_url = "<URL to your firmware images directory>"
# Apps that you support and for which the binaries are available to publish. You can have multiple apps as a comma separated list
# The launch pad UI will automatically show these Apps in the available apps dropdown
# There should be a config section per listed App
supported_apps = ["YOUR_FIRMWARE_APP_NAME"]

# Optional: This should be a publicly accessible URL of the application configuration markdown file
# The markdown file will display the application configuration.
# It might include details such as the revisions of esp-idf, esp-matter, etc. or any other application configuration
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"]
# 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"
# Optional: Phone APP URLs if any for Playstores
android_app_url = ""
ios_app_url = ""
# Optional: URL of the Markdown file for additional information about the app
readme.text = "<URL to your Markdown file>"
# Optional: Supported console baudrate for app firmware (default value is 115200)
console_baudrate = <SUPPORTED_CONSOLE_BAUDRATE>

index.html Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants