`lib-energyStar` 库参考

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793881766/FIN+5.3.1+lib-energyStar 中文整理基于 FIN 5.3.1

导读： 能源之星投资组合管理连接器

以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。

目录（导读）

lib
meta
docs
tags
apps
funcs
views
def
supertypes
Overview
Accounts
Setup
Connectors
Site Mapping
Meter Mapping
Property-Meter Associations
EnergyStarApp
- usage
- tags
- enum
energyStarCustomerList(conn)
energyStarHisPull(proxies, range)
energyStarHisPush(proxies, range)
energyStarMeterDelete(conn, meterId)
energyStarMeterList(conn, propertyId)
energyStarMeterPull(conn, site, meterId)
energyStarMeterPush(conn, point)
energyStarMeterRead(conn, meterId)
energyStarOnsiteRenewableDetailWrite(conn, meterId, detail)
energyStarPing(conn)
energyStarPropertyAssociationsPush(conn, site)
energyStarPropertyDelete(conn, propertyId)
energyStarPropertyList(conn)
energyStarPropertyMetrics(conn, propertyId, month, metrics)
energyStarPropertyPull(conn, propertyId)
energyStarPropertyPush(conn, site)
energyStarPropertyRead(conn, propertyId)
energyStarUsageDelete(conn, consumptionDataId)
energyStarUsageRead(conn, meterId, limit: Number.<ctor>(100))
energyStarUsageWrite(conn, meterId, usage)
- src

概述（中译）

能源之星投资组合管理连接器

API 正文（英文）

docs

Overview • Accounts • Setup • Connectors • Site Mapping • Meter Mapping • Property-Meter Associations • EnergyStarApp

tags


energyStarConn	Energy Star connector to a portfolio manager account
energyStarConnRef	Used on a proxy object to reference its parent `energyStarConn`
energyStarCustomerIds	Comma separated list of customer account ids used for the connection
energyStarMeter	Tag applied to a `point` record which marks the point as mapped to a meter in Portfolio Manager
energyStarMeterType	String enum for EnergyStar meter type applied to `energyStarMeter` points
energyStarSite	Tag applied to a `site` record which marks a site as mapped into Portfolio Manager

apps


energyStar	Views used for Energy Star Portfolio Manager integration

funcs


energyStarCustomerList	Read list of customers that you are connected with as grid with following columns
energyStarHisPull	Pull energy star usage into the given mapped meter points history
energyStarHisPush	Push the daily rollup consumption of mapped meter points to portfolio manager
energyStarMeterDelete	Delete the meter identified by the given meter id string from the energy star Portfolio Manager
energyStarMeterList	Read meters for given property as grid with following columns
energyStarMeterPull	Create or update a local meter point record from a meter in Portfolio Manager
energyStarMeterPush	Create or update a meter in Portfolio Manager from a local meter point record
energyStarMeterRead	Read the given meter and return as Dict
energyStarOnsiteRenewableDetailWrite	Write onsite green power renewable details
energyStarPing	Asynchronously ping energy star connector to verify connectivity and account credentials
energyStarPropertyAssociationsPush	This function recreates the list of property/meter associations in Energy Star
energyStarPropertyDelete	Delete the property identified by the given property id string from the energy star Portfolio Manager
energyStarPropertyList	Read properties as grid with following columns
energyStarPropertyMetrics	Read a list of metrics for a specific property
energyStarPropertyPull	Create or update a local site record from a property in Portfolio Manager
energyStarPropertyPush	Create or update a property in Portfolio Manager from a local site record
energyStarPropertyRead	Read the given property and return as Dict
energyStarUsageDelete	Delete the given usage item from portfolio manager
energyStarUsageRead	Read consumption data for given meter
energyStarUsageWrite	Write consumption data to portfolio manager for given meter

views


energyStarMeters	Manage Energy Star meters
energyStarProperties	Manage Energy Star sites

app:energyStar

Views used for Energy Star Portfolio Manager integration

meta


def	app:energyStar
disKey	ui::energyStar
icon	energyStar
is	app
lib	lib:energyStar

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
app	UI application grouping of views

