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
use sep2_common_derive::{SEIdentifiedObject, SEList, SEResource, SEResponse};
use yaserde::{YaDeserialize, YaSerialize};
use super::identification::ResponseStatus;
use super::links::ResponseListLink;
use super::primitives::{HexBinary160, String32, Uint32};
use super::types::{MRIDType, TimeType, VersionType};
use crate::traits::{SEIdentifiedObject, SEList, SEResource, SEResponse, Validate};
#[cfg(feature = "drlc")]
use super::{
drlc::{ApplianceLoadReduction, DutyCycle, Offset, SetPoint},
primitives::Uint16,
types::UnitType,
};
#[derive(
Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEResponse, SEResource,
)]
#[yaserde(rename = "DERControlResponse")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct DERControlResponse {
/// The createdDateTime field contains the date and time when the
/// acknowledgement/status occurred in the client. The client will provide
/// the timestamp to ensure the proper time is captured in case the response
/// is delayed in reaching the server (server receipt time would not be the
/// same as the actual confirmation time). The time reported from the client
/// should be relative to the time server indicated by the
/// FunctionSetAssignment that also indicated the event resource; if no
/// FunctionSetAssignment exists, the time of the server where the event
/// resource was hosted.
#[yaserde(rename = "createdDateTime")]
pub created_date_time: Option<TimeType>,
/// Contains the LFDI of the device providing the response.
#[yaserde(rename = "endDeviceLFDI")]
pub end_device_lfdi: HexBinary160,
/// The status field contains the acknowledgement or status. Each event type
/// (DRLC, DER, Price, or Text) can return different status information (e.g.
/// an Acknowledge will be returned for a Price event where a DRLC event can
/// return Event Received, Event Started, and Event Completed). The Status
/// field value definitions are defined in Table 27: Response Types by
/// Function Set.
#[yaserde(rename = "status")]
pub status: Option<ResponseStatus>,
/// The subject field provides a method to match the response with the
/// originating event. It is populated with the mRID of the original object.
#[yaserde(rename = "subject")]
pub subject: MRIDType,
/// 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 DERControlResponse {}
#[cfg(feature = "flow_reservation")]
#[derive(
Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEResponse, SEResource,
)]
#[yaserde(rename = "FlowReservationResponseResponse")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct FlowReservationResponseResponse {
/// The createdDateTime field contains the date and time when the
/// acknowledgement/status occurred in the client. The client will provide
/// the timestamp to ensure the proper time is captured in case the response
/// is delayed in reaching the server (server receipt time would not be the
/// same as the actual confirmation time). The time reported from the client
/// should be relative to the time server indicated by the
/// FunctionSetAssignment that also indicated the event resource; if no
/// FunctionSetAssignment exists, the time of the server where the event
/// resource was hosted.
#[yaserde(rename = "createdDateTime")]
pub created_date_time: Option<TimeType>,
/// Contains the LFDI of the device providing the response.
#[yaserde(rename = "endDeviceLFDI")]
pub end_device_lfdi: HexBinary160,
/// The status field contains the acknowledgement or status. Each event type
/// (DRLC, DER, Price, or Text) can return different status information (e.g.
/// an Acknowledge will be returned for a Price event where a DRLC event can
/// return Event Received, Event Started, and Event Completed). The Status
/// field value definitions are defined in Table 27: Response Types by
/// Function Set.
#[yaserde(rename = "status")]
pub status: Option<ResponseStatus>,
/// The subject field provides a method to match the response with the
/// originating event. It is populated with the mRID of the original object.
#[yaserde(rename = "subject")]
pub subject: MRIDType,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
#[cfg(feature = "flow_reservation")]
impl Validate for FlowReservationResponseResponse {}
#[cfg(feature = "drlc")]
/// Specifies the value of the TargetReduction applied by the device.
#[derive(Default, PartialEq, Eq, Debug, Clone, Copy, YaSerialize, YaDeserialize)]
#[yaserde(rename = "AppliedTargetReduction")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct AppliedTargetReduction {
/// Enumerated field representing the type of reduction requested.
#[yaserde(rename = "type")]
pub _type: UnitType,
/// Indicates the requested amount of the relevant commodity to be reduced.
#[yaserde(rename = "value")]
pub value: Uint16,
}
#[cfg(feature = "drlc")]
impl Validate for AppliedTargetReduction {}
#[cfg(feature = "drlc")]
#[derive(
Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEResponse, SEResource,
)]
#[yaserde(rename = "DrResponse")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct DrResponse {
#[yaserde(rename = "ApplianceLoadReduction")]
pub appliance_load_reduction: Option<ApplianceLoadReduction>,
#[yaserde(rename = "AppliedTargetReduction")]
pub applied_target_reduction: Option<AppliedTargetReduction>,
#[yaserde(rename = "DutyCycle")]
pub duty_cycle: Option<DutyCycle>,
#[yaserde(rename = "Offset")]
pub offset: Option<Offset>,
/// Indicates the amount of time, in seconds, that the client partially
/// opts-out during the demand response event. When overriding within the
/// allowed override duration, the client SHALL send a partial opt-out
/// (Response status code 8) for partial opt-out upon completion, with the
/// total time the event was overridden (this attribute) populated. The
/// client SHALL send a no participation status response (status type 10) if
/// the user partially opts-out for longer than
/// EndDeviceControl.overrideDuration.
#[yaserde(rename = "overrideDuration")]
pub override_duration: Option<Uint16>,
#[yaserde(rename = "SetPoint")]
pub set_point: Option<SetPoint>,
/// The createdDateTime field contains the date and time when the
/// acknowledgement/status occurred in the client. The client will provide
/// the timestamp to ensure the proper time is captured in case the response
/// is delayed in reaching the server (server receipt time would not be the
/// same as the actual confirmation time). The time reported from the client
/// should be relative to the time server indicated by the
/// FunctionSetAssignment that also indicated the event resource; if no
/// FunctionSetAssignment exists, the time of the server where the event
/// resource was hosted.
#[yaserde(rename = "createdDateTime")]
pub created_date_time: Option<TimeType>,
/// Contains the LFDI of the device providing the response.
#[yaserde(rename = "endDeviceLFDI")]
pub end_device_lfdi: HexBinary160,
/// The status field contains the acknowledgement or status. Each event type
/// (DRLC, DER, Price, or Text) can return different status information (e.g.
/// an Acknowledge will be returned for a Price event where a DRLC event can
/// return Event Received, Event Started, and Event Completed). The Status
/// field value definitions are defined in Table 27: Response Types by
/// Function Set.
#[yaserde(rename = "status")]
pub status: Option<ResponseStatus>,
/// The subject field provides a method to match the response with the
/// originating event. It is populated with the mRID of the original object.
#[yaserde(rename = "subject")]
pub subject: MRIDType,
/// A reference to the resource address (URI). Required in a response to a
/// GET, ignored otherwise.
#[yaserde(attribute, rename = "href")]
pub href: Option<String>,
}
#[cfg(feature = "drlc")]
impl Validate for DrResponse {}
#[derive(
Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEResponse, SEResource,
)]
#[yaserde(rename = "PriceResponse")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct PriceResponse {
/// The createdDateTime field contains the date and time when the
/// acknowledgement/status occurred in the client. The client will provide
/// the timestamp to ensure the proper time is captured in case the response
/// is delayed in reaching the server (server receipt time would not be the
/// same as the actual confirmation time). The time reported from the client
/// should be relative to the time server indicated by the
/// FunctionSetAssignment that also indicated the event resource; if no
/// FunctionSetAssignment exists, the time of the server where the event
/// resource was hosted.
#[yaserde(rename = "createdDateTime")]
pub created_date_time: Option<TimeType>,
/// Contains the LFDI of the device providing the response.
#[yaserde(rename = "endDeviceLFDI")]
pub end_device_lfdi: HexBinary160,
/// The status field contains the acknowledgement or status. Each event type
/// (DRLC, DER, Price, or Text) can return different status information (e.g.
/// an Acknowledge will be returned for a Price event where a DRLC event can
/// return Event Received, Event Started, and Event Completed). The Status
/// field value definitions are defined in Table 27: Response Types by
/// Function Set.
#[yaserde(rename = "status")]
pub status: Option<ResponseStatus>,
/// The subject field provides a method to match the response with the
/// originating event. It is populated with the mRID of the original object.
#[yaserde(rename = "subject")]
pub subject: MRIDType,
/// 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 PriceResponse {}
#[derive(Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEList, SEResource)]
#[yaserde(rename = "ResponseList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct ResponseList<T: SEResponse + Ord> {
#[yaserde(rename = "Response")]
pub response: Vec<T>,
/// 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<T: SEResponse + Ord> Validate for ResponseList<T> {}
#[derive(
Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEIdentifiedObject, SEResource,
)]
#[yaserde(rename = "ResponseSet")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct ResponseSet {
#[yaserde(rename = "ResponseListLink")]
pub response_list_link: Option<ResponseListLink>,
/// 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 ResponseSet {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for ResponseSet {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
// Primary Key - mRID (descending)
self.mrid.cmp(&other.mrid).reverse()
}
}
impl Validate for ResponseSet {}
#[derive(Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEList, SEResource)]
#[yaserde(rename = "ResponseSetList")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct ResponseSetList {
#[yaserde(rename = "ResponseSet")]
pub response_set: Vec<ResponseSet>,
/// 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 ResponseSetList {}
#[derive(
Default, PartialEq, Eq, Debug, Clone, YaSerialize, YaDeserialize, SEResponse, SEResource,
)]
#[yaserde(rename = "TextResponse")]
#[yaserde(namespace = "urn:ieee:std:2030.5:ns")]
pub struct TextResponse {
/// The createdDateTime field contains the date and time when the
/// acknowledgement/status occurred in the client. The client will provide
/// the timestamp to ensure the proper time is captured in case the response
/// is delayed in reaching the server (server receipt time would not be the
/// same as the actual confirmation time). The time reported from the client
/// should be relative to the time server indicated by the
/// FunctionSetAssignment that also indicated the event resource; if no
/// FunctionSetAssignment exists, the time of the server where the event
/// resource was hosted.
#[yaserde(rename = "createdDateTime")]
pub created_date_time: Option<TimeType>,
/// Contains the LFDI of the device providing the response.
#[yaserde(rename = "endDeviceLFDI")]
pub end_device_lfdi: HexBinary160,
/// The status field contains the acknowledgement or status. Each event type
/// (DRLC, DER, Price, or Text) can return different status information (e.g.
/// an Acknowledge will be returned for a Price event where a DRLC event can
/// return Event Received, Event Started, and Event Completed). The Status
/// field value definitions are defined in Table 27: Response Types by
/// Function Set.
#[yaserde(rename = "status")]
pub status: Option<ResponseStatus>,
/// The subject field provides a method to match the response with the
/// originating event. It is populated with the mRID of the original object.
#[yaserde(rename = "subject")]
pub subject: MRIDType,
/// 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 TextResponse {}