service_tariff

Service: tariff

Method customLabels

Provides user-defined labels for instance-specific tariff segments The customLabels action related to tariffs provides custom labels for the tariff segments in an instance.These are mapped to correspond with the specific use case, such as representing tariffs like peak and off-peak.The internal identifiers range from virtual_1 to virtual_9 and are configured accordingly.The configuration is done in the runtime.settings.js file and should be set before the initial start of the framework;it is not intended to be changed during runtime

Called by:

• clearing.retrieve()
• metering.updateReading()
• tariff.setPrices()
• tariff.getPrices()

graph TD
   clearing.retrieve --> tariff.customLabels
   metering.updateReading --> tariff.customLabels
   tariff.setPrices --> tariff.customLabels
   tariff.getPrices --> tariff.customLabels

Loading

Method setPrices

Specify kWh price per tariff segment. The setPrices action allows setting a price per kilowatt-hour for each tariff segment within this environment for energy applications. You can retrieve the available tariff segments through the tariff.customLabels action. When setting prices, a price must be specified for each tariff segment using the internal labels virtual_1 to virtual_9. Additionally, an optional time slice (epoch) can be provided to indicate from when the price information becomes valid

Calls:

• tariff.customLabels()
• price_model.find()
• price_model.remove()
• price_model.insert()

graph TD
   tariff.setPrices --> tariff.customLabels
   tariff.setPrices --> price_model.find
   tariff.setPrices --> price_model.remove
   tariff.setPrices --> price_model.insert

Loading

Method getPrices

Gives setup price infos of current environment.

Called by:

• clearing.commit()
• tariff.prices()

Calls:

• price_model.find()
• tariff.customLabels()
• price_model.find()

graph TD
   clearing.commit --> tariff.getPrices
   tariff.prices --> tariff.getPrices
   tariff.getPrices --> price_model.find
   tariff.getPrices --> tariff.customLabels
   tariff.getPrices --> price_model.find

Loading

Method listPrices

Calls:

• price_model.find()

graph TD
   tariff.listPrices --> price_model.find

Loading

Method epochDuration

graph TD

Loading

Method prices

Gives combined labels and prices.

Calls:

• tariff.labels()
• tariff.getPrices()
• access.createTariffJWT()

graph TD
   tariff.prices --> tariff.labels
   tariff.prices --> tariff.getPrices
   tariff.prices --> access.createTariffJWT

Loading

Method labels

Called by:

• settlement.retrieve()
• tariff.prices()

Calls:

• tariff_model.find()
• price_model.find()
• tariff_model.insert()

graph TD
   settlement.retrieve --> tariff.labels
   tariff.prices --> tariff.labels
   tariff.labels --> tariff_model.find
   tariff.labels --> price_model.find
   tariff.labels --> tariff_model.insert

Loading