Adds deprecation warnings

CHANGES.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.2.3] - 2022-08-08
+### Added:
+- Deprecation messages for substituted/altered functions
+
 ## [1.2.2] - 2022-07-28
 ### Added:
 - Error messages for BSMP return errors (0xE_)

src/pydrs/__init__.py

@@ -1,4 +1,4 @@
 from .pydrs import EthDRS, SerialDRS, GenericDRS
 
-__version__ = "1.2.2"
-__date__ = "28/07/2022"
+__version__ = "1.2.3"
+__date__ = "08/08/2022"

src/pydrs/base.py

@@ -3,6 +3,7 @@
 import csv
 import math
 import os
+from pprint import pprint
 import struct
 import time
 
@@ -165,6 +166,18 @@ def slave_addr(self) -> int:
     def slave_addr(self, address: int):
         self._slave_addr = struct.pack("B", address).decode("ISO-8859-1")
 
+    def set_slave_add(self, address: int):
+        print(
+            f"From 2.0.0 onwards, the slave address will be a property. Use 'slave_addr = {address}' instead"
+        )
+        self.slave_addr = address
+
+    def get_slave_add(self) -> int:
+        print(
+            "From 2.0.0 onwards, the slave address will be a property. Use 'slave_addr' instead"
+        )
+        return self.slave_addr
+
     """
     ======================================================================
                     Funções Internas da Classe
@@ -1409,7 +1422,10 @@ def decode_interlocks(self, reg_interlocks, list_interlocks: list) -> list:
         return active_interlocks
 
     def read_vars_fbp(self, n: int = 1, dt: float = 0.5):
-        vars_list = []
+        vars = {}
+        print(
+            "From 2.0.0, read_vars_fbp will not loop or print implicitly. It will only return a dictionary."
+        )
         for _ in range(n):
             self.read_vars_common()
 
@@ -1446,13 +1462,16 @@ def read_vars_fbp(self, n: int = 1, dt: float = 0.5):
                 + " %",
             }
 
-            vars_list.append(self._include_interlocks(vars))
+            pprint(vars)
 
             time.sleep(dt)
-        return vars_list
+        return vars
 
     def read_vars_fbp_dclink(self, n: int = 1, dt: float = 0.5) -> list:
-        vars_list = []
+        vars = {}
+        print(
+            "From 2.0.0, read_vars_fbp_dclink will not loop or print implicitly. It will only return a dictionary."
+        )
         try:
             for i in range(n):
                 self.read_vars_common()
@@ -1479,12 +1498,14 @@ def read_vars_fbp_dclink(self, n: int = 1, dt: float = 0.5) -> list:
                         hard_itlks, list_fbp_dclink_hard_interlocks
                     )
 
-                vars_list.append(vars)
+                pprint(vars)
                 time.sleep(dt)
 
         except Exception:
             pass
 
+        return vars
+
     def read_vars_fac_acdc(self, n=1, dt: float = 0.5, iib: bool = True):
         for i in range(n):
 

src/pydrs/pydrs.py

@@ -115,7 +115,7 @@ def _get_reply(self, size: int = None) -> bytes:
         except IndexError:
             self._reset_input_buffer()
             raise SerialErrPckgLen(
-                "Received empty response, check if the controller is on and connected"
+                "Received empty response, check if the controller is on and connected. If you receive garbled output, try disconnecting and reconnecting."
             )
 
         return payload

src/pydrs/validation.py

@@ -53,20 +53,22 @@ def wrapper(*args, **kwargs):
         if len(reply) == 0 or (len(reply) == 1 and reply[0] == ETH_ANSWER_NOQUEUE):
             args[0]._reset_input_buffer()
             raise SerialErrPckgLen(
-                "Received empty response, check if the controller is on and connected"
+                "Received empty response, check if the controller is on and connected. If you receive garbled output, try disconnecting and reconnecting."
             )
 
         reply = reply[1:] if len(reply) - 1 == args[2] else reply
         check_serial_error(reply)
 
-        if len(reply) != args[2] or (len(reply)-1 != args[2] and reply[0] == 0x21):
-            offset = 1 if reply[0] == 0x21 else 0 
+        if len(reply) != args[2] or (len(reply) - 1 != args[2] and reply[0] == 0x21):
+            offset = 1 if reply[0] == 0x21 else 0
             if len(reply) > 5:
                 check_serial_error(reply[offset:])
 
             args[0]._reset_input_buffer()
             raise SerialErrPckgLen(
-                "Expected {} bytes, received {} bytes".format(args[2], len(reply) - offset)
+                "Expected {} bytes, received {} bytes".format(
+                    args[2], len(reply) - offset
+                )
             )
 
         if reply != checksum(reply[:-1]):