Regulator Controller#

pydantic model gdm.RegulatorController#

Interface 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 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 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 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 vsetpoint: ')] [Required]#: The target control voltage for regulator controller.