lib energyStar

Overview

The ENERGY STAR extension implements a client interface to the Portfolio Manager web service. Features include:

An ENERGY STAR connector maps to an account and is used to manage your sites, meters, usage
Ability to manage your ENERGY STAR properties and map them to SkySpark sites
Ability to manage your ENERGY STAR meters and map them to SkySpark meter points
Ability to manage your ENERGY STAR meter usage data
Push history data from SkySpark to ENERGY STAR

Accounts

In order to use the ENERGY STAR connector your organization will need an account in the Portfolio Manager system. By default, Portfolio Manager accounts do not have access to web service API live environment.

You can follow these steps to request live access:

Click "Account Settings" from the ribbon on the top righthand side of your Portfolio Manager account
Click the "Software Development" tab
The following question will appear on the software development tab: "Will you be using the web services API to develop software to exchange data with Portfolio Manager?" Select "Yes" to continue.
Select all meter types you would like to permit your customers to share with you (this includes energy, water, waste, and IT energy meter types)
Specify terms of use (optional)
Select "Register"

The ENERGY STAR team is has approved SkySpark for use in the live environment, but may follow up with additional questions about your proposed implementation before approving the request. You should expect to see an email response to your registration request from WebServFAQs-Utility@icfi.com within 5 business days.

In the SkySpark integration, you will be integrating your Portfolio Manager account with your Skyspark account. If your customers also already have an existing Portfolio Manager account used to manage their buildings, your customer first needs to send you a request to connect their Portfolio Manager account with your Portfolio Manager account. Upon your acceptance of that account connection, your customer will then share their properties and meters with your Portfolio Manager account using the "Set Up Web Services/Data Exchange" option on the "Sharing" tab of the Portfolio Manager user interface. Details on the connection and sharing process can be found on the Portfolio Manager web site

Once this is done you can configure the energyStarCustomerIds tag on your connector record to determine which properties are being used by the project.

Setup

Enable the EnergyStarExt in SettingsApp
Use ConnApp to setup a connector for your account and ping to verify connectivity
Add necessary tags to your site and meter points recs to map them correctly
Use EnergyStarApp to map your sites to properties and setup their energyStarSite tag
Use EnergyStarApp to map your meter points to meters and setup their energyStarMeter and energyStarConnRef tags
Once a site has all its meters mapped, then use the "Push Associations" command in Meters tab to setup the property and meters associations in ENERGY STAR
Manually or via jobs push data to ENERGY STAR using the energyStarHisPush() func (or you can use the lower level energyStarUsageWrite() func).

Connectors

An EnergyStar connector supports the following tags:

energyStarConn: required marker tag
username: account username
password: must have password stored in password db for connector's record id
uri: optional URI to support switching between the live production server versus the test server

The following URIs are used to access EnergyStar Portfolio Manager:

live: https://portfoliomanager.energystar.gov/ws
test: https://portfoliomanager.energystar.gov/wstest/

The live version is assumed, unless the uri tag is configured on the connector rec.

The web services TEST environment https://portfoliomanager.energystar.gov/wstest/ is designed to help you test web services only. EPA offers a test server, with which you can exchange data via all of our web services. It is important to note that the TEST environment does not include any user interface, as there is no test version of the Portfolio Manager graphical user interface. Additionally, data that exists in the TEST environment cannot be transferred over to the LIVE environment

The expectation is that exactly one EnergyStar connector is defined for a project. If multiple connectors are defined, then the UI will not work (all the functions support multiple connectors).

Site Mapping

Site records in SkySpark are mapped to ENERGY STAR properties as follows:

EnergyStar              SkySpark
-----------------       ----------------------
name                    dis
id                      energyStarSite (Str)
primaryFunction         primaryFunction
numberOfBuildings       always 1
yearBuilt               yearBuilt
constructionStatus      constructionStatus (defaults to Existing)
address.address1        geoStreet
address.city            geoCity
address.state           geoState
address.country         geoCountry
address.postalCode      geoPostalCode
grossFloorArea          area
occupancyPercentage     occupancyPercentage (defaults to 100%)
isFederalProperty       isFederalProperty (marker or defaults to false)

