From ce716abb4fcc235e0e0eac2c2628d3c9a7a21082 Mon Sep 17 00:00:00 2001 From: Felix Grzelka Date: Sat, 3 Feb 2024 00:32:41 +0100 Subject: [PATCH] restructure table, add more infos --- Binary-file-nomenclature.md | 73 ++++++++++++++++++++++++------------- 1 file changed, 48 insertions(+), 25 deletions(-) diff --git a/Binary-file-nomenclature.md b/Binary-file-nomenclature.md index 0226739..09bd4bd 100644 --- a/Binary-file-nomenclature.md +++ b/Binary-file-nomenclature.md @@ -21,61 +21,84 @@ OpenEPaperLink_Mini_AP.bin For Tag binaries as found in `binaries/Tag` the filename consists of: ~~~ -_[]_.bin +_[]_.bin ~~~ -### Nameoftag -The name of the tag as found in tag_types.h -Which follows the scheme +The AP's auto update function uses the mapping defined in [`tagotaversions.json`](https://github.com/jjwbruijn/OpenEPaperLink/blob/master/binaries/Tag/tagotaversions.json) to select the right firmware for OTA updates based on the `hwType`, as defined in [`tag_types.h`](https://github.com/jjwbruijn/OpenEPaperLink/blob/master/tag_types.h). + +### Overview + +| Model | MAC ID | Firmware | +| ----- | ------ | -------- | +| 1.54″‐1.6″ ST-GR16000 | 341 | `SOL_M2_154_SSD_.bin` | +| 1.54″‐1.6″ ST-GR160BN | 343 | ? | +| 1.54″‐1.6″ ST-GR1600N | 163 | ? | +| 2.2″ EL022H3WRA | B19 | `SOL_M3_Uni__.bin` | +| 2.7″ ST‐GR27000 | 2F3 | ? | +| 2.9″ EL029D2WRA SubGHz | B23 | not (yet) supported | +| 2.9″ EL029GSWRN | B27 | work in progress | +| 2.9″ EL029H3WRA | B29 | `SOL_M3_Uni__.bin` | +| 2.9″ ST-GM29XXF Low Temp | 2D1 | `SOL_M2_29_LT_.bin` | +| 2.9″ ST‐GR29000 | 3B1 | `SOL_M2_29_SSD_.bin` | +| 2.9″ ST-GR2900N | 3B3 | `SOL_M2_29_UC_.bin` | +| 2.9″ ST-GR2900L | 3B3 | ? | +| 4.2″ ST-GR42003N2 | 483 | `SOL_M2_42_SSD_.bin` | +| 4.2″ ST-GR42003N | 411 | ? | +| 4.2″‐ST‐GR4200C | B57 | ? | +| 7.5″ ST‐GR750BN | 743 | `SOL_M2_75__.bin` | +| 13.3″ EL133C2WRN | BB7 | not (yet) supported | + +### Tag-Name +The name of the tag as found in [`tag_types.h`](https://github.com/jjwbruijn/OpenEPaperLink/blob/master/tag_types.h). +It is composed of the following parts: + ~~~ ___ ~~~ -Examples: +Examples: ~~~ SOL_M2_29_SSD_15.bin -# Firmware for a 2.9" ZBS based tags with no mods to be put on the tag with version 15 +# Firmware for a 2.9″ ZBS based tags with no mods to be put on the tag with version 15 SOL_M3_Uni_full_16.bin -# Firmware to flash a M3 2.9" tag with version 16 +# Firmware to flash a M3 2.9″ tag with version 16 ~~~ #### Manufacturer - SOL => SOLUM -- TLSR => ? +- TLSR => Controller used by the Hanshow 3.5″ tag #### Brand - M2 => Solum M2 Model -- M3 => Solum M3 Model +- M3 => M3 Newton 2.2″ Electronic Shelf Label by Solum #### Display Size + +The firmware for M3 tags is universal for all display sizes. + - 154 => 1.54″ - 29 => 2.9″ - 42 => 4.2″ - 29 => 2.9″ - 75 => 7.5″ +- uni => universal firmware for all sizes of M3 tags -#### Display Controller +#### [Optional] Display Controller + +Only used by M2 firmware. - SSD => used for most common "normal" tags: ST‐GR16000, ST-GR29000 - LT => used for low temperature tags -- UC => used for nfc enabled tags +- UC => used for NFC enabled tags -| Model | MAC ID | Firmware | -| ----- | ------ | -------- | -|ST-GR16000 | 341 | `SOL_M2_154_SSD_.bin` | -|ST-GR160BN | 343 | ? | -|ST-GR1600N | 163 | ? | -|ST-GR29000 | 3B1 | `SOL_M2_29_SSD_.bin` | -|ST-GR2900N | 3B3 | `SOL_M2_29_UC_.bin` | -|ST-GM29XXF | 2D1 | `SOL_M2_29_LT_.bin` | -|ST-GR42003N2| 483 | `SOL_M2_42_SSD_.bin` ? | -|ST-GR750BN | 743 | `SOL_M2_75__.bin` | +#### [Optional] Full or OTA -### Full or OTA -Some tags have different files for OTA and direct to tag flashing. If this this is the case, this part can be `full` or `ota`. -If not, this field is not present. +Some tags have different files for OTA and direct to tag flashing. +If this this is the case, this part can be `full` or `ota`. +This mainly concerns M3 tags and the M2 7.5″ ST‐GR750BN. +For most M2 tags there is only one binary, which can be used in both cases. ### Version -The version of the firmware in hex format, always 2 digits. +The version of the firmware in hex format, always 2 digits.