das.iot_client package

Subpackages

• das.iot_client.interfaces package
  • Submodules
  • das.iot_client.interfaces.assets_client module
    • AssetsClient
      • AssetsClient.get_all_assets()
      • AssetsClient.get_asset_template()
      • AssetsClient.get_asset_templates()
      • AssetsClient.get_assets()
      • AssetsClient.get_attributes()
      • AssetsClient.print_asset_tree()
  • das.iot_client.interfaces.commands_client module
    • CommandsClient
      • CommandsClient.get_command_details()
      • CommandsClient.send_command()
      • CommandsClient.send_control_command()
  • das.iot_client.interfaces.credentials_client module
    • CredentialsClient
      • CredentialsClient.get_credential_query()
      • CredentialsClient.get_credentials()
  • das.iot_client.interfaces.data_client module
    • DataClient
      • DataClient.get_multiple_timeseries()
      • DataClient.get_statistics()
      • DataClient.get_timeseries()
      • DataClient.get_timesignal()
      • DataClient.write_calculated()
      • DataClient.write_static()
      • DataClient.write_telemetry()
      • DataClient.write_timesignal()
      • DataClient.write_timesignals()
  • das.iot_client.interfaces.devices_client module
    • DevicesClient
      • DevicesClient.get_device()
      • DevicesClient.get_devices()
  • das.iot_client.interfaces.events_client module
    • EventsClient
      • EventsClient.asset_event_active_count
      • EventsClient.get_asset_event_history()
      • EventsClient.get_asset_events_active()
      • EventsClient.write_device_event()
      • EventsClient.write_device_events()
  • das.iot_client.interfaces.models_client module
    • BaseClient
    • ModelsClient
      • ModelsClient.analytics_items_count
      • ModelsClient.delete_model()
      • ModelsClient.get_all_analytics_items()
      • ModelsClient.get_model_details()
      • ModelsClient.get_model_list()
      • ModelsClient.register_model()
      • ModelsClient.update_model()
    • OnnxClient
      • OnnxClient.delete_onnx_model()
      • OnnxClient.get_onnx_model_details()
      • OnnxClient.get_onnx_model_list()
      • OnnxClient.register_onnx_model()
      • OnnxClient.update_onnx_model()
    • ServicesClient
      • ServicesClient.delete_service()
      • ServicesClient.get_service_details()
      • ServicesClient.get_service_list()
      • ServicesClient.register_service()
      • ServicesClient.update_service()
  • das.iot_client.interfaces.organizations_client module
    • OrganizationsClient
      • OrganizationsClient.get_organization_details()
      • OrganizationsClient.get_organizations()
  • Module contents

Submodules

das.iot_client.client module

Top-level class to be called with the sdk

class das.iot_client.client.IoTClient(base_url=None, subscription=None, organization_id=None, client_id=None, client_secret=None, username=None, password=None, identity_provider=None, auth_flow='legacy', keep_alive=False)

Bases: AssetsClient, CredentialsClient, DataClient, DevicesClient, EventsClient, ModelsClient, OnnxClient, OrganizationsClient, ServicesClient

REST API client for IoT-TICKET 4.x

Attributes

analytics_items_count

Get the count of how many analytics items (MLModels, MLServices and OnnxModels) are currently registered to IoT-TICKET.

asset_event_active_count

Get the number of events that are currently active.

Methods

delete_model([model_name, model_id])	Delete a registered model in IoT-TICKET.
delete_onnx_model([model_name, model_id])	Delete an ONNX model that is registered into IoT-TICKET
delete_service([service_name, service_id])	Delete a registered service in IoT-TICKET.
get_all_analytics_items()	List all data-analytics items that are registered to IoT-TICKET, including models, services and ONNX-models.
get_all_assets([templates, event_types])	Get all assets for the organization.
get_asset_event_history([asset_ids, ...])	Get event history from IoT-TICKET for an organization.
get_asset_events_active([asset_ids, ...])	Get active asset events from IoT-TICKET for an organization.
get_asset_template([template_id, template_name])	Get details of an asset template in IoT-TICKET.
get_asset_templates()	Get a list of asset templates in IoT-TICKET.
get_assets([asset_id, asset_name, names_path])	Get information of assets in a certain position of the asset tree.
get_attributes([asset_id, asset_name, ...])	Read asset attributes information.
get_credential_query([organization_id, ...])	Query credentials by given information.
get_credentials([organization_id])	Read credentials information.
get_device(device_id)	Get information from a specific device.
get_devices([asset_id, asset_name, names_path])	Get device ids.
get_model_details([model_name, model_id])	Get details of a model registered into IoT-TICKET.
get_model_list()	List all models that are registered into IoT-TICKET.
get_multiple_timeseries([names_path, ...])	Get data from multiple Telemetry Data or Calculated attributes with the same call.
get_onnx_model_details([model_name, model_id])	Get details of a registered ONNX Model.
get_onnx_model_list()	Get all registered ONNX Models.
get_organization_details([organization_id])	Get details for current organization (default), or for the organization of which id was given.
get_organizations()	Read organizations information.
get_service_details([service_name, service_id])	Get details of a service registered into IoT-TICKET.
get_service_list()	List all services that are registered into IoT-TICKET.
get_statistics(period, dimension[, ...])	Read asset attribute statistics values.
get_timeseries([names_path, attribute_id, ...])	Read asset attribute values from a single Telemetry Data or Calculated attribute.
get_timesignal(timesignal_id[, ...])	Read asset timesignal attribute values.
print_asset_tree([asset_id, asset_name, ...])	Get all available assets printed in a tree form.
register_model(model)	Create a registered ML model to IoT-TICKET.
register_onnx_model(name, file_location[, ...])	Register a model to IoT-TICKET in ONNX (Open Neural Network Exchange) form.
register_service(service)	Create a registered ML service to IoT-TICKET.
update_model(model)	Update a model in IoT-TICKET.
update_onnx_model(payload[, model_id])	Update ONNX model basic information.
update_service(service[, service_name, ...])	Update a service in IoT-TICKET.
write_calculated(data[, names_path, ...])	Write to IoT-TICKET's Calculated attributes.
write_device_event(device_id, ...[, ...])	Write a device event to IoT-TICKET.
write_device_events(device_id, ...[, tz])	Write multiple device events to IoT-TICKET based on the complete json payload that is delivered by the user.
write_static(data[, attribute_ids, ...])	Write to IoT-TICKET's static String or Number attributes.
write_telemetry(data, device_id, ...[, ...])	Write data to a device in IoT-TICKET.
write_timesignal(device_id, device_username, ...)	Write a time signal to a device in IoT-TICKET.
write_timesignals(device_id, ...[, tz])	Write one or multiple time signals to a device in IoT-TICKET based on the complete payload given by the user.

logout

allowed_flows = ['legacy', 'webapp-manual', 'webapp-auto']

logout(delete_token_cache=False)

Module contents