OpenFactory#

class openfactory.OpenFactory(ksqlClient, bootstrap_servers=None)[source]#

Bases: object

Main API to OpenFactory.

Provides access to deployed assets, their availability, Docker services, and their classification by type (devices, agents, etc.).

__init__(ksqlClient, bootstrap_servers=None)[source]#

Initialize the OpenFactory API.

Parameters:

ksqlClient (KSQLDBClient) – A client capable of executing KSQL queries.
bootstrap_servers (str) – Kafka bootstrap server address.

agents()[source]#

Get Asset objects corresponding to deployed MTConnect agents.

Return type:: List[Asset]
Returns:: List[Asset] – Deployed MTConnect agent assets.

agents_uuid()[source]#

Get UUIDs of deployed MTConnect agents.

Return type:: List[str]
Returns:: List[str] – UUIDs of deployed MTConnect agents.

applications()[source]#

Get Asset objects corresponding to deployed OpenFactory applications.

Return type:: List[Asset]
Returns:: List[Asset] – Deployed OpenFactory application-type assets.

applications_uuid()[source]#

Get UUIDs of deployed OpenFactory applications.

Return type:: List[str]
Returns:: List[str] – UUIDs of deployed OpenFactory application-type assets.

assets()[source]#

Get list of Asset objects deployed on OpenFactory.

Return type:: List[Asset]
Returns:: List[Asset] – Deployed Asset instances.

assets_availability()[source]#

Get availability data for all deployed assets.

Return type:: DataFrame
Returns:: DataFrame – Availability data of deployed assets.

assets_docker_services()[source]#

Get Docker services associated with all deployed assets.

Return type:: DataFrame
Returns:: DataFrame – Docker services data of deployed assets.

assets_uuid()[source]#

Get list of asset UUIDs deployed on OpenFactory.

Return type:: List[str]
Returns:: List[str] – UUIDs of all deployed assets.

devices()[source]#

Get Asset objects corresponding to deployed devices.

Return type:: List[Asset]
Returns:: List[Asset] – Deployed device-type assets.

devices_uuid()[source]#

Get UUIDs of all devices deployed on OpenFactory.

Return type:: List[str]
Returns:: List[str] – UUIDs of deployed device-type assets.

producers()[source]#

Get Asset objects corresponding to deployed Kafka producers.

Return type:: List[Asset]
Returns:: List[Asset] – Kafka producer assets.

producers_uuid()[source]#

Get UUIDs of deployed Kafka producers.

Return type:: List[str]
Returns:: List[str] – UUIDs of deployed Kafka producer assets.

supervisors()[source]#

Get Asset objects corresponding to deployed Supervisors.

Return type:: List[Asset]
Returns:: List[Asset] – Deployed supervisor-type assets.

supervisors_uuid()[source]#

Get UUIDs of deployed Supervisors.

Return type:: List[str]
Returns:: List[str] – UUIDs of deployed supervisor-type assets.