Skip to content

api.md

Latest commit

 

History

History
90 lines (51 loc) · 1.54 KB

api.md

File metadata and controls

90 lines (51 loc) · 1.54 KB

API Reference

All public symbols are re-exported from the top-level package and can be imported directly:

from oshconnect import OSHConnect, Node, Datastream, TimePeriod, ObservationFormat

Lower-level CS API utilities are available from the oshconnect.csapi4py sub-package:

from oshconnect.csapi4py import APIResourceTypes, MQTTCommClient, ConnectedSystemsRequestBuilder

Core Application

::: oshconnect.oshconnectapi

Streamable Resources

The primary objects for interacting with systems, datastreams, and control streams on an OSH node. Includes Node, System, Datastream, ControlStream, and supporting enums.

::: oshconnect.streamableresource

Resource Data Models

Pydantic models that represent CS API resources returned from or sent to an OSH server.

::: oshconnect.resource_datamodels

SWE Schema Components

Builder classes for constructing datastream and command schemas using SWE Common data types.

::: oshconnect.swe_components

::: oshconnect.schema_datamodels

Event System

Pub/sub event bus for in-process notifications. Implement IEventListener to receive events.

::: oshconnect.eventbus

::: oshconnect.events.core

::: oshconnect.events.builder

Time Management

::: oshconnect.timemanagement

CS API Integration (csapi4py)

Constants and Enums

::: oshconnect.csapi4py.constants

Request Builder

::: oshconnect.csapi4py.con_sys_api

API Helper

::: oshconnect.csapi4py.default_api_helpers

MQTT Client

::: oshconnect.csapi4py.mqtt