Documentation ¶
Overview ¶
Package queryDeviceInfo - 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
- type EndPoint
- func (e EndPoint) CacheFilename() string
- func (e EndPoint) Call() api.EndPoint
- func (e EndPoint) GetArea() api.AreaName
- func (e EndPoint) GetCacheTimeout() time.Duration
- func (e *EndPoint) GetData() api.DataMap
- func (e EndPoint) GetEndPointData() api.DataMap
- func (e EndPoint) GetEndPointDataTables() output.Tables
- func (e EndPoint) GetEndPointResultTable() output.Table
- func (e EndPoint) GetError() error
- func (e EndPoint) GetJsonData(raw bool) output.Json
- func (e EndPoint) GetName() api.EndPointName
- func (e EndPoint) GetRequest() Request
- func (e EndPoint) GetRequestArgNames() map[string]string
- func (e EndPoint) GetRequestJson() output.Json
- func (e EndPoint) GetResponse() Response
- func (e EndPoint) GetResponseJson() output.Json
- func (e EndPoint) GetUrl() api.EndPointUrl
- func (e EndPoint) Help() string
- func (e EndPoint) Init(apiRoot api.Web) *EndPoint
- func (e EndPoint) IsDebug() bool
- func (e EndPoint) IsDisabled() bool
- func (e EndPoint) IsError() bool
- func (e EndPoint) IsRequestValid() error
- func (e EndPoint) IsResponseValid() error
- func (e EndPoint) MarshalJSON() ([]byte, error)
- func (e EndPoint) ReadDataFile() error
- func (e EndPoint) RequestFingerprint() string
- func (e EndPoint) RequestRef() interface{}
- func (e EndPoint) RequestString() string
- func (e EndPoint) ResponseRef() interface{}
- func (e EndPoint) ResponseString() string
- func (e EndPoint) ResultDataRef() ResultData
- func (e EndPoint) SetCacheTimeout(duration time.Duration) api.EndPoint
- func (e EndPoint) SetError(format string, a ...interface{}) api.EndPoint
- func (e EndPoint) SetFilenamePrefix(format string, args ...interface{}) string
- func (e EndPoint) SetRequest(ref interface{}) api.EndPoint
- func (e EndPoint) SetRequestByJson(j output.Json) api.EndPoint
- func (e EndPoint) SetResponse(ref []byte) api.EndPoint
- func (e EndPoint) String() string
- func (e EndPoint) WriteDataFile() error
- type Request
- type RequestData
- type Response
- type ResultData
Constants ¶
const Disabled = false
const EndPointName = "AppService.queryDeviceInfo"
const Url = "/v1/devService/queryDeviceInfo"
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 ¶
Assert - Used to obtain locally scoped EndPoint methods, (not visible from api.EndPoint).
func (EndPoint) CacheFilename ¶
CacheFilename - Check if a cache file exists for this EndPoint.
func (EndPoint) Call ¶
Call - Once RequestData is populated, this will access the iSolarCloud API and populate ResultData.
func (EndPoint) GetCacheTimeout ¶
GetCacheTimeout - Return the cache timeout for this EndPoint.
func (EndPoint) GetEndPointData ¶
func (EndPoint) GetEndPointDataTables ¶
func (EndPoint) GetEndPointResultTable ¶
func (EndPoint) GetJsonData ¶
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) GetRequest ¶
GetRequest - Get the Request structure as scoped by this endpoint.
func (EndPoint) GetRequestArgNames ¶
GetRequestArgNames -
func (EndPoint) GetRequestJson ¶
GetRequestJson - Return the Request structure as a JSON string.
func (EndPoint) GetResponse ¶
GetResponse - Get the Response structure as scoped by this endpoint.
func (EndPoint) GetResponseJson ¶
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 ¶
Help - Return help information on the JSON structure used to populate RequestData.
func (EndPoint) IsDisabled ¶
IsDisabled - Is this endpoint disabled? See data.go Disabled constant.
func (EndPoint) IsRequestValid ¶
IsRequestValid - Is api.RequestCommon and RequestData valid?
func (EndPoint) IsResponseValid ¶
IsResponseValid - Is api.ResponseCommon and ResultData valid?
func (EndPoint) MarshalJSON ¶
MarshalJSON - Marshall the EndPoint.
func (EndPoint) ReadDataFile ¶
ReadDataFile - Read a JSON file and populate the ResultData structure. (File names will default to AREA-ENDPOINT.json )
func (EndPoint) RequestFingerprint ¶
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 ¶
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 ¶
ResponseString - Return the Response structure as a human-readable string.
func (EndPoint) ResultDataRef ¶
func (e EndPoint) ResultDataRef() ResultData
ResultDataRef - Return the locally scoped ResultData structure.
func (EndPoint) SetCacheTimeout ¶
SetCacheTimeout - Set the cache timeout for this EndPoint. (Defaults to 1 hour.)
func (EndPoint) SetFilenamePrefix ¶
SetFilenamePrefix - Produce filename based on area and endpoint name.
func (EndPoint) SetRequest ¶
SetRequest - Save an interface reference as either api.RequestCommon or RequestData.
func (EndPoint) SetRequestByJson ¶
SetRequestByJson - Save RequestData from a JSON string.
func (EndPoint) SetResponse ¶
SetResponse - Save a JSON string to the Response structure. (Used by the web call method.)
func (EndPoint) WriteDataFile ¶
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 { DeviceSn valueTypes.String `json:"device_sn,omitempty"` Uuid valueTypes.String `json:"uuid,omitempty"` }
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" PointIdReplace:"true"` }
Response - Holds the api.ResponseCommon and endpoint specific ResultData structures. See data.go for response fields.
type ResultData ¶
type ResultData struct { DeviceModelList []struct { GoStruct.GoStruct `json:"-" PointIdFrom:"ModelId" PointIdReplace:"false"` DeviceModel valueTypes.String `json:"device_model"` DeviceModelCode valueTypes.String `json:"device_model_code"` ModelId valueTypes.Integer `json:"model_id"` } `json:"deviceModelList" PointId:"device_model_list" DataTable:"true"` DevicePropertyValueList []struct { GoStruct.GoStruct `json:"-" PointIdFrom:"UUID" PointIdReplace:"false"` DeviceType valueTypes.Integer `json:"device_type"` PropertyCode valueTypes.Integer `json:"property_code"` PropertyDefVal valueTypes.String `json:"property_def_val"` PropertyName valueTypes.String `json:"property_name"` PropertyValue valueTypes.String `json:"property_value"` UUID valueTypes.String `json:"uuid"` } `json:"devicePropertyValueList" PointId:"device_property_value_list" DataTable:"true"` PsKey valueTypes.String `json:"ps_key"` PsId valueTypes.PsId `json:"ps_id"` DeviceType valueTypes.Integer `json:"device_type"` DeviceCode valueTypes.Integer `json:"device_code"` ChannelId valueTypes.Integer `json:"chnnl_id" PointId:"channel_id"` PsName valueTypes.String `json:"ps_name"` PsShortName valueTypes.String `json:"ps_short_name"` ArmVersion interface{} `json:"arm_version"` BatVersion valueTypes.String `json:"bat_version"` BatteryVersion interface{} `json:"battery_version"` CommandStatus valueTypes.Integer `json:"command_status"` CommunicationDevUUID valueTypes.Integer `json:"communication_dev_uuid"` CountryId valueTypes.Integer `json:"country_id"` CpldVersion interface{} `json:"cpld_version"` DataFlagDetail valueTypes.Integer `json:"data_flag_detail"` DevFaultStatus valueTypes.Integer `json:"dev_fault_status"` DevStatus valueTypes.Integer `json:"dev_status"` DeviceArea valueTypes.String `json:"device_area"` DeviceAreaName valueTypes.String `json:"device_area_name"` DeviceFactoryId interface{} `json:"device_factory_id"` DeviceModel valueTypes.String `json:"device_model"` DeviceModelCode valueTypes.String `json:"device_model_code"` DeviceModelId valueTypes.Integer `json:"device_model_id"` DeviceName valueTypes.String `json:"device_name"` DeviceProSn valueTypes.String `json:"device_pro_sn"` DeviceStatus valueTypes.Integer `json:"device_status"` FactoryName valueTypes.String `json:"factory_name"` GridTypeId valueTypes.Float `json:"grid_type_id"` InstallerDevFaultStatus valueTypes.Float `json:"installer_dev_fault_status"` InverterModelType valueTypes.Integer `json:"inverter_model_type"` IsCountryCheck valueTypes.Bool `json:"is_country_check"` IsEnable valueTypes.Bool `json:"is_enable"` IsG2point5Module valueTypes.Bool `json:"is_g2point5_module"` IsHaveversion valueTypes.Bool `json:"is_haveversion" PointId:"is_have_version"` IsInit valueTypes.Bool `json:"is_init"` IsNeedModbusAddress valueTypes.Bool `json:"is_need_modbus_address"` IsReadSet valueTypes.Bool `json:"is_read_set"` IsReplacing valueTypes.Bool `json:"is_replacing"` IsReset valueTypes.Bool `json:"is_reset"` IsSupportParamSet valueTypes.Bool `json:"is_support_param_set"` IsSupportRemoteUpgrade valueTypes.Bool `json:"is_support_remote_upgrade"` IsThirdParty valueTypes.Bool `json:"is_third_party"` Latitude valueTypes.Float `json:"latitude"` LcdVersion valueTypes.String `json:"lcd_version"` LoggerCode valueTypes.Integer `json:"logger_code"` Longitude valueTypes.Float `json:"longitude"` MVersion valueTypes.String `json:"m_version"` MachineVersion interface{} `json:"machine_version"` MasterNodeVersion interface{} `json:"master_node_version"` McuVersion interface{} `json:"mcu_version"` MdspVersion valueTypes.String `json:"mdsp_version"` ModelTechList []interface{} `json:"modelTechList"` NodeTimestamps interface{} `json:"node_timestamps"` OwnerDevFaultStatus valueTypes.Integer `json:"owner_dev_fault_status"` P2 interface{} `json:"p2"` P24 interface{} `json:"p24"` PvdVersion interface{} `json:"pvd_version"` SdspVersion valueTypes.String `json:"sdsp_version"` Sn valueTypes.String `json:"sn" PointName:"Serial Number"` SubTypeList []interface{} `json:"subTypeList"` TempVersion interface{} `json:"temp_version"` TypeName valueTypes.String `json:"type_name"` UpUUID valueTypes.Integer `json:"up_uuid"` UpgradeVersion interface{} `json:"upgrade_version"` UUID valueTypes.Integer `json:"uuid"` Version1 valueTypes.String `json:"version1"` Version10 valueTypes.String `json:"version10"` Version11 valueTypes.String `json:"version11"` Version12 valueTypes.String `json:"version12"` Version2 valueTypes.String `json:"version2"` Version3 valueTypes.String `json:"version3"` Version4 valueTypes.String `json:"version4"` Version5 valueTypes.String `json:"version5"` Version6 valueTypes.String `json:"version6"` Version7 valueTypes.String `json:"version7"` Version8 valueTypes.String `json:"version8"` Version9 valueTypes.String `json:"version9"` }
func AssertResultData ¶
func AssertResultData(e api.EndPoint) ResultData
AssertResultData - Used to obtain locally scoped ResultData methods, (not visible from api.EndPoint).
func (*ResultData) IsValid ¶
func (e *ResultData) IsValid() error