See primaryFunction tag for valid string values.

Meter Mapping

EnergyStar doesn't have the concept of meter equipment versus meter points. So we map EnergyStar meters directly to SkySpark meter point records. The mapping is:

EnergyStar              SkySpark
-----------------       ----------------------
name                    dis
id                      energyStarMeter (Str)
type                    energyStarMeterType (see below)
firstBillDate           firstBillDate (Date)
unitOfMeasure           unit
inUse                   always true
metered                 always true

If the point's unit tag is "kWh", then the meter type is assumed to be "Electric". Otherwise the point must define the energyStarMeterType tag with one of the valid string values.

If the meter is a "waste" meter you must set the energyStarMeterType tag on the meter. Further, if the waste meter is setup for disposal in the ENERGY STAR Portfolio Manager, then you must set one or more of these tags on the meter with the appropriate percentages:

energyStarLandfillPercentage
energyStarIncinerationPercentage
energyStarWasteToEnergyPercentage
energyStarUnknownDestPercentage

Property-Meter Associations

The EnergyStar model requires an extra step to create an association between properties and meters before the meter usage can be used for scoring. Once you have defined and mapped your sites and meter points, you may use the energyStarPropertyAssociationsPush() function to create a "Whole Site" association for all the meter points under a site. This function can also be accessed in the Meters tab of the EnergyStarApp.

EnergyStarApp

The EnergyStarApp may be used to manage and your sites and meters. It provides the ability to create/update/delete properties and meters in the ENERGY STAR Portfolio Manager by mapping a SkySpark site to an ENERGY STAR "Property", and by mapping a SkySpark point to an ENERGY STAR "Meter". These mappings are done manually, but you can use the Details button to compare the SkySpark and EnergyStar version side-by-side.

Note that the app only works if one connector is defined.

def

energyStarConn

Energy Star connector to a portfolio manager account. See energyStar.

meta


def	energyStarConn
icon	energyStar
is	conn
lib	lib:energyStar

usage


energyStarConn conn

supertypes


marker	Marker labels a dict with typing information
entity	Top-level dicts with a unique identifier
conn	Connector for communication to a remote system

tags


actorTimeout	Timeout for messages send to the connector's actor thread
connErr	Error message associated when `connStatus` indicates an error condition
connLinger	Linger timeout used to keep a connector open
connOpenRetryFreq	Duration used for connector open retries
connPingFreq	Duration used to configure the auto-ping feature on a given connector
connState	Current connection state of a connector as one of the predefined strings
connStatus	Current status of a connector as one of the predefined strings See Connectors
connTuningRef	Reference to a tuning configuration defined by a `connTuning` rec
dis	Display name for an entity
disabled	Indicates the entity is in a disabled state
energyStarCustomerIds	Comma separated list of customer account ids used for the connection
id	Defines the unique identifier of an entity in system using a `ref` value type
password	Manages password which is hashed/stored to the password store
uri	Universal resource identifier
username	Username for an authentication account

def

energyStarConnRef

Used on a proxy object to reference its parent energyStarConn

meta


def	energyStarConnRef
is	ref
lib	lib:energyStar
of	energyStarConn
tagOn	energyStarMeter, energyStarSite

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
ref	Reference to an entity

def

energyStarCustomerIds

Comma separated list of customer account ids used for the connection. See energyStar.

meta


def	energyStarCustomerIds
is	str
lib	lib:energyStar
tagOn	energyStarConn

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

energyStarMeter

Tag applied to a point record which marks the point as mapped to a meter in Portfolio Manager. The tag value is the meter identifier in the Energy Star system.

meta


def	energyStarMeter
is	str
lib	lib:energyStar

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

tags


energyStarConnRef	Used on a proxy object to reference its parent `energyStarConn`
energyStarMeterType	String enum for EnergyStar meter type applied to `energyStarMeter` points

def

energyStarMeterType

String enum for EnergyStar meter type applied to energyStarMeter points.

meta


def	energyStarMeterType
enum	See below
is	str
lib	lib:energyStar
tagOn	energyStarMeter

enum


