pub struct SampledValue {
pub value: String,
pub context: Option<ReadingContext>,
pub format: Option<ValueFormat>,
pub measurand: Option<Measurand>,
pub phase: Option<Phase>,
pub location: Option<Location>,
pub unit: Option<UnitOfMeasure>,
}Expand description
The OCPP 1.6 SampledValue data type.
Fields§
§value: StringThe value member.
context: Option<ReadingContext>The context member.
format: Option<ValueFormat>The format member.
measurand: Option<Measurand>The measurand member.
phase: Option<Phase>The phase member.
location: Option<Location>The location member.
unit: Option<UnitOfMeasure>The unit member.
Implementations§
Source§impl SampledValue
impl SampledValue
Sourcepub fn signed(value: &SignedMeterValue) -> Self
pub fn signed(value: &SignedMeterValue) -> Self
A sampled value carrying a signed meter value, in the shape 1.6 defines for it.
Sets both halves of that shape: the record serialised into value, and the format
of SignedData without which a CSMS reads the document as a measurement. A station
writing this by hand gets the second half wrong, and nothing tells it so — the message
is schema-valid either way.
use ocpp_kit::metering::SignedMeterValue;
use ocpp_kit::v1_6::{Measurand, ReadingContext, SampledValue};
let record = SignedMeterValue::new("T0NNRnx7fQ==").with_encoding_method("OCMF");
let sample = SampledValue::signed(&record)
.with_measurand(Measurand::EnergyActiveImportRegister)
.with_context(ReadingContext::TransactionEnd);
// …and it reads back as what went in.
assert_eq!(sample.signed_meter_value().unwrap().unwrap(), record);Sourcepub fn signed_meter_value(
&self,
) -> Option<Result<SignedMeterValue, SignedDataError>>
pub fn signed_meter_value( &self, ) -> Option<Result<SignedMeterValue, SignedDataError>>
The signed meter value this sampled value carries, if it carries one.
1.6 has no signedMeterValue field. The OCA application note (§3.2.1) reuses 2.x’s
SignedMeterValueType by serializing the whole object into this sampled value’s
value string, with format set to SignedData:
{"format": "SignedData",
"value": "{\"signedMeterData\":\"T0NNRnx7…\",\"encodingMethod\":\"OCMF\"}",
"context": "Transaction.End", "measurand": "Energy.Active.Import.Register"}So value is a string holding JSON holding Base64 holding the record, and a CSMS
reading it as a measurement — which is what the field is for everywhere else — finds a
JSON document where it expected kilowatt-hours. Every calibration-law-compliant German
1.6 station sends its billable value this way.
Returns None when format is not SignedData, and Some(Err(_)) when it is but
the string is not the document the note describes — which is worth surfacing rather
than dropping, since the station is then unbillable and does not know it.
Source§impl SampledValue
impl SampledValue
Sourcepub fn with_context(self, value: ReadingContext) -> Self
pub fn with_context(self, value: ReadingContext) -> Self
Sets the optional context field.
Sourcepub fn with_format(self, value: ValueFormat) -> Self
pub fn with_format(self, value: ValueFormat) -> Self
Sets the optional format field.
Sourcepub fn with_measurand(self, value: Measurand) -> Self
pub fn with_measurand(self, value: Measurand) -> Self
Sets the optional measurand field.
Sourcepub fn with_phase(self, value: Phase) -> Self
pub fn with_phase(self, value: Phase) -> Self
Sets the optional phase field.
Sourcepub fn with_location(self, value: Location) -> Self
pub fn with_location(self, value: Location) -> Self
Sets the optional location field.
Sourcepub fn with_unit(self, value: UnitOfMeasure) -> Self
pub fn with_unit(self, value: UnitOfMeasure) -> Self
Sets the optional unit field.
Trait Implementations§
Source§impl Clone for SampledValue
impl Clone for SampledValue
Source§impl Debug for SampledValue
impl Debug for SampledValue
Source§impl<'de> Deserialize<'de> for SampledValue
impl<'de> Deserialize<'de> for SampledValue
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl PartialEq for SampledValue
impl PartialEq for SampledValue
Source§impl Serialize for SampledValue
impl Serialize for SampledValue
impl StructuralPartialEq for SampledValue
Source§impl Validate for SampledValue
impl Validate for SampledValue
Source§fn validate_at(&self, path: &mut ValidationPath, out: &mut Violations)
fn validate_at(&self, path: &mut ValidationPath, out: &mut Violations)
out, relative to path.