Skip to content

Commit

Permalink
Initial stab at the web installer
Browse files Browse the repository at this point in the history
Signed-off-by: Ricardo Lanziano <ricardo.lanziano@erlang-solutions.com>
  • Loading branch information
arpunk committed May 5, 2024
1 parent 891c57b commit 0ba555f
Show file tree
Hide file tree
Showing 6 changed files with 83 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ jobs:
uses: erlef/setup-beam@v1
with:
otp-version: '26.2'
rebar3-version: '3.22.1'
rebar3-version: '3.23.0'
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Generate documentation
run: rebar3 ex_doc
run: rebar3 do compile, ex_doc
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/esp32-mkimage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
with:
otp-version: ${{ matrix.otp }}
elixir-version: ${{ matrix.elixir_version }}
rebar3-version: '3.22.1'
rebar3-version: '3.23.0'

- name: "APT update"
run: apt update -y
Expand Down
12 changes: 12 additions & 0 deletions installer/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "C3card",
"version": "v0.2.0",
"builds": [
{
"chipFamily": "ESP32-C3",
"parts": [
{ "path": "https://github.com/esl/c3card/releases/download/v0.2.0/AtomVM-c3card-esp32c3-master.img", "offset": 0 }
]
}
]
}
67 changes: 67 additions & 0 deletions markdown/installer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Installer

## Installation instructions

### Requirements

- Compatible Browsers: Chrome or Edge on Desktop. Android support is
currently not available.

- Required Drivers: Ensure your computer has the necessary drivers
installed for ESP devices.

### Step-by-Step Guide

#### Initial checklist

- Use Google Chrome or Microsoft Edge on a desktop computer to access
the installation tools.

- Confirm that your `c3card` is connected to your computer. If the
device is not recognized, you may need to install additional
drivers.

#### Install drivers if needed

- If your `c3card` is not detected, it's likely due to missing
drivers. Below are links to download drivers for the most common USB
serial chips used in ESP devices:

- **CP2102 Drivers:** [Download for Windows & Mac](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
- **CH342, CH343, CH9102 Drivers:**
- [Download for Windows](https://www.wch.cn/downloads/CH343SER_ZIP.html)
- [Download for Mac](https://www.wch.cn/downloads/CH34XSER_MAC_ZIP.html)
- **CH340, CH341 Drivers:**
- [Download for Windows](https://www.wch.cn/downloads/CH341SER_ZIP.html)
- [Download for Mac](https://www.wch.cn/downloads/CH341SER_MAC_ZIP.html)

#### Install the c3card firmware

- Follow the on-screen instructions to load the `c3card` firmware onto
your device.

#### Initial provisioning

- Check the display, which should indicate successful initialization
and WiFi details for further configuration.

#### Troubleshooting

- **Device Not Recognized:** Ensure that the correct drivers are
installed and your browser supports the ESP Web Tools.

- **Serial Port Issues:** If the serial port is not visible, this
typically indicates missing USB serial drivers. Refer to the driver
installation links provided above.

## Web installer

<div>
<script type="module"
src="https://unpkg.com/esp-web-tools@10/dist/web/install-button.js?module">
</script>

<esp-web-install-button manifest="/installer/manifest.json">
<button slot="activate">Latest version</button>
</esp-web-install-button>
</div>
File renamed without changes.
2 changes: 1 addition & 1 deletion rebar.config
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
]}.

{ex_doc, [
{extras, ["README.md", "LICENSE", "workshop.md"]},
{extras, ["README.md", "LICENSE", "markdown/workshop.md", "markdown/installer.md"]},
{main, "README.md"},
{source_url, "https://github.com/esl/c3card"},
{homepage_url, "https://github.com/esl/c3card"},
Expand Down

0 comments on commit 0ba555f

Please sign in to comment.