getPsList

package
v1.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 11, 2022 License: GPL-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package getPsList - This file is auto-generated from the update_all.sh script. Do not modify anything here. Any changes to this EndPoint should be made in the data.go file. The only exception is the AppService.login package.

Index

Constants

View Source 
const Disabled = false
View Source 
const Url = "/v1/powerStationService/getPsList"

Variables

This section is empty.

Functions

This section is empty.

Types

type EndPoint 

type EndPoint struct {
	api.EndPointStruct
	Request  Request
	Response Response
}

EndPoint - Holds the request, response and web method structures.

func Assert 

func Assert(e api.EndPoint) EndPoint

Assert - Used to obtain locally scoped EndPoint methods, (not visible from api.EndPoint).

func Init 

func Init(apiRoot api.Web) EndPoint

Init - Used to initialize a new endpoint instance. Usually called from an area.

func (EndPoint) CacheFilename 

func (e EndPoint) CacheFilename() string

CacheFilename - Check if a cache file exists for this EndPoint.

func (EndPoint) Call 

func (e EndPoint) Call() api.EndPoint

Call - Once RequestData is populated, this will access the iSolarCloud API and populate ResultData.

func (EndPoint) GetArea 

func (e EndPoint) GetArea() api.AreaName

GetArea - Returns the API area that this EndPoint is located.

func (EndPoint) GetCacheTimeout 

func (e EndPoint) GetCacheTimeout() time.Duration

GetCacheTimeout - Return the cache timeout for this EndPoint.

func (*EndPoint) GetData 

func (e *EndPoint) GetData() api.DataMap

func (*EndPoint) GetDataTable 

func (e *EndPoint) GetDataTable() output.Table

func (EndPoint) GetError 

func (e EndPoint) GetError() error

GetError - Get the error code for this EndPoint.

func (EndPoint) GetJsonData 

func (e EndPoint) GetJsonData(raw bool) output.Json

GetJsonData - Get the JSON representation of ResultData, either as condensed or "pretty".

func (EndPoint) GetName 

func (e EndPoint) GetName() api.EndPointName

GetName - Returns the API EndPoint name.

func (*EndPoint) GetPsId 

func (e *EndPoint) GetPsId() int64

func (EndPoint) GetRequest 

func (e EndPoint) GetRequest() Request

GetRequest - Get the Request structure as scoped by this endpoint.

func (EndPoint) GetRequestJson 

func (e EndPoint) GetRequestJson() output.Json

GetRequestJson - Return the Request structure as a JSON string.

func (EndPoint) GetResponse 

func (e EndPoint) GetResponse() Response

GetResponse - Get the Response structure as scoped by this endpoint.

func (EndPoint) GetResponseJson 

func (e EndPoint) GetResponseJson() output.Json

GetResponseJson - Return the Response structure as a JSON string.

func (EndPoint) GetUrl 

func (e EndPoint) GetUrl() api.EndPointUrl

GetUrl - Returns the API EndPoint url.

func (EndPoint) Help 

func (e EndPoint) Help() string

Help - Return help information on the JSON structure used to populate RequestData.

func (EndPoint) Init 

func (e EndPoint) Init(apiRoot api.Web) *EndPoint

Init - If the endpoint needs to be re-initialized.

func (EndPoint) IsDisabled 

func (e EndPoint) IsDisabled() bool

IsDisabled - Is this endpoint disabled? See data.go Disabled constant.

func (EndPoint) IsError 

func (e EndPoint) IsError() bool

IsError - Is there an error?

func (EndPoint) IsRequestValid 

func (e EndPoint) IsRequestValid() error

IsRequestValid - Is api.RequestCommon and RequestData valid?

func (EndPoint) IsResponseValid 

func (e EndPoint) IsResponseValid() error

IsResponseValid - Is api.ResponseCommon and ResultData valid?

func (EndPoint) MarshalJSON 

func (e EndPoint) MarshalJSON() ([]byte, error)

MarshalJSON - Marshall the EndPoint.

func (EndPoint) ReadDataFile 

func (e EndPoint) ReadDataFile() error

