Sensative · dparyani · Mar 14, 2024 · Mar 14, 2024 · Mar 16, 2024 · Mar 16, 2024
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 yarn.lock
 node_modules
 install-all.sh
+.vscode/
diff --git a/README.md b/README.md
@@ -84,4 +84,18 @@ Also for this functionality the translator requires the previous translation res
 
 All this is made available in the MQTT client, which also support reformatting the output to fit your environment, and publishing it there.
 
+# Basic Translator
 
+Should you be using only a single type of unit and have no ability to set up a independent MQTT client for any reason you can instead use the simplified translators in /basic-translators/ instead of adapting the universal generated translator to your system, as that requires persistent data memory that most LNSes lack. Navigate to the folder compatible with your LNS and find your product and app version and use it in your LNS.
+
+## How to identify which version to use
+
+If you are unsure which version to use, simply chose any version of your product and join your device to the network. After the join sequence, the device will upload data on port 15, which when translated will contain a ´ruleCrc32´ value. If your device is already joined, you can trigger the device to resend the information by sending a downlink with the hex data 00 to port 15. (Note that you will have to wait for the device to send an uplink before it will accept the downlink.)
+
+When you have your CRC, compare that value to the table in vsm-translator-open-source/basic-translator/x/dots-basic-x-translator-index.csv. If your CRC is compatible with the version you already picked you're good to go, if it does not match, simply switch to the correct version and any future data will be decoded correctly.
+
+## Drawbacks to basic translators
+
+To handle large uplinks the device will normally split an uplink into multiple frames when they cannot fit in the max frame allowed by the data rate. The basic translator lacks the memory to access the previous frames and therefore this functionality will not work. This is mainly a concern for the uplink of WiFi and GNSS geopositioning scanning, however, but may in some very rare cases also affect normal data transfer on networks with very poor conditions.
+
+Any positioning data you do manage to get through will also not result in a solved position, as positioning solving requires an external service such as Semtech LoRa Cloud to function which you will have to set up seperately.
diff --git a/basic-translators/README.md b/basic-translators/README.md
@@ -0,0 +1,43 @@
+# README
+
+* The decoders for Chirpstack V3 can be found in the `chirpstack-v3` folder
+
+* The decoders for Chirpstack V4 & The Things Network (TTN) can be found in the `thethingsnetwork-chirpstack-v4` folder
+
+<br>
+
+<h3>The following decoders/translators are valid for the following applications and respective firmware version:<h3>
+
+|Product Application    |Firmware Versions                      |CRCs                                      |
+|-----------------------|---------------------------------------|------------------------------------------|
+|Airport-int            |R11 R12 R13 R14 R15                    |1695912328&#124;1872032769                     |
+|Airport-int            |R21                                    |2371105800                                |
+|Airport-int            |R20                                    |2719891747                                |
+|Airport-int            |R21                                    |3169307235                                |
+|Airport-int            |R16 R18 R19 R20                        |3532693249&#124;3625056904                     |
+|Airport-int-R6-fw-patch|R20 R21                                |1016353446                                |
+|Airport-int-R6-fw-patch|R18 R19                                |2745602166                                |
+|Default                |R11 R12 R13 R14 R15 R16 R18 R19 R20 R21|2132727044                                |
+|Digital-gpio           |R11 R12 R13 R14 R15 R16 R18 R19 R20 R21|1617091456&#124;3497448490                     |
+|Gnss-autonomous-test   |R11 R12 R13 R14 R15 R16 R18 R19 R20 R21|1815337626                                |
+|Heartstarter           |R11 R12 R13 R14 R15 R16 R18 R19 R20 R21|1727723267                                |
+|IR-proximity           |R16 R18 R19 R20 R21                    |2355202201                                |
+|Lifefinder             |R11 R12 R13 R14 R15                    |47853213&#124;3321548430                       |
+|Lifefinder-motion      |R11 R12 R13 R14 R15                    |1938827428&#124;3031484599                     |
+|Lifefinder-squad       |R11 R12 R13 R14 R15                    |399948366&#124;3505805917                      |
+|Lifefinder-wifi        |R11 R12 R13 R14 R15                    |691254335&#124;3994244140                      |
+|Lifefinder-wifi        |R16 R18 R19 R20 R21                    |2274655646                                |
+|Motion-measure         |R11 R12 R13 R14 R15 R16 R18 R19 R20 R21|2297466901                                |
+|Puck-radar             |R13 R14 R15 R16 R18 R19 R20 R21        |561898260                                 |
+|Puck-radar             |R11 R12                                |1325798073                                |
+|Puck-radar-fast-rejoin |R12                                    |729172455                                 |
+|Puck-radar-fast-rejoin |R13 R14 R15 R16 R18 R19 R20 R21        |1121182195                                |
+|Square-air             |R11 R12 R13 R14 R15                    |472391447&#124;915094797&#124;3634715455&#124;4002204643 |
+|Square-air             |R16 R18 R19 R20 R21                    |3241343967                                |
+|Square-comfort         |R14 R15 R16 R18 R19 R20 R21            |2266505222&#124;2696231198                     |
+|Square-comfort         |R11 R12 R13                            |3530880224&#124;4174894842                     |
+|Square-comfort-sound   |R11 R12 R13 R14 R15                    |517999093&#124;2338085954&#124;2387046759&#124;2766427005|
+|Square-comfort-sound   |R16 R18                                |1355326083                                |
+|Square-comfort-sound   |R19 R20 R21                            |3090458506                                |
+|Tracker                |R11 R12 R13 R14 R15 R16 R18 R19 R20 R21|489186430                                 |
+|Tracker-stats          |R11 R12 R13 R14 R15 R16 R18 R19 R20 R21|1711284143                                |
diff --git a/basic-translators/chirpstack-v3/1-dots-basic-chirpstack-v3-translators-index.csv b/basic-translators/chirpstack-v3/1-dots-basic-chirpstack-v3-translators-index.csv
@@ -0,0 +1,32 @@
+Filename,Product Application,Versions,CRCs
+chirpstack-v3/Airport-int-R11-to-R15.js,Airport-int,R11 R12 R13 R14 R15,1695912328|1872032769
+chirpstack-v3/Airport-int-R21.js,Airport-int,R21,2371105800
+chirpstack-v3/Airport-int-R20.js,Airport-int,R20,2719891747
+chirpstack-v3/Airport-int-R21.js,Airport-int,R21,3169307235
+chirpstack-v3/Airport-int-R16-to-R20.js,Airport-int,R16 R18 R19 R20,3532693249|3625056904
+chirpstack-v3/Airport-int-R6-fw-patch-R20-to-R21.js,Airport-int-R6-fw-patch,R20 R21,1016353446
+chirpstack-v3/Airport-int-R6-fw-patch-R18-to-R19.js,Airport-int-R6-fw-patch,R18 R19,2745602166
+chirpstack-v3/Default-R11-to-R21.js,Default,R11 R12 R13 R14 R15 R16 R18 R19 R20 R21,2132727044
+chirpstack-v3/Digital-gpio-R11-to-R21.js,Digital-gpio,R11 R12 R13 R14 R15 R16 R18 R19 R20 R21,1617091456|3497448490
+chirpstack-v3/Gnss-autonomous-test-R11-to-R21.js,Gnss-autonomous-test,R11 R12 R13 R14 R15 R16 R18 R19 R20 R21,1815337626
+chirpstack-v3/Heartstarter-R11-to-R21.js,Heartstarter,R11 R12 R13 R14 R15 R16 R18 R19 R20 R21,1727723267
+chirpstack-v3/IR-proximity-R16-to-R21.js,IR-proximity,R16 R18 R19 R20 R21,2355202201
+chirpstack-v3/Lifefinder-R11-to-R15.js,Lifefinder,R11 R12 R13 R14 R15,47853213|3321548430
+chirpstack-v3/Lifefinder-motion-R11-to-R15.js,Lifefinder-motion,R11 R12 R13 R14 R15,1938827428|3031484599
+chirpstack-v3/Lifefinder-squad-R11-to-R15.js,Lifefinder-squad,R11 R12 R13 R14 R15,399948366|3505805917
+chirpstack-v3/Lifefinder-wifi-R11-to-R15.js,Lifefinder-wifi,R11 R12 R13 R14 R15,691254335|3994244140
+chirpstack-v3/Lifefinder-wifi-R16-to-R21.js,Lifefinder-wifi,R16 R18 R19 R20 R21,2274655646
+chirpstack-v3/Motion-measure-R11-to-R21.js,Motion-measure,R11 R12 R13 R14 R15 R16 R18 R19 R20 R21,2297466901
+chirpstack-v3/Puck-radar-R13-to-R21.js,Puck-radar,R13 R14 R15 R16 R18 R19 R20 R21,561898260
+chirpstack-v3/Puck-radar-R11-to-R12.js,Puck-radar,R11 R12,1325798073
+chirpstack-v3/Puck-radar-fast-rejoin-R12.js,Puck-radar-fast-rejoin,R12,729172455
+chirpstack-v3/Puck-radar-fast-rejoin-R13-to-R21.js,Puck-radar-fast-rejoin,R13 R14 R15 R16 R18 R19 R20 R21,1121182195
+chirpstack-v3/Square-air-R11-to-R15.js,Square-air,R11 R12 R13 R14 R15,472391447|915094797|3634715455|4002204643
+chirpstack-v3/Square-air-R16-to-R21.js,Square-air,R16 R18 R19 R20 R21,3241343967
+chirpstack-v3/Square-comfort-R14-to-R21.js,Square-comfort,R14 R15 R16 R18 R19 R20 R21,2266505222|2696231198
+chirpstack-v3/Square-comfort-R11-to-R13.js,Square-comfort,R11 R12 R13,3530880224|4174894842
+chirpstack-v3/Square-comfort-sound-R11-to-R15.js,Square-comfort-sound,R11 R12 R13 R14 R15,517999093|2338085954|2387046759|2766427005
+chirpstack-v3/Square-comfort-sound-R16-to-R18.js,Square-comfort-sound,R16 R18,1355326083
+chirpstack-v3/Square-comfort-sound-R19-to-R21.js,Square-comfort-sound,R19 R20 R21,3090458506
+chirpstack-v3/Tracker-R11-to-R21.js,Tracker,R11 R12 R13 R14 R15 R16 R18 R19 R20 R21,489186430
+chirpstack-v3/Tracker-stats-R11-to-R21.js,Tracker-stats,R11 R12 R13 R14 R15 R16 R18 R19 R20 R21,1711284143