Added tls example for gateway client

Author: imbeacon

examples/gateway/DEPRECATEDclaiming_device_pe_only.py

@@ -0,0 +1,76 @@
+#  Copyright 2025 ThingsBoard
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+# This example demonstrates how to connect to ThingsBoard over SSL using the GatewayClient,
+# connect a device, and send telemetry data securely.
+
+import asyncio
+import logging
+import random
+
+from tb_mqtt_client.common.config_loader import GatewayConfig
+from tb_mqtt_client.common.logging_utils import configure_logging, get_logger
+from tb_mqtt_client.entities.data.timeseries_entry import TimeseriesEntry
+from tb_mqtt_client.service.gateway.client import GatewayClient
+
+configure_logging()
+logger = get_logger(__name__)
+logger.setLevel(logging.INFO)
+logging.getLogger("tb_mqtt_client").setLevel(logging.INFO)
+
+
+PLATFORM_HOST = 'localhost'  # Update with your ThingsBoard host
+PLATFORM_PORT = 8883  # Default port for MQTT over SSL
+
+
+# Update with your CA certificate, client certificate, and client key paths. There are no default files generated.
+# You can generate them using the following guides:
+# Certificates for server - https://thingsboard.io/docs/user-guide/mqtt-over-ssl/
+# Certificates for client - https://thingsboard.io/docs/user-guide/certificates/?ubuntuThingsboardX509=X509Leaf
+CA_CERT_PATH = "mqttserver.pem"  # Update with your CA certificate path (Default - mqttserver.pem in the examples directory)
+CLIENT_CERT_PATH = "cert.pem"  # Update with your client certificate path (Default - cert.pem in the examples directory)
+CLIENT_KEY_PATH = "key.pem"  # Update with your client key path (Default - key.pem in the examples directory)
+
+
+async def main():
+    config = GatewayConfig()
+
+    config.host = PLATFORM_HOST
+    config.port = PLATFORM_PORT
+
+    config.ca_cert = CA_CERT_PATH
+    config.client_cert = CLIENT_CERT_PATH
+    config.private_key = CLIENT_KEY_PATH
+
+    client = GatewayClient(config)
+    await client.connect()
+
+    device_name = "Test Device B1"
+    device_profile = "Test devices"
+    logger.info("Connecting device: %s", device_name)
+    device_session, publish_results = await client.connect_device(device_name, device_profile, wait_for_publish=True)
+
+    # Sending telemetry data to the connected device
+    list_timeseries = [
+            TimeseriesEntry(key="temperature", value=random.randint(20, 35)),
+            TimeseriesEntry(key="humidity", value=random.randint(40, 80))
+    ]
+    logger.info("Sending list of timeseries: %s", list_timeseries)
+    await client.send_device_timeseries(device_session=device_session, data=list_timeseries, wait_for_publish=True)
+    logger.info("List of timeseries sent successfully.")
+
+    await client.stop()
+
+if __name__ == "__main__":
+    asyncio.run(main())

examples/gateway/tls_connect.py

@@ -100,6 +100,8 @@ def __init__(self, config=None):
         if os.getenv("TB_GW_QOS") is not None:
             self.qos: int = int(os.getenv("TB_GW_QOS", 1))
 
+
+
     def __repr__(self):
         return (f"GatewayConfig(host={self.host}, port={self.port}, "
                 f"auth={'token' if self.access_token else 'user/pass'} "

tb_mqtt_client/common/config_loader.py

@@ -402,10 +402,6 @@ async def _unsubscribe_from_gateway_topics(self):
     async def _handle_rate_limit_response(self, response: RPCResponse):  # noqa
         device_rate_limits_processing_result = await super()._handle_rate_limit_response(response)
         try:
-            if not isinstance(response.result, dict) or 'gatewayRateLimits' not in response.result:
-                logger.warning("Invalid gateway rate limit response: %r", response)
-                return None
-
             gateway_rate_limits = response.result.get('gatewayRateLimits', {})
 
             await self._gateway_rate_limiter.message_rate_limit.set_limit(gateway_rate_limits.get('messages', '0:0,'), percentage=DEFAULT_RATE_LIMIT_PERCENTAGE)

tb_mqtt_client/service/gateway/client.py

@@ -484,22 +484,5 @@ async def test_handle_rate_limit_response():
         client._mqtt_manager.set_gateway_rate_limits_received.assert_called_once()
 
 
-@pytest.mark.asyncio
-async def test_handle_rate_limit_response_invalid_response():
-    # Setup
-    client = GatewayClient()
-    
-    # Create an invalid response
-    response = RPCResponse.build(1, result="invalid")
-    
-    # Mock the parent class method
-    with patch('tb_mqtt_client.service.device.client.DeviceClient._handle_rate_limit_response', return_value=None):
-        # Act
-        result = await client._handle_rate_limit_response(response)
-        
-        # Assert
-        assert result is None
-
-
 if __name__ == '__main__':
     pytest.main([__file__])