infuse-iot 0.1.0__tar.gz

infuse_iot-0.1.0/LICENSE.md

@@ -0,0 +1,105 @@
+# Functional Source License, Version 1.1, ALv2 Future License
+
+## Abbreviation
+
+FSL-1.1-ALv2
+
+## Notice
+
+Copyright 2025 Embeint Holdings Pty Ltd
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or
+service that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software
+   that exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee
+   using the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to
+the infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES,
+EVEN IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following
+will apply:
+
+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.

infuse_iot-0.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: infuse_iot
+Version: 0.1.0
+Summary: Infuse-IoT Platform python package
+Author-email: Embeint Holdings Pty Ltd <support@embeint.com>
+License-Expression: LicenseRef-FSL-1.1-ALv2
+Project-URL: Homepage, https://github.com/Embeint/python-tools
+Project-URL: Issues, https://github.com/Embeint/python-tools/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: argcomplete
+Requires-Dist: aiohttp
+Requires-Dist: attrs
+Requires-Dist: bleak
+Requires-Dist: cryptography
+Requires-Dist: colorama
+Requires-Dist: httpx
+Requires-Dist: pylink-square
+Requires-Dist: pyserial
+Requires-Dist: python-dateutil
+Requires-Dist: rich
+Requires-Dist: simple-term-menu
+Requires-Dist: tabulate
+Requires-Dist: keyring
+Requires-Dist: pyocd
+Requires-Dist: pyyaml
+Requires-Dist: paho-mqtt
+Dynamic: license-file
+
+# Infuse-IoT Python Tools
+
+## Installation
+
+Clone source code from Github and install as a local pip package.
+
+```
+git clone git@github.com:Embeint/python-tools.git
+pip install -e python-tools
+```
+
+## Register Autocomplete
+
+To register for autocompletion (tab complete).
+
+```
+autoload -Uz compinit
+compinit
+eval "$(register-python-argcomplete infuse)"
+```
+
+## Usage
+
+```
+> infuse --help
+usage: infuse [-h] [--version] <command> ...
+
+options:
+  -h, --help         show this help message and exit
+  --version          show program's version number and exit
+
+commands:
+  <command>
+    bt_log           Connect to remote Bluetooth device serial logs
+    cloud            Infuse-IoT cloud interaction
+    credentials      Manage Infuse-IoT credentials
+    csv_annotate     Annotate CSV data
+    csv_plot         Plot CSV data
+    gateway          Connect to a local gateway device
+    localhost        Run a local server for TDF viewing
+    native_bt        Native Bluetooth gateway
+    ota_upgrade      Automatically OTA upgrade observed devices
+    provision        Provision device on Infuse Cloud
+    rpc              Run remote procedure calls on devices
+    rpc_cloud        Manage remote procedure calls through Infuse-IoT cloud
+    serial_throughput
+                     Test serial throughput to local gateway
+    tdf_csv          Save received TDFs in CSV files
+    tdf_list         Display received TDFs in a list
+```
+
+## Credential Storage
+
+Under linux, the preferred credential storage provider for the python ``keyring``
+package is provided by ``gnome-keyring``. The available backends can be listed with
+``keyring --list-backends``.
+
+```
+sudo apt install gnome-keyring
+```
+
+### WSL Issues
+
+Under WSL, they keyring has been observed to consistently raise
+``secretstorage.exceptions.PromptDismissedException: Prompt dismissed``.
+This can be resolved by adding the following to ``~/.bashrc`` and reloading
+the terminal.
+```
+dbus-update-activation-environment --all > /dev/null 2>&1
+```

infuse_iot-0.1.0/README.md

