Protobuf Docs

Table of Contents

• historian.proto

  • HistorianRequest

  • HistorianService

• Scalar Value Types

Top

historian.proto

HistorianRequest

Field	Type	Label	Description
mrid	string
beginTimeStamp	int32
endTimeStamp	int32
limit	int32

Top

HistorianService

Method Name	Request Type	Response Type	Description
GetBreakerReading	HistorianRequest	.breakermodule.BreakerReadingProfile stream	Breaker
GetBreakerStatus	HistorianRequest	.breakermodule.BreakerStatusProfile stream
GetBreakerDiscreteControl	HistorianRequest	.breakermodule.BreakerDiscreteControlProfile stream
GetBreakerEvent	HistorianRequest	.breakermodule.BreakerEventProfile stream
GetCapBankReading	HistorianRequest	.capbankmodule.CapBankReadingProfile stream	Capbank
GetCapBankStatus	HistorianRequest	.capbankmodule.CapBankStatusProfile stream
GetCapBankDiscreteControl	HistorianRequest	.capbankmodule.CapBankDiscreteControlProfile stream
GetCapBankEvent	HistorianRequest	.capbankmodule.CapBankEventProfile stream
GetESSReading	HistorianRequest	.essmodule.ESSReadingProfile stream	ESS
GetESSStatus	HistorianRequest	.essmodule.ESSStatusProfile stream
GetESSControl	HistorianRequest	.essmodule.ESSControlProfile stream
GetESSEvent	HistorianRequest	.essmodule.ESSEventProfile stream
GetGenerationReading	HistorianRequest	.generationmodule.GenerationReadingProfile stream	Generation
GetGenerationStatus	HistorianRequest	.generationmodule.GenerationStatusProfile stream
GetGenerationDiscreteControl	HistorianRequest	.generationmodule.GenerationDiscreteControlProfile stream
GetGenerationEvent	HistorianRequest	.generationmodule.GenerationEventProfile stream
GetLoadReading	HistorianRequest	.loadmodule.LoadReadingProfile stream	Load
GetLoadStatus	HistorianRequest	.loadmodule.LoadStatusProfile stream
GetLoadControl	HistorianRequest	.loadmodule.LoadControlProfile stream
GetLoadEvent	HistorianRequest	.loadmodule.LoadEventProfile stream
GetMeterReading	HistorianRequest	.metermodule.MeterReadingProfile stream	Meter
GetRecloserReading	HistorianRequest	.reclosermodule.RecloserReadingProfile stream	Recloser
GetRecloserStatus	HistorianRequest	.reclosermodule.RecloserStatusProfile stream
GetRecloserDiscreteControl	HistorianRequest	.reclosermodule.RecloserDiscreteControlProfile stream
GetRecloserEvent	HistorianRequest	.reclosermodule.RecloserEventProfile stream
GetRegulatorReading	HistorianRequest	.regulatormodule.RegulatorReadingProfile stream	Regulator
GetRegulatorStatus	HistorianRequest	.regulatormodule.RegulatorStatusProfile stream
GetRegulatorDiscreteControl	HistorianRequest	.regulatormodule.RegulatorDiscreteControlProfile stream
GetRegulatorEvent	HistorianRequest	.regulatormodule.RegulatorEventProfile stream
GetSolarReading	HistorianRequest	.solarmodule.SolarReadingProfile stream	Solar
GetSolarStatus	HistorianRequest	.solarmodule.SolarStatusProfile stream
GetSolarControl	HistorianRequest	.solarmodule.SolarControlProfile stream
GetSolarEvent	HistorianRequest	.solarmodule.SolarEventProfile stream
GetSwitchReading	HistorianRequest	.switchmodule.SwitchReadingProfile stream	Switch
GetSwitchStatus	HistorianRequest	.switchmodule.SwitchStatusProfile stream
GetSwitchDiscreteControl	HistorianRequest	.switchmodule.SwitchDiscreteControlProfile stream
GetSwitchEvent	HistorianRequest	.switchmodule.SwitchEventProfile stream
GetOpenDSORuleEvent	HistorianRequest	.events.RuleEvent stream	RuleEvents

Top

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)