Merge branch 'issue37' into fl

Author: f-laurens

nabcommon/network.py

@@ -0,0 +1,52 @@
+import fcntl
+import re
+import socket
+import struct
+
+
+def ip_address(ifname="wlan0"):
+    """
+    Return the IP address for given interface
+    """
+    try:
+        with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as s:
+            ip_addr = socket.inet_ntoa(
+                fcntl.ioctl(
+                    s.fileno(),
+                    0x8915,  # SIOCGIFADDR
+                    struct.pack("256s", bytes(ifname[:15], "utf-8")),
+                )[20:24]
+            )
+            matchObj = re.match(r"169\.254", ip_addr)
+            if matchObj:
+                # ignore self-assigned link-local address
+                return None
+            else:
+                return ip_addr
+    except OSError:
+        return None
+
+
+def internet_connection():
+    """
+    Return True if connected to Internet, False otherwise
+    """
+    DNS_SERVER_LIST = [
+        "1.1.1.1",  # Cloudflare
+        "208.67.222.222",  # Open DNS
+        "8.8.8.8",  # Google DNS
+        "1.0.0.1",  # Cloudflare
+        "208.67.220.220",  # Open DNS
+        "8.8.4.4",  # Google DNS
+    ]
+    dns_port = 53
+    timeout = 3.0
+    for dns_server in DNS_SERVER_LIST:
+        try:
+            with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
+                s.settimeout(timeout)
+                s.connect((dns_server, dns_port))
+                return True
+        except OSError:
+            pass
+    return False

nabd/nabd.py

@@ -18,7 +18,7 @@
 from lockfile import AlreadyLocked, LockFailed
 from lockfile.pidlockfile import PIDLockFile
 
-from nabcommon import nablogging, settings
+from nabcommon import nablogging, network, settings
 from nabcommon.nabservice import NabService
 
 from .ears import Ears
@@ -30,6 +30,8 @@
     TagFlags,
 )
 
+_PYTEST = os.path.basename(sys.argv[0]) != "nabd.py"
+
 
 class State(Enum):
     IDLE = "idle"
@@ -110,7 +112,7 @@ async def reload_config(self):
                 self.nlu = NLU(self._nlu_locale)
                 Nabd.leds_boot(self.nabio, 4)
             self.nabio.set_leds(None, None, None, None, None)
-        self.nabio.pulse(Led.BOTTOM, (255, 0, 255))
+        self.nabio.pulse(Led.BOTTOM, (0, 255, 255))  # Cyan
 
     async def _do_transition_to_idle(self):
         """
@@ -119,8 +121,16 @@ async def _do_transition_to_idle(self):
         Thread: service or idle_worker_loop
         """
         left, right = self.ears["left"], self.ears["right"]
-        await self.nabio.move_ears_with_leds((255, 0, 255), left, right)
-        self.nabio.pulse(Led.BOTTOM, (255, 0, 255))
+        await self.nabio.move_ears_with_leds((0, 255, 255), left, right)
+        self.nabio.pulse(Led.BOTTOM, (0, 255, 255))  # Cyan
+        if network.ip_address(self.nabio.network_interface()) is None:
+            # not even a local network connection: real bad
+            logging.error("no network connection")
+            self.nabio.pulse(Led.BOTTOM, (255, 0, 0))  # Red
+        elif not network.internet_connection():
+            # local network connection, but no Internet access: not so good
+            logging.warning("no Internet access")
+            self.nabio.pulse(Led.BOTTOM, (255, 165, 0))  # Orange
 
     async def sleep_setup(self):
         self.nabio.set_leds(None, None, None, None, None)
@@ -843,9 +853,8 @@ async def _shutdown(self, doReboot):
             await self._do_system_command("/sbin/halt")
 
     async def _do_system_command(self, sytemCommandStr):
-        inTesting = os.path.basename(sys.argv[0]) in ("pytest", "py.test")
-        if not inTesting:
-            logging.info(f"Initiating system command: {sytemCommandStr}")
+        logging.info(f"Initiating system command: {sytemCommandStr}")
+        if not _PYTEST:
             os.system(sytemCommandStr)
 
     def ears_callback(self, ear):

nabd/nabio.py

@@ -328,6 +328,11 @@ def has_rfid(self):
         """Determine if we have an rfid reader"""
         raise NotImplementedError("Should have implemented")
 
