@citrineos/base
Version:
The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.
97 lines (96 loc) • 3.19 kB
JSON
{
"$id": "GetDERControlRequest",
"comment": "OCPP 2.1 Edition 1 (c) OCA, Creative Commons Attribution-NoDerivatives 4.0 International Public License",
"definitions": {
"DERControlEnumType": {
"description": "Type of control settings to retrieve. Not used when _controlId_ is provided.\r\n\r\n",
"javaType": "DERControlEnum",
"type": "string",
"additionalProperties": false,
"enum": [
"EnterService",
"FreqDroop",
"FreqWatt",
"FixedPFAbsorb",
"FixedPFInject",
"FixedVar",
"Gradients",
"HFMustTrip",
"HFMayTrip",
"HVMustTrip",
"HVMomCess",
"HVMayTrip",
"LimitMaxDischarge",
"LFMustTrip",
"LVMustTrip",
"LVMomCess",
"LVMayTrip",
"PowerMonitoringMustTrip",
"VoltVar",
"VoltWatt",
"WattPF",
"WattVar"
],
"tsEnumNames": [
"EnterService",
"FreqDroop",
"FreqWatt",
"FixedPFAbsorb",
"FixedPFInject",
"FixedVar",
"Gradients",
"HFMustTrip",
"HFMayTrip",
"HVMustTrip",
"HVMomCess",
"HVMayTrip",
"LimitMaxDischarge",
"LFMustTrip",
"LVMustTrip",
"LVMomCess",
"LVMayTrip",
"PowerMonitoringMustTrip",
"VoltVar",
"VoltWatt",
"WattPF",
"WattVar"
]
},
"CustomDataType": {
"description": "This class does not get 'AdditionalProperties = false' in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.",
"javaType": "CustomData",
"type": "object",
"properties": {
"vendorId": {
"type": "string",
"maxLength": 255
}
},
"required": ["vendorId"]
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"requestId": {
"description": "RequestId to be used in ReportDERControlRequest.\r\n",
"type": "integer"
},
"isDefault": {
"description": "True: get a default DER control. False: get a scheduled control.\r\n\r\n",
"type": "boolean"
},
"controlType": {
"$ref": "#/definitions/DERControlEnumType"
},
"controlId": {
"description": "Id of setting to get. When omitted all settings for _controlType_ are retrieved.\r\n\r\n",
"type": "string",
"maxLength": 36
},
"customData": {
"$ref": "#/definitions/CustomDataType"
}
},
"required": ["requestId"]
}