OrbitEOS Energy Management

List all accounts (organizations) on the platform. Root admin only.

Create a new account (organization) on the platform. Root admin only.

Update an account. Root admin only.

List sub-accounts (divisions) for an account.

Create a sub-account (division) within an account.

Update a sub-account.

Delete a sub-account.

List all sites accessible to the current user. Supports tree view (lazy loading by parentId) or flat list.

Search sites by name, description, or location across the entire hierarchy. Returns breadcrumb paths.

Get detailed information about a specific site including edge mappings.

Create a new site in the hierarchy. Types: region, hub, site, zone. Only "site" type can have edge mappings.

Update a site's properties, hierarchy position, or edge mappings.

Delete a site and all its children in the hierarchy.

Get the full component configuration for a site (fetched live from the energy system). Shows all controllers, meters, inverters, etc.

List all users in the current account. Shows name, email, role, last login, and active status.

Get detailed information about a specific user including their assigned sites.

Create a new user in the account. Assign a role and optionally specific sites.

Update a user's profile, role, active status, or site assignments.

Deactivate a user account. Does not permanently delete — can be reactivated.

Send an email invitation for someone to join the account.

List all roles in the account with their permissions.

List all available permissions that can be assigned to roles.

Create a custom role with specific permissions.

Update a role's name, description, or permissions.

Delete a custom role. Cannot delete system roles or roles assigned to users.

Get current live power/energy snapshot for a site. Returns grid power, solar production, consumption, battery SoC, etc.

Get a single channel value from a site. Channels are addresses like "_sum/GridActivePower" or "ess0/Soc".

Explain what OrbitEOS is, what sections the dashboard has, and what metrics are available. Useful for orientation.

Get a human-readable summary of a site: what components it has, its capabilities, current status.

Query historical timeseries power data for a site. Returns time-indexed power values (watts) for the specified channels and date range.

Query cumulative energy totals (kWh) for a site over a date range. Returns production, consumption, grid import/export, battery charge/discharge.

Export historical data as CSV for a site and date range.

Create a new component (controller, meter, inverter, etc.) on a site. Requires the factory ID and configuration properties.

Update configuration properties of an existing component on a site.

Delete a component from a site. Use with caution — this removes the component from the energy system.

Write a value to a writable channel on a site. Used for manual control (e.g., set EV charger power limit, force battery charge/discharge).

Check if a site's energy system is running normally. Answers "Is my system running normally?" by checking online status, battery SoC, grid connection, and component states.

Analyze why grid import is high. Compares production vs consumption patterns. Answers "Why am I importing so much from the grid?"

Compare solar production across two periods. Answers "Solar seems lower than usual" by comparing recent vs previous period.

Get energy summary for a site over a period. Answers "How much solar did I generate this month?" or "What's my energy usage?"

Analyze battery charge/discharge patterns and provide sizing recommendations. Answers "Should I get a bigger battery?"

Get system logs for a site. Shows runtime log entries filtered by level.

Execute a system command on a site's edge controller. Use with caution. Commands: restart, factoryReset, etc.

Get all platform configuration settings. Root admin only. Includes SMTP, branding, security, edge connection, LLM config.

Update platform configuration settings. Root admin only. Pass an array of {key, value} pairs.

Test SMTP email configuration by sending a test email.

Query the audit log to see who did what and when. Shows user actions like logins, creates, updates, deletes.

Search across all entities: accounts, sub-accounts, sites, users. Returns matching results with entity types.

Check the health of the OrbitEOS platform itself (database connection, edge backend connectivity).

List all marketplace categories: Energy Devices, Cloud Integrations, Analytics, Control Strategies, Notifications, Dashboard Widgets, Data Export, Protocols, UI Apps.

Browse available plugins in the marketplace. Filter by category, type, or search text.

Get detailed information about a marketplace plugin including its configuration schema and capabilities.

Install a marketplace plugin for your account. Once installed, it can be assigned to specific sites.

List all plugins installed in your account, including their site assignments.

Update configuration of an installed plugin.

Uninstall a plugin from your account. Removes all site assignments.

Assign an installed plugin to a specific site. This creates a device/algorithm/integration instance at the site level. E.g., assign "SMA Inverter" driver to "Munich Factory" site.

Remove a plugin assignment from a site.

List all plugins/devices/algorithms assigned to a specific site.

Create a new marketplace category. Root admin only.

Create a new plugin in the marketplace. Root admin only.