Fixes #17 this is 1.0.2

Author: BobDenny

CHANGES.rst

@@ -1,3 +1,10 @@
+Version 1.0.2 Update (2025-02-16)
+=================================
+* This responds to `GitHub Issue  #17
+  <https://github.com/ASCOMInitiative/AlpycaDevice/issues/17>`_ to correct
+  the handling of missing Alpaca ``ClientID`` and ``ClientTransactionID`` HTTP
+  parameters, making them optional with a default value of 0.
+
 Version 1.0.1 Update (2025-02-05)
 =================================
 * This responds to `GitHub Issue  #16

Current ConformU Protocol.txt

@@ -247,3 +247,8 @@ along with rst-check, leaving rstcheck as the linter. Good enough.
 05-Feb-2025
 -----------
 * 1.0.1 Regenerated templates for the Id thing and for Fix #16 for property Connected on_put() and a typo. 1.0.1.
+
+16-Feb-2025
+-----------
+* Fix ClientID and ClientTransactionID in shr.py per GitHub #17. Release 1.0.2
+

Current ConformU Validation.txt

@@ -1,14 +1,14 @@
 # AlpycaDevice - Python Alpaca Device Driver SDK
 
-## Version 1.0.1, February 5, 2025 (ASCOM Platform 7)
+## Version 1.0.2, February 17, 2025 (ASCOM Platform 7)
 
 <img align="right" width="210" height="166" hspace="20" vspace="20" src="https://ascom-standards.org/alpyca/readme-assets/AlpacaLogo210.png">
 
 This project is a lightweight Python framework for a device
 driver that supports the Alpaca protocol and ASCOM Standards as of Platform 7. It implements a basic Rotator device with a simple simulation for Conform tests. **Templates for all ASCOM device types are provided**.
 The "boiler plate" logic remains the same for any device.
 
-## [AlpycaDevice SDK 1.0.1 Documentation](https://ascom-standards.org/alpycadevice/)
+## [AlpycaDevice SDK 1.0.2 Documentation](https://ascom-standards.org/alpycadevice/)
 
 [![AlpycaDevice Video](https://raw.githubusercontent.com/BobDenny/AlpycaDevice/master/docs/source/vthumb.png)](https://www.youtube.com/watch?v=soGb0j4iOt4 "AlpycaDevice Video")
 

RBD-Notes.txt

@@ -60,6 +60,9 @@
 # 16-Feb-2024   rbd 0.6 For Platform 7, common DeviceState property.
 #               New StateValue object, and enhance PropertyResponse to
 #               serialize objects into JSON (the StateValue objects).
+# 16-Feb-2025   rbd 1.0.2 Issue #17 Correct handling of ClientID and
+#               ClientTransactionID. Add missing keywords to some Falcon
+#               HTTPBadRequest exceptions to prevent deprecation warnings.
 
 from threading import Lock
 from exceptions import Success
@@ -187,21 +190,21 @@ def _check_request(self, req: Request, devnum: int):  # Raise on failure
         if devnum > self.maxdev:
             msg = f'Device number {str(devnum)} does not exist. Maximum device number is {self.maxdev}.'
             logger.error(msg)
-            raise HTTPBadRequest(_bad_title, msg)
-        test: str = get_request_field('ClientID', req, True)        # Caseless
-        if test is None:
-            msg = 'Request has missing Alpaca ClientID value'
-            logger.error(msg)
-            raise HTTPBadRequest(_bad_title, msg)
+            raise HTTPBadRequest(title=_bad_title, description=msg)
+        test: str = get_request_field('ClientID', req, True, '0')   # Caseless, default = 0 if missing
         if not self._pos_or_zero(test):
             msg = f'Request has bad Alpaca ClientID value {test}'
             logger.error(msg)
-            raise HTTPBadRequest(_bad_title, msg)
-        test: str = get_request_field('ClientTransactionID', req, True)
+            raise HTTPBadRequest(title=_bad_title, description=msg)
+        if test == '0':
+            req.params['ClientID'] = '0'                            # In case it's missing
+        test: str = get_request_field('ClientTransactionID', req, True, '0') # Caseless, default = 0 if missing
         if not self._pos_or_zero(test):
             msg = f'Request has bad Alpaca ClientTransactionID value {test}'
             logger.error(msg)
-            raise HTTPBadRequest(_bad_title, msg)
+            raise HTTPBadRequest(title=_bad_title, description=msg)
+        if test == '0':
+            req.params['ClientTransactionID'] = '0'                 # In case it's missing
 
     #
     # params contains {'devnum': n } from the URI template matcher

README.md

@@ -34,8 +34,8 @@ class Desc_Sig_Space(DocutilsInlineNode):
 author = 'Bob Denny'
 
 # The full version, including alpha/beta/rc tags
-version = '1.0.1'
-release = '1.0.1'
+version = '1.0.2'
+release = '1.0.2'
 
 # -- General configuration ---------------------------------------------------
 #
@@ -125,7 +125,7 @@ class Desc_Sig_Space(DocutilsInlineNode):
 rinoh_documents = [dict(doc='index',                # top-level file (index.rst)
                         target='alpyca',            # output file (alpyca.pdf)
                         title='Alpyca Device',
-                        subtitle='Release 1.0.1',
+                        subtitle='Release 1.0.2',
                         author='Robert B. Denny <rdenny@dc3.com>',
                         logo='alpaca1000.png',
                         template='alpyca.rtt')]

device/shr.py

@@ -25,7 +25,7 @@ conforming Alpaca device with a minimum of "just in time learning".
     **Start Here:** :doc:`/quickstart` then look through :doc:`/introduction`.
 
 .. Note::
-    This is the 1.0.1 (February 5, 2025) updated production version. This
+    This is the 1.0.2 (February 20, 2025) updated production version. This
     contains the additions to the interfaces for Platform 7.
     See |plat7changes|. For Release Notes on this SDK see the
     |changes| on the |github|.