1. Control Commands & Dispatch
FoxCloud OpenAPI
Vpp Flow
  • Vpp Flow
  • Full API Reference
  • What's New & Milestones
  • Getting Started
    • 1. Overview & Integration Scope
    • 2. Environments & Prerequisites
  • End-User Enrollment & OAuth Flow
    • 0. Introduction
    • 1. The User Authorization Journey
    • 2. OAuth Token Operating Model
    • 3. Implementation Guide
  • API Technical Specifications
    • 1. Universal Request Rules
    • 2. Rate Limiting Strategy
    • 3. Response Structure
    • 4. Error Code Reference
  • Telemetry & Data Acquisition
    • 1. Data Pipeline & Scaling Strategy
    • 2. Telemetry Data Query (Real-time)
    • 4. Telemetry Variable Dictionary
    • 5. System Performance & SLA
    • 3. Device Configuration & Settings: Pre-Dispatch State Awareness
  • Control Commands & Dispatch
    • 1. Core Dispatch Architecture: Scheduler V3
    • 2. Scheduler V3 Operations
    • 3. Real-time Device Settings
    • 4. Strategic Roadmap: Scaling for Massive Fleets
  • FAQ
    • Troubleshooting Quick Guide
  1. Control Commands & Dispatch

3. Real-time Device Settings

Beyond scheduled energy management, your platform may need to adjust specific device parameters in real-time. These interfaces are ideal for setting global constraints or changing the fundamental operational mode of a device.

3.1 Core API Endpoints#

Set General Device Settings: POST /op/v0/device/setting/set
Get General Device Settings: POST /op/v0/device/setting/get

3.2 Supported Setting Variables#

The following table lists the most commonly used setting keys supported by the FoxCloud platform. Use these keys in the key parameter when calling the setting APIs.
Setting KeyUnitBusiness MeaningApplicable Devices
ExportLimitkWMaximum Export Power. Limits the maximum power the device is allowed to feed back into the grid.Hybrid / Grid-tied
MinSoc%Minimum State of Charge. The lowest battery percentage the device will discharge to. Used to reserve battery capacity for backup.ESU / Hybrid
WorkMode-Operating Mode. Defines the core behavior (e.g., SelfUse, Feedin, Backup, ForceCharge, ForceDischarge).ESU / Hybrid
ForceChargeTime-Force Charge Schedule. Defines specific time windows where the battery will actively charge (e.g., from the grid or PV).ESU / Hybrid
BatteryPowerkWBattery Charge/Discharge Power. Directly sets the target charge or discharge power for the battery.ESU / Hybrid
️Critical Note:
Not all hardware models support every setting variable. For example, a standard Grid-tied inverter without a battery will ignore MinSoc or BatteryPower commands.
Current Best Practice: To verify which settings are supported for a specific device model, please log in to the FoxCloud Web 2.0 Portal and check the available configuration options for that device.
Future Updates: The API's support for various setting variables is continuously being optimized and expanded. We recommend regularly checking the documentation for updates.

3.3 Business Logic & Best Practices#

Pre-Check Before Setting: Before sending a setting/set command, it is highly recommended to first call setting/get to ensure the device supports the target key and to understand its current allowableRange (min/max bounds).
Conflict with Scheduler: Be aware that real-time settings (like ExportLimit) may interact with your scheduled plans. Ensure your VPP logic clearly defines whether real-time overrides or scheduled segments take precedence.
Reference: For the complete JSON request body structure, exact parameter formatting, and response examples, please refer to the Full API Reference List and search for /op/v0/device/setting.
Modified at 2026-07-21 08:30:53
Previous
2. Scheduler V3 Operations
Next
4. Strategic Roadmap: Scaling for Massive Fleets
Built with