ReadDataFile - Read a JSON file and populate the ResultData structure. (File names will default to AREA-ENDPOINT.json )

func (EndPoint) RequestFingerprint 

func (e EndPoint) RequestFingerprint() string

RequestFingerprint - Check if a cache file exists for this EndPoint.

func (EndPoint) RequestRef 

func (e EndPoint) RequestRef() interface{}

RequestRef - Return the locally scoped Request structure.

func (EndPoint) RequestString 

func (e EndPoint) RequestString() string

RequestString - Return the Request structure as a human-readable string.

func (EndPoint) ResponseRef 

func (e EndPoint) ResponseRef() interface{}

ResponseRef - Return the locally scoped Response structure.

func (EndPoint) ResponseString 

func (e EndPoint) ResponseString() string

ResponseString - Return the Response structure as a human-readable string.

func (EndPoint) SetCacheTimeout 

func (e EndPoint) SetCacheTimeout(duration time.Duration) api.EndPoint

SetCacheTimeout - Set the cache timeout for this EndPoint. (Defaults to 1 hour.)

func (EndPoint) SetError 

func (e EndPoint) SetError(format string, a ...interface{}) api.EndPoint

SetError - Set the error code for this EndPoint.

func (EndPoint) SetRequest 

func (e EndPoint) SetRequest(ref interface{}) api.EndPoint

SetRequest - Save an interface reference as either api.RequestCommon or RequestData.

func (EndPoint) SetRequestByJson 

func (e EndPoint) SetRequestByJson(j output.Json) api.EndPoint

SetRequestByJson - Save RequestData from a JSON string.

func (EndPoint) SetResponse 

func (e EndPoint) SetResponse(ref []byte) api.EndPoint

SetResponse - Save a JSON string to the Response structure. (Used by the web call method.)

func (EndPoint) String 

func (e EndPoint) String() string

String - Stringer method for this EndPoint.

func (EndPoint) WriteDataFile 

func (e EndPoint) WriteDataFile() error

WriteDataFile - Write to a file, the contents of ResultData as JSON. (File names will default to AREA-ENDPOINT.json )

type Request 

type Request struct {
	api.RequestCommon
	RequestData
}

Request - Holds the api.RequestCommon and user RequestData structures. See data.go for request fields.

type RequestData 

type RequestData struct {
}

func (RequestData) Help 

func (rd RequestData) Help() string

func (RequestData) IsValid 

func (rd RequestData) IsValid() error

type Response 

type Response struct {
	api.ResponseCommon
	ResultData ResultData `json:"result_data"`
}

Response - Holds the api.ResponseCommon and endpoint specific ResultData structures. See data.go for response fields.

type ResultData 

