Capacitor Controllers

Capacitor Controllers#

pydantic model gdm.distribution.controllers.VoltageCapacitorController#

Data model for a Capacitor Controller which uses voltage.

Show JSON schema

{
   "title": "VoltageCapacitorController",
   "description": "Data model for a Capacitor Controller which uses voltage.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "default": "",
         "description": "Name of the capacitor controller.",
         "title": "Name",
         "type": "string"
      },
      "delay_on": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching on",
         "title": "Delay On",
         "type": "string"
      },
      "delay_off": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching off",
         "title": "Delay Off",
         "type": "string"
      },
      "dead_time": {
         "default": null,
         "description": "The time that the capacitor must remain off before turning back on again",
         "title": "Dead Time",
         "type": "string"
      },
      "on_voltage": {
         "default": null,
         "description": "Value of the controller voltage, above which the capacitor switches on.",
         "title": "On Voltage",
         "type": "string"
      },
      "off_voltage": {
         "default": null,
         "description": "Value of the voltage, below which the capacitors switches off.",
         "title": "Off Voltage",
         "type": "string"
      },
      "pt_ratio": {
         "description": "Value of the voltage (potential) transformer ratio used to step down the voltage for the controller.",
         "minimum": 0.0,
         "title": "Pt Ratio",
         "type": "number"
      }
   },
   "additionalProperties": false,
   "required": [
      "on_voltage",
      "off_voltage",
      "pt_ratio"
   ]
}

Config:

str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True

Fields:

dead_time (infrasys.quantities.Time | None)
delay_off (infrasys.quantities.Time | None)
delay_on (infrasys.quantities.Time | None)
name (str)
off_voltage (infrasys.quantities.Voltage)
on_voltage (infrasys.quantities.Voltage)
pt_ratio (float)
uuid (uuid.UUID)

field dead_time: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor must remain off before turning back on again')] = None#

The time that the capacitor must remain off before turning back on again

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_off: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching off')] = None#

The time that the capacitor needs to connect or disconnect when switching off

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_on: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching on')] = None#

The time that the capacitor needs to connect or disconnect when switching on

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field name: Annotated[str, Field('', description='Name of the capacitor controller.')] = ''#: Name of the capacitor controller.

field off_voltage: ', metadata=[Gt(gt=0)])] [Required]#

Value of the voltage, below which the capacitors switches off.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}
gt = 0

field on_voltage: ', metadata=[Gt(gt=0)])] [Required]#

Value of the controller voltage, above which the capacitor switches on.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}
gt = 0

field pt_ratio: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Value of the voltage (potential) transformer ratio used to step down the voltage for the controller.', metadata=[Ge(ge=0)])] [Required]#

Value of the voltage (potential) transformer ratio used to step down the voltage for the controller.

Constraints:

ge = 0

pydantic model gdm.distribution.controllers.ActivePowerCapacitorController#

Data model for a Capacitor Controller which uses active power.

Show JSON schema

{
   "title": "ActivePowerCapacitorController",
   "description": "Data model for a Capacitor Controller which uses active power.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "default": "",
         "description": "Name of the capacitor controller.",
         "title": "Name",
         "type": "string"
      },
      "delay_on": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching on",
         "title": "Delay On",
         "type": "string"
      },
      "delay_off": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching off",
         "title": "Delay Off",
         "type": "string"
      },
      "dead_time": {
         "default": null,
         "description": "The time that the capacitor must remain off before turning back on again",
         "title": "Dead Time",
         "type": "string"
      },
      "on_power": {
         "default": null,
         "description": "Value of the active power, above which the capacitor switches on.",
         "title": "On Power",
         "type": "string"
      },
      "off_power": {
         "default": null,
         "description": "Value of the active power, below which the capacitor switches off.",
         "title": "Off Power",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "on_power",
      "off_power"
   ]
}

Config:

str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True

Fields:

