Updated range tutorial to reflect changes with the protocol

Author: laurentva

pypozyx/definitions/bitmasks.py

@@ -26,11 +26,6 @@
 POZYX_INT_MASK_PIN = 0x80
 POZYX_INT_MASK_ALL = 0x1F
 
-# Bit mask for POZYX_RANGE_PROTOCOL
-POZYX_RANGE_PROTOCOL_PRECISION = 0x00
-POZYX_RANGE_PROTOCOL_FAST = 0x01
-POZYX_RANGE_PROTOCOL_TEST = 0x02
-
 # Bit mask for POZYX_LED_CTRL
 POZYX_LED_CTRL_LED1 = 0x01
 POZYX_LED_CTRL_LED2 = 0x02

pypozyx/definitions/constants.py

@@ -61,6 +61,11 @@
 POZYX_POS_ALG_UWB_ONLY = 0
 POZYX_POS_ALG_TRACKING = 4
 
+# ranging protocol options
+POZYX_RANGE_PROTOCOL_PRECISION = 0x00
+POZYX_RANGE_PROTOCOL_FAST = 0x01
+POZYX_RANGE_PROTOCOL_TEST = 0x02
+
 # positioning filters
 FILTER_TYPE_NONE = 0
 FILTER_TYPE_FIR = 1

pypozyx/lib.py

@@ -547,6 +547,40 @@ def getUpdateInterval(self, ms, remote_id=None):
         """
         return self.getRead(POZYX_POS_INTERVAL, ms, remote_id)
 
+    def getRangingProtocol(self, protocol, remote_id=None):
+        """
+        Obtains the Pozyx's ranging protocol
+
+        Args:
+            protocol: Container for the read protocol data. SingleRegister or Data([0])
+
+        Kwargs:
+            remote_id: Remote Pozyx ID
+
+        Returns:
+            POZYX_SUCCESS, POZYX_FAILURE, POZYX_TIMEOUT
+        """
+        return self.getRead(POZYX_RANGE_PROTOCOL, protocol, remote_id)
+
+    def setRangingProtocol(self, protocol, remote_id=None):
+        """
+        Set the Pozyx's ranging protocol.
+
+        Args:
+            protocol: the new ranging protocol. See POZYX_RANGE_PROTOCOL register. integer or SingleRegister(protocol)
+
+        Kwargs:
+            remote_id: Remote Pozyx ID
+
+        Returns:
+            POZYX_SUCCESS, POZYX_FAILURE, POZYX_TIMEOUT
+        """
+        if not dataCheck(protocol):
+            protocol = SingleRegister(protocol)
+        assert protocol[0] >= 0 and protocol[0] <=2, 'setRangingProtocol: wrong protocol %i' % protocol[0]
+
+        return self.setWrite(POZYX_RANGE_PROTOCOL, protocol, remote_id)
+
     def getPositionAlgorithm(self, algorithm, remote_id=None):
         """
         Obtains the Pozyx's positioning algorithm.
@@ -736,26 +770,6 @@ def setUpdateInterval(self, ms, remote_id=None):
             0] <= 600000, 'setUpdateInterval: ms not 100<ms<60000'
         return self.setWrite(POZYX_POS_INTERVAL, ms, remote_id)
 
-    def setOperationMode(self, mode, remote_id=None):
-        """
-        Set the Pozyx's operation mode.
-
-        Args:
-            mode: New operation mode. See POZYX_OPERATION_MODE register. integer mode or SingleRegister(mode).
-
-        Kwargs:
-            remote_id: Remote Pozyx ID.
-
-        Returns:
-            POZYX_SUCCESS, POZYX_FAILURE, POZYX_TIMEOUT
-        """
-        if not dataCheck(mode):
-            mode = SingleRegister(mode)
-        assert mode[0] == POZYX_ANCHOR_MODE or mode[
-            0] == POZYX_TAG_MODE, 'setOperationMode: wrong mode'
-
-        return self.setWrite(POZYX_OPERATION_MODE, mode, remote_id)
-
     def setCoordinates(self, coordinates, remote_id=None):
         """
         Set the Pozyx's coordinates.

tutorials/ready_to_range.py

@@ -3,9 +3,8 @@
 The Pozyx ready to range tutorial (c) Pozyx Labs
 Please read the tutorial that accompanies this sketch: https://www.pozyx.io/Documentation/Tutorials/ready_to_range/Python
 
-This demo requires two Pozyx devices and one Arduino. It demonstrates the ranging capabilities and the functionality to
-to remotely control a Pozyx device. Place one of the Pozyx shields on the Arduino and upload this sketch. Move around
-with the other Pozyx device.
+This demo requires two Pozyx devices. It demonstrates the ranging capabilities and the functionality to
+to remotely control a Pozyx device. Move around with the other Pozyx device.
 
 This demo measures the range between the two devices. The closer the devices are to each other, the more LEDs will
 light up on both devices.
@@ -16,11 +15,12 @@
 class ReadyToRange(object):
     """Continuously performs ranging between the Pozyx and a destination and sets their LEDs"""
 
-    def __init__(self, pozyx, destination_id, range_step_mm=1000, remote_id=None):
+    def __init__(self, pozyx, destination_id, range_step_mm=1000, protocol=POZYX_RANGE_PROTOCOL_FAST, remote_id=None):
         self.pozyx = pozyx
         self.destination_id = destination_id
         self.range_step_mm = range_step_mm
         self.remote_id = remote_id
+        self.protocol = protocol
 
     def setup(self):
         """Sets up both the ranging and destination Pozyx's LED configuration"""
@@ -41,6 +41,8 @@ def setup(self):
         self.pozyx.setLedConfig(led_config, self.remote_id)
         # do the same for the destination.
         self.pozyx.setLedConfig(led_config, self.destination_id)
+        # set the ranging protocol
+        self.pozyx.setRangingProtocol(self.protocol)
 
     def loop(self):
         """Performs ranging and sets the LEDs accordingly"""
@@ -76,8 +78,10 @@ def ledControl(self, distance):
     destination_id = 0x6069      # network ID of the ranging destination
     range_step_mm = 1000         # distance that separates the amount of LEDs lighting up.
 
+    ranging_protocol = POZYX_RANGE_PROTOCOL_PRECISION # the ranging protocol
+
     pozyx = PozyxSerial(port)
-    r = ReadyToRange(pozyx, destination_id, range_step_mm, remote_id)
+    r = ReadyToRange(pozyx, destination_id, range_step_mm, ranging_protocol, remote_id)
     r.setup()
     while True:
         r.loop()