Skip to main content

IoT Inspector API Client

This is the official Python client for the IoT Inspector public API.

Usage

First, you have to log in and select a tenant:

from iot_inspector_client import Client

YOUR_API_URL = "https://demo.iot-inspector.com/api"

client = Client(api_url=YOUR_API_URL)

client.login(EMAIL, PASSWORD)
tenant = client.get_tenant("Environment name")
client.use_tenant(tenant)

After you logged in and selected the tenant, you can query the GraphQL API

GET_ALL_FIRMWARES = """
query {
  allFirmwares {
    id
    name
  }
}
"""
res = client.query(GET_ALL_FIRMWARES)
print(res)

GET_PRODUCT_GROUPS = """
query {
  allProductGroups {
    id
    name
  }
}
"""
res = client.query(GET_PRODUCT_GROUPS)
default_product_group = next(pg for pg in res["allProductGroups"] if pg["name"] == "Default")

You can upload firmwares:

metadata = FirmwareMetadata(
    name="myFirmware",
    vendor_name="myVendor",
    product_name="myProduct",
    product_group_id=default_product_group["id"],
)

firmware_path = Path("/path/to/firmware.bin")
res = client.upload_firmware(metadata, firmware_path, enable_monitoring=True)
print(res)

Support

You can create a new issue in this repo or contact us at support@iot-inspector.com.

Metadata

Release files for iot-inspector-client 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iot-inspector-client 1.2.1
File Size Uploaded
iot_inspector_client-1.2.1.tar.gz 19.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for iot-inspector-client 1.2.1
File Interpreter ABI Platform
iot_inspector_client-1.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 38.7 kB

Release files / iot_inspector_client-1.2.1.tar.gz

Download URL iot_inspector_client-1.2.1.tar.gz
Size 19.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b74b5f778dd4038091d6f8251d46a236d700aa5180858b1b3d240ff48197729f
BLAKE2b-256 checksum
How to use checksums
3d9bc0b1b4d4f67ec9907368bba16c4dd1336fff9c31913d5338da9b4f659a78
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.13 CPython/3.10.4 Linux/5.13.0-1021-azure

Release files / iot_inspector_client-1.2.1-py3-none-any.whl

Download URL iot_inspector_client-1.2.1-py3-none-any.whl
Size 19.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aa8106efe14f031acfb6d6feb332ae3487379d2f5d7638204195bd7e4f6d975a
BLAKE2b-256 checksum
How to use checksums
eb9667f4e09899b852a25bbfea2298f87a9e6e57da785a22d1c7c951d61d6950
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.13 CPython/3.10.4 Linux/5.13.0-1021-azure

Release history Release notifications | RSS feed

This release

1.2.1 This release

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page