dead_time (infrasys.quantities.Time | None)
delay_off (infrasys.quantities.Time | None)
delay_on (infrasys.quantities.Time | None)
name (str)
off_power (infrasys.quantities.ActivePower)
on_power (infrasys.quantities.ActivePower)
uuid (uuid.UUID)

field dead_time: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor must remain off before turning back on again')] = None#

The time that the capacitor must remain off before turning back on again

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_off: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching off')] = None#

The time that the capacitor needs to connect or disconnect when switching off

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_on: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching on')] = None#

The time that the capacitor needs to connect or disconnect when switching on

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field name: Annotated[str, Field('', description='Name of the capacitor controller.')] = ''#: Name of the capacitor controller.

field off_power: ', metadata=[Gt(gt=0)])] [Required]#

Value of the active power, below which the capacitor switches off.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}
gt = 0

field on_power: ', metadata=[Ge(ge=0)])] [Required]#

Value of the active power, above which the capacitor switches on.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}
ge = 0

pydantic model gdm.distribution.controllers.ReactivePowerCapacitorController#

Data model for a Capacitor Controller which uses reactive power.

Show JSON schema

{
   "title": "ReactivePowerCapacitorController",
   "description": "Data model for a Capacitor Controller which uses reactive power.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "default": "",
         "description": "Name of the capacitor controller.",
         "title": "Name",
         "type": "string"
      },
      "delay_on": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching on",
         "title": "Delay On",
         "type": "string"
      },
      "delay_off": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching off",
         "title": "Delay Off",
         "type": "string"
      },
      "dead_time": {
         "default": null,
         "description": "The time that the capacitor must remain off before turning back on again",
         "title": "Dead Time",
         "type": "string"
      },
      "on_power": {
         "default": null,
         "description": "Value of the reactive power, above which the capacitor switches on.",
         "title": "On Power",
         "type": "string"
      },
      "off_power": {
         "default": null,
         "description": "Value of the reactive power, below which the capacitor switches off.",
         "title": "Off Power",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "on_power",
      "off_power"
   ]
}

Config:

str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True

Fields:

dead_time (infrasys.quantities.Time | None)
delay_off (infrasys.quantities.Time | None)
delay_on (infrasys.quantities.Time | None)
name (str)
off_power (gdm.quantities.ReactivePower)
on_power (gdm.quantities.ReactivePower)
uuid (uuid.UUID)

field dead_time: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor must remain off before turning back on again')] = None#

The time that the capacitor must remain off before turning back on again

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_off: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching off')] = None#

The time that the capacitor needs to connect or disconnect when switching off

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_on: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching on')] = None#

The time that the capacitor needs to connect or disconnect when switching on

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field name: Annotated[str, Field('', description='Name of the capacitor controller.')] = ''#: Name of the capacitor controller.

field off_power: ', metadata=[Gt(gt=0)])] [Required]#

Value of the reactive power, below which the capacitor switches off.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}
gt = 0

field on_power: ', metadata=[Gt(gt=0)])] [Required]#

Value of the reactive power, above which the capacitor switches on.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}
gt = 0

pydantic model gdm.distribution.controllers.CurrentCapacitorController#

Data model for a Capacitor Controller which uses current.

Show JSON schema

{
   "title": "CurrentCapacitorController",
   "description": "Data model for a Capacitor Controller which uses current.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "default": "",
         "description": "Name of the capacitor controller.",
         "title": "Name",
         "type": "string"
      },
      "delay_on": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching on",
         "title": "Delay On",
         "type": "string"
      },
      "delay_off": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching off",
         "title": "Delay Off",
         "type": "string"
      },
      "dead_time": {
         "default": null,
         "description": "The time that the capacitor must remain off before turning back on again",
         "title": "Dead Time",
         "type": "string"
      },
      "on_current": {
         "default": null,
         "description": "Value of the controller current, above which the capacitor switches on.",
         "title": "On Current",
         "type": "string"
      },
      "off_current": {
         "default": null,
         "description": "Value of the controller current, below which the capacitor switches off.",
         "title": "Off Current",
         "type": "string"
      },
      "ct_ratio": {
         "description": "The current transformer ratio used to step down the current for the controller.",
         "minimum": 0.0,
         "title": "Ct Ratio",
         "type": "number"
      }
   },
   "additionalProperties": false,
   "required": [
      "on_current",
      "off_current",
      "ct_ratio"
   ]
}