Coal Anthracite
Coal Bituminous
Coke
Diesel
District Chilled Water - Absorption Chiller using Natural Gas
District Chilled Water - Electric-Driven Chiller
District Chilled Water - Engine-Driven Chiller using Natural Gas
District Chilled Water - Other
District Hot Water
District Steam
Electric
Electric on Site Solar
Electric on Site Wind
Fuel Oil No 1
Fuel Oil No 2
Fuel Oil No 4
Fuel Oil No 5 or 6
Kerosene
Liquid Propane
Natural Gas
Other (Energy)
Propane
Wood
IT Equipment Input Energy (meters on each piece of equipment)
Power Distribution Unit (PDU) Input Energy
Power Distribution Unit (PDU) Output Energy
Uninterruptible Power Supply (UPS) Output Energy
Municipally Supplied Potable Water - Mixed Indoor/Outdoor
Municipally Supplied Potable Water - Indoor
Municipally Supplied Potable Water - Outdoor
Municipally Supplied Reclaimed Water - Mixed Indoor/Outdoor
Municipally Supplied Reclaimed Water - Indoor
Municipally Supplied Reclaimed Water - Outdoor
Other - Mixed Indoor/Outdoor (Water)
Other - Outdoor
Other - Indoor
Average Influent Flow
Well Water - Mixed Indoor/Outdoor
Well Water - Indoor
Well Water - Outdoor

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

energyStarSite

Tag applied to a site record which marks a site as mapped into Portfolio Manager. The tag value is the property identifier in the Energy Star system.

meta


def	energyStarSite
is	str
lib	lib:energyStar
tagOn	site

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

tags


energyStarConnRef	Used on a proxy object to reference its parent `energyStarConn`

def

func:energyStarCustomerList

energyStarCustomerList(conn)

Read list of customers that you are connected with as grid with following columns:

id: energy star customer id str
dis: display name of the customer

meta


def	func:energyStarCustomerList
is	func
lib	lib:energyStar
name	energyStarCustomerList

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarHisPull

energyStarHisPull(proxies, range)

Pull energy star usage into the given mapped meter points history. The proxies may be any set of points accepted by toRecList().

Each point is required:

define energyStarConnRef tag for connector to use
define energyStarMeter for which meter it is mapped to
must be a point with historized consumption values
point's site must define energyStarSite tag

The EnergyStar usage must provide daily values which are mapped to midnight of the starting date.

meta


admin	✓
def	func:energyStarHisPull
is	func
lib	lib:energyStar
name	energyStarHisPull

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarHisPush

energyStarHisPush(proxies, range)

Push the daily rollup consumption of mapped meter points to portfolio manager. The proxies may be any set of points accepted by toRecList().

Each point is required:

define energyStarConnRef tag for connector to use
define energyStarMeter for which meter it is mapped to
must be a point with historized consumption values
point's site must define energyStarSite tag

If the range is null, then we perform a read using energyStarUsageRead() to find the last endDate written. Then we assume a range of endDate+1day to yesterday. This guarantees that we are only pushing newer data to portfolio manager.

The usage to push is calcualted by perform a daily rollup on the history using the sum() function:

read(proxy).hisRead(range).hisClip.hisRollup(sum, 1day)

meta


admin	✓
def	func:energyStarHisPush
is	func
lib	lib:energyStar
name	energyStarHisPush

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarMeterDelete

energyStarMeterDelete(conn, meterId)

Delete the meter identified by the given meter id string from the energy star Portfolio Manager.

Any recs with matching energyStarMeter value also have have that tag removed.

meta


admin	✓
def	func:energyStarMeterDelete
is	func
lib	lib:energyStar
name	energyStarMeterDelete

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarMeterList

energyStarMeterList(conn, propertyId)

Read meters for given property as grid with following columns:

id: energy star meter id str
dis: display name of the meter
association: meter/property association formatted as "meter: representation" such as "energyMeter: Whole Property". If this cell is null, then an association has not been made yet.

meta


def	func:energyStarMeterList
is	func
lib	lib:energyStar
name	energyStarMeterList

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarMeterPull

