Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix limit types #186

Merged
merged 1 commit into from
Oct 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
type: object
title: Active Power and Power Factor
additionalProperties: false
properties:
mw:
type: number
description: Active Power in megawatts
format: float
minimum: 1
maximum: 10000
pf:
type: number
description: Assumed power factor.
format: float
minimum: 0
maximum: 1
required:
- mw
- pf
11 changes: 1 addition & 10 deletions docs/_data/components/schemas/limit-types/active-power.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: object
title: Active Power
additionalProperties: false
properties:
mw:
Expand All @@ -7,15 +8,5 @@ properties:
format: float
minimum: 1
maximum: 10000
pf:
type: number
description: |
Assumed power factor.

N.b. power factor is optional in the spec though it may be required in a
particular exchange.
format: float
minimum: 0
maximum: 1
required:
- mw
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: object
title: Apparent Power
additionalProperties: false
properties:
mva:
Expand Down
7 changes: 4 additions & 3 deletions docs/_data/components/schemas/limit-types/current.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
type: object
title: Current (nominal voltage assumed)
description: >-
Representation of a limit in amperes. Assumes that Clearinghouse Provider
has the nominal voltage in its model.
additionalProperties: false
properties:
amps:
type: number
description: >-
Representation of a limit in amperes. Assumes that Clearinghouse Provider
has the nominal voltage in its model.
format: float
minimum: 1
maximum: 100000
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
type: object
title: Reactive Power
description: Representation of a limit in megavolt-amperes reactive (MVAR).
additionalProperties: false
properties:
mvar:
type: number
description: Representation of a limit in megavolt-amperes reactive (MVAR).
format: float
minimum: -10000
maximum: 10000
Expand Down
51 changes: 35 additions & 16 deletions docs/_data/components/schemas/limit-types/voltage.yaml
Original file line number Diff line number Diff line change
@@ -1,52 +1,71 @@
overvoltage-threshold-pu:
type: object
title: Overvoltage Threshold per unit (nominal voltage assumed)
description: >
An upper limit to voltage for a transmission facility in per unit with
the base voltage assumed to be the nominal voltage.
additionalProperties: false
properties:
voltage-pu-max: &pu
type: number
description: >
An upper limit to voltage for a transmission facility in per unit.
format: float
minimum: 0
maximum: 2
base-kV: &voltage
type: number
description: >
The base voltage in kilovolts for the per unit voltage.
format: int32
minimum: 0
maximum: 1100
required:
- voltage-pu-max

overvoltage-threshold:
type: object
title: Overvoltage Threshold
description: An upper limit to voltage for a transmission facility in kilovolts.
additionalProperties: false
properties:
kV-max:
<<: *voltage
description: >
An upper limit to voltage for a transmission facility in kilovolts.
kV-max: &voltage
type: number
format: int32
minimum: 0
maximum: 1100
required:
- kV-max

undervoltage-threshold-pu:
type: object
title: Undervoltage Threshold per unit (nominal voltage assumed)
description: >
An lower limit to voltage for a transmission facility in per unit
with the nominal voltage assumed to be the base voltage.
additionalProperties: false
properties:
voltage-pu-min:
<<: *pu
description: An lower limit to voltage for a transmission facility in per unit.
base-kV: *voltage
required:
- voltage-pu-min

undervoltage-threshold:
type: object
title: Undervoltage Threshold
description: A lower limit to voltage for a transmission facility in kilovolts.
additionalProperties: false
properties:
kV-min:
<<: *voltage
description: A lower limit to voltage for a transmission facility in kilovolts.
required:
- kV-min

current-with-kV:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! There it is.

type: object
title: Current
description: Representation of a limit in amperes and associated voltage.
additionalProperties: false
properties:
amps:
type: number
format: float
minimum: 1
maximum: 100000
kV:
<<: *voltage
description: The voltage in kilovolts for the current limit.
required:
- amps
- kV
4 changes: 3 additions & 1 deletion docs/_data/components/schemas/limit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ type: object
title: Limit
description: |

Defines the limit. In practice, most exchanges will only support one kind of
Defines the limit. In practice most exchanges will only support one kind of
limit for proposals and snapshots. However, the specification supports
defining limits on a per resource basis as well as limit types that are not
anticipated to be used to implement Order 881. TROLIE server implementations
Expand All @@ -12,8 +12,10 @@ description: |

oneOf:
- $ref: './limit-types/active-power.yaml'
- $ref: './limit-types/active-power-with-power-factor.yaml'
- $ref: './limit-types/apparent-power.yaml'
- $ref: './limit-types/current.yaml'
- $ref: './limit-types/voltage.yaml#/current-with-kV'
- $ref: './limit-types/reactive-power.yaml'
- $ref: './limit-types/voltage.yaml#/overvoltage-threshold-pu'
- $ref: './limit-types/voltage.yaml#/overvoltage-threshold'
Expand Down