Config:

str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True

Fields:

ct_ratio (float)
dead_time (infrasys.quantities.Time | None)
delay_off (infrasys.quantities.Time | None)
delay_on (infrasys.quantities.Time | None)
name (str)
off_current (infrasys.quantities.Current)
on_current (infrasys.quantities.Current)
uuid (uuid.UUID)

field ct_ratio: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='The current transformer ratio used to step down the current for the controller.', metadata=[Ge(ge=0)])] [Required]#

The current transformer ratio used to step down the current for the controller.

Constraints:

ge = 0

field dead_time: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor must remain off before turning back on again')] = None#

The time that the capacitor must remain off before turning back on again

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_off: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching off')] = None#

The time that the capacitor needs to connect or disconnect when switching off

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_on: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching on')] = None#

The time that the capacitor needs to connect or disconnect when switching on

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field name: Annotated[str, Field('', description='Name of the capacitor controller.')] = ''#: Name of the capacitor controller.

field off_current: ', metadata=[Ge(ge=0)])] [Required]#

Value of the controller current, below which the capacitor switches off.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}
ge = 0

field on_current: ', metadata=[Gt(gt=0)])] [Required]#

Value of the controller current, above which the capacitor switches on.

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}
gt = 0

pydantic model gdm.distribution.controllers.DailyTimedCapacitorController#

Data model for a Capacitor Controller which uses a timed controller.

Show JSON schema

{
   "title": "DailyTimedCapacitorController",
   "description": "Data model for a Capacitor Controller which uses a timed controller.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "default": "",
         "description": "Name of the capacitor controller.",
         "title": "Name",
         "type": "string"
      },
      "delay_on": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching on",
         "title": "Delay On",
         "type": "string"
      },
      "delay_off": {
         "default": null,
         "description": "The time that the capacitor needs to connect or disconnect when switching off",
         "title": "Delay Off",
         "type": "string"
      },
      "dead_time": {
         "default": null,
         "description": "The time that the capacitor must remain off before turning back on again",
         "title": "Dead Time",
         "type": "string"
      },
      "on_time": {
         "description": "Time at which the capacitor switches on.",
         "format": "time",
         "title": "On Time",
         "type": "string"
      },
      "off_time": {
         "description": "Time at which the capacitor switches off.",
         "format": "time",
         "title": "Off Time",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "on_time",
      "off_time"
   ]
}

Config:

str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True

Fields:

dead_time (infrasys.quantities.Time | None)
delay_off (infrasys.quantities.Time | None)
delay_on (infrasys.quantities.Time | None)
name (str)
off_time (datetime.time)
on_time (datetime.time)
uuid (uuid.UUID)

field dead_time: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor must remain off before turning back on again')] = None#

The time that the capacitor must remain off before turning back on again

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_off: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching off')] = None#

The time that the capacitor needs to connect or disconnect when switching off

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field delay_on: Annotated[Time | None, PINT_SCHEMA, Field(None, description='The time that the capacitor needs to connect or disconnect when switching on')] = None#

The time that the capacitor needs to connect or disconnect when switching on

Constraints:

json_schema = {‘type’: ‘string’, ‘default’: None}

field name: Annotated[str, Field('', description='Name of the capacitor controller.')] = ''#: Name of the capacitor controller.

field off_time: Annotated[time, FieldInfo(annotation=NoneType, required=True, description='Time at which the capacitor switches off.')] [Required]#: Time at which the capacitor switches off.

field on_time: Annotated[time, FieldInfo(annotation=NoneType, required=True, description='Time at which the capacitor switches on.')] [Required]#: Time at which the capacitor switches on.

Capacitor Controllers

Contents

Capacitor Controllers#