energyStarMeterPull(conn, site, meterId)

Create or update a local meter point record from a meter in Portfolio Manager. If an existing rec has energyStarMeter tag then it is the point to update. If the point has to be created, then it is always placed under the main electrict meter queried by elecMeter and siteMeter. Or if a main meter is not found, one is automatically created. The point many not have all its tags automatically created, so check the record in the BuilderApp. See energyStar.

meta


admin	✓
def	func:energyStarMeterPull
is	func
lib	lib:energyStar
name	energyStarMeterPull

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarMeterPush

energyStarMeterPush(conn, point)

Create or update a meter in Portfolio Manager from a local meter point record. If the rec has energyStarMeter tag then it is the meter id to update. Otherwise create a new meter and add energyStarMeter tag to the site record. See energyStar.

meta


admin	✓
def	func:energyStarMeterPush
is	func
lib	lib:energyStar
name	energyStarMeterPush

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarMeterRead

energyStarMeterRead(conn, meterId)

Read the given meter and return as Dict. See energyStar.

meta


def	func:energyStarMeterRead
is	func
lib	lib:energyStar
name	energyStarMeterRead

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarOnsiteRenewableDetailWrite

energyStarOnsiteRenewableDetailWrite(conn, meterId, detail)

Write onsite green power renewable details. See https://portfoliomanager.energystar.gov/webservices/home/api/meter/onsite/post for details on this API request.

meterId: The meter id of the meter to write details for
detail: A Dict containing the details to write. The structure of this Dict must adhere to the onsiteRenewableDetail.xsd schema specified by the API in the link above. It is your responsibility to construct a details that meets the semantic constraints of the api - this func does constraint checking.

detail: {currentAsOf: 2024-12-06, energyUsedOnsite: {recOwnership: "Owned"}, energyExportedToGrid: {recOwnership: "Owned"}}
energyStarOnsiteRenewableDetailWrite(conn, meterId, detail)

meta


admin	✓
def	func:energyStarOnsiteRenewableDetailWrite
is	func
lib	lib:energyStar
name	energyStarOnsiteRenewableDetailWrite

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarPing

energyStarPing(conn)

Asynchronously ping energy star connector to verify connectivity and account credentials.

meta


admin	✓
def	func:energyStarPing
is	func
lib	lib:energyStar
name	energyStarPing

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarPropertyAssociationsPush

energyStarPropertyAssociationsPush(conn, site)

This function recreates the list of property/meter associations in Energy Star. The site must be an id or record for a site which has been mapped to Energy Star with an energyStarSite tag. Associations are created for every meter point within the site which has been mapped with the energyStarMeter tag. All associations are currently mapped as "Whole Property'. See energyStar.

meta


def	func:energyStarPropertyAssociationsPush
is	func
lib	lib:energyStar
name	energyStarPropertyAssociationsPush

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarPropertyDelete

energyStarPropertyDelete(conn, propertyId)

Delete the property identified by the given property id string from the energy star Portfolio Manager.

Any site recs with matching energyStarSite value also have have that tag removed.

meta


admin	✓
def	func:energyStarPropertyDelete
is	func
lib	lib:energyStar
name	energyStarPropertyDelete

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarPropertyList

energyStarPropertyList(conn)

Read properties as grid with following columns:

id: energy star property id str
dis: display name of the property

By default this returns the properties associated with the connector's accountId. However if the connector defines the energyStarCustomerIds tag, then those account ids are used to populate the property list.

meta


def	func:energyStarPropertyList
is	func
lib	lib:energyStar
name	energyStarPropertyList

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarPropertyMetrics

energyStarPropertyMetrics(conn, propertyId, month, metrics)

Read a list of metrics for a specific property. The month to be should be passed as month literal YYYY-MM or any Date in that month. The metrics to be read as passed as Dict or markers and returned as a Dict with the resulting values. If the metric is not available, then it is not included in the resulting Dict.

For list of metrics to query see EnergyStar Docs.

Example:

energyStarPropertyMetrics(conn, "123", 2013-01, {score})  >>>  {score: 67}

meta


