# Hyperwisor

> Build IoT products, sell them, and monitor your fleet — one platform.

## Docs

- [Authentication](https://docs.hyperwisor.com/api/authentication.md): API keys, the required headers, and keeping your secret key safe.
- [Database](https://docs.hyperwisor.com/api/database.md): Manage product database schemas, tables, and runtime data via the Manufacturer API.
- [Devices](https://docs.hyperwisor.com/api/devices.md): List devices, send commands, and store sensor data via the Manufacturer API.
- [Onboarding](https://docs.hyperwisor.com/api/onboarding.md): QR scan, device registration, and user-device management via the Manufacturer API.
- [Manufacturer API Overview](https://docs.hyperwisor.com/api/overview.md): The authenticated REST API behind the dev interfaces — base URL, auth, and endpoint groups.
- [Products](https://docs.hyperwisor.com/api/products.md): List, create, update, and delete products via the Manufacturer API.
- [AI-Generated Screens](https://docs.hyperwisor.com/apps/ai-screens.md): Generate bespoke device UIs with an AI agent instead of hand-laying them out.
- [Branding & Theming](https://docs.hyperwisor.com/apps/branding.md): Customize the app's colors, logo, and theme.
- [Deployment](https://docs.hyperwisor.com/apps/deployment.md): Build the app-starter for web and native.
- [Single vs Multi-Product](https://docs.hyperwisor.com/apps/modes.md): Choosing the app mode in app.config.ts.
- [White-label Apps](https://docs.hyperwisor.com/apps/overview.md): Ship a branded web + mobile app for your device line with the app-starter.
- [App Quickstart](https://docs.hyperwisor.com/apps/quickstart.md): From cloning the app-starter to a running app in five minutes.
- [Security](https://docs.hyperwisor.com/apps/security.md): Protect your manufacturer secret key in production.
- [Binding Data](https://docs.hyperwisor.com/dashboard/binding-data.md): Connect widgets to device payloads with widget IDs and field paths.
- [Dashboard Designer](https://docs.hyperwisor.com/dashboard/overview.md): The canvas and the four-tab properties model.
- [Control Widgets](https://docs.hyperwisor.com/dashboard/widgets/controls.md): The 15 widgets that send commands or capture input — their settings and binding behavior.
- [Display Widgets](https://docs.hyperwisor.com/dashboard/widgets/display.md): The 24 widgets that visualize device data — their settings and what they bind to.
- [Navigation Widgets](https://docs.hyperwisor.com/dashboard/widgets/navigation.md): Widgets for moving between dashboard pages and opening links.
- [Widget Reference](https://docs.hyperwisor.com/dashboard/widgets/overview.md): All 50 dashboard widgets, grouped by category.
- [Shape Widgets](https://docs.hyperwisor.com/dashboard/widgets/shapes.md): Vector primitives for layout, framing, and decoration.
- [Utility Widgets](https://docs.hyperwisor.com/dashboard/widgets/utility.md): Helper widgets that act on the dashboard itself.
- [Arduino — API Reference](https://docs.hyperwisor.com/firmware/arduino/api-reference.md): Every public method of the HyperwisorIOT class.
- [Arduino — Examples](https://docs.hyperwisor.com/firmware/arduino/examples.md): Worked examples shipped with the Hyperwisor Arduino library.
- [Arduino — Install](https://docs.hyperwisor.com/firmware/arduino/install.md): Install the Hyperwisor Arduino library and its dependencies.
- [Arduino — Provisioning](https://docs.hyperwisor.com/firmware/arduino/provisioning.md): Get a device onto Wi-Fi and linked to an account — AP-mode or manual.
- [ESP-IDF — API Reference](https://docs.hyperwisor.com/firmware/esp-idf/api-reference.md): The C API exposed through the umbrella header.
- [ESP-IDF — Configuration](https://docs.hyperwisor.com/firmware/esp-idf/configuration.md): Kconfig feature toggles, connection settings, and the board port.
- [ESP-IDF — Install](https://docs.hyperwisor.com/firmware/esp-idf/install.md): Add the Hyperwisor component to your ESP-IDF project.
- [ESP-IDF — OTA Updates](https://docs.hyperwisor.com/firmware/esp-idf/ota.md): Enable and use over-the-air firmware updates.
- [Firmware SDK Overview](https://docs.hyperwisor.com/firmware/overview.md): Choosing between the Arduino and ESP-IDF libraries.
- [NI Evaluation Board V1](https://docs.hyperwisor.com/hardware/ni-evaluation-board-v1.md): Industrial-grade ESP32 I/O board — 8 digital inputs, 2 relays, 0-10V DAC, pulse counting, RS485/Modbus, PWM.
- [Hardware Lineup](https://docs.hyperwisor.com/hardware/overview.md): Hyperwisor-ready hardware modules.
- [Core Concepts](https://docs.hyperwisor.com/learn/concepts.md): Product, device, user, and dashboard — the four ideas everything builds on.
- [How It Works](https://docs.hyperwisor.com/learn/how-it-works.md): The widget/command loop that connects firmware to dashboards.
- [Introduction](https://docs.hyperwisor.com/learn/introduction.md): What Hyperwisor is and the three roles it serves.
- [Lesson 1 — Your First Device Online](https://docs.hyperwisor.com/learn/lessons/01-first-device.md): Flash, provision, and confirm an ESP32 connects to Hyperwisor.
- [Lesson 2 — Push a Sensor Value](https://docs.hyperwisor.com/learn/lessons/02-push-sensor-value.md): Send a reading from firmware to a dashboard Gauge by its widget ID.
- [Lesson 3 — Control Hardware](https://docs.hyperwisor.com/learn/lessons/03-control-hardware.md): Receive a command from a dashboard Switch and drive a GPIO.
- [Lesson 4 — Store Readings](https://docs.hyperwisor.com/learn/lessons/04-store-data.md): Persist device data to the product database and read it back.
- [Lesson 5 — Publish & Onboard](https://docs.hyperwisor.com/learn/lessons/05-publish-onboard.md): Make your product available and onboard a device as a user.
- [Lessons](https://docs.hyperwisor.com/learn/lessons/overview.md): A guided path from your first device online to a published product.
- [Licensing](https://docs.hyperwisor.com/monetization/licensing.md): The five license types, the buyer acceptance flow, and the certificate.
- [Marketplace](https://docs.hyperwisor.com/monetization/marketplace.md): List and sell your products as templates.
- [Monetization Overview](https://docs.hyperwisor.com/monetization/overview.md): The ways a manufacturer earns on Hyperwisor.
- [Payment Widget](https://docs.hyperwisor.com/monetization/payment-widget.md): Charge users for a paid action or unlock inside a dashboard.
- [Revenue Sharing & Payouts](https://docs.hyperwisor.com/monetization/revenue-sharing.md): How marketplace earnings split and settle, and how to track them.
- [Onboard with the Official App](https://docs.hyperwisor.com/onboarding/official-app.md): Scan a device's QR, add it, and send Wi-Fi credentials in AP mode using the official Hyperwisor app.
- [Onboarding Overview](https://docs.hyperwisor.com/onboarding/overview.md): The ways a user adds a device to their account — and the official-app QR + Wi-Fi flow.
- [Get the QR onto the Hardware](https://docs.hyperwisor.com/onboarding/qr-code.md): Download a product's QR code and affix it to the device for onboarding.
- [db](https://docs.hyperwisor.com/script/database-api.md): Query and insert product database records from a script.
- [context](https://docs.hyperwisor.com/script/device-context.md): Product, device, user, and environment info available to a script.
- [Events](https://docs.hyperwisor.com/script/events.md): The widget event system — subscribe, emit, and clean up.
- [Script Examples](https://docs.hyperwisor.com/script/examples.md): Common scripting patterns built from the Script API.
- [location](https://docs.hyperwisor.com/script/location-api.md): Read the viewing device's geolocation from a script.
- [Script API Overview](https://docs.hyperwisor.com/script/overview.md): Author JavaScript logic on a dashboard with the Script tab.
- [storage](https://docs.hyperwisor.com/script/storage-api.md): Persist small values on the client from a script.
- [ws](https://docs.hyperwisor.com/script/websocket-api.md): Send and receive realtime messages from a script.
- [widget](https://docs.hyperwisor.com/script/widgets-api.md): Read and control dashboard widgets from a script.