aboutsummaryrefslogtreecommitdiff
path: root/docs/which-hex-file.md
diff options
context:
space:
mode:
authorSelene ToyKeeper2023-12-05 16:49:24 -0700
committerSelene ToyKeeper2023-12-05 16:49:24 -0700
commit50ae5684534ec9333a648794d4f371b882e53075 (patch)
treee666fea7d540632dc99643468184b519e647c12d /docs/which-hex-file.md
parentd3aa: made it easy to switch between vddio2 and external voltage divider (diff)
parentmoved version string calculation to bin/version-string.sh (diff)
downloadanduril-50ae5684534ec9333a648794d4f371b882e53075.tar.gz
anduril-50ae5684534ec9333a648794d4f371b882e53075.tar.bz2
anduril-50ae5684534ec9333a648794d4f371b882e53075.zip
Merge branch 'trunk' into emisar-d3aa
* trunk: moved version string calculation to bin/version-string.sh forgot one item in the ChangeLog ChangeLog: added 2023-12-03 release notes, converted @modelname to &modelname docs: expanded / reorganized info on Version Check formats updated MODELS, bin/models.py, and hw/BRANDS... fw3x: document how it ships with the wrong fuse values, and how to fix it github CI: fetch history too, to allow detection of version tags build-all: handle the case where "git describe" can't get any tags run CI on all branches, not just on trunk fetch tags on CI checkout, so 'git describe' can work added docs/battery-rainbow.png from old repo, since it's still relevant added bin/make-release.sh to generate a .zip file ready for release build-all.sh: re-indented, started organizing code into functions changed version number to use the latest release tag instead of build date
Diffstat (limited to 'docs/which-hex-file.md')
-rw-r--r--docs/which-hex-file.md42
1 files changed, 11 insertions, 31 deletions
diff --git a/docs/which-hex-file.md b/docs/which-hex-file.md
index d59c6bd..3847217 100644
--- a/docs/which-hex-file.md
+++ b/docs/which-hex-file.md
@@ -1,41 +1,21 @@
# How to figure out which .hex file to use
-1. Use the version check function (15 or more clicks from Off) to find out
+The name of a product is **not** enough information to find the right .hex
+file. Ask the light what firmware it needs!
+
+1. Use the Version Check function (15 or more clicks from Off) to find out
which flavor of the firmware the light has installed.
**WRITE THIS DOWN.**
2. Look up the model number in the [MODELS file](../MODELS),
to get the name and MCU type.
-3. Find the newest firmware for that model.
- https://github.com/ToyKeeper/anduril/releases
- https://toykeeper.net/torches/fsm/anduril2/?C=M;O=D
-
-If the version doesn't include a model number, you may be able to find
-the model in the PRODUCTS file to see which version it probably uses:
-
- https://bazaar.launchpad.net/~toykeeper/flashlight-firmware/anduril2/view/head:/PRODUCTS
-
-
-## Version Check Formats
-
-The Version Check function should blink out a series of numbers in one of
-several formats:
-
- - `NNNN-YYYY-MM-DD`
- Anduril 2 from 2023-05 or later.
- It's a model number and build date,
- with "buzz" flashes between sections.
- - `NNNN`: model number
- - `YYYY`: year
- - `MM`: month
- - `DD`: day
-
- - `YYYYMMDDNNNN`
- Anduril 2 from 2023-05 or earlier.
- It's a build date and model number.
+3. Find (or build) the newest firmware for that model.
+ https://github.com/ToyKeeper/anduril/releases
-- `YYYYMMDD`
- This is an old Anduril 1 version. It's just a build date.
- If the model name isn't obvious, try looking it up in the PRODUCTS file.
+The Version Check format has changed a few times. Use
+[this section of the manual](anduril-manual.md#Version_Check_Formats)
+to learn about those formats and how to use them. In most cases, it should
+have a model number and a date... and you need the model number to find the
+correct .hex file.