From 5fe104ab1cb2f425ba11787a8fc2eda679085f30 Mon Sep 17 00:00:00 2001 From: keeramis Date: Tue, 3 Dec 2024 08:45:05 -0800 Subject: [PATCH] Update readme for esim --- ESIM_PROVISION.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/ESIM_PROVISION.md b/ESIM_PROVISION.md index 4105a45cb..383d77e0c 100644 --- a/ESIM_PROVISION.md +++ b/ESIM_PROVISION.md @@ -3,13 +3,13 @@ ### Pre-req 1. Input JSON (A JSON file that has a list of EIDs and their respective RSP URLs) -2. Output JSON (A blank file to store logs) +2. Output (Folder where output logs will be stored. Defaults to `esim_loading_logs` if not set) 3. lpa tool (lpa tool binary - differently built for mac and windows) -4. binaries (A folder with the user binaries) +4. binaries (Folder with the user binaries) ## Setup -### Local setup on computer +### Local folder setup on computer Put your files in this structure (for example) @@ -19,8 +19,30 @@ Put your files in this structure (for example) │ ├── esim-firmware-b5som.bin │ ├── esim-firmware-msom.bin ├── input.json -├── output.json +├── custom_output_folder/ ├── lpa +│ ├── mac +│ ├── ├── lpa +│ ├── windows +│ ├── ├── lpa.exe +``` + +### Particle CLI points to Staging +``` +$ particle update-cli --disable-updates +Automatic update checks are now disabled + +$ export PARTICLE_MANIFEST_HOST=binaries.staging.particle.io + +$ particle update-cli --version 3.30.3 +Updating the CLI to 3.30.3 +Automatic update checks are now disabled +CLI updated successfully + +$ particle --version +3.30.3 + +$ ``` ### Device Setup @@ -28,11 +50,11 @@ Put your files in this structure (for example) 1. Connect your device(s) to the computer 2. Run this command ``` -particle.js esim provision --input /path/to/input.json --output /path/to/output.json --lpa /path/to/lpa-tool --binaries /path/to/binaries --bulk true +particle.js esim provision --input /path/to/input.json --lpa /path/to/lpa-tool --binaries /path/to/binaries --bulk true ``` ### Expected Outcome -First, the device(s) are flashed. Once the download process starts on a given device, device will turn its LED into yellow. If the download passes, LED turns green. If the download failed, LED turns red. +First, the device(s) are flashed. Once the download process starts on a given device, device will turn its LED into yellow. If the download worked, LED turns green. If the download failed, LED turns red. ### Notes and Warnings 1. \ No newline at end of file