Standalone TagoTiP client for sending device commands

docs/source/Services/index.rst

@@ -197,32 +197,6 @@ Send SMS to phone number
                     "message": "Test",
                 }
             )
-=======
-TagoTiP
-=======
-
-Send a command to a device through TagoTiP
-
-Requires a Service Authorization token in the module token.
-
-    **Parameters:**
-
-        | **command**: :ref:`TagoTiPCommand`
-        | Command object with serial, protocol and body
-
-.. code-block::
-    :caption: **Example:**
-
-            from tagoio_sdk import Services
-
-            services = Services({"token": "your-service-authorization-token"})
-            services.tagotip.cmd(
-                {
-                    "serial": "mqtt1",
-                    "protocol": "mqtt",
-                    "body": "reboot-now",
-                }
-            )
 
 
 .. toctree::
@@ -233,7 +207,6 @@ Requires a Service Authorization token in the module token.
     Notification_Type
     Pdf_Type
     SMS_Type
-    TagoTiP_Type
 
 
 

docs/source/Services/TagoTiP_Type.rst → docs/source/TagoTiP/TagoTiP_Type.rst

@@ -1,5 +1,5 @@
 **TagoTiP Type**
-===================
+================
 
 
 .. _TagoTiPCommand:

docs/source/TagoTiP/index.rst

@@ -0,0 +1,54 @@
+**TagoTiP**
+===========
+
+========
+Instance
+========
+
+    **Parameters:**
+
+        | **token**: str
+        | Service Authorization token.
+
+        | *Optional* **region**: str "us-e1" or "ue-w1" or "env"
+        | Region is a optional parameter
+
+.. code-block::
+    :caption: **Example:**
+
+        from tagoio_sdk import TagoTiP
+
+        tagotip = TagoTiP({"token": "your-service-authorization-token"})
+
+
+===
+cmd
+===
+
+Send a command to a device through TagoTiP
+
+Requires a Service Authorization token in the module token.
+
+    **Parameters:**
+
+        | **command**: :ref:`TagoTiPCommand`
+        | Command object with serial, protocol and body
+
+.. code-block::
+    :caption: **Example:**
+
+            from tagoio_sdk import TagoTiP
+
+            tagotip = TagoTiP({"token": "your-service-authorization-token"})
+            tagotip.cmd(
+                {
+                    "serial": "mqtt1",
+                    "protocol": "mqtt",
+                    "body": "reboot-now",
+                }
+            )
+
+
+.. toctree::
+
+    TagoTiP_Type

docs/source/index.rst

@@ -277,6 +277,7 @@ API Reference
    Resources/index
    Device/index
    Services/index
+   TagoTiP/index
    Utils/index
 
 .. toctree::

src/tagoio_sdk/__init__.py

@@ -5,6 +5,7 @@
 from .modules.Resources.AccountDeprecated import AccountDeprecated as Account
 from .modules.Resources.Resources import Resources
 from .modules.Services.Services import Services
+from .modules.TagoTiP.TagoTiP import TagoTiP
 
 
-__all__ = ["Analysis", "Device", "Account", "Resources", "Services"]
+__all__ = ["Analysis", "Device", "Account", "Resources", "Services", "TagoTiP"]

src/tagoio_sdk/modules/Services/Services.py

@@ -9,7 +9,6 @@
 from tagoio_sdk.modules.Services.Notification import Notification
 from tagoio_sdk.modules.Services.PDF import PDFService
 from tagoio_sdk.modules.Services.SMS import SMS
-from tagoio_sdk.modules.Services.TagoTiP import TagoTiP
 from tagoio_sdk.params import get_params
 
 
@@ -24,4 +23,3 @@ def __init__(self, params: Optional[GenericModuleParams] = None):
         self.Notification = Notification(self.params)
         self.Attachment = Attachment(self.params)
         self.PDF = PDFService(self.params)
-        self.tagotip = TagoTiP(self.params)

src/tagoio_sdk/modules/Services/TagoTiP.py → src/tagoio_sdk/modules/TagoTiP/TagoTiP.py

@@ -28,9 +28,9 @@ def cmd(self, command: TagoTiPCommand) -> str:
         :param TagoTiPCommand command: Command object with serial, protocol and body
 
         Example:
-            >>> from tagoio_sdk import Services
-            >>> services = Services({"token": "your-service-authorization-token"})
-            >>> services.tagotip.cmd({
+            >>> from tagoio_sdk import TagoTiP
+            >>> tagotip = TagoTiP({"token": "your-service-authorization-token"})
+            >>> tagotip.cmd({
             ...     "serial": "mqtt1",
             ...     "protocol": "mqtt",
             ...     "body": "reboot-now",

tests/Services/test_tagotip.py → tests/TagoTiP/test_tagotip.py

@@ -1,22 +1,15 @@
-import os
-
 from requests_mock.mocker import Mocker
 
-from tagoio_sdk.modules.Services.Services import Services
-
-
-os.environ["T_ANALYSIS_TOKEN"] = "your_token_value"
+from tagoio_sdk import TagoTiP
 
 
 def testTagoTiPCmd(requests_mock: Mocker) -> None:
-    """Test cmd method of TagoTiP service."""
-    requests_mock.post(
-        "https://api.tago.io/tip/cmd", json={"status": True, "result": "ok"}
-    )
+    """Test cmd method of TagoTiP client."""
+    requests_mock.post("https://api.tago.io/tip/cmd", json={"status": True, "result": "ok"})
 
-    services = Services({"token": "your-service-authorization-token"})
+    tagotip = TagoTiP({"token": "your-service-authorization-token"})
 
-    result = services.tagotip.cmd(
+    result = tagotip.cmd(
         {
             "serial": "mqtt1",
             "protocol": "mqtt",
@@ -30,3 +23,4 @@ def testTagoTiPCmd(requests_mock: Mocker) -> None:
         "protocol": "mqtt",
         "body": "reboot-now",
     }
+    assert requests_mock.last_request.headers["token"] == "your-service-authorization-token"