@@ -0,0 +1,70 @@
+# Infuse-IoT Python Tools
+
+## Installation
+
+Clone source code from Github and install as a local pip package.
+
+```
+git clone git@github.com:Embeint/python-tools.git
+pip install -e python-tools
+```
+
+## Register Autocomplete
+
+To register for autocompletion (tab complete).
+
+```
+autoload -Uz compinit
+compinit
+eval "$(register-python-argcomplete infuse)"
+```
+
+## Usage
+
+```
+> infuse --help
+usage: infuse [-h] [--version] <command> ...
+
+options:
+  -h, --help         show this help message and exit
+  --version          show program's version number and exit
+
+commands:
+  <command>
+    bt_log           Connect to remote Bluetooth device serial logs
+    cloud            Infuse-IoT cloud interaction
+    credentials      Manage Infuse-IoT credentials
+    csv_annotate     Annotate CSV data
+    csv_plot         Plot CSV data
+    gateway          Connect to a local gateway device
+    localhost        Run a local server for TDF viewing
+    native_bt        Native Bluetooth gateway
+    ota_upgrade      Automatically OTA upgrade observed devices
+    provision        Provision device on Infuse Cloud
+    rpc              Run remote procedure calls on devices
+    rpc_cloud        Manage remote procedure calls through Infuse-IoT cloud
+    serial_throughput
+                     Test serial throughput to local gateway
+    tdf_csv          Save received TDFs in CSV files
+    tdf_list         Display received TDFs in a list
+```
+
+## Credential Storage
+
+Under linux, the preferred credential storage provider for the python ``keyring``
+package is provided by ``gnome-keyring``. The available backends can be listed with
+``keyring --list-backends``.
+
+```
+sudo apt install gnome-keyring
+```
+
+### WSL Issues
+
+Under WSL, they keyring has been observed to consistently raise
+``secretstorage.exceptions.PromptDismissedException: Prompt dismissed``.
+This can be resolved by adding the following to ``~/.bashrc`` and reloading
+the terminal.
+```
+dbus-update-activation-environment --all > /dev/null 2>&1
+```

infuse_iot-0.1.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=61.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "infuse_iot"
+version = "0.1.0"
+authors = [{name = "Embeint Holdings Pty Ltd", email = "support@embeint.com"}]
+description = "Infuse-IoT Platform python package"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "argcomplete",
+    "aiohttp",
+    "attrs",
+    "bleak",
+    "cryptography",
+    "colorama",
+    "httpx",
+    "pylink-square",
+    "pyserial",
+    "python-dateutil",
+    "rich",
+    "simple-term-menu",
+    "tabulate",
+    "keyring",
+    "pyocd",
+    "pyyaml",
+    "paho-mqtt",
+]
+license = "LicenseRef-FSL-1.1-ALv2"
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.scripts]
+infuse = "infuse_iot.app.main:main"
+
+[project.urls]
+Homepage = "https://github.com/Embeint/python-tools"
+Issues = "https://github.com/Embeint/python-tools/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+zip-safe = false
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false

infuse_iot-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

infuse_iot-0.1.0/src/infuse_iot/__init__.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python3
+
+import logging
+
+# https://docs.python.org/3/howto/logging.html#configuring-logging-for-a-library
+logging.getLogger("infuse").addHandler(logging.NullHandler())

infuse_iot-0.1.0/src/infuse_iot/__main__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python3
+
+from infuse_iot.app.main import main
+
+main()

infuse_iot-0.1.0/src/infuse_iot/api_client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Infuse API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

infuse_iot-0.1.0/src/infuse_iot/api_client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

infuse_iot-0.1.0/src/infuse_iot/api_client/api/board/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

infuse_iot-0.1.0/src/infuse_iot/api_client/api/board/create_board.py

@@ -0,0 +1,166 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.board import Board
+from ...models.new_board import NewBoard
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: NewBoard,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/board",
+    }
+
+    _body = body.to_dict()
+
+    _kwargs["json"] = _body
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, Board]]:
+    if response.status_code == 201:
+        response_201 = Board.from_dict(response.json())
+
+        return response_201
+    if response.status_code == 409:
+        response_409 = cast(Any, None)
+        return response_409
+    if response.status_code == 422:
+        response_422 = cast(Any, None)
+        return response_422
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Any, Board]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: NewBoard,
+) -> Response[Union[Any, Board]]:
+    """Create a new board
+
+    Args:
+        body (NewBoard):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, Board]]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: NewBoard,
+) -> Optional[Union[Any, Board]]:
+    """Create a new board
+
+    Args:
+        body (NewBoard):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, Board]
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: NewBoard,
+) -> Response[Union[Any, Board]]:
+    """Create a new board
+
+    Args:
+        body (NewBoard):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, Board]]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: NewBoard,
+) -> Optional[Union[Any, Board]]:
+    """Create a new board
+
+    Args:
+        body (NewBoard):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, Board]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

infuse_iot-0.1.0/src/infuse_iot/api_client/api/board/get_board_by_id.py

@@ -0,0 +1,154 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.board import Board
+from ...types import Response
+
+
+def _get_kwargs(
+    id: UUID,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/board/id/{id}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Any, Board]]:
+    if response.status_code == 200:
+        response_200 = Board.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[Any, Board]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: UUID,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[Any, Board]]:
+    """Get a board by ID
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, Board]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: UUID,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[Any, Board]]:
+    """Get a board by ID
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, Board]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: UUID,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[Any, Board]]:
+    """Get a board by ID
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[Any, Board]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: UUID,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[Any, Board]]:
+    """Get a board by ID
+
+    Args:
+        id (UUID):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[Any, Board]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed