Ona SDK Documentation
The Ona SDK provides typed client libraries (Python & JavaScript) for integrating with the Ona Intelligence Layer — energy forecasting, fault detection, inverter telemetry, and O&M intelligence for solar, wind, and battery storage assets.
Quick Start
Install the SDK:
# Python
git clone https://github.com/AsobaCloud/sdk.git
cd sdk/python && pip3 install -e .
# JavaScript
git clone https://github.com/AsobaCloud/sdk.git
cd sdk/javascript && npm install
Set your API key (contact support@asoba.org to get one):
export INVERTER_TELEMETRY_ENDPOINT=https://api.asoba.org
export INVERTER_TELEMETRY_API_KEY=<your_api_key>
Make your first call:
from ona_platform import OnaClient
client = OnaClient()
period = client.inverter_telemetry.get_data_period(site_id="Sibaya")
print(f"Data available from {period['first_record']} to {period['last_record']}")
→ See the full Quickstart Guide for streaming, alerts, and more.
SDK Service Guides
| Service | Description |
|---|---|
| Inverter Telemetry | Query and stream live inverter data |
| OODA Terminal Alerts | Query and stream fault/diagnostic alerts |
| Forecasting | Device, site, and customer-level energy forecasts |
| Freemium Forecasting | No-API-key forecasting with email verification |
| Terminal OODA Workflow | Full OODA loop: detect → diagnose → decide → act |
| Partner API | Pre-computed JSON snapshots with ETag caching |
| Energy Analyst | RAG-powered energy policy queries |
| Edge Devices | Device discovery and management |
| Data Ingestion & Training | Upload data and manage ML models |
| PV Insight Service | RAG-powered O&M recommendations from anomaly detections |
ODS-E & Data Architecture
- What is ODS-E? — The Open Data Schema for Energy specification
- Ona Intelligence Layer Architecture — How ODS-E fits with the platform
- ODS-E & the SDK — How ODS-E connects to SDK data flows
Code Examples
- Complete Workflow — Multi-service integration walkthrough
- Python vs JavaScript — Side-by-side language comparison
- All Examples on GitHub — Full source with tests
Resources
- SDK Overview — Architecture, service map, and design philosophy
- Installation — Setup and configuration
- Authentication — API keys and multi-endpoint config
- Error Handling — Error classes, retry logic, rate limiting
Repositories
- Ona SDK — Python & JavaScript SDKs
- ODS-E Protocol — Open data schema specification
Support
- GitHub Issues: AsobaCloud/sdk
- Email: support@asoba.org
- Discord: Join our community