Improve output. Assert valid XML. Remove dup def of prDim. Use keyword args explicitly to avoid incorrect usage. Assert CDI is loaded. Reuse NodeID instance for explicitness (and to avoid mutation). Show localNodeID on socket loop failure.

Author: Poikilos

examples/example_node_implementation.py

@@ -11,17 +11,20 @@
                           the address and port). Defaults to a hard-coded test
                           address and port.
 '''
+import os
 import socket
+from typing import Set, Union
 
 # region same code as other examples
-from examples_settings import Settings  # do 1st to fix path if no pip install
+from examples_settings import Settings
+from openlcb.convert import Convert
 settings = Settings()
 
 if __name__ == "__main__":
     settings.load_cli_args(docstring=__doc__)
 # endregion same code as other examples
 
-from openlcb import precise_sleep  # noqa: E402
+from openlcb import prDim, precise_sleep  # noqa: E402
 from openlcb.tcplink.tcpsocket import TcpSocket  # noqa: E402
 
 from openlcb.canbus.canphysicallayergridconnect import (  # noqa: E402
@@ -66,18 +69,7 @@
 #     sock.sendString(string)
 #     physicalLayer.onFrameSent(frame)
 
-
-def prDim(s: str):
-    """Show extra debugging information in darker text so special cases
-    are readable (resets to 00 [default colors] for text after prDim).
-    Note: 0;30;40 is non-bold dim, but that's invisible in cmd.exe.
-    """
-    print("\033[1;30;40m {}\033[00m".format(s))
-    # - `\033[` (or `\e[`, see
-    #   https://gist.github.com/JBlond/2fea43a3049b38287e5e9cefc87b2124)
-    #   starts ansi escape sequence
-    # - 30 for gray
-    # - 00 to reset to white
+me = os.path.basename(__file__)
 
 
 def printFrame(frame):
@@ -89,25 +81,18 @@ def printFrame(frame):
 
 
 def printMessage(message: Message):
-    prDim("RM: {} from {}".format(message, message.source))
-    if message.mti is MTI.Verified_NodeID:
-        # REPLY
-        # Use source as destination (Get more info about verified node)
-        message = Message(MTI.Simple_Node_Ident_Info_Request,
-                          localNodeID, message.source)
-        print(f"[{__file__}] Sending {message.mti} to {message.destination}...")
-        canLink.sendMessage(message)
+    """Received message (RM) handler."""
+    prDim(f"RM: {message.mti} from {message.source}")
 
 
 localNodeID = NodeID(settings['localNodeID'])
 print()
 print(f"[example_node_memory_implementation] localNodeID: {localNodeID}")
 
 canLink = CanLink(physicalLayer, localNodeID)
-canLink.registerMessageReceivedListener(printMessage)
-
 datagramService = DatagramService(canLink)
 canLink.registerMessageReceivedListener(datagramService.process)
+canLink.registerMessageReceivedListener(printMessage)
 
 
 def printDatagram(memo):
@@ -143,15 +128,22 @@ def memoryReadFail(memo):
 # This is a very minimal node, which just takes part in the low-level common
 # protocols
 localNode = Node(
-    NodeID(settings['localNodeID']),
-    SNIP("python-openlcb", "example_node_implementation",
-         "0.1", "0.2", "Example Node Implementation",
-         "Example from python-openlcb"),
-    set([PIP.SIMPLE_NODE_IDENTIFICATION_PROTOCOL, PIP.DATAGRAM_PROTOCOL])
+    localNodeID,
+    snip=SNIP("python-openlcb", "example_node_implementation",
+              "0.1", "0.2", "Example Node Implementation",
+              "Example from python-openlcb"),
+    pipSet=set([
+        PIP.SIMPLE_NODE_IDENTIFICATION_PROTOCOL,
+        PIP.DATAGRAM_PROTOCOL,
+    ])
 )
 
 localNodeProcessor = LocalNodeProcessor(canLink, localNode)
 canLink.registerMessageReceivedListener(localNodeProcessor.process)
+# ^ Must be registered after CanPhysicalLayer constructor
+#   since that registers canLink.handleFrameReceived which
+#   maps aliases and allows us to reply if request was the
+#   first message to supply the far NodeID.
 
 
 def displayOtherNodeIds(message: Message) :
@@ -185,19 +177,23 @@ def displayOtherNodeIds(message: Message) :
 print("      SL : link up")
 # request that nodes identify themselves so that we can print their node IDs
 message = Message(MTI.Verify_NodeID_Number_Global,
-                  NodeID(settings['localNodeID']), None)
+                  localNodeID, None)
 canLink.sendMessage(message)
 
 # process resulting activity
 while True:
     count = 0
-    count += physicalLayer.sendAll(sock, verbose=True,
-                                   verbose_fn=prDim)
-    count += physicalLayer.receiveAll(sock, verbose=settings['trace'],
-                                      verbose_fn=prDim)
-    if count < 1:
-        precise_sleep(.01)
-    # else skip sleep to avoid latency (port already delayed)
+    try:
+        count += physicalLayer.sendAll(sock, verbose=True,
+                                       verbose_fn=prDim)
+        count += physicalLayer.receiveAll(sock, verbose=settings['trace'],
+                                          verbose_fn=prDim)
+        if count < 1:
+            precise_sleep(.01)
+        # else skip sleep to avoid latency (port already delayed)
+    except Exception:
+        print(f"localNodeID={localNodeID}")
+        raise
 
 print("Calling physicalLayerDown...")
 physicalLayer.physicalLayerDown()

examples/example_node_memory_implementation.py

@@ -21,27 +21,32 @@
 import os
 import socket
 import struct
+import xml.etree.ElementTree as ET
+
+from logging import getLogger
+from typing import Set
 
 # region same code as other examples
 from examples_settings import Settings
+from openlcb.convert import Convert
 from openlcb.localnode import LocalNode
 from openlcb.memoryspace import MemorySpace
-from openlcb.memorymanager import Segment  # do 1st to fix path if no pip install
+from openlcb.memorymanager import Segment
 settings = Settings()
 
 if __name__ == "__main__":
     settings.load_cli_args(docstring=__doc__)
 # endregion same code as other examples
 
-from openlcb import emit_cast, get_config_dir, precise_sleep  # noqa: E402
+from openlcb import assert_xml, emit_cast, formatted_ex, get_config_dir, prDim, precise_sleep  # noqa: E402, E501
 from openlcb.tcplink.tcpsocket import TcpSocket  # noqa: E402
 
 from openlcb.canbus.canphysicallayergridconnect import (  # noqa: E402
     CanPhysicalLayerGridConnect,
 )
 from openlcb.canbus.canlink import CanLink  # noqa: E402
 from openlcb.nodeid import NodeID  # noqa: E402
-from openlcb.datagramservice import DatagramService  # noqa: E402
+from openlcb.datagramservice import DatagramReadMemo, DatagramService  # noqa: E402, E501
 from openlcb.memoryservice import MemoryService  # noqa: E402
 from openlcb.message import Message  # noqa: E402
 from openlcb.mti import MTI  # noqa: E402
@@ -71,23 +76,15 @@
 print("RR, SR are raw socket interface receive and send;"
       " RL, SL are link interface; RM, SM are message interface")
 
+me = os.path.basename(__file__)
+logger = getLogger(__name__)
 
 # def sendToSocket(frame: CanFrame):
 #     string = frame.encodeAsString()
 #     print("      SR: {}".format(string.strip()))
 #     sock.sendString(string)
 #     physicalLayer.onFrameSent(frame)
 
-def prDim(s: str):
-    """Show extra debugging information in darker text so special cases
-    are readable (resets to 00 [default colors] for text after prDim).
-    Note: 0;30;40 is non-bold dim, but that's invisible in cmd.exe.
-    """
-    print("\033[1;30;40m {}\033[00m".format(s))
-    # - `\033` starts ansi escape sequence
-    # - 30 for gray
-    # - 00 to reset to white
-
 
 def printFrame(frame):
     prDim("   RL: {}".format(frame))
@@ -98,7 +95,11 @@ def printFrame(frame):
 
 
 def printMessage(message: Message):
-    prDim("RM: {} from {}".format(message.mti, message.source))
+    prDim(f"RM: {message.mti} from {message.source}")
+    # state = canLink.pollState()
+    # if state is not CanLink.State.Permitted:
+    #     print(f"RM: - SKIPPED (state={state})")
+    #     return
 
 
 localNodeID = NodeID(settings['localNodeID'])
@@ -159,7 +160,10 @@ def printMessage(message: Message):
 """  # noqa: E501
 
 
-def handleDatagram(memo):
+assert_xml(cdi)
+
+
+def handleDatagram(memo: DatagramReadMemo):
     """create a call-back to print datagram contents when received
 
     Args:
@@ -169,7 +173,7 @@ def handleDatagram(memo):
         bool: Always False (True would mean we sent a reply to the datagram,
             but let the MemoryService do that).
     """
-    print(f"Datagram receive call back: {emit_cast(memo)}")
+    print(f"Datagram receive call back: {Convert.toHex(memo.data)}")
     return False
 
 
@@ -189,24 +193,24 @@ def memoryReadFail(memo):
 
 
 # create a node and connect it update
-# This is a very minimal node, which just takes part in the low-level common
-# protocols
-localNodeID = NodeID(settings['localNodeID'])
+# This node takes part in high level protocols.
+# See docstring.
 localNode = LocalNode(
     localNodeID,
-    SNIP("python-openlcb example authors",
-         "example_node_memory_implementation",
-         "1.0", "1.0", "example_node_memory_implementation",
-         "python-openlcb example node with memory"),
-    set([
+    canLink,
+    snip=SNIP("python-openlcb example authors",
+              "example_node_memory_implementation",
+              "1.0", "1.0", "example_node_memory_implementation",
+              "python-openlcb example node with memory"),
+    pipSet=set([
         PIP.SIMPLE_NODE_IDENTIFICATION_PROTOCOL,
         PIP.DATAGRAM_PROTOCOL,
         PIP.CONFIGURATION_DESCRIPTION_INFORMATION,
         PIP.ADCDI_PROTOCOL,
         PIP.MEMORY_CONFIGURATION_PROTOCOL,
     ]),
-    canLink
 )
+
 memoryService.memory = localNode
 my_conf_dir = os.path.join(get_config_dir("python-openlcb"))
 backup_name = "example_node_memory_implementation.cdi.xml"
@@ -218,6 +222,10 @@ def memoryReadFail(memo):
 segment = localNode.getSegment(MemorySpace.CDI.value)
 assert isinstance(segment, Segment)
 assert isinstance(segment._data, (bytearray, bytes))
+last = localNode.getLast(0xFF)
+assert last is not None
+last = localNode.getLast(MemorySpace.CDI)
+assert last is not None
 # localNodeProcessor = LocalNodeProcessor(canLink, localNode)
 # canLink.registerMessageReceivedListener(localNodeProcessor.process)
 localNodeProcessor = localNode.localNodeProcessor
@@ -231,8 +239,7 @@ def displayOtherNodeIds(message: Message) :
     """
     if message.mti == MTI.Verified_NodeID :
         print(f"[displayOtherNodeIds] Detected farNodeID {message.source}")
-    else:
-        print(f"[displayOtherNodeIds] {message.mti} from {message.source}")
+    # For others, see printMessage
 
 
 canLink.registerMessageReceivedListener(displayOtherNodeIds)
@@ -252,19 +259,22 @@ def displayOtherNodeIds(message: Message) :
     precise_sleep(.02)
 print("      SL : link up")
 # request that nodes identify themselves so that we can print their node IDs
-message = Message(MTI.Verify_NodeID_Number_Global,
-                  NodeID(settings['localNodeID']), None)
+message = Message(MTI.Verify_NodeID_Number_Global, localNodeID, None)
 canLink.sendMessage(message)
 
 # process resulting activity
 while True:
     count = 0
-    count += physicalLayer.sendAll(sock, verbose=True,
-                                   verbose_fn=prDim)
-    count += physicalLayer.receiveAll(sock, verbose=settings['trace'],
-                                      verbose_fn=prDim)
-    if count < 1:
-        precise_sleep(.01)
-    # else skip sleep to avoid latency (port already delayed)
+    try:
+        count += physicalLayer.sendAll(sock, verbose=True,
+                                       verbose_fn=prDim)
+        count += physicalLayer.receiveAll(sock, verbose=settings['trace'],
+                                          verbose_fn=prDim)
+        if count < 1:
+            precise_sleep(.01)
+        # else skip sleep to avoid latency (port already delayed)
+    except Exception:
+        print(f"localNodeID={localNodeID}")
+        raise
 
 physicalLayer.physicalLayerDown()

openlcb/localnode.py

@@ -3,6 +3,7 @@
 from logging import getLogger
 from typing import Union
 from openlcb import emit_cast
+from openlcb.linklayer import LinkLayer
 from openlcb.memoryspace import MemorySpace
 from openlcb.memorymanager import MemoryManager, Segment
 from openlcb.node import PIP, SNIP, Node
@@ -28,9 +29,14 @@ class LocalNode(Node, MemoryManager):
     """A Node with its own virtual memory
     (emulate memory spaces such as for creating a virtual
     signal node with settings)"""
-    def __init__(self, id: NodeID, snip: SNIP, pipSet: set,
-                 linkLayer: CanLink):
-        Node.__init__(self, id, snip, pipSet)
+    def __init__(self, id: NodeID, linkLayer: CanLink,
+                 snip: Union[SNIP, None] = None,
+                 pipSet: Union[set, None] = None):
+        if not issubclass(type(linkLayer), LinkLayer):
+            raise TypeError("Expected LinkLayer/subclass,"
+                            f" got a {type(linkLayer).__name__}")
+        Node.__init__(self, id, snip=snip, pipSet=pipSet)
+        pipSet = self.pipSet  # ensured non-None by Node init.
         MemoryManager.__init__(self)
         self.cdiBackupDir = None  # type: str|None
         self.cdi = None  # type: XMLDataProcessor|None

tests/test_memorymanager.py

@@ -330,18 +330,18 @@ def virtual_send(data):
 
         virtualNode = LocalNode(
             virtualNodeID,
-            SNIP("python-openlcb authors",
-                 "test_memorymanager VN",
-                 "1.0", "1.0", "test_memorymanager VN",
-                 "python-openlcb virtual node with memory for test_memorymanager"),  # noqa: E501
-            set([
+            virtualCanLink,
+            snip=SNIP("python-openlcb authors",
+                      "test_memorymanager VN",
+                      "1.0", "1.0", "test_memorymanager VN",
+                      "python-openlcb virtual node with memory for test_memorymanager"),  # noqa: E501
+            pipSet=set([
                 PIP.SIMPLE_NODE_IDENTIFICATION_PROTOCOL,
                 PIP.DATAGRAM_PROTOCOL,
                 PIP.CONFIGURATION_DESCRIPTION_INFORMATION,
                 PIP.ADCDI_PROTOCOL,
                 PIP.MEMORY_CONFIGURATION_PROTOCOL,
             ]),
-            virtualCanLink
         )
         # dgService = DatagramService(canLink)
         # localMemoryService = MemoryService(dgService)