1. Telemetry & Data Acquisition
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. Telemetry & Data Acquisition

3. Device Configuration & Settings: Pre-Dispatch State Awareness

Before sending any control commands to a device, your VPP platform must understand both its physical capabilities and its current operational limits. This section covers the complete state awareness workflow.

4.1 Static Configuration: Understanding Device Capabilities#

API Endpoint: POST /op/v1/device/detail
Purpose: Determine the physical hardware setup and installed components. This data rarely changes and defines what a device can do.
Key Response Fields:
Hardware Identification: deviceSN, stationID, stationName, capacity (rated power in kW).
Battery Details: The batteryList array provides critical storage information, including batterySN, model, capicty (in Wh), and productDate.
Firmware & Status: hardwareVersion, managerVersion, and status (1: online, 2: breakdown, 3: offline).
Business Value: Essential for service eligibility checks. For example, you should not send a battery dispatch command to a grid-tied inverter that has no battery installed (empty batteryList), or to a device that is currently offline (status: 3).

4.2 Dynamic Settings: Understanding Operational Limits#

API Endpoint: POST /op/v0/device/setting/get
Purpose: Query the current user-defined or system-defined limits. This defines what a device is allowed to do at this moment.
Key Parameters:
key: The specific setting identifier (e.g., ExportLimit, MinSoc, WorkMode).
sns: The device serial number(s).
Response Structure: Returns the current value, unit, precision, and allowableRange (min/max bounds).
Business Value: Critical for safe dispatching. Before sending a charge/discharge command, your platform should verify that the target power level is within the device's current ExportLimit and that the battery SoC is above the user's configured MinSoc.
Modified at 2026-07-09 12:30:42
Previous
5. System Performance & SLA
Next
1. Core Dispatch Architecture: Scheduler V3
Built with