Regulator Controller#

pydantic model gdm.distribution.controllers.RegulatorController#

Data model for a Regulator Controller.

field bandwidth: WithJsonSchema(json_schema={'type': 'string'}, mode=None), FieldInfo(annotation=NoneType, required=True, description='The total voltage bandwidth for the controller')] [Required]#: The total voltage bandwidth for the controller

field controlled_bus: Annotated[DistributionBus, FieldInfo(annotation=NoneType, required=True, description='The bus that is being controlled by the controller.')] [Required]#: The bus that is being controlled by the controller.

field controlled_phase: Annotated[Phase, FieldInfo(annotation=NoneType, required=True, description='The phase that is being controlled by the controller.')] [Required]#: The phase that is being controlled by the controller.

field ct_primary: ')] = None#: Current at which the line drop compensator voltages match the R and X settings.

field delay: WithJsonSchema(json_schema={'type': 'string'}, mode=None), FieldInfo(annotation=NoneType, required=True, description='Delay for the first tap change operation')] [Required]#: Delay for the first tap change operation

field is_reversible: Annotated[bool, FieldInfo(annotation=NoneType, required=True, description='Boolean value representing whether the tap change is reversible or not.')] [Required]#: Boolean value representing whether the tap change is reversible or not.

field ldc_R: ')] = None#: R setting on the line drop compensator of the regulator in Volts.

field ldc_X: ')] = None#: X setting on the line drop compensator of the regulator in Volts.

field max_step: Annotated[int, FieldInfo(annotation=NoneType, required=True, description='Maximum number of steps upwards or downwards that can be made per control iteration.', metadata=[Ge(ge=0)])] [Required]#: Maximum number of steps upwards or downwards that can be made per control iteration.

field max_v_limit: ')] [Required]#: The maximum voltage limit for regulator controller.

field min_v_limit: ')] [Required]#: The minimum voltage limit for regulator controller.

field name: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='', description='Name of the regulator controller.')] = ''#: Name of the regulator controller.

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.

field use_ldc: Annotated[bool, FieldInfo(annotation=NoneType, required=True, description='Boolean value representing whether the line drop compensator is used or not.')] [Required]#: Boolean value representing whether the line drop compensator is used or not.

field uuid: UUID [Optional]#

field v_setpoint: ')] [Required]#: The target control voltage for regulator controller.