1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
use crate::traits::{
SEEvent, SEIdentifiedObject, SEList, SERandomizableEvent, SEResource, SERespondableResource,
SERespondableSubscribableIdentifiedObject, SESubscribableList, SESubscribableResource,
Validate,
};
use sep2_common_derive::{
SEEvent, SEIdentifiedObject, SEList, SERandomizableEvent, SEResource, SERespondableResource,
SERespondableSubscribableIdentifiedObject, SESubscribableList, SESubscribableResource,
};
use yaserde::{YaDeserialize, YaSerialize};
use super::{
identification::ResponseRequired,
links::{
ActiveTimeTariffIntervalListLink, ConsumptionTariffIntervalListLink, RateComponentListLink,
ReadingTypeLink, TimeTariffIntervalListLink,
},
objects::EventStatus,
primitives::{Int32, String20, String32, Uint32, Uint48, Uint8},
types::{
ConsumptionBlockType, CurrencyCode, DateTimeInterval, MRIDType, OneHourRangeType,
PowerOfTenMultiplierType, PrimacyType, RoleFlagsType, ServiceKind, SubscribableType,
TOUType, TimeType, UnitValueType, VersionType,
},
};
#[derive(Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEResource)]
#[yaserde(rename = "ConsumptionTariffInterval")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct ConsumptionTariffInterval {
/// Indicates the consumption block related to the reading. If not specified,
/// is assumed to be "0 - N/A".
#[yaserde(rename = "consumptionBlock")]
pub consumption_block: ConsumptionBlockType,
#[yaserde(rename = "EnvironmentalCost")]
pub environmental_cost: Vec<EnvironmentalCost>,
/// The charge for this rate component, per unit of measure defined by the
/// associated ReadingType, in currency specified in TariffProfile.
/// The Pricing service provider determines the appropriate price attribute
/// value based on its applicable regulatory rules. For example, price could
/// be net or inclusive of applicable taxes, fees, or levies.
/// The Billing function set provides the ability to represent billing
/// information in a more detailed manner.
#[yaserde(rename = "price")]
pub price: Option<Int32>,
/// The lowest level of consumption that defines the starting point of this
/// consumption step or block. Thresholds start at zero for each billing
/// period.
/// If specified, the first ConsumptionTariffInterval.startValue for a
/// TimeTariffInteral instance SHALL begin at "0." Subsequent
/// ConsumptionTariffInterval.startValue elements SHALL be greater than the
/// previous one.
#[yaserde(rename = "startValue")]
pub start_value: Uint48,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl PartialOrd for ConsumptionTariffInterval {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for ConsumptionTariffInterval {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
// Primary Key - startValue (ascending)
self.start_value.cmp(&other.start_value)
}
}
impl Validate for ConsumptionTariffInterval {}
#[derive(Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEList, SEResource)]
#[yaserde(rename = "ConsumptionTariffIntervalList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct ConsumptionTariffIntervalList {
#[yaserde(rename = "ConsumptionTariffInterval")]
pub consumption_tariff_interval: Vec<ConsumptionTariffInterval>,
/// The number specifying "all" of the items in the list. Required on a
/// response to a GET, ignored otherwise.
#[yaserde(attribute, rename = "all")]
pub all: Uint32,
/// Indicates the number of items in this page of results.
#[yaserde(attribute, rename = "results")]
pub results: Uint32,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl Validate for ConsumptionTariffIntervalList {}
#[derive(Default, PartialEq, Eq, Debug, Clone, Copy, YaSerialize, YaDeserialize)]
#[yaserde(rename = "CostKindType")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
#[repr(u8)]
pub enum CostKindType {
#[default]
/// Carbon Dioxide emissions, in grams per unit
CarbonDioxide = 0,
/// Sulfur Dioxide emissions, in grams per unit
SulfurDioxide = 1,
/// Nitrogen Oxides emissions, in grams per unit
NitrogenOxide = 2,
/// Renewable generation, as a percentage of overall generation
RenewablePercentage = 3,
// 4-255 RESERVED
}
impl Validate for CostKindType {}
/// Provides alternative or secondary price information for the relevant
/// RateComponent. Supports jurisdictions that seek to convey the environmental
/// price per unit of the specified commodity not expressed in currency.
/// Implementers and consumers can use this attribute to prioritize operations of
/// their HAN devices (e.g., PEV charging during times of high availability of
/// renewable electricity resources).
#[derive(Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize)]
#[yaserde(rename = "EnvironmentalCost")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct EnvironmentalCost {
/// The estimated or actual environmental or other cost, per commodity unit
/// defined by the ReadingType, for this RateComponent (e.g., grams of carbon
/// dioxide emissions each per kWh).
#[yaserde(rename = "amount")]
pub amount: Uint32,
/// The kind of cost referred to in the amount.
#[yaserde(rename = "costKind")]
pub cost_kind: CostKindType,
/// The relative level of the amount attribute. In conjunction with
/// numCostLevels, this attribute informs a device of the relative scarcity
/// of the amount attribute (e.g., a high or low availability of renewable
/// generation).
/// numCostLevels and costLevel values SHALL ascend in order of scarcity,
/// where "0" signals the lowest relative cost and higher values signal
/// increasing cost. For example, if numCostLevels is equal to “3,” then
/// if the lowest relative costLevel were equal to “0,” devices would
/// assume this is the lowest relative period to operate. Likewise, if the
/// costLevel in the next TimeTariffInterval instance is equal to “1,”
/// then the device would assume it is relatively more expensive, in
/// environmental terms, to operate during this TimeTariffInterval instance
/// than the previous one.
/// There is no limit to the number of relative price levels other than that
/// indicated in the attribute type, but for practicality, service providers
/// should strive for simplicity and recognize the diminishing returns
/// derived from increasing the numCostLevel value greater than four.
#[yaserde(rename = "costLevel")]
pub cost_level: Uint8,
/// The number of all relative cost levels.
/// In conjunction with costLevel, numCostLevels signals the relative
/// scarcity of the commodity for the duration of the TimeTariffInterval
/// instance (e.g., a relative indication of cost). This is useful in
/// providing context for nominal cost signals to consumers or devices that
/// might see a range of amount values from different service providres or
/// from the same service provider.
#[yaserde(rename = "numCostLevels")]
pub num_cost_levels: Uint8,
}
impl Validate for EnvironmentalCost {}
#[derive(
Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEIdentifiedObject, SEResource,
)]
#[yaserde(rename = "RateComponent")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct RateComponent {
#[yaserde(rename = "ActiveTimeTariffIntervalListLink")]
pub active_time_tariff_interval_list_link: Option<ActiveTimeTariffIntervalListLink>,
/// Specifies the maximum flow rate (e.g. kW for electricity) for which this
/// RateComponent applies, for the usage point and given rate / tariff.
/// In combination with flowRateStartLimit, allows a service provider to
/// define the demand or output characteristics for the particular tariff
/// design. If a server includes the flowRateEndLimit attribute, then it
/// SHALL also include flowRateStartLimit attribute.
/// For example, a service provider’s tariff limits customers to 20 kWs of
/// demand for the given rate structure. Above this threshold (from 20-50
/// kWs), there are different demand charges per unit of consumption. The
/// service provider can use flowRateStartLimit and flowRateEndLimit to
/// describe the demand characteristics of the different rates. Similarly,
/// these attributes can be used to describe limits on premises DERs that
/// might be producing a commodity and sending it back into the distribution
/// network.
/// Note: At the time of writing, service provider tariffs with demand-based
/// components were not originally identified as being in scope, and service
/// provider tariffs vary widely in their use of demand components and the
/// method for computing charges. It is expected that industry groups (e.g.,
/// OpenSG) will document requirements in the future that the IEEE 2030.5
/// community can then use as source material for the next version of IEEE
/// 2030.5.
#[yaserde(rename = "flowRateEndLimit")]
pub flow_rate_end_limit: Option<UnitValueType>,
/// Specifies the minimum flow rate (e.g., kW for electricity) for which this
/// RateComponent applies, for the usage point and given rate / tariff.
/// In combination with flowRateEndLimit, allows a service provider to define
/// the demand or output characteristics for the particular tariff design. If
/// a server includes the flowRateStartLimit attribute, then it SHALL also
/// include flowRateEndLimit attribute.
#[yaserde(rename = "flowRateStartLimit")]
pub flow_rate_start_limit: Option<UnitValueType>,
/// Provides indication of the ReadingType with which this price is
/// associated.
#[yaserde(rename = "ReadingTypeLink")]
pub reading_type_link: ReadingTypeLink,
/// Specifies the roles that this usage point has been assigned.
#[yaserde(rename = "roleFlags")]
pub role_flags: RoleFlagsType,
#[yaserde(rename = "TimeTariffIntervalListLink")]
pub time_tariff_interval_list_link: TimeTariffIntervalListLink,
/// The global identifier of the object.
#[yaserde(rename = "mRID")]
pub mrid: MRIDType,
/// The description is a human readable text describing or naming the object.
#[yaserde(rename = "description")]
pub description: Option<String32>,
/// Contains the version number of the object. See the type definition for
/// details.
#[yaserde(rename = "version")]
pub version: Option<VersionType>,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl PartialOrd for RateComponent {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for RateComponent {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
// Primary Key - mRID (descending)
self.mrid.cmp(&other.mrid).reverse()
}
}
impl Validate for RateComponent {}
#[derive(Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEList, SEResource)]
#[yaserde(rename = "RateComponentList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct RateComponentList {
#[yaserde(rename = "RateComponent")]
pub rate_component: Vec<RateComponent>,
/// The number specifying "all" of the items in the list. Required on a
/// response to a GET, ignored otherwise.
#[yaserde(attribute, rename = "all")]
pub all: Uint32,
/// Indicates the number of items in this page of results.
#[yaserde(attribute, rename = "results")]
pub results: Uint32,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl Validate for RateComponentList {}
/// Describes the time-differentiated portion of the RateComponent,
/// if applicable, and provides the ability to specify multiple time intervals,
/// each with its own consumption-based components and other attributes.
#[derive(
Default,
PartialEq,
Eq,
Debug,
Clone,
YaSerialize,
YaDeserialize,
SERandomizableEvent,
SEEvent,
SERespondableSubscribableIdentifiedObject,
SEIdentifiedObject,
SESubscribableResource,
SERespondableResource,
SEResource,
)]
#[yaserde(rename = "TimeTariffInterval")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct TimeTariffInterval {
#[yaserde(rename = "ConsumptionTariffIntervalListLink")]
pub consumption_tariff_interval_list_link: Option<ConsumptionTariffIntervalListLink>,
/// Indicates the time of use tier related to the reading. If not specified,
/// is assumed to be "0 - N/A".
#[yaserde(rename = "touTier")]
pub tou_tier: TOUType,
/// Number of seconds boundary inside which a random value must be selected
/// to be applied to the associated interval duration, to avoid sudden
/// synchronized demand changes. If related to price level changes, sign may
/// be ignored. Valid range is -3600 to 3600. If not specified, 0 is the
/// default.
#[yaserde(rename = "randomizeDuration")]
pub randomize_duration: Option<OneHourRangeType>,
/// Number of seconds boundary inside which a random value must be selected
/// to be applied to the associated interval start time, to avoid sudden
/// synchronized demand changes. If related to price level changes, sign may
/// be ignored. Valid range is -3600 to 3600. If not specified, 0 is the
/// default.
#[yaserde(rename = "randomizeStart")]
pub randomize_start: Option<OneHourRangeType>,
/// The time at which the Event was created.
#[yaserde(rename = "creationTime")]
pub creation_time: TimeType,
#[yaserde(rename = "EventStatus")]
pub event_status: EventStatus,
/// The period during which the Event applies.
#[yaserde(rename = "interval")]
pub interval: DateTimeInterval,
/// The global identifier of the object.
#[yaserde(rename = "mRID")]
pub mrid: MRIDType,
/// The description is a human readable text describing or naming the object.
#[yaserde(rename = "description")]
pub description: Option<String32>,
/// Contains the version number of the object. See the type definition for
/// details.
#[yaserde(rename = "version")]
pub version: Option<VersionType>,
/// Indicates whether or not subscriptions are supported for this resource,
/// and whether or not conditional (thresholds) are supported. If not
/// specified, is "not subscribable" (0).
#[yaserde(attribute, rename = "subscribable")]
pub subscribable: Option<SubscribableType>,
/// A reference to the response resource address (URI). Required on a
/// response to a GET if responseRequired is "true".
#[yaserde(attribute, rename = "replyTo")]
pub reply_to: Option<String>,
/// Indicates whether or not a response is required upon receipt, creation or
/// update of this resource. Responses shall be posted to the collection
/// specified in "replyTo".
/// If the resource has a deviceCategory field, devices that match one or
/// more of the device types indicated in deviceCategory SHALL respond
/// according to the rules listed below. If the category does not match, the
/// device SHALL NOT respond. If the resource does not have a deviceCategory
/// field, a device receiving the resource SHALL respond according to the
/// rules listed below.
/// Value encoded as hex according to the following bit assignments, any
/// combination is possible.
/// See Table 27 for the list of appropriate Response status codes to be sent
/// for these purposes.
/// 0 - End device shall indicate that message was received
/// 1 - End device shall indicate specific response.
/// 2 - End user / customer response is required.
/// All other values reserved.
#[yaserde(attribute, rename = "responseRequired")]
pub response_required: Option<ResponseRequired>,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl PartialOrd for TimeTariffInterval {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for TimeTariffInterval {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
// Primary Key - interval.start (ascending)
match self.interval.start.cmp(&other.interval.start) {
core::cmp::Ordering::Equal => {}
ord => return ord,
}
// Secondary Key - creationTime (descending)
match self.creation_time.cmp(&other.creation_time).reverse() {
core::cmp::Ordering::Equal => {}
ord => return ord,
}
// Tertiary Key - mRID (descending)
self.mrid.cmp(&other.mrid).reverse()
}
}
impl Validate for TimeTariffInterval {}
#[derive(
Default,
PartialEq,
Eq,
Debug,
Clone,
YaSerialize,
YaDeserialize,
SESubscribableList,
SEList,
SESubscribableResource,
SEResource,
)]
#[yaserde(rename = "TariffProfileList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct TariffProfileList {
#[yaserde(rename = "TariffProfile")]
pub tariff_profile: Vec<TariffProfile>,
/// The default polling rate for this function set (this resource and all
/// resources below), in seconds. If not specified, a default of 900 seconds
/// (15 minutes) is used. It is RECOMMENDED a client poll the resources of
/// this function set every pollRate seconds.
#[yaserde(attribute, rename = "pollRate")]
pub poll_rate: Option<Uint32>,
/// The number specifying "all" of the items in the list. Required on GET,
/// ignored otherwise.
#[yaserde(attribute, rename = "all")]
pub all: Uint32,
/// Indicates the number of items in this page of results.
#[yaserde(attribute, rename = "results")]
pub results: Uint32,
/// Indicates whether or not subscriptions are supported for this resource,
/// and whether or not conditional (thresholds) are supported. If not
/// specified, is "not subscribable" (0).
#[yaserde(attribute, rename = "subscribable")]
pub subscribable: Option<SubscribableType>,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl Validate for TariffProfileList {}
#[derive(
Default,
PartialEq,
Eq,
Debug,
Clone,
YaSerialize,
YaDeserialize,
SESubscribableList,
SEList,
SESubscribableResource,
SEResource,
)]
#[yaserde(rename = "TimeTariffIntervalList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct TimeTariffIntervalList {
#[yaserde(rename = "TimeTariffInterval")]
pub time_tariff_interval: Vec<TimeTariffInterval>,
/// The number specifying "all" of the items in the list. Required on GET,
/// ignored otherwise.
#[yaserde(attribute, rename = "all")]
pub all: Uint32,
/// Indicates the number of items in this page of results.
#[yaserde(attribute, rename = "results")]
pub results: Uint32,
/// Indicates whether or not subscriptions are supported for this resource,
/// and whether or not conditional (thresholds) are supported. If not
/// specified, is "not subscribable" (0).
#[yaserde(attribute, rename = "subscribable")]
pub subscribable: Option<SubscribableType>,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl Validate for TimeTariffIntervalList {}
/// A schedule of charges; structure that allows the definition
/// of tariff structures such as step (block) and time of use (tier)
/// when used in conjunction with TimeTariffInterval and ConsumptionTariffInterval.
#[derive(
Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEIdentifiedObject, SEResource,
)]
#[yaserde(rename = "TariffProfile")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct TariffProfile {
/// The currency code indicating the currency for this TariffProfile.
#[yaserde(rename = "currency")]
pub currency: Option<CurrencyCode>,
/// Indicates the power of ten multiplier for the price attribute.
#[yaserde(rename = "pricePowerOfTenMultiplier")]
pub price_power_of_ten_multiplier: Option<PowerOfTenMultiplierType>,
/// Indicates the relative primacy of the provider of this program.
#[yaserde(rename = "primacy")]
pub primacy: PrimacyType,
/// The rate code for this tariff profile. Provided by the Pricing service
/// provider per its internal business needs and practices and provides a
/// method to identify the specific rate code for the TariffProfile instance.
/// This would typically not be communicated to the user except to facilitate
/// troubleshooting due to its service provider-specific technical nature.
#[yaserde(rename = "rateCode")]
pub rate_code: Option<String20>,
#[yaserde(rename = "RateComponentListLink")]
pub rate_component_list_link: Option<RateComponentListLink>,
/// The kind of service provided by this usage point.
#[yaserde(rename = "serviceCategoryKind")]
pub service_category_kind: ServiceKind,
/// The global identifier of the object.
#[yaserde(rename = "mRID")]
pub mrid: MRIDType,
/// The description is a human readable text describing or naming the object.
#[yaserde(rename = "description")]
pub description: Option<String32>,
/// Contains the version number of the object. See the type definition for
/// details.
#[yaserde(rename = "version")]
pub version: Option<VersionType>,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
impl PartialOrd for TariffProfile {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for TariffProfile {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
// Primary Key - mRID (descending)
self.mrid.cmp(&other.mrid).reverse()
}
}
impl Validate for TariffProfile {}