dpsctl nvgrid#

`dpsctl nvgrid` Usage Guide#

Overview#

dpsctl nvgrid provides DPS NvGrid power management operations for grid integration and load target scheduling.

Usage#

dpsctl nvgrid [command [command options]]

Flags#

Includes global dpsctl options.

   --help, -h  show help

Commands#

set-load-target - Set a load target for power feeds
get-schedule - Get load schedule for specified feeds and time interval
get-current - Get currently active load targets for all feeds
get-metadata - Get metadata for all power feeds
get-status - Get current system status for all feeds
register-webhook - Register a webhook for power events
unregister-webhook - Unregister a previously registered webhook
help, h - Shows a list of commands or help for one command

Examples#

Query Feed Information#

# Get feed metadata
dpsctl nvgrid get-metadata

# Get current status
dpsctl nvgrid get-status

# Get active targets
dpsctl nvgrid get-current

Schedule Load Targets#

# Schedule 6MW target for 1 hour
dpsctl nvgrid set-load-target \
  --value=6 \
  --unit=megawatt \
  --start-time="2025-10-24T15:00:00Z" \
  --end-time="2025-10-24T16:00:00Z" \
  --best-effort=true

# Schedule with specific correlation ID
dpsctl nvgrid set-load-target \
  --value=5 \
  --unit=megawatt \
  --start-time="2025-10-24T17:00:00Z" \
  --end-time="2025-10-24T18:00:00Z" \
  --correlation-id="curtailment-001" \
  --best-effort=true

# Target specific feeds
dpsctl nvgrid set-load-target \
  --value=4.5 \
  --unit=megawatt \
  --start-time="2025-10-24T15:00:00Z" \
  --end-time="2025-10-24T15:30:00Z" \
  --feed-tags="feed-a1,feed-a2"

# Reset to default constraint (method 1: using --default)
dpsctl nvgrid set-load-target \
  --default \
  --start-time="2025-10-24T18:00:00Z" \
  --end-time="2025-10-24T20:00:00Z"

# Reset to default constraint (method 2: using --value=0)
dpsctl nvgrid set-load-target \
  --value=0 \
  --unit=watt \
  --start-time="2025-10-24T18:00:00Z" \
  --end-time="2025-10-24T20:00:00Z"

Query Schedules#

# Query schedule for next 4 hours
dpsctl nvgrid get-schedule \
  --start-time="2025-10-24T14:00:00Z" \
  --end-time="2025-10-24T18:00:00Z"

# Query specific feeds
dpsctl nvgrid get-schedule \
  --start-time="2025-10-24T14:00:00Z" \
  --end-time="2025-10-24T18:00:00Z" \
  --feed-tags="feed-a1"

Webhook Management#

# Register webhook for all events
dpsctl nvgrid register-webhook \
  --url="https://grid-solution.example.com/webhook"

# Register for specific events
dpsctl nvgrid register-webhook \
  --url="https://grid-solution.example.com/webhook" \
  --events="start-ramp-down,end-ramp-down"

# Unregister webhook
dpsctl nvgrid unregister-webhook \
  --url="https://grid-solution.example.com/webhook"

Common Flags#

set-load-target#

Flag	Type	Description
`--value`	float	Target load value (mutually exclusive with `--default`)
`--unit`	string	Unit: `watt`, `w`, `kilowatt`, `kw`, `megawatt`, or `mw` (required with `--value`)
`--default`	bool	Reset to default (zero) power constraint (mutually exclusive with `--value` and `--unit`)
`--start-time`	timestamp	Start time in RFC3339 format (e.g., 2025-10-24T15:00:00Z)
`--end-time`	timestamp	End time in RFC3339 format (e.g., 2025-10-24T16:00:00Z)
`--feed-tags`	string	Comma-separated feed tags (empty = all feeds)
`--correlation-id`	string	Tracking ID for this load target (optional)
`--best-effort`	bool	Use best-effort strategy (default: true)

Note: Either --default or --value must be specified. When using --value, --unit is required. Setting --value=0 with any unit is equivalent to using --default (both set the default/zero constraint).

get-schedule#

Flag	Type	Description
`--start-time`	timestamp	Schedule query start time (ISO 8601)
`--end-time`	timestamp	Schedule query end time (ISO 8601)
`--feed-tags`	string	Comma-separated feed tags (empty = all)

register-webhook#

Flag	Type	Description
`--url`	string	Webhook URL (must be whitelisted)
`--events`	string	Comma-separated events (empty = all): `start-ramp-up`, `end-ramp-up`, `start-ramp-down`, `end-ramp-down`

unregister-webhook#

Flag	Type	Description
`--url`	string	Webhook URL to unregister