def	func:energyStarPropertyMetrics
is	func
lib	lib:energyStar
name	energyStarPropertyMetrics

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarPropertyPull

energyStarPropertyPull(conn, propertyId)

Create or update a local site record from a property in Portfolio Manager. If an existing rec has energyStarSite tag then it is the site to update. Otherwise create a new site record. Note if there is navigation recs above the site level, then you must manually add the appropiate ref tags. If creating a new record, not all the tags may be get automatically created, so check the record in the BuilderApp. See energyStar.

meta


admin	✓
def	func:energyStarPropertyPull
is	func
lib	lib:energyStar
name	energyStarPropertyPull

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarPropertyPush

energyStarPropertyPush(conn, site)

Create or update a property in Portfolio Manager from a local site record. If the rec has energyStarSite tag then it is the property id to update. Otherwise a new property is created under the connector's account and the energyStarSite tag is added to the site record. See energyStar.

meta


admin	✓
def	func:energyStarPropertyPush
is	func
lib	lib:energyStar
name	energyStarPropertyPush

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarPropertyRead

energyStarPropertyRead(conn, propertyId)

Read the given property and return as Dict. See energyStar.

meta


def	func:energyStarPropertyRead
is	func
lib	lib:energyStar
name	energyStarPropertyRead

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarUsageDelete

energyStarUsageDelete(conn, consumptionDataId)

Delete the given usage item from portfolio manager

meta


admin	✓
def	func:energyStarUsageDelete
is	func
lib	lib:energyStar
name	energyStarUsageDelete

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarUsageRead

energyStarUsageRead(conn, meterId, limit: Number.<ctor>(100))

Read consumption data for given meter. Return grid with cols:

id: Str identifier for the consumption data item
startDate: first Date of consumption
endDate: last Date of consumption
usage: Number for usage of date range
recownership (optional): If present, the Str REC ownership status.
energyExportedOffSite (optional): If present, the Number for the amount of energy exported off site.

It is expected for the EnergyStar web service to give us pages of data from newest dates down to oldest dates. We continue to read pages of data until no data is left or we hit our limit for rows of usage data.

meta


def	func:energyStarUsageRead
is	func
lib	lib:energyStar
name	energyStarUsageRead

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:energyStarUsageWrite

energyStarUsageWrite(conn, meterId, usage)

Write consumption data to portfolio manager for given meter. The usage must be grid with cols:

startDate: first Date of consumption
endDate: last Date of consumption (or if missing, startDate is assumed)
usage: Number for usage of date range
cost: (optional) Number for cost of usage
estimatedValue: (optional) Marker or Bool indicating if the value is estimated.

meta


admin	✓
def	func:energyStarUsageWrite
is	func
lib	lib:energyStar
name	energyStarUsageWrite

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

view:energyStarMeters

Manage Energy Star meters

meta


appName	energyStar
def	view:energyStarMeters
dis	Meters
icon	view
is	view
lib	lib:energyStar
order	51

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:    {inherit:"table"}
site:    {input var disKey:"ui::site" kind:"Ref<site>" navAuxFilter:"energyStarSite"}
details: {action:"energyStarAppMeterDetails" select}
push:    {action:"energyStarAppMeterPush" select}
pull:    {action:"energyStarAppMeterPull" select}
assoc:   {action:"energyStarAppMeterAssoc" select disKey:"ui::energyStar.pushAssoc"}
delete:  {action:"energyStarAppMeterDelete" select}
data:    {expr:"energyStarAppMetersInSite({{site}})"}

def

view:energyStarProperties

Manage Energy Star sites

meta


appName	energyStar
def	view:energyStarProperties
dis	Properties
icon	view
is	view
lib	lib:energyStar
order	50

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
view	Fresco UI view

src

view:    {inherit:"table"}
details: {action:"energyStarAppPropertiesDetails" select}
push:    {action:"energyStarAppPropertyPush" select}
pull:    {action:"energyStarAppPropertyPull" select}
delete:  {action:"energyStarAppPropertyDelete" select confirm: {icon:"warn" detailsKey:"ui::energyStar.propDelete.confirm"}}
data:    {expr:"energyStarAppPropertiesList()"}

