Merge pull request #6 from simonthorell/setup

Change report template
simonthorell · Feb 7, 2024 · 11fe025 · 11fe025
2 parents 3a595c8 + 44f67d7
commit 11fe025
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 9 deletions.
diff --git a/docs/REPORT.md b/docs/REPORT.md
@@ -1,8 +1,11 @@
 # Wireless Protocols Report
 
 ### Purpose of the Report
-Explain the importance of selecting the appropriate wireless protocol for IoT devices.
-State the goal of the report, which is to compare WiFi, Bluetooth, Bluetooth LE, Zigbee, Z-Wave, and NFC based on specific parameters. 
+This report aims to guide in selecting wireless communication protocols for IoT
+devices, focusing on efficiency, cost, scalability, and reliability. We compare
+WiFi, Bluetooth, Bluetooth LE, Zigbee, Z-Wave, and NFC across various parameters
+such as range, data rate, power consumption, and security, to aid stakeholders
+in making informed decisions for IoT applications.
 
 ### Areas to Investigate
 - Protocol Cverwiev
@@ -137,4 +140,24 @@ Some text...
 ### Other Considerations for IoT
 1) List item
 2) List item
-3) List item
+3) List item
+
+<BR>
+
+## Report Summary
+
+- **WiFi** emerges as the go-to choice for high-bandwidth applications requiring internet access, 
+although at the cost of higher power consumption.
+- **Bluetooth** and **Bluetooth LE** offer versatility, with BLE being particularly advantageous 
+for battery-operated devices due to its low energy profile.
+- **Zigbee** and **Z-Wave** stand out in creating extensive, low-power mesh networks, 
+ideal for home automation and sensor networks.
+- **NFC** offers a unique niche in close-proximity, secure transactions and data exchange.
+
+### Conclusion: Choosing the Right Wireless Protocol for IoT
+
+Selecting a wireless protocol is crucial, with each serving specific IoT needs.
+The choice hinges on application, range, throughput, power, and interoperability.
+This report aims to help IoT developers in making protocol choices, the key to efficient and
+scalable IoT solutions. Embracing the right protocol is strategic, essential for
+IoT innovation and advancement.
diff --git a/docs/REPORT.stub b/docs/REPORT.stub
@@ -1,8 +1,11 @@
 # Wireless Protocols Report
 
 ### Purpose of the Report
-Explain the importance of selecting the appropriate wireless protocol for IoT devices.
-State the goal of the report, which is to compare WiFi, Bluetooth, Bluetooth LE, Zigbee, Z-Wave, and NFC based on specific parameters.
+This report aims to guide in selecting wireless communication protocols for IoT
+devices, focusing on efficiency, cost, scalability, and reliability. We compare
+WiFi, Bluetooth, Bluetooth LE, Zigbee, Z-Wave, and NFC across various parameters
+such as range, data rate, power consumption, and security, to aid stakeholders
+in making informed decisions for IoT applications.
 
 ### Areas to Investigate
 - Protocol Cverwiev
@@ -12,14 +15,34 @@ State the goal of the report, which is to compare WiFi, Bluetooth, Bluetooth LE,
 - Other Considerations for IoT
 
 ### Authors
-Simon Thorell, Erik Pettersson, Nathan Tewelde Bahta, Milad Isho Saeb and Abdihakim Abdisamad Roble.
+Simon Thorell, Erik Pettersson, Nathan Tewelde Bahta, 
+Milad Isho Saeb and Abdihakim Abdisamad Roble.
 
 ### Download the report: [PDF](https://github.com/simonthorell/wl-protocols-report/pdfs/REPORT.pdf)
 
-
 {WIFI}
 {BLUETOOTH}
 {BLUETOOTH_LE}
 {ZIGBEE}
 {ZWAVE}
 {NFC}
+
+<BR>
+
+### Protocol Summaries
+
+- **WiFi** emerges as the go-to choice for high-bandwidth applications requiring internet access, 
+although at the cost of higher power consumption.
+- **Bluetooth** and **Bluetooth LE** offer versatility, with BLE being particularly advantageous 
+for battery-operated devices due to its low energy profile.
+- **Zigbee** and **Z-Wave** stand out in creating extensive, low-power mesh networks, 
+ideal for home automation and sensor networks.
+- **NFC** offers a unique niche in close-proximity, secure transactions and data exchange.
+
+### Conclusion: Choosing the Right Wireless Protocol for IoT
+
+Selecting a wireless protocol is crucial, with each serving specific IoT needs.
+The choice hinges on application, range, throughput, power, and interoperability.
+This report aims to help IoT developers in making protocol choices, the key to efficient and
+scalable IoT solutions. Embracing the right protocol is strategic, essential for
+IoT innovation and advancement.
diff --git a/scripts/create_report.py b/scripts/create_report.py
@@ -20,15 +20,15 @@ def main():
 
     first_replacement = True
     # List of protocol names to replace in the stub
-    protocols = ['WIFI', 'BLUETOOTH', 'BLUETOOTH LE', 'ZIGBEE', 'ZWAVE', 'NFC']
+    protocols = ['WIFI', 'BLUETOOTH', 'BLUETOOTH_LE', 'ZIGBEE', 'ZWAVE', 'NFC']
 
     # Replace each placeholder with the corresponding markdown content
     for protocol in protocols:
         content = load_protocol_content(protocol, protocols_path=protocols_path)
         # Add a new line between each markdown file content
         if first_replacement:
             # For the first replacement, remove the leading newline to avoid an extra line at the beginning
-            content = content.lstrip("\n")
+            content = content.lstrip("\n<br/>\n")
             first_replacement = False
         report_content = report_content.replace(f'{{{protocol}}}', content)