Skip to main content
The component is configured through Kconfig (idf.py menuconfig or sdkconfig.defaults). Features compile in only when enabled, so you pay for what you use.

​
Feature toggles

SymbolDefaultPurpose
HYPERWISOR_ENABLE_SYSTEMyBuilt-in restart, status commands
HYPERWISOR_ENABLE_NTPySNTP time sync after Wi-Fi up
HYPERWISOR_ENABLE_HTTPyhyperwisor_http_get/post helpers
HYPERWISOR_ENABLE_WIDGETyPush live values to dashboard widgets
HYPERWISOR_ENABLE_OTAnOTA via the OTA_UPDATE cloud command
HYPERWISOR_ENABLE_GPIOnCloud-driven GPIO read/write
HYPERWISOR_ENABLE_DISPLAYnBacklight control via the board port

​
Connection settings

CONFIG_HYPERWISOR_HTTP_BASE_URL="https://your.api/functions/v1"
CONFIG_HYPERWISOR_WS_HOST="your.realtime.host"
CONFIG_HYPERWISOR_WS_PORT=443
The defaults point at the official Hyperwisor cloud. Override these only when self-hosting.

​
Board port (optional)

For production boards, provide a hyperwisor_port_t struct of function pointers to integrate with a specific board’s GPIO whitelist, display backlight, or sensor APIs. See hyperwisor_port.h for the full interface.

Next: API reference

The C API across the umbrella header.