Skip to content

Commit

Permalink
Update readme for esim
Browse files Browse the repository at this point in the history
  • Loading branch information
keeramis committed Dec 3, 2024
1 parent d541648 commit e55de05
Showing 1 changed file with 37 additions and 6 deletions.
43 changes: 37 additions & 6 deletions ESIM_PROVISION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -19,20 +19,51 @@ 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

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.

### After testing

Return to using particle-cli for production

$ export PARTICLE_MANIFEST_HOST=binaries.particle.io
$ particle update-cli --enable-updates
$ particle update-cli
$ particle --version

### Notes and Warnings
1.

0 comments on commit e55de05

Please sign in to comment.