aboutsummaryrefslogtreecommitdiff
path: root/docs/which-hex-file.md
diff options
context:
space:
mode:
authorSelene ToyKeeper2023-12-03 17:49:25 -0700
committerSelene ToyKeeper2023-12-03 17:49:25 -0700
commit6589bea67429f8837fd555f06ab933b8950cdf38 (patch)
treeab56e4dbc8642e40145dc046601a3e79cbe5f263 /docs/which-hex-file.md
parentupdated MODELS, bin/models.py, and hw/BRANDS... (diff)
downloadanduril-6589bea67429f8837fd555f06ab933b8950cdf38.tar.gz
anduril-6589bea67429f8837fd555f06ab933b8950cdf38.tar.bz2
anduril-6589bea67429f8837fd555f06ab933b8950cdf38.zip
docs: expanded / reorganized info on Version Check formats
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.