Industrial IoT SDK for Python¶
Introduction¶
The Industrial IoT SDK for Python enables developers to work with Insights Hub easily. It is divided into a core module and several service modules, which allows developers to include only those parts of the SDK required for their use case.
The core module provides authentication, logging, credentials configuration and a common API client implementation to access the RESTful Industrial IoT APIs. All service modules have dependency on the core module.
The Industrial IoT SDK for Python provides client implementations for the following APIs:
| Name | API Version |
|---|---|
| SDK Core | 1.0.3 |
| Asset Management | 3.11.6 |
| Integrated Data Lake | 3.10.1 |
| IoT Time Series | 3.4.3 |
| TS Aggregates | 4.2.1 |
| IoT File Service | 3.2.6 |
| Event Analytics | 3.1.5 |
| MindConnect | 3.5.3 |
| TSBulk | 3.5.2 |
| Semantic Data Interconnect | 1.0.5 |
Following older SDK & API versions can be referred for backward compatibility & will be deprecated in upcoming SDK releases:
| Name | API Version |
|---|---|
| IoT Time Series | 3.3.2 |
| IoT TS Aggregates | 3.2.2 |
Refer to the Getting Started for details on installation of modules and configuration of an API clients.
Get the SDK¶
The Industrial IoT SDK for Python is available for download on the Siemens Industry Online Support (SIOS) Portal. The SDK core and service specific modules(.whl) are bundled into a ZIP file.
Features¶
Industrial IoT SDK Core¶
The core module of the Industrial IoT SDK for Python handles authorization, client configuration, error handling, logging, and a common API Client to access RESTful Industrial IoT APIs. All service modules have a dependency on the core module.
Client Configuration¶
You can easily configure the Industrial IoT SDK for Python through configuration parameters such as proxy settings, host environment and connection time-outs.
Token Handling Mechanism¶
The Industrial IoT SDK for Python provides an easy authorization mechanism. It handles technical token fetching, caching, validation and re-fetching based on user authorization tokens or service credentials as configured.
Refer to Token Handling for more information.
Logging¶
The Industrial IoT SDK for Python uses Python's built-in logging module. Logging can be enabled or disabled and set to the required level.
Refer to Logging for more information.
Error Handling¶
The Industrial IoT SDK for Python provides an error handling mechanism. Different error classes help to identify whether an error was caused by your client or by the Industrial IoT server. Detailed information such as error, message, HTTP status and logref are provided for investigation.
Refer to Error Handling for more information.