Merge pull request #41 from coelner/master

Aypac · web-flow · commit 102b9b41be78 · 2021-06-18T21:05:21.000+02:00
Add TAM status example
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+Hi and welcome!
+Before opening a bug-related issue, please check on the [wiki](https://github.com/Aypac/Arduino-TR-064-SOAP-Library/wiki) if you can resolve the bug yourself. A surprising number of problems ultimately turn out not to be related to this library, in that case it is wasting everyone's time to open an issue here. (This should not keep you from opening one, once you checked all you options in the wiki!)
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected/Attempted behavior**
+A clear and concise description of what you wanted to achieve/expected to happen.
+
+**To Reproduce**
+Shot relevant code segments. Use the (code-formatting markdown)[https://guides.github.com/features/mastering-markdown/] please!
+
+**Logs**
+If applicable, add logs to help explain your problem. Use
+`<details><summary>(Click to show)</summary>```looooong log```</details>`
+to keep it readable.
+
+**µController**
+ - Which chip and board are you using?
+
+**Router model and firmware version**
+- Brand, model and firmware version of the router you are using.
+
+**Related issues**
+Please check if you can find any other [issues here](https://github.com/Aypac/Arduino-TR-064-SOAP-Library/issues) that might be related to this one.
diff --git a/.travis.yml b/.travis.yml
@@ -13,7 +13,7 @@ git:
   quiet: true
 env:
   global:
-     - ARDUINO_IDE_VERSION="1.8.11"
+     - ARDUINO_IDE_VERSION="1.8.13"
      - PRETTYNAME="Arduino TR-064 Library"
 # Optional, will default to "$TRAVIS_BUILD_DIR/Doxyfile"
 #    - DOXYFILE: $TRAVIS_BUILD_DIR/Doxyfile
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # Arduino-TR-064-SOAP-Library [![Build Status](https://travis-ci.com/Aypac/Arduino-TR-064-SOAP-Library.svg?branch=master)](https://travis-ci.com/Aypac/Arduino-TR-064-SOAP-Library)
-Arduino library to facilitate the use of the TR-064 protocol ([definition](https://www.broadband-forum.org/technical/download/TR-064.pdf) and [description](https://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/AVM_TR-064_first_steps.pdf)), most commonly used by Fritz!Box.
+Arduino library to facilitate the use of the TR-064 protocol ([my "simple" explanation](https://github.com/Aypac/Arduino-TR-064-SOAP-Library/wiki/How-does-the-TR-064-protocol-work%3F), the [definition](https://www.broadband-forum.org/technical/download/TR-064.pdf) and an official [description](https://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/AVM_TR-064_first_steps.pdf)), most commonly used by Fritz!Box.
 
 This library has been developed on an ESP8266 and tested on an ESP32.
 
@@ -8,7 +8,7 @@ To get started, I recommend to check out the [examples folder](https://github.co
 If you still have question please don't hesistate to [open an issue here on Github](https://github.com/Aypac/Arduino-TR-064-SOAP-Library/issues/new). If you made something cool with this library please provide it as an example. Please create a pull request (or, if you don't know how, [an issue](https://github.com/Aypac/Arduino-TR-064-SOAP-Library/issues/new)) to do that.
 
 ## Installation and usage
-Simply go to `Tools→Manage Libraries...` in the Arduino IDE and search for `TR-064`. Press install. The examples can then also be found in the IDE under `Examples→TR-064 SOAP Library`.
+Simply go to `Tools → Manage Libraries...` in the Arduino IDE and search for `TR-064`. Press install. The examples can then also be found in the IDE under `Examples → TR-064 SOAP Library`.
 
 Don't forget that you also need to [add the board you are using to the IDE](https://learn.adafruit.com/add-boards-arduino-v164/setup); 
 <details><summary>Example board URLs</summary>
@@ -31,6 +31,7 @@ If you know more/have tested a device not on the list, please let me know!
 				<li> Fritz!Box 7490 (tested by Dirk Kaben)</li>
 				<li> Fritz!Box 7580</li>
 				<li> Fritz!Box 7590</li>
+				<li> FRITZ!Box 6590 Cable (tested by <a href='https://github.com/jipp'>Wolfgang (jipp)</a>)</li>
 				<li> Fritz!Box 5490 (<a href='https://github.com/Aypac/Arduino-TR-064-SOAP-Library/issues/21'>not finally confirmed</a>, tested by <a href='https://github.com/Paul760'>Paul760</a>)</li>
 				<li> FRITZ!DECT 200 (tested by Oliver-André Urban)</li>
 				<li> FRITZ!DECT 210 (test by Thorsten Godau)</li>
@@ -60,21 +61,20 @@ Some of the old issues are:
 ### Library
 
 * Add yield()'s (where sensible)
-* figure out the occasional crashes (might be fixed, but please report if still encountered)
-* Make code more efficient
 * Do some (better) error-handeling
   * Return proper errors
-* Add some more comments
-* Create a sophisticated debug/verbose mode (and silence the non-debug mode!)
+* Reduce occasional crashes (should be fixed, but please report if still encountered)
+* Should some of the calls of the examples be included into the library?
 
 ### Examples
 
 * Add yield()'s (where sensible)
+* Try to find a way to externalize the settings (WIFI etc)
 * Add a few more nice examples
   * turning on/off (guest) wifi
-  * read out and display connection speed
+  * read out connection speed
   * alternate WPS button
-  * Emergency dial-up to relatives or emergency services
+  * emergency dial-up to relatives or emergency services
   * recognize when devices (like washing machines) are done (along the lines of [this](https://github.com/dl9sec/ArduinoSIP/tree/master/examples/LaundryNotifier)
   * Start devices through e.g. telegram messages (e.g. coffee machine, washing machine, ...)
 * WhoIsHomeIndicator
@@ -83,10 +83,11 @@ Some of the old issues are:
 * Extend doorbell example to also send telegram messages :)
 
 <hr />
-<center>
-	<table>
+
+<p align="justify" style="text-align:justify;">
+	<table style="text-align:center;">
 		<tr><td>◽</td><td>◾</td><td>◽</td></tr>
 		<tr><td>◾</td><td>◽</td><td>◽</td></tr>
 		<tr><td>◾</td><td>◾</td><td>◾</td></tr>
 	</table>
-</center>
+</p>
diff --git a/examples/M5StickC-fritzbox-TAM/M5StickC-fritzbox-TAM.ino b/examples/M5StickC-fritzbox-TAM/M5StickC-fritzbox-TAM.ino
@@ -0,0 +1,139 @@
+/*
+   M5StickC as simple ON/OFF switch for the TAM
+
+   https://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/AHA-HTTP-Interface.pdf
+   https://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/x_tam.pdf
+
+*/
+//#define M5Stick_C //uncomment this line if the board match
+#if defined(M5Stick_C)
+
+#include <M5StickC.h>
+#include <tr064.h>
+
+
+const char* WIFI_SSID = "your SSID here";
+const char* WIFI_PASS = "the wifi password";
+const char* FRITZBOX_AIN = "admin"; //admin if no username is used
+const char* FRITZBOX_PASS = "einsElfELF!!11";
+const String FRITZBOX_DOMAIN = "fritz.box";
+const int PORT = 49000;
+const unsigned long UPDATE_INTERVAL = 10000UL; //Check TAM switch every 10 seconds
+
+unsigned long lastConnection = 0;
+
+TR064 connection(PORT, FRITZBOX_DOMAIN, FRITZBOX_AIN, FRITZBOX_PASS);
+
+void setup() {
+  M5.begin();
+  pinMode(M5_BUTTON_HOME, INPUT);
+
+  Serial.begin( 115200 );
+  if (Serial) Serial.print("ESP Board MAC Address:  ");
+  if (Serial) Serial.println(WiFi.macAddress());
+  M5.Lcd.fillScreen(WHITE);
+
+  M5.Lcd.setRotation(3);
+  M5.Lcd.setCursor(2, 10);
+  M5.Lcd.setTextColor(BLACK);
+  M5.Lcd.setTextSize(2);
+  M5.Lcd.print(WiFi.macAddress());
+  M5.Lcd.setTextSize(12);
+
+  if (connectWiFi()) {
+    if (Serial) Serial.println( "WiFi connection established" );
+    M5.Lcd.fillScreen(ORANGE);
+    M5.Lcd.setCursor(15, 15);
+    M5.Lcd.print("---");
+    delay(100);
+    if (Serial) Serial.println("Initialize TR-064 connection");
+    connection.debug_level = DEBUG_WARNING; //DEBUG_VERBOSE; //0: None, 1: Errors, 2: Warning, 3: Info, 4: Verbose
+    connection.init();
+  }
+}
+
+void loop() {
+  M5.update();
+  yield();
+  connectWiFi();
+  unsigned long int now = millis();
+  if ( (now - lastConnection) > UPDATE_INTERVAL ) {
+    if (Serial) Serial.print("Routine TAM check: ");
+    if (Serial) Serial.println(refreshScreen(getABStatus() == 1) ? "ON" : "OFF");
+    lastConnection = millis();
+  }
+  if (M5.BtnA.wasPressed()) {
+    ButtonACallback();
+  }
+}
+
+
+bool connectWiFi() {
+  if ( WiFi.status() == WL_CONNECTED ) {
+    return true;
+  }
+  else {
+    WiFi.mode( WIFI_STA );
+    WiFi.begin( WIFI_SSID, WIFI_PASS );
+
+    if ( WiFi.waitForConnectResult() != WL_CONNECTED ) {
+      if (Serial) Serial.println( "WiFi connection failed" );
+      M5.Lcd.fillScreen(ORANGE);
+      M5.Lcd.setTextColor(WHITE);
+      M5.Lcd.setCursor(15, 15);
+      M5.Lcd.print("ERR");
+      return false;
+    }
+    return true;
+  }
+}
+
+int getABStatus() {
+  String params[][2] = {"NewIndex", "0"};
+  int a = 1;
+  String req[][2] = {"NewEnable", "0"};
+  int b = 1;
+  connection.action("urn:dslforum-org:service:X_AVM-DE_TAM:1", "GetInfo", params, a, req, b);
+  return req[0][1].toInt();
+}
+
+bool switchABStatus() {
+  int currentValue = getABStatus();
+  int newValue = (currentValue == 1) ? 0 : 1;
+  String params[][2] = {{"NewIndex", "0"}, {"NewEnable", String(newValue)}};
+  int a = 2;
+  connection.action("urn:dslforum-org:service:X_AVM-DE_TAM:1", "SetEnable", params, a);
+  return (getABStatus() == newValue) ? true : false;
+}
+
+void ButtonACallback() {
+  if (Serial) Serial.print("Switch TAM Status: ");
+  if (Serial) Serial.println((switchABStatus()) ? "success" : "fail");
+  refreshScreen(getABStatus());
+  return;
+}
+
+int refreshScreen(int value) {
+  if (value == 1) {
+    M5.Lcd.setTextColor(BLACK);
+    M5.Lcd.fillScreen(TFT_DARKGREEN);
+    M5.Lcd.setCursor(15, 15);
+    M5.Lcd.print("ON");
+  }
+  else {
+    M5.Lcd.setTextColor(WHITE);
+    M5.Lcd.fillScreen(TFT_RED);
+    M5.Lcd.setCursor(15, 15);
+    M5.Lcd.print("OFF");
+  }
+  return value;
+}
+
+#else
+void setup() {
+
+}
+void loop() {
+  yield();
+}
+#endif
diff --git a/examples/M5StickC-fritzbox-TAM/README.md b/examples/M5StickC-fritzbox-TAM/README.md
@@ -0,0 +1,4 @@
+# Further information on the usage of M5StickC-fritzbox-TAM.ino
+
+Yes, out of the box it just runs on a M5StickC. Yes, you can adopt it easily but you need to integrate a display/LED and button. Furthermore it is based on a ESP32-PICO.
+The idea behind this was the challenge for elderly people to recognize easily the status of the TAM. However the fritz!fon buttons are small and the menu too complex. Therefore some Gigasets E290HX were used, because the HD feature is pretty good for those people, the buttons are big and it has an loudness amplifier. But there is no TAM station like the E290A, this would be ideal. 
