ftespnow: Added examples and updated docstrings

Author: Schneck2004

micropython/ftespnow/examples/client_side_example.py

@@ -0,0 +1,54 @@
+import ftespnow
+
+# Initialize ESP-NOW client
+esp = ftespnow.CLIENT()
+
+# Connect to ESP-NOW server
+esp.connect("a4f00f772d15") # Change to actual server mac address
+
+# Send a message
+message = "Hello"
+sent = esp.send_message(message)
+if sent: # Check if server received the data
+    print("Message received by server")
+else:
+    print("Message not received by server")
+
+# Receive a message
+received_data = esp.receive_message()
+if received_data == None: # Check if any data was received
+    print("No message was received (timed out)")
+else:
+    print(f"Here is the received data: {received_data}")
+
+# Send a .txt file
+txt_sent = esp.send_txt("filepath/filename.txt")
+if txt_sent: # Check if server received the data
+    print("File received by server")
+else:
+    print("File not received by server")
+
+# Send a .json file
+json_sent = esp.send_json("filepath/filename.json")
+if json_sent: # Check if server received the data
+    print("File received by server")
+else:
+    print("File not received by server")
+
+# Write received data to .txt file
+txt_received = esp.receive_to_txt("filepath/filename.txt", mode='w') # Set mode to 'w' so file is truncated before writing
+if txt_received:
+    print("File received successfully")
+else:
+    print("No file received. Destination file was not created/modified")
+
+# Write received data to .json file
+json_received = esp.receive_to_json("filepath/filename.json", mode='w') # Set mode to 'w' so file is truncated before writing
+if json_received:
+    print("File received successfully")
+else:
+    print("No file received. Destination file was not created/modified")
+
+# Write received data to a python dictionary
+data_dict = esp.receive_to_dict()
+print(data_dict)

micropython/ftespnow/examples/server_side_example.py

@@ -0,0 +1,52 @@
+import ftespnow
+
+# Initialize ESP-NOW client
+esp = ftespnow.SERVER()
+
+# Send a message
+message = "Hello"
+peer = "a4f00f772d15" # Mac address of the client that you want to send data to
+sent = esp.send_message(peer, message)
+if sent: # Check if client received the data
+    print("Message received by clientclient")
+else:
+    print("Message not received by client")
+
+# Receive a message
+received_data = esp.receive_message()
+if received_data == None: # Check if any data was received
+    print("No message was received (timed out)")
+else:
+    print(f"Here is the received data: {received_data}")
+
+# Send a .txt file
+txt_sent = esp.send_txt(peer, "filepath/filename.txt")
+if txt_sent: # Check if client received the data
+    print("File received by client")
+else:
+    print("File not received by client")
+
+# Send a .json file
+json_sent = esp.send_json(peer, "filepath/filename.json")
+if json_sent: # Check if client received the data
+    print("File received by client")
+else:
+    print("File not received by client")
+
+# Write received data to .txt file
+txt_received = esp.receive_to_txt("filepath/filename.txt", mode='w') # Set mode to 'w' so file is truncated before writing
+if txt_received:
+    print("File received successfully")
+else:
+    print("No file received. Destination file was not created/modified")
+
+# Write received data to .json file
+json_received = esp.receive_to_json("filepath/filename.json", mode='w') # Set mode to 'w' so file is truncated before writing
+if json_received: # Check if any data was received
+    print("File received successfully")
+else:
+    print("No file received. Destination file was not created/modified")
+
+# Write received data to a python dictionary
+data_dict = esp.receive_to_dict() # Will return {} if no data was received
+print(data_dict)

micropython/ftespnow/ftespnow-client/ftespnow/client.py

@@ -2,10 +2,11 @@
 import json
 
 class CLIENT:
-    def __init__(self) -> None:
+    def __init__(self, *, timeout: int=5) -> None:
         self.esp = espnow.ESPNow()
+        self.timeout = timeout
 
-    def configure(self, timeout=5) -> None:
+    def configure(self, *, timeout: int=5) -> None:
         self.timeout: int = timeout
 
     def connect(self, peer: str) -> None:
@@ -87,7 +88,9 @@ def send_json(self, filename: str, *, indent: int=4) -> bool:
 
     def receive_to_txt(self, target_file: str, mode: str='a') -> bool:
         """
-        Write received `string` into a `.txt` file.
+        Write received `string` into a `.txt` file. 
+        
+        **Will not write or create file if no data is received**
         
         Args:
             
@@ -112,7 +115,7 @@ def receive_to_txt(self, target_file: str, mode: str='a') -> bool:
             Read `open()`_ for more information
         
         Returns:
-            
+
             received (bool): Confirmation flag (`True` if data was received, `False` otherwise)
         
         .. _open(): https://docs.python.org/3/library/functions.html#open
@@ -135,6 +138,8 @@ def receive_to_json(self, target_file: str, mode: str='a') -> bool:
         """
         Write received `string` into a `.json` file.
         
+        **Will not write or create file if no data is received**
+        
         Args:
             
             target_file (str): Filepath of the destination file for the received data with file name and extension.

micropython/ftespnow/ftespnow-server/ftespnow/server.py

@@ -91,6 +91,8 @@ def receive_to_txt(self, target_file: str, mode: str='a') -> bool:
         """
         Write received `string` into a `.txt` file.
         
+        **Will not write or create file if no data is received**
+        
         Args:
             
             target_file (str): Filepath of the destination file for the received data with file name and extension.
@@ -136,6 +138,8 @@ def receive_to_json(self, target_file: str, mode: str='a') -> bool:
         """
         Write received `string` into a `.json` file.
         
+        **Will not write or create file if no data is received**
+        
         Args:
             
             target_file (str): Filepath of the destination file for the received data with file name and extension.