+    @abc.abstractmethod
+    def network_interface(self):
+        """Return name of network interface"""
+        raise NotImplementedError("Should have implemented")
+
     async def test(self, test):
         if test == "ears":
             (

nabd/nabio_hw.py

@@ -27,6 +27,9 @@ def has_sound_input(self):
     def has_rfid(self):
         return self.model == NabIOHW.MODEL_2019_TAGTAG
 
+    def network_interface(self):
+        return "wlan0"
+
     async def gestalt(self):
         MODEL_NAMES = {
             NabIO.MODEL_2018: "2018",

nabd/nabio_virtual.py

@@ -49,6 +49,9 @@ def has_sound_input(self):
     def has_rfid(self):
         return True
 
+    def network_interface(self):
+        return "eth0"
+
     def update_rabbit(self):
         for writer in self.virtual_clients:
             self.display_rabbit(writer)

nabd/tests/mock.py

@@ -94,6 +94,9 @@ def has_sound_input(self):
     def has_rfid(self):
         return False
 
+    def network_interface(self):
+        return "eth0"
+
     async def gestalt(self):
         return {"model": "Test mock"}
 

nabd/tests/nabd_test.py

@@ -76,7 +76,7 @@ def test_init(self):
         self.assertEqual(self.nabio.left_led, None)
         self.assertEqual(self.nabio.center_led, None)
         self.assertEqual(self.nabio.right_led, None)
-        self.assertEqual(self.nabio.bottom_led, "pulse((255, 0, 255))")
+        self.assertEqual(self.nabio.bottom_led, "pulse((0, 255, 255))")  # Cyan
         self.assertEqual(self.nabio.nose_led, None)
 
     def service_socket(self):

nabweb/locale/fr_FR/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2021-06-18 22:58+0200\n"
+"POT-Creation-Date: 2021-07-14 14:10+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -175,49 +175,75 @@ msgstr ""
 "En dernier ressort, vous pouvez aussi arrêter le lapin en appuyant le bouton "
 "sur sa tête rapidement trois fois à la suite."
 
-#: templates/nabweb/help.html:15
+#: templates/nabweb/help.html:14
+msgid "Base LED pulse color"
+msgstr "La couleur de pulsation de la LED de base"
+
+#: templates/nabweb/help.html:14
+msgid "indicates the rabbit's network connection state"
+msgstr "indique l'état de la connexion réseau du lapin"
+
+#: templates/nabweb/help.html:14
+msgid ""
+"<span class=\"badge badge-pill badge-info\">Cyan</span> means <i>all is "
+"fine</i>: rabbit has an IP address on your local network, and access to the "
+"Internet.<br><span class=\"badge badge-pill badge-warning\">Orange</span> "
+"means <i>not so good</i>: rabbit has a local IP address, but no Internet "
+"connection (check your router).<br><span class=\"badge badge-pill badge-"
+"danger\">Red</span> means <i>real bad</i>: rabbit has no IP address (check "
+"your WiFi access point / DHCP server)."
+msgstr ""
+"<span class=\"badge badge-pill badge-info\">Cyan</span> signifie <i>tout va "
+"bien</i> : le lapin a une adresse IP sur votre réseau local, et accès à "
+"l'Internet.<br><span class=\"badge badge-pill badge-warning\">Orange</span> "
+"signifie <i>pas très bon</i> : le lapin a une adresse IP locale, mais pas de "
+"connexion Internet (vérifiez votre routeur).<br><span class=\"badge badge-"
+"pill badge-danger\">Rouge</span> signifie <i>pas bon du tout</i> : le lapin "
+"n'a pas d'adresse IP (vérifiez votre point d'accès WiFi / serveur DHCP)."
+
+#: templates/nabweb/help.html:16
 msgid "On the Internet"
 msgstr "Sur l'Internet"
 
-#: templates/nabweb/help.html:16
+#: templates/nabweb/help.html:17
 msgid ""
 "<a target='_blank' href='https://tinyletter.com/nabaztag' rel='noopener "
 "noreferrer'>Nabaztag is back!</a>"
 msgstr ""
 "<a target='_blank' href='https://tinyletter.com/nabaztag' rel='noopener "
 "noreferrer'>Nabaztag revient !</a>"
 
-#: templates/nabweb/help.html:16
+#: templates/nabweb/help.html:17
 msgid "Subscribe to the newsletter."
 msgstr "Abonnez vous à la lettre d'information."
 
-#: templates/nabweb/help.html:17
+#: templates/nabweb/help.html:18
 msgid ""
 "The <a target='_blank' href='https://www.tagtagtag.fr/forum/' rel='noopener "
 "noreferrer'>Tag:Tag:Tag user forum</a>"
 msgstr ""
 "Le <a target='_blank' href='https://www.tagtagtag.fr/forum/' rel='noopener "
 "noreferrer'>forum d'utilisateurs Tag:Tag:Tag</a>"
 
-#: templates/nabweb/help.html:17
+#: templates/nabweb/help.html:18
 msgid "Share your problems and solutions with other rabbit breeders."
 msgstr ""
 "Partagez vos problèmes et vos solutions avec d'autres éleveurs de lapins."
 
-#: templates/nabweb/help.html:18
+#: templates/nabweb/help.html:19
 msgid ""
 "The <a target='_blank' href='https://github.com/nabaztag2018/pynab/#readme' "
 "rel='noopener noreferrer'>GitHub repository</a>"
 msgstr ""
 "Le <a target='_blank' href='https://github.com/nabaztag2018/pynab/#readme' "
 "rel='noopener noreferrer'>référentiel GitHub</a>"
 
-#: templates/nabweb/help.html:18
+#: templates/nabweb/help.html:19
 msgid "Report bugs or contribute to the project with other developers."
 msgstr ""
 "Signalez des bogues ou contribuez au projet avec d'autres développeurs."
 
-#: templates/nabweb/help.html:19
+#: templates/nabweb/help.html:20
 msgid ""
 "<a target='_blank' href='https://f-laurens.github.io/pynab_cli/' "
 "rel='noopener noreferrer'>Pynab CLI</a>"

nabweb/templates/nabweb/help.html

@@ -11,7 +11,8 @@ <h1 class="display-5">{% trans "Nabaztag help" %}</h1>
       <p>{% trans "<b>The " %}<a href='/help/airquality' title='{% trans "The air quality visual animations" %}'>{% trans "air quality visual animations" %}</b></a>.</p>
       <p id="asr"><b>{% trans "Talking to the rabbit (speech recognition)" %}</b><br>{% trans "You need to push and hold the button on the rabbit's head long enough to hear a 'beep', then wait a couple of seconds and speak. When you are done just release the button." %}<br>{% trans "The speech processing is done locally and the answer should come shortly!" %}</p>
       <p><b>{% trans "Reboot or shutdown the rabbit" %}</b><br>{% blocktrans %}You can do this cleanly by using the <kbd class="btn-warning">Reboot</kbd> or <kbd class="btn-danger">Shutdown</kbd> buttons on the <a  target='_parent' href='/system-info/'>System information</a> tab of the configuration page.{% endblocktrans %}<br>{% trans "As a last resort, you can also shutdown the rabbit by pushing its head button quickly three times in a row." %}</p>
-     <hr class="my-4">
+      <p><b>{% trans "Base LED pulse color" %}</b> {% trans "indicates the rabbit's network connection state" %}<br>{% blocktrans %}<span class="badge badge-pill badge-info">Cyan</span> means <i>all is fine</i>: rabbit has an IP address on your local network, and access to the Internet.<br><span class="badge badge-pill badge-warning">Orange</span> means <i>not so good</i>: rabbit has a local IP address, but no Internet connection (check your router).<br><span class="badge badge-pill badge-danger">Red</span> means <i>real bad</i>: rabbit has no IP address (check your WiFi access point / DHCP server).{% endblocktrans %}</p>
+      <hr class="my-4">
       <p class="lead">{% trans "On the Internet" %}</p>
       <p><b>{% trans "<a target='_blank' href='https://tinyletter.com/nabaztag' rel='noopener noreferrer'>Nabaztag is back!</a>" %}</b><br>{% trans "Subscribe to the newsletter." %}</p>
       <p><b>{% trans "The <a target='_blank' href='https://www.tagtagtag.fr/forum/' rel='noopener noreferrer'>Tag:Tag:Tag user forum</a>" %}</b><br>{% trans "Share your problems and solutions with other rabbit breeders." %}</p>