Review, mostly README.md.

studierendenwerk-ulm · Sep 18, 2019 · 2ceed38 · 2ceed38
1 parent bd9d44b
commit 2ceed38
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -1,24 +1,30 @@
-## Studierendenwerk Ulm
-
-[![N|Solid](https://avatars2.githubusercontent.com/u/34131127?s=200&v=4)](https://nodesource.com/products/nsolid)
-
 # JavaScript payload decoder for ZENNER's EASY PROTECT Radio smoke detector
 
+This decoder interprets the payload of ZENNER's EASY PROTECT Radio smoke detectors. It was developed to be used in The Things Network, adaption for other setups should be easy.
 
-## About
-This is a payload decoder for The Things Network to interpret the payload raw. This is based on Zenner's documentation. 
+Development was based on ZENNNER's documentation, titled:
 * LoRa radio packet definitions version 1.13
 * EASY PROTECT Radio Information for system integrators firmware v1.6.0
 
-## [Test Decoder here.](https://studierendenwerk-ulm.github.io/payload-decoder-zenner-easy-protect-radio-lora/index.html)
+Verification was done using ZENNER's EASY PROTECT Radio smoke detector FIXME.
+
+A small frontend to test the decocer is available [here](https://studierendenwerk-ulm.github.io/payload-decoder-zenner-easy-protect-radio-lora/index.html).
+
+
+## Implemented features
+
+Interpretation of packet types:
+* Synchronous packets 9.1 and 9.2 (SP9.1 and SP9.2).
+* Asynchronous packet 1 (AP1).
+
+
+## Missing features
+* Interpretation of synchronous packet 1 (SP1). Documentation, i.e. byte/bit order, is unclear.
+
 
-### Features of the decoder
-The decoder can interpret the following packet types:
-* Synchronous Package 9.1 and 9.2 -> SP9.1 & SP9.2
-* Asynchronous packet 1 -> AP1
+---
 
 
-### Planned Features
-* synchronous packet 1 -> SP1
-(The interpretation of synchronous packet 1 (SP1) has not yet been implemented. Currently the documentation there is not clear enough to implement a general interpretation.)
+**Studierendenwerk Ulm** | Aron Lanza, Simon Lüke | [Lizenz](./LICENSE)
 
+[![Logo Studierendenwerk Ulm](https://studierendenwerk-ulm.de/wp-content/themes/studentenwerk/assets/img/logo.png)](https://studierendenwerk-ulm.de/)
diff --git a/index.html b/index.html
@@ -7,9 +7,9 @@
 <body>
 
 <div class="header">
-    <h1>Here you can test your Payload Raw.</h1>
-    <p>Please enter payload_raw (Base64) from the TTN separated by spaces. <br>
-        Example: EQAAAAA= EQgAAAA= .. (delimiter is space!)"</p>
+    <h1>Here you can test raw payload.</h1>
+    <p>Please enter payload_raw (Base64), e.g. from TTN; optionally multiple separated by spaces. <br>
+        Example: EQAAAAA= EQgAAAA="</p>
 </div>
 
 Base64:<br> <label for="textInput"></label><textarea id="textInput"></textarea> <br>
@@ -96,13 +96,12 @@ <h2>input</h2>
 
 
 
+<script src="decoder.js"></script>
+
 <script>
 
 
 
-    /************************************************************************************************************
-     * The following code is for testing purposes only and does not apply to the decoder itself.
-     ************************************************************************************************************/
     function decodeFromHTML() {
         let input = document.getElementById('textInput').value;
         //let input = "EQAAAAA= EQgAAAA= EQEAAAA= ERAAAAA= EQQAAAA= ERgAAAA= EQgAAAA= ERkAAAA= oAIAfSU= oBwAYSY= oBwAdyY= oBwAcyU= oAIAaCU= oAIAaSU= oAIAfig= khwAAQIBAAEQAAhn0zJTAAA= kSwAcCUAAAAAAAA= kSoAcCYgAAAAAAA= EQQAAAA= EQwAAAA= kScBRCEhAAAAAAA= khwAAQIBAAEQAAhn0zJTAAA= oAIASSE=";
@@ -149,8 +148,5 @@ <h2>input</h2>
     }
 </script>
 
-
-<script src="decoder.js"></script>
-
 </body>
 </html>