type ResultData struct {
	PageList []struct {
		AlarmCount                int64         `json:"alarm_count" PointId:"alarm_count" PointType:"PointTypeBoot"`
		AlarmDevCount             int64         `json:"alarm_dev_count" PointId:"alarm_dev_count" PointType:"PointTypeBoot"`
		AreaID                    interface{}   `json:"area_id" PointId:"area_id" PointType:""`
		AreaType                  interface{}   `json:"area_type" PointId:"area_type" PointType:""`
		ArrearsStatus             int64         `json:"arrears_status" PointId:"arrears_status" PointType:""`
		BuildDate                 string        `json:"build_date" PointId:"build_date" PointType:""`
		BuildStatus               int64         `json:"build_status" PointId:"build_status" PointType:""`
		Co2Reduce                 api.UnitValue `json:"co2_reduce" PointId:"co2_reduce" PointType:""`
		Co2ReduceTotal            api.UnitValue `json:"co2_reduce_total" PointId:"co2_reduce_total" PointType:"PointTypeTotal"`
		CurrPower                 api.UnitValue `json:"curr_power" PointId:"curr_power" PointType:""`
		DailyIrradiation          api.UnitValue `json:"daily_irradiation" PointId:"daily_irradiation" PointType:"PointTypeDaily"`
		DailyIrradiationVirgin    interface{}   `json:"daily_irradiation_virgin" PointId:"daily_irradiation_virgin" PointType:"PointTypeDaily"`
		DesignCapacity            string        `json:"design_capacity" PointId:"design_capacity" PointType:""`
		DesignCapacityUnit        string        `json:"design_capacity_unit" PointId:"design_capacity_unit" PointType:""`
		DesignCapacityVirgin      float64       `json:"design_capacity_virgin" PointId:"design_capacity_virgin" PointType:""`
		EquivalentHour            api.UnitValue `json:"equivalent_hour" PointId:"equivalent_hour" PointType:"PointTypeDaily"`
		EsDisenergy               api.UnitValue `json:"es_discharge_energy" PointId:"es_discharge_energy" PointAlias:"p83089" PointType:""`
		EsEnergy                  api.UnitValue `json:"es_energy" PointId:"es_energy" PointAlias:"p83120" PointType:""`
		EsPower                   api.UnitValue `json:"es_power" PointId:"es_power" PointAlias:"p83081" PointType:""`
		EsTotalDisenergy          api.UnitValue `json:"es_total_discharge_energy" PointId:"es_total_discharge_energy" PointAlias:"p83095" PointType:"PointTypeTotal"`
		EsTotalEnergy             api.UnitValue `json:"es_total_energy" PointId:"es_total_energy" PointAlias:"p83127" PointType:"PointTypeTotal"`
		ExpectInstallDate         string        `json:"expect_install_date" PointId:"expect_install_date" PointType:""`
		FaultAlarmOfflineDevCount int64         `json:"fault_alarm_offline_dev_count" PointId:"fault_alarm_offline_dev_count" PointType:""`
		FaultCount                int64         `json:"fault_count" PointId:"fault_count" PointType:""`
		FaultDevCount             int64         `json:"fault_dev_count" PointId:"fault_dev_count" PointType:""`
		GcjLatitude               string        `json:"gcj_latitude" PointId:"gcj_latitude" PointType:""`
		GcjLongitude              string        `json:"gcj_longitude" PointId:"gcj_longitude" PointType:""`
		GprsLatitude              interface{}   `json:"gprs_latitude" PointId:"gprs_latitude" PointType:""`
		GprsLongitude             interface{}   `json:"gprs_longitude" PointId:"gprs_longitude" PointType:""`
		Images                    []struct {
			FileID      int64       `json:"file_id"`
			ID          int64       `json:"id"`
			PicLanguage int64       `json:"pic_language"`
			PicType     int64       `json:"pic_type"`
			PictureName string      `json:"picture_name"`
			PictureURL  string      `json:"picture_url"`
			PsID        int64       `json:"ps_id"`
			PsUnitUUID  interface{} `json:"ps_unit_uuid"`
		} `json:"images"`
		InstallDate            string        `json:"install_date" PointId:"install_date" PointType:""`
		InstalledPowerMap      api.UnitValue `json:"installed_power_map" PointId:"installed_power_map" PointType:""`
		InstalledPowerVirgin   float64       `json:"installed_power_virgin" PointId:"installed_power_virgin" PointType:""`
		InstallerAlarmCount    int64         `json:"installer_alarm_count" PointId:"installer_alarm_count" PointType:""`
		InstallerFaultCount    int64         `json:"installer_fault_count" PointId:"installer_fault_count" PointType:""`
		InstallerPsFaultStatus int64         `json:"installer_ps_fault_status" PointId:"installer_ps_fault_status" PointType:""`
		IsBankPs               int64         `json:"is_bank_ps" PointId:"is_bank_ps" PointType:""`
		IsTuv                  int64         `json:"is_tuv" PointId:"is_tuv" PointType:""`
		JoinYearInitElec       float64       `json:"join_year_init_elec" PointId:"join_year_init_elec" PointType:""`
		Latitude               float64       `json:"latitude" PointId:"latitude" PointType:""`
		Location               string        `json:"location" PointId:"location" PointType:""`
		Longitude              float64       `json:"longitude" PointId:"longitude" PointType:""`
		MapLatitude            string        `json:"map_latitude" PointId:"map_latitude" PointType:""`
		MapLongitude           string        `json:"map_longitude" PointId:"map_longitude" PointType:""`
		MlpeFlag               int64         `json:"mlpe_flag" PointId:"mlpe_flag" PointType:""`
		Nmi                    interface{}   `json:"nmi" PointId:"nmi" PointType:""`
		OfflineDevCount        int64         `json:"offline_dev_count" PointId:"offline_dev_count" PointType:""`
		OperateYear            interface{}   `json:"operate_year" PointId:"operate_year" PointType:""`
		OperationBusName       interface{}   `json:"operation_bus_name" PointId:"operation_bus_name" PointType:""`
		OwnerAlarmCount        int64         `json:"owner_alarm_count" PointId:"owner_alarm_count" PointType:""`
		OwnerFaultCount        int64         `json:"owner_fault_count" PointId:"owner_fault_count" PointType:""`
		OwnerPsFaultStatus     int64         `json:"owner_ps_fault_status" PointId:"owner_ps_fault_status" PointType:""`
		P83022y                string        `json:"p83022y" PointId:"P83022" PointType:""`
		P83046                 interface{}   `json:"p83046" PointId:"p83046" PointType:""`
		P83048                 interface{}   `json:"p83048" PointId:"p83048" PointType:""`
		P83049                 interface{}   `json:"p83049" PointId:"p83049" PointType:""`
		P83050                 interface{}   `json:"p83050" PointId:"p83050" PointType:""`
		P83051                 interface{}   `json:"p83051" PointId:"p83051" PointType:""`
		P83054                 interface{}   `json:"p83054" PointId:"p83054" PointType:""`
		P83055                 interface{}   `json:"p83055" PointId:"p83055" PointType:""`
		P83067                 interface{}   `json:"p83067" PointId:"p83067" PointType:""`
		P83070                 interface{}   `json:"p83070" PointId:"p83070" PointType:""`
		P83076                 float64       `json:"p83076" PointId:"p83076" PointType:""` // Dupe of PvPower
		P83077                 float64       `json:"p83077" PointId:"p83077" PointType:""`
		P83081                 float64       `json:"p83081" PointId:"p83081" PointType:""` // Dupe of EsPower
		P83089                 float64       `json:"p83089" PointId:"p83089" PointType:""` // Dupe of EsDisenergy
		P83095                 float64       `json:"p83095" PointId:"p83095" PointType:""` // Dupe of EsTotalDisenergy
		P83118                 float64       `json:"p83118" PointId:"p83118" PointType:""` // Dupe of UseEnergy
		P83120                 float64       `json:"p83120" PointId:"p83120" PointType:""` // Dupe of EsEnergy
		P83127                 float64       `json:"p83127" PointId:"p83127" PointType:""` // Dupe of EsTotalEnergy
		ParamCo2               float64       `json:"param_co2" PointId:"param_co2" PointType:""`
		ParamCoal              float64       `json:"param_coal" PointId:"param_coal" PointType:""`
		ParamIncome            float64       `json:"param_income" PointId:"param_income" PointType:""`
		ParamMeter             float64       `json:"param_meter" PointId:"param_meter" PointType:""`
		ParamNox               float64       `json:"param_nox" PointId:"param_nox" PointType:""`
		ParamPowder            float64       `json:"param_powder" PointId:"param_powder" PointType:""`
		ParamSo2               float64       `json:"param_so2" PointId:"param_so2" PointType:""`
		ParamTree              float64       `json:"param_tree" PointId:"param_tree" PointType:""`
		ParamWater             float64       `json:"param_water" PointId:"param_water" PointType:""`
		PrScale                string        `json:"pr_scale" PointId:"pr_scale" PointType:""`
		Producer               interface{}   `json:"producer" PointId:"producer" PointType:""`
		PsCountryID            int64         `json:"ps_country_id" PointId:"ps_country_id" PointType:""`
		PsFaultStatus          int64         `json:"ps_fault_status" PointId:"ps_fault_status" PointType:""`
		PsHealthStatus         string        `json:"ps_health_status" PointId:"ps_health_status" PointType:""`
		PsHolder               string        `json:"ps_holder" PointId:"ps_holder" PointType:""`
		PsID                   int64         `json:"ps_id" PointId:"ps_id" PointType:""`
		PsIsNotInit            string        `json:"ps_is_not_init" PointId:"ps_is_not_init" PointType:""`
		PsName                 string        `json:"ps_name" PointId:"ps_name" PointType:""`
		PsShortName            string        `json:"ps_short_name" PointId:"ps_short_name" PointType:""`
		PsStatus               int64         `json:"ps_status" PointId:"ps_status" PointType:""`
		PsTimezone             string        `json:"ps_timezone" PointId:"ps_timezone" PointType:""`
		PsType                 int64         `json:"ps_type" PointId:"ps_type" PointType:""`
		PvEnergy               api.UnitValue `json:"pv_energy" PointId:"pv_energy" PointAlias:"p83077" PointType:""`
		PvPower                api.UnitValue `json:"pv_power" PointId:"pv_power" PointAlias:"p83076" PointType:""`
		Radiation              api.UnitValue `json:"radiation" PointId:"radiation" PointType:""`
		RadiationVirgin        interface{}   `json:"radiation_virgin" PointId:"radiation_virgin" PointType:""`
		RecoreCreateTime       string        `json:"recore_create_time" PointId:"recore_create_time" PointType:""`
		SafeStartDate          string        `json:"safe_start_date" PointId:"safe_start_date" PointType:""`
		ShareType              string        `json:"share_type" PointId:"share_type" PointType:""`
		ShippingAddress        string        `json:"shipping_address" PointId:"shipping_address" PointType:""`
		ShippingZipCode        string        `json:"shipping_zip_code" PointId:"shipping_zip_code" PointType:""`
		TodayEnergy            api.UnitValue `json:"today_energy" PointId:"today_energy" PointType:"PointTypeDaily"`
		TodayIncome            api.UnitValue `json:"today_income" PointId:"today_income" PointType:"PointTypeDaily"`
		TotalCapcity           api.UnitValue `json:"total_capacity" PointId:"total_capacity" PointType:"PointTypeTotal"`
		TotalEnergy            api.UnitValue `json:"total_energy" PointId:"total_energy" PointType:"PointTypeTotal"`
		TotalIncome            api.UnitValue `json:"total_income" PointId:"total_income" PointType:"PointTypeTotal"`
		TotalInitCo2Accelerate float64       `json:"total_init_co2_accelerate" PointId:"total_init_co2_accelerate" PointType:"PointTypeTotal"`
		TotalInitElec          float64       `json:"total_init_elec" PointId:"total_init_elec" PointType:"PointTypeTotal"`
		TotalInitProfit        float64       `json:"total_init_profit" PointId:"total_init_profit" PointType:"PointTypeTotal"`
		UseEnergy              api.UnitValue `json:"use_energy" PointId:"use_energy" PointAlias:"p83118" PointType:""`
		ValidFlag              int64         `json:"valid_flag" PointId:"valid_flag" PointType:""`
		WgsLatitude            float64       `json:"wgs_latitude" PointId:"wgs_latitude" PointType:""`
		WgsLongitude           float64       `json:"wgs_longitude" PointId:"wgs_longitude" PointType:""`
		ZipCode                string        `json:"zip_code" PointId:"zip_code" PointType:""`
	} `json:"pageList"`
	RowCount int64 `json:"rowCount"`
}

func AssertResultData 

func AssertResultData(e api.EndPoint) ResultData

AssertResultData - Used to obtain locally scoped ResultData methods, (not visible from api.EndPoint).

func (*ResultData) GetData 

func (e *ResultData) GetData() api.DataMap

func (*ResultData) GetPsId 

func (e *ResultData) GetPsId() int64

func (*ResultData) GetPsName 

func (e *ResultData) GetPsName() string

func (*ResultData) GetPsSerial 

func (e *ResultData) GetPsSerial() string

func (*ResultData) IsValid 

func (e *ResultData) IsValid() error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.