Skip to main content

SampledValue

Struct SampledValue 

Source
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: String

The 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

Source

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);
Source

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

Source

pub fn new(value: impl Into<String>) -> Self

Creates a SampledValue from its required fields.

Source

pub fn with_context(self, value: ReadingContext) -> Self

Sets the optional context field.

Source

pub fn with_format(self, value: ValueFormat) -> Self

Sets the optional format field.

Source

pub fn with_measurand(self, value: Measurand) -> Self

Sets the optional measurand field.

Source

pub fn with_phase(self, value: Phase) -> Self

Sets the optional phase field.

Source

pub fn with_location(self, value: Location) -> Self

Sets the optional location field.

Source

pub fn with_unit(self, value: UnitOfMeasure) -> Self

Sets the optional unit field.

Trait Implementations§

Source§

impl Clone for SampledValue

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SampledValue

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SampledValue

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SampledValue

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for SampledValue

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SampledValue

Source§

impl Validate for SampledValue

Source§

fn validate_at(&self, path: &mut ValidationPath, out: &mut Violations)

Appends this value’s violations to out, relative to path.
Source§

fn validate(&self) -> Result<(), Violations>

Validates this value from the payload root.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.