OSHConnect-Python

OSHConnect-Python is the Python member of the OSHConnect family of application libraries. It provides a simple, straightforward way to interact with OpenSensorHub (or any other OGC API – Connected Systems server).

What do you want to do?

• Read live sensor data — start with the Quickstart, then Consuming Sensor Data.

• Feed data into an OSH node (build a sensor driver or ingester in Python) — Publishing Sensor Data.

• Send commands to devices — Commanding Systems.

• Work with binary or compact wire formats (video, swe+proto, swe+flatbuffers) — Binary and Compact Encodings.

• Understand the object model — Architecture.

• Look up a class or function — API Reference.

Capabilities

OSHConnect-Python supports Parts 1, 2, and 3 (Pub/Sub) of the OGC Connected Systems API, including:

• System, Datastream, and ControlStream discovery and management

• Real-time MQTT streaming using CS API Part 3 :data/<format> topic conventions (swe-binary, swe-json, json, …)

• Resource event topic subscriptions (CloudEvents lifecycle notifications)

• Batch retrieval and archival stream playback

• Configuration persistence (JSON save / load)

• SWE Common schema builders for defining datastream and command schemas

• OGC standard-format serialization (SML+JSON, OM+JSON, SWE+JSON, GeoJSON)

All major classes and utilities are importable directly from oshconnect. Lower-level CS API utilities are available from oshconnect.csapi4py.

Getting Started

• Installation
• Prerequisites
• Quickstart

Guides

• Connecting to a Node
• Consuming Sensor Data
• Publishing Sensor Data
• Commanding Systems
• Binary and Compact Encodings
• Saving and Loading Configuration

Concepts

• Architecture

Reference

• API Reference

Indices and tables

• Index

• Module Index

• Search Page