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
use crate::traits::{
SEEvent, SEIdentifiedObject, SEList, SEResource, SERespondableResource,
SERespondableSubscribableIdentifiedObject, SESubscribableList, SESubscribableResource,
Validate,
};
use sep2_common_derive::{
SEEvent, SEIdentifiedObject, SEList, SEResource, SERespondableResource,
SERespondableSubscribableIdentifiedObject, SESubscribableList, SESubscribableResource,
};
use super::{
der::ActivePower,
identification::ResponseRequired,
objects::EventStatus,
primitives::{String32, Uint16, Uint32},
types::{
DateTimeInterval, MRIDType, SignedRealEnergy, SubscribableType, TimeType, VersionType,
},
};
use yaserde::{YaDeserialize, YaSerialize};
/// The RequestStatus object is used to indicate the current status of a Flow
/// Reservation Request.
#[derive(Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize)]
#[yaserde(rename = "RequestStatus")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct RequestStatus {
/// The dateTime attribute will provide a timestamp of when the request
/// status was set. dateTime MUST be set to the time at which the status
/// change occurred, not a time in the future or past.
#[yaserde(rename = "dateTime")]
pub date_time: TimeType,
/// Field representing the request status type.
/// 0 = Requested
/// 1 = Cancelled
/// All other values reserved.
#[yaserde(rename = "requestStatus")]
pub request_status: RequestStatusType,
}
#[derive(Default, PartialEq, Eq, Debug, Clone, Copy, YaSerialize, YaDeserialize)]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
#[repr(u8)]
pub enum RequestStatusType {
#[default]
Requested = 0,
Cancelled = 1,
}
impl Validate for RequestStatus {}
#[derive(
Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEIdentifiedObject, SEResource,
)]
#[yaserde(rename = "FlowReservationRequest")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct FlowReservationRequest {
/// The time at which the request was created.
#[yaserde(rename = "creationTime")]
pub creation_time: TimeType,
/// A value that is calculated by the storage device that defines the minimum
/// duration, in seconds, that it will take to complete the actual flow
/// transaction, including any ramp times and conditioning times, if
/// applicable.
#[yaserde(rename = "durationRequested")]
pub duration_requested: Option<Uint16>,
/// Indicates the total amount of energy, in Watt-Hours, requested to be
/// transferred between the storage device and the electric power system.
/// Positive values indicate charging and negative values indicate
/// discharging. This sign convention is different than for the DER function
/// where discharging is positive. Note that the energyRequestNow attribute
/// in the PowerStatus Object must always represent a charging solution and
/// it is not allowed to have a negative value.
#[yaserde(rename = "energyRequested")]
pub energy_requested: SignedRealEnergy,
/// The time window during which the flow reservation is needed. For example,
/// if an electric vehicle is set with a 7:00 AM time charge is needed, and
/// price drops to the lowest tier at 11:00 PM, then this window would likely
/// be from 11:00 PM until 7:00 AM.
#[yaserde(rename = "intervalRequested")]
pub interval_requested: DateTimeInterval,
/// Indicates the sustained level of power, in Watts, that is requested. For
/// charging this is calculated by the storage device and it represents the
/// charging system capability (which for an electric vehicle must also
/// account for any power limitations due to the EVSE control pilot). For
/// discharging, a lower value than the inverter capability can be used as a
/// target.
#[yaserde(rename = "powerRequested")]
pub power_requested: ActivePower,
#[yaserde(rename = "RequestStatus")]
pub request_status: RequestStatus,
/// 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 FlowReservationRequest {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for FlowReservationRequest {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
// Primary Key - interval.start (ascending)
match self
.interval_requested
.start
.cmp(&other.interval_requested.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 FlowReservationRequest {}
#[derive(Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEList, SEResource)]
#[yaserde(rename = "FlowReservationRequestList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct FlowReservationRequestList {
#[yaserde(rename = "FlowReservationRequest")]
pub flow_reservation_request: Vec<FlowReservationRequest>,
/// 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 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 FlowReservationRequestList {}
#[derive(
Default,
PartialEq,
Eq,
Debug,
Clone,
YaSerialize,
YaDeserialize,
SEEvent,
SERespondableSubscribableIdentifiedObject,
SEIdentifiedObject,
SESubscribableResource,
SERespondableResource,
SEResource,
)]
#[yaserde(rename = "FlowReservationResponse")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct FlowReservationResponse {
/// Indicates the amount of energy available.
#[yaserde(rename = "energyAvailable")]
pub energy_available: SignedRealEnergy,
/// Indicates the amount of power available.
#[yaserde(rename = "powerAvailable")]
pub power_available: ActivePower,
/// The subject field provides a method to match the response with the
/// originating event. It is populated with the mRID of the corresponding
/// FlowReservationRequest object.
#[yaserde(rename = "subject")]
pub subject: MRIDType,
/// 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 FlowReservationResponse {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for FlowReservationResponse {
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 FlowReservationResponse {}
#[derive(
Default,
PartialEq,
Eq,
Debug,
Clone,
YaSerialize,
YaDeserialize,
SESubscribableList,
SEList,
SESubscribableResource,
SEResource,
)]
#[yaserde(rename = "FlowReservationResponseList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct FlowReservationResponseList {
#[yaserde(rename = "FlowReservationResponse")]
pub flow_reservation_response: Vec<FlowReservationResponse>,
/// 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 FlowReservationResponseList {}