lib-energyStar 库参考 ​

目录（导读） ​

概述（中译） ​

API 正文（英文） ​

docs ​

apps ​

funcs ​

views ​

app:energyStar ​

lib energyStar ​

Overview ​

Accounts ​

Setup ​

Connectors ​

Site Mapping ​

Meter Mapping ​

Property-Meter Associations ​

EnergyStarApp ​

energyStarConn ​

energyStarConnRef ​

energyStarCustomerIds ​

energyStarMeter ​

energyStarMeterType ​

energyStarSite ​

func:energyStarCustomerList ​

energyStarCustomerList(conn) ​

func:energyStarHisPull ​

energyStarHisPull(proxies, range) ​

func:energyStarHisPush ​

energyStarHisPush(proxies, range) ​

func:energyStarMeterDelete ​

energyStarMeterDelete(conn, meterId) ​

func:energyStarMeterList ​

energyStarMeterList(conn, propertyId) ​

func:energyStarMeterPull ​

energyStarMeterPull(conn, site, meterId) ​

func:energyStarMeterPush ​

energyStarMeterPush(conn, point) ​

func:energyStarMeterRead ​

energyStarMeterRead(conn, meterId) ​

func:energyStarOnsiteRenewableDetailWrite ​

energyStarOnsiteRenewableDetailWrite(conn, meterId, detail) ​

func:energyStarPing ​

energyStarPing(conn) ​

func:energyStarPropertyAssociationsPush ​

energyStarPropertyAssociationsPush(conn, site) ​

func:energyStarPropertyDelete ​

energyStarPropertyDelete(conn, propertyId) ​

func:energyStarPropertyList ​

energyStarPropertyList(conn) ​

func:energyStarPropertyMetrics ​

energyStarPropertyMetrics(conn, propertyId, month, metrics) ​

func:energyStarPropertyPull ​

energyStarPropertyPull(conn, propertyId) ​

func:energyStarPropertyPush ​

energyStarPropertyPush(conn, site) ​

func:energyStarPropertyRead ​

energyStarPropertyRead(conn, propertyId) ​

func:energyStarUsageDelete ​

energyStarUsageDelete(conn, consumptionDataId) ​

`lib-energyStar` 库参考

目录（导读）

概述（中译）

API 正文（英文）

docs

apps

funcs

views

app:energyStar

lib energyStar

Overview

Accounts

Setup

Connectors

Site Mapping

Meter Mapping

Property-Meter Associations

EnergyStarApp

energyStarConn

energyStarConnRef

energyStarCustomerIds

energyStarMeter

energyStarMeterType

energyStarSite

func:energyStarCustomerList

energyStarCustomerList(conn)

func:energyStarHisPull

energyStarHisPull(proxies, range)

func:energyStarHisPush

energyStarHisPush(proxies, range)

func:energyStarMeterDelete

energyStarMeterDelete(conn, meterId)

func:energyStarMeterList

energyStarMeterList(conn, propertyId)

func:energyStarMeterPull

energyStarMeterPull(conn, site, meterId)

func:energyStarMeterPush

energyStarMeterPush(conn, point)

func:energyStarMeterRead

energyStarMeterRead(conn, meterId)

func:energyStarOnsiteRenewableDetailWrite

energyStarOnsiteRenewableDetailWrite(conn, meterId, detail)

func:energyStarPing

energyStarPing(conn)

func:energyStarPropertyAssociationsPush

energyStarPropertyAssociationsPush(conn, site)

func:energyStarPropertyDelete

energyStarPropertyDelete(conn, propertyId)

func:energyStarPropertyList

energyStarPropertyList(conn)

func:energyStarPropertyMetrics

energyStarPropertyMetrics(conn, propertyId, month, metrics)

func:energyStarPropertyPull

energyStarPropertyPull(conn, propertyId)

func:energyStarPropertyPush

energyStarPropertyPush(conn, site)

func:energyStarPropertyRead

energyStarPropertyRead(conn, propertyId)

func:energyStarUsageDelete

energyStarUsageDelete(